*** empty log message ***
[bpt/emacs.git] / lisp / progmodes / idlw-shell.el
CommitLineData
5e72c6b2 1;; idlw-shell.el --- run IDL as an inferior process of Emacs.
d7a0267c 2
e6ce8c42
GM
3;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
4;; 2009 Free Software Foundation, Inc.
5e72c6b2 5
52a244eb
S
6;; Authors: J.D. Smith <jdsmith@as.arizona.edu>
7;; Carsten Dominik <dominik@astro.uva.nl>
8;; Chris Chase <chase@att.com>
5e72c6b2 9;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
dd5baa1a 10;; Version: 6.1_em22
8c7b4ec8
EZ
11;; Keywords: processes
12
13;; This file is part of GNU Emacs.
14
b1fc2b50 15;; GNU Emacs is free software: you can redistribute it and/or modify
8c7b4ec8 16;; it under the terms of the GNU General Public License as published by
b1fc2b50
GM
17;; the Free Software Foundation, either version 3 of the License, or
18;; (at your option) any later version.
8c7b4ec8
EZ
19
20;; GNU Emacs is distributed in the hope that it will be useful,
21;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23;; GNU General Public License for more details.
24
25;; You should have received a copy of the GNU General Public License
b1fc2b50 26;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
8c7b4ec8
EZ
27
28;;; Commentary:
5e72c6b2
S
29;;
30;; This mode is for IDL version 5 or later. It should work on
31;; Emacs>20.3 or XEmacs>20.4.
32;;
dd5baa1a 33;; Runs IDL as an inferior process of Emacs, much like the Emacs
8c7b4ec8
EZ
34;; `shell' or `telnet' commands. Provides command history and
35;; searching. Provides debugging commands available in buffers
36;; visiting IDL procedure files, e.g., breakpoint setting, stepping,
37;; execution until a certain line, printing expressions under point,
38;; visual line pointer for current execution line, etc.
39;;
40;; Documentation should be available online with `M-x idlwave-info'.
5e72c6b2
S
41;;
42;; New versions of IDLWAVE, documentation, and more information
43;; available from:
44;; http://idlwave.org
45;;
8c7b4ec8
EZ
46;; INSTALLATION:
47;; =============
5cba7601 48;;
8c7b4ec8
EZ
49;; Follow the instructions in the INSTALL file of the distribution.
50;; In short, put this file on your load path and add the following
51;; lines to your .emacs file:
52;;
53;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
54;;
55;;
56;; SOURCE
57;; ======
58;;
59;; The newest version of this file can be found on the maintainers
60;; web site.
5cba7601 61;;
5e72c6b2 62;; http://idlwave.org
5cba7601 63;;
8c7b4ec8
EZ
64;; DOCUMENTATION
65;; =============
66;;
67;; IDLWAVE is documented online in info format.
68;; A printable version of the documentation is available from the
69;; maintainers webpage (see under SOURCE)
70;;
71;;
72;; KNOWN PROBLEMS
73;; ==============
74;;
8c7b4ec8
EZ
75;; Under XEmacs the Debug menu in the shell does not display the
76;; keybindings in the prefix map. There bindings are available anyway - so
77;; it is a bug in XEmacs.
ca660d22 78;; The Debug menu in source buffers *does* display the bindings correctly.
8c7b4ec8 79;;
5cba7601 80;;
8c7b4ec8
EZ
81;; CUSTOMIZATION VARIABLES
82;; =======================
83;;
84;; IDLWAVE has customize support - so if you want to learn about
85;; the variables which control the behavior of the mode, use
86;; `M-x idlwave-customize'.
87;;
88;;--------------------------------------------------------------------------
89;;
8c7b4ec8
EZ
90\f
91;;; Code:
92
93(require 'comint)
94(require 'idlwave)
95
96(eval-when-compile (require 'cl))
97
98(defvar idlwave-shell-have-new-custom nil)
8c7b4ec8
EZ
99
100;;; Customizations: idlwave-shell group
101
76959b77 102;; General/Misc. customizations
8c7b4ec8 103(defgroup idlwave-shell-general-setup nil
05a1abfc
CD
104 "General setup of the Shell interaction for IDLWAVE/Shell."
105 :prefix "idlwave-shell"
8c7b4ec8
EZ
106 :group 'idlwave)
107
3938cb82 108(defcustom idlwave-shell-prompt-pattern "^\r? ?IDL> "
5cba7601
GM
109 "*Regexp to match IDL prompt at beginning of a line.
110For example, \"^\r?IDL> \" or \"^\r?WAVE> \".
3938cb82
S
111The \"^\r?\" is needed, to indicate the beginning of the line, with
112optional return character (which IDL seems to output randomly).
5cba7601 113This variable is used to initialize `comint-prompt-regexp' in the
8c7b4ec8
EZ
114process buffer.
115
116This is a fine thing to set in your `.emacs' file."
117 :group 'idlwave-shell-general-setup
118 :type 'regexp)
119
120(defcustom idlwave-shell-process-name "idl"
121 "*Name to be associated with the IDL process. The buffer for the
122process output is made by surrounding this name with `*'s."
123 :group 'idlwave-shell-general-setup
124 :type 'string)
125
05a1abfc 126;; (defcustom idlwave-shell-automatic-start...) See idlwave.el
8c7b4ec8 127
f66f03de
S
128(defcustom idlwave-shell-use-dedicated-window nil
129 "*Non-nil means, never replace the shell frame with another buffer."
130 :group 'idlwave-shell-general-setup
5cba7601 131 :type 'boolean)
f66f03de 132
8c7b4ec8
EZ
133(defcustom idlwave-shell-use-dedicated-frame nil
134 "*Non-nil means, IDLWAVE should use a special frame to display shell buffer."
135 :group 'idlwave-shell-general-setup
136 :type 'boolean)
137
138(defcustom idlwave-shell-frame-parameters
139 '((height . 30) (unsplittable . nil))
140 "The frame parameters for a dedicated idlwave-shell frame.
141See also `idlwave-shell-use-dedicated-frame'.
142The default makes the frame splittable, so that completion works correctly."
143 :group 'idlwave-shell-general-setup
144 :type '(repeat
145 (cons symbol sexp)))
146
5e72c6b2
S
147(defcustom idlwave-shell-raise-frame t
148 "*Non-nil means, `idlwave-shell' raises the frame showing the shell window."
149 :group 'idlwave-shell-general-setup
150 :type 'boolean)
151
05a1abfc
CD
152(defcustom idlwave-shell-arrows-do-history t
153 "*Non-nil means UP and DOWN arrows move through command history.
154This variable can have 3 values:
155nil Arrows just move the cursor
156t Arrows force the cursor back to the current command line and
157 walk the history
158'cmdline When the cursor is in the current command line, arrows walk the
159 history. Everywhere else in the buffer, arrows move the cursor."
160 :group 'idlwave-shell-general-setup
161 :type '(choice
162 (const :tag "never" nil)
163 (const :tag "everywhere" t)
164 (const :tag "in command line only" cmdline)))
165
5e72c6b2 166;; FIXME: add comint-input-ring-size?
5e72c6b2 167
8c7b4ec8 168(defcustom idlwave-shell-use-toolbar t
05a1abfc 169 "*Non-nil means, use the debugging toolbar in all IDL related buffers.
ca660d22
CD
170Starting the shell will then add the toolbar to all idlwave-mode buffers.
171Exiting the shell will removed everywhere.
8c7b4ec8 172Available on XEmacs and on Emacs 21.x or later.
ca660d22
CD
173At any time you can toggle the display of the toolbar with
174`C-c C-d C-t' (`idlwave-shell-toggle-toolbar')."
8c7b4ec8
EZ
175 :group 'idlwave-shell-general-setup
176 :type 'boolean)
177
178(defcustom idlwave-shell-temp-pro-prefix "/tmp/idltemp"
179 "*The prefix for temporary IDL files used when compiling regions.
180It should be an absolute pathname.
5e72c6b2 181The full temporary file name is obtained by using `make-temp-file'
8c7b4ec8
EZ
182so that the name will be unique among multiple Emacs processes."
183 :group 'idlwave-shell-general-setup
184 :type 'string)
185
186(defvar idlwave-shell-fix-inserted-breaks nil
187 "*OBSOLETE VARIABLE, is no longer used.
188
189The documentation of this variable used to be:
190If non-nil then run `idlwave-shell-remove-breaks' to clean up IDL messages.")
191
192(defcustom idlwave-shell-prefix-key "\C-c\C-d"
193 "*The prefix key for the debugging map `idlwave-shell-mode-prefix-map'.
194This variable must already be set when idlwave-shell.el is loaded.
05a1abfc 195Setting it in the mode-hook is too late."
8c7b4ec8
EZ
196 :group 'idlwave-shell-general-setup
197 :type 'string)
198
199(defcustom idlwave-shell-activate-prefix-keybindings t
200 "Non-nil means, the debug commands will be bound to the prefix key.
201The prefix key itself is given in the option `idlwave-shell-prefix-key'.
202So by default setting a breakpoint will be on C-c C-d C-b."
203 :group 'idlwave-shell-general-setup
204 :type 'boolean)
205
52a244eb 206(defcustom idlwave-shell-automatic-electric-debug 'breakpoint
5cba7601 207 "Enter the electric-debug minor mode automatically.
52a244eb
S
208This occurs at a breakpoint or any other halt. The mode is exited
209upon return to the main level. Can be set to 'breakpoint to enter
210electric debug mode only when breakpoints are tripped."
211 :group 'idlwave-shell-general-setup
212 :type '(choice
213 (const :tag "never" nil)
214 (const :tag "always" t)
215 (const :tag "for breakpoints only" breakpoint)))
216
217(defcustom idlwave-shell-electric-zap-to-file t
218 "When entering electric debug mode, select the window displaying the
219file at which point is stopped. This takes point away from the shell
220window, but is useful for stepping, etc."
221 :group 'idlwave-shell-general-setup
222 :type 'boolean)
223
05a1abfc
CD
224;; (defcustom idlwave-shell-debug-modifiers... See idlwave.el
225
226(defvar idlwave-shell-activate-alt-keybindings nil
227 "Obsolete variable. See `idlwave-shell-debug-modifiers'.")
8c7b4ec8
EZ
228
229(defcustom idlwave-shell-use-truename nil
230 "*Non-nil means, use use `file-truename' when looking for buffers.
231If this variable is non-nil, Emacs will use the function `file-truename' to
232resolve symbolic links in the file paths printed by e.g., STOP commands.
233This means, unvisited files will be loaded under their truename.
15e42531 234However, when a file is already visited under a different name, IDLWAVE will
8c7b4ec8
EZ
235reuse that buffer.
236This option was once introduced in order to avoid multiple buffers visiting
237the same file. However, IDLWAVE no longer makes this mistake, so it is safe
238to set this option to nil."
239 :group 'idlwave-shell-general-setup
240 :type 'boolean)
241
dd5baa1a 242(defcustom idlwave-shell-file-name-chars "~/A-Za-z0-9+:_.$#%={}\\- "
8c7b4ec8
EZ
243 "The characters allowed in file names, as a string.
244Used for file name completion. Must not contain `'', `,' and `\"'
245because these are used as separators by IDL."
246 :group 'idlwave-shell-general-setup
247 :type 'string)
248
249(defcustom idlwave-shell-mode-hook '()
250 "*Hook for customising `idlwave-shell-mode'."
251 :group 'idlwave-shell-general-setup
252 :type 'hook)
253
76959b77
S
254(defcustom idlwave-shell-graphics-window-size '(500 400)
255 "Size of IDL graphics windows popped up by special IDLWAVE command.
256The command is `C-c C-d C-f' and accepts as a prefix the window nr.
257A command like `WINDOW,N,xsize=XX,ysize=YY' is sent to IDL."
258 :group 'idlwave-shell-general-setup
259 :type '(list
260 (integer :tag "x size")
261 (integer :tag "y size")))
262
52a244eb 263
76959b77
S
264;; Commands Sent to Shell... etc.
265(defgroup idlwave-shell-command-setup nil
266 "Setup for command parameters of the Shell interaction for IDLWAVE."
267 :prefix "idlwave-shell"
268 :group 'idlwave)
269
52a244eb 270(defcustom idlwave-shell-initial-commands "!more=0 & defsysv,'!ERROR_STATE',EXISTS=__e & if __e then begin & !ERROR_STATE.MSG_PREFIX=\"% \" & delvar,__e & endif"
76959b77
S
271 "Initial commands, separated by newlines, to send to IDL.
272This string is sent to the IDL process by `idlwave-shell-mode' which is
273invoked by `idlwave-shell'."
274 :group 'idlwave-shell-command-setup
275 :type 'string)
276
277(defcustom idlwave-shell-save-command-history t
278 "Non-nil means preserve command history between sessions.
279The file `idlwave-shell-command-history-file' is used to save and restore
280the history."
281 :group 'idlwave-shell-command-setup
282 :type 'boolean)
283
52a244eb 284(defcustom idlwave-shell-command-history-file "idlwhist"
76959b77
S
285 "The file in which the command history of the idlwave shell is saved.
286In order to change the size of the history, see the variable
287`comint-input-ring-size'.
288The history is only saved if the variable `idlwave-shell-save-command-history'
289is non-nil."
290 :group 'idlwave-shell-command-setup
291 :type 'file)
5cba7601 292
76959b77
S
293(defcustom idlwave-shell-show-commands
294 '(run misc breakpoint)
13ae1076 295 "*A list of command types to show output from in the shell.
52a244eb
S
296Possibilities are 'run, 'debug, 'breakpoint, and 'misc. Unselected
297types are not displayed in the shell. The type 'everything causes all
298the copious shell traffic to be displayed."
76959b77
S
299 :group 'idlwave-shell-command-setup
300 :type '(choice
301 (const everything)
302 (set :tag "Checklist" :greedy t
5cba7601 303 (const :tag "All .run and .compile commands" run)
52a244eb
S
304 (const :tag "All breakpoint commands" breakpoint)
305 (const :tag "All debug and stepping commands" debug)
306 (const :tag "Close, window, retall, etc. commands" misc))))
5e72c6b2 307
f66f03de
S
308(defcustom idlwave-shell-max-print-length 200
309 "Maximum number of array elements to print when examining."
310 :group 'idlwave-shell-command-setup
311 :type 'integer)
312
5cba7601
GM
313(defcustom idlwave-shell-examine-alist
314 `(("Print" . ,(concat "idlwave_print_safe,___,"
315 (number-to-string
f66f03de 316 idlwave-shell-max-print-length)))
5e72c6b2
S
317 ("Help" . "help,___")
318 ("Structure Help" . "help,___,/STRUCTURE")
319 ("Dimensions" . "print,size(___,/DIMENSIONS)")
320 ("Type" . "print,size(___,/TNAME)")
321 ("N_Elements" . "print,n_elements(___)")
322 ("All Size Info" . "help,(__IWsz__=size(___,/STRUCTURE)),/STRUCTURE & print,__IWsz__.DIMENSIONS")
323 ("Ptr Valid" . "print,ptr_valid(___)")
f66f03de 324 ("Arg Present" . "print,arg_present(___)")
5e72c6b2
S
325 ("Widget Valid" . "print,widget_info(___,/VALID)")
326 ("Widget Geometry" . "help,widget_info(___,/GEOMETRY)"))
5cba7601 327 "Alist of special examine commands for popup selection.
5e72c6b2
S
328The keys are used in the selection popup created by
329`idlwave-shell-examine-select', and the corresponding value is sent as
330a command to the shell, with special sequence `___' replaced by the
331expression being examined."
76959b77 332 :group 'idlwave-shell-command-setup
5e72c6b2 333 :type '(repeat
5cba7601 334 (cons
5e72c6b2
S
335 (string :tag "Label ")
336 (string :tag "Command"))))
ca660d22 337
76959b77
S
338(defvar idlwave-shell-print-expression-function nil
339 "*OBSOLETE VARIABLE, is no longer used.")
340
5e72c6b2
S
341(defcustom idlwave-shell-separate-examine-output t
342 "*Non-nil mean, put output of examine commands in their own buffer."
76959b77 343 :group 'idlwave-shell-command-setup
5e72c6b2 344 :type 'boolean)
5cba7601 345
76959b77
S
346(defcustom idlwave-shell-comint-settings
347 '((comint-scroll-to-bottom-on-input . t)
348 (comint-scroll-to-bottom-on-output . t)
3938cb82
S
349 (comint-scroll-show-maximum-output . nil)
350 (comint-prompt-read-only . t))
76959b77
S
351
352 "Alist of special settings for the comint variables in the IDLWAVE Shell.
353Each entry is a cons cell with the name of a variable and a value.
354The function `idlwave-shell-mode' will make local variables out of each entry.
355Changes to this variable will only be active when the shell buffer is
356newly created."
357 :group 'idlwave-shell-command-setup
358 :type '(repeat
359 (cons variable sexp)))
360
361(defcustom idlwave-shell-query-for-class t
362 "*Non-nil means query the shell for object class on object completions."
363 :group 'idlwave-shell-command-setup
364 :type 'boolean)
365
15e42531
CD
366(defcustom idlwave-shell-use-input-mode-magic nil
367 "*Non-nil means, IDLWAVE should check for input mode spells in output.
368The spells are strings printed by your IDL program and matched
369by the regular expressions in `idlwave-shell-input-mode-spells'.
370When these expressions match, IDLWAVE switches to character input mode and
371back, respectively. See `idlwave-shell-input-mode-spells' for details."
76959b77 372 :group 'idlwave-shell-command-setup
15e42531
CD
373 :type 'boolean)
374
375(defcustom idlwave-shell-input-mode-spells
376 '("^<onechar>$" "^<chars>$" "^</chars>$")
377 "The three regular expressions which match the magic spells for input modes.
378
52a244eb 379When the first regexp matches in the output stream of IDL, IDLWAVE
15e42531
CD
380prompts for a single character and sends it immediately to IDL, similar
381to the command \\[idlwave-shell-send-char].
382
383When the second regexp matches, IDLWAVE switches to a blocking
384single-character input mode. This is the same mode which can be entered
385manually with \\[idlwave-shell-char-mode-loop].
386This input mode exits when the third regexp matches in the output,
387or when the IDL prompt is encountered.
388
389The variable `idlwave-shell-use-input-mode-magic' must be non-nil to enable
390scanning for these expressions. If the IDL program produces lots of
391output, shell operation may be slowed down.
392
393This mechanism is useful for correct interaction with the IDL function
394GET_KBRD, because in normal operation IDLWAVE only sends \\n terminated
05a1abfc 395strings. Here is some example code which makes use of the default spells.
15e42531
CD
396
397 print,'<chars>' ; Make IDLWAVE switch to character mode
398 REPEAT BEGIN
399 A = GET_KBRD(1)
400 PRINT, BYTE(A)
401 ENDREP UNTIL A EQ 'q'
402 print,'</chars>' ; Make IDLWAVE switch back to line mode
403
404 print,'Quit the program, y or n?'
405 print,'<onechar>' ; Ask IDLWAVE to send one character
406 answer = GET_KBRD(1)
407
408Since the IDLWAVE shell defines the system variable `!IDLWAVE_VERSION',
5cba7601 409you could actually check if you are running under Emacs before printing
15e42531
CD
410the magic strings. Here is a procedure which uses this.
411
412Usage:
413======
414idlwave_char_input ; Make IDLWAVE send one character
415idlwave_char_input,/on ; Start the loop to send characters
52a244eb 416idlwave_char_input,/off ; End the loop to send characters
15e42531
CD
417
418
419pro idlwave_char_input,on=on,off=off
420 ;; Test if we are running under Emacs
421 defsysv,'!idlwave_version',exists=running_emacs
422 if running_emacs then begin
423 if keyword_set(on) then print,'<chars>' $
424 else if keyword_set(off) then print,'</chars>' $
425 else print,'<onechar>'
5cba7601 426 endif
15e42531 427end"
76959b77 428 :group 'idlwave-shell-command-setup
15e42531
CD
429 :type '(list
430 (regexp :tag "One-char regexp")
431 (regexp :tag "Char-mode regexp")
432 (regexp :tag "Line-mode regexp")))
433
3938cb82
S
434(defcustom idlwave-shell-breakpoint-popup-menu t
435 "*If non-nil, provide a menu on mouse-3 on breakpoint lines, and
436popup help text on the line."
437 :group 'idlwave-shell-command-setup
438 :type 'boolean)
8c7b4ec8 439
f66f03de
S
440(defcustom idlwave-shell-reset-no-prompt nil
441 "If non-nil, skip the yes/no prompt when resetting the IDL session."
442 :group 'idlwave-shell-command-setup
443 :type 'boolean)
444
76959b77 445;; Breakpoint Overlays etc
8c7b4ec8 446(defgroup idlwave-shell-highlighting-and-faces nil
05a1abfc
CD
447 "Highlighting and Faces used by the IDLWAVE Shell mode."
448 :prefix "idlwave-shell"
8c7b4ec8
EZ
449 :group 'idlwave)
450
451(defcustom idlwave-shell-mark-stop-line t
452 "*Non-nil means, mark the source code line where IDL is currently stopped.
2e8b9c7d 453Value decides about the method which is used to mark the line. Valid values
8c7b4ec8
EZ
454are:
455
456nil Do not mark the line
457'arrow Use the overlay arrow
458'face Use `idlwave-shell-stop-line-face' to highlight the line.
05a1abfc 459t Use what IDLWAVE thinks is best. Will be a face where possible,
8c7b4ec8
EZ
460 otherwise the overlay arrow.
461The overlay-arrow has the disadvantage to hide the first chars of a line.
462Since many people do not have the main block of IDL programs indented,
463a face highlighting may be better.
5e72c6b2 464In Emacs 21, the overlay arrow is displayed in a special area and never
8c7b4ec8
EZ
465hides any code, so setting this to 'arrow on Emacs 21 sounds like a good idea."
466 :group 'idlwave-shell-highlighting-and-faces
467 :type '(choice
468 (const :tag "No marking" nil)
469 (const :tag "Use overlay arrow" arrow)
470 (const :tag "Highlight with face" face)
471 (const :tag "Face or arrow." t)))
472
473(defcustom idlwave-shell-overlay-arrow ">"
474 "*The overlay arrow to display at source lines where execution halts.
475We use a single character by default, since the main block of IDL procedures
476often has no indentation. Where possible, IDLWAVE will use overlays to
477display the stop-lines. The arrow is only used on character-based terminals.
478See also `idlwave-shell-use-overlay-arrow'."
479 :group 'idlwave-shell-highlighting-and-faces
480 :type 'string)
481
482(defcustom idlwave-shell-stop-line-face 'highlight
483 "*The face for `idlwave-shell-stop-line-overlay'.
484Allows you to choose the font, color and other properties for
485line where IDL is stopped. See also `idlwave-shell-mark-stop-line'."
486 :group 'idlwave-shell-highlighting-and-faces
487 :type 'symbol)
488
52a244eb
S
489(defcustom idlwave-shell-electric-stop-color "Violet"
490 "*The color for the default face or overlay arrow when stopped."
491 :group 'idlwave-shell-highlighting-and-faces
492 :type 'string)
493
5cba7601 494(defcustom idlwave-shell-electric-stop-line-face
52a244eb 495 (prog1
f66f03de 496 (copy-face 'modeline 'idlwave-shell-electric-stop-line)
5cba7601 497 (set-face-background 'idlwave-shell-electric-stop-line
52a244eb
S
498 idlwave-shell-electric-stop-color)
499 (condition-case nil
f66f03de 500 (set-face-foreground 'idlwave-shell-electric-stop-line nil)
52a244eb
S
501 (error nil)))
502 "*The face for `idlwave-shell-stop-line-overlay' when in electric debug mode.
503Allows you to choose the font, color and other properties for the line
504where IDL is stopped, when in Electric Debug Mode."
505 :group 'idlwave-shell-highlighting-and-faces
506 :type 'symbol)
507
8c7b4ec8
EZ
508(defcustom idlwave-shell-mark-breakpoints t
509 "*Non-nil means, mark breakpoints in the source files.
2e8b9c7d 510Valid values are:
8c7b4ec8
EZ
511nil Do not mark breakpoints.
512'face Highlight line with `idlwave-shell-breakpoint-face'.
513'glyph Red dot at the beginning of line. If the display does not
514 support glyphs, will use 'face instead.
515t Glyph when possible, otherwise face (same effect as 'glyph)."
516 :group 'idlwave-shell-highlighting-and-faces
517 :type '(choice
518 (const :tag "No marking" nil)
519 (const :tag "Highlight with face" face)
520 (const :tag "Display glyph (red dot)" glyph)
521 (const :tag "Glyph or face." t)))
522
523(defvar idlwave-shell-use-breakpoint-glyph t
cff745c3 524 "Obsolete variable. See `idlwave-shell-mark-breakpoints.")
8c7b4ec8 525
57267a95 526(defcustom idlwave-shell-breakpoint-face 'idlwave-shell-bp
8c7b4ec8
EZ
527 "*The face for breakpoint lines in the source code.
528Allows you to choose the font, color and other properties for
529lines which have a breakpoint. See also `idlwave-shell-mark-breakpoints'."
530 :group 'idlwave-shell-highlighting-and-faces
531 :type 'symbol)
532
57267a95
MB
533(if (not idlwave-shell-have-new-custom)
534 ;; Just copy the underline face to be on the safe side.
535 (copy-face 'underline 'idlwave-shell-bp)
536 ;; We have the new customize - use it to define a customizable face
537 (defface idlwave-shell-bp
538 '((((class color)) (:foreground "Black" :background "Pink"))
539 (t (:underline t)))
540 "Face for highlighting lines with breakpoints."
e95e5f81 541 :group 'idlwave-shell-highlighting-and-faces))
8c7b4ec8 542
5cba7601 543(defcustom idlwave-shell-disabled-breakpoint-face
57267a95 544 'idlwave-shell-disabled-bp
52a244eb
S
545 "*The face for disabled breakpoint lines in the source code.
546Allows you to choose the font, color and other properties for
547lines which have a breakpoint. See also `idlwave-shell-mark-breakpoints'."
548 :group 'idlwave-shell-highlighting-and-faces
549 :type 'symbol)
550
57267a95
MB
551(if (not idlwave-shell-have-new-custom)
552 ;; Just copy the underline face to be on the safe side.
553 (copy-face 'underline 'idlwave-shell-disabled-bp)
554 ;; We have the new customize - use it to define a customizable face
555 (defface idlwave-shell-disabled-bp
556 '((((class color)) (:foreground "Black" :background "gray"))
557 (t (:underline t)))
558 "Face for highlighting lines with breakpoints."
e95e5f81 559 :group 'idlwave-shell-highlighting-and-faces))
52a244eb 560
f66f03de 561
ca660d22
CD
562(defcustom idlwave-shell-expression-face 'secondary-selection
563 "*The face for `idlwave-shell-expression-overlay'.
564Allows you to choose the font, color and other properties for
565the expression printed by IDL."
566 :group 'idlwave-shell-highlighting-and-faces
567 :type 'symbol)
568
5e72c6b2
S
569(defcustom idlwave-shell-output-face 'secondary-selection
570 "*The face for `idlwave-shell-output-overlay'.
571Allows you to choose the font, color and other properties for
572the expression output by IDL."
573 :group 'idlwave-shell-highlighting-and-faces
574 :type 'symbol)
575
8c7b4ec8
EZ
576;;; End user customization variables
577
578;;; External variables
579(defvar comint-last-input-start)
580(defvar comint-last-input-end)
581
ddd709d1
S
582;; Other variables
583(defvar idlwave-shell-temp-pro-file nil
584 "Absolute pathname for temporary IDL file for compiling regions")
585
586(defvar idlwave-shell-temp-rinfo-save-file nil
587 "Absolute pathname for temporary IDL file save file for routine_info.
588This is used to speed up the reloading of the routine info procedure
589before use by the shell.")
590
5e72c6b2
S
591(defun idlwave-shell-temp-file (type)
592 "Return a temp file, creating it if necessary.
593
ddd709d1
S
594TYPE is either 'pro' or 'rinfo', and `idlwave-shell-temp-pro-file' or
595`idlwave-shell-temp-rinfo-save-file' is set (respectively)."
5cba7601 596 (cond
5e72c6b2 597 ((eq type 'rinfo)
5cba7601
GM
598 (or idlwave-shell-temp-rinfo-save-file
599 (setq idlwave-shell-temp-rinfo-save-file
5e72c6b2
S
600 (idlwave-shell-make-temp-file idlwave-shell-temp-pro-prefix))))
601 ((eq type 'pro)
602 (or idlwave-shell-temp-pro-file
5cba7601 603 (setq idlwave-shell-temp-pro-file
5e72c6b2 604 (idlwave-shell-make-temp-file idlwave-shell-temp-pro-prefix))))
5cba7601 605 (t (error "Wrong argument (idlwave-shell-temp-file): %s"
5e72c6b2 606 (symbol-name type)))))
5cba7601 607
8c7b4ec8 608
5e72c6b2
S
609(defun idlwave-shell-make-temp-file (prefix)
610 "Create a temporary file."
611 ; Hard coded make-temp-file for Emacs<21
612 (if (fboundp 'make-temp-file)
613 (make-temp-file prefix)
614 (let (file
615 (temp-file-dir (if (boundp 'temporary-file-directory)
616 temporary-file-directory
617 "/tmp")))
618 (while (condition-case ()
619 (progn
620 (setq file
621 (make-temp-name
622 (expand-file-name prefix temp-file-dir)))
623 (if (featurep 'xemacs)
624 (write-region "" nil file nil 'silent nil)
625 (write-region "" nil file nil 'silent nil 'excl))
626 nil)
627 (file-already-exists t))
628 ;; the file was somehow created by someone else between
629 ;; `make-temp-name' and `write-region', let's try again.
630 nil)
631 file)))
15e42531 632
52a244eb 633
76959b77 634(defvar idlwave-shell-dirstack-query "cd,current=___cur & print,___cur"
5cba7601 635 "Command used by `idlwave-shell-resync-dirs' to query IDL for
8c7b4ec8
EZ
636the directory stack.")
637
52a244eb
S
638(defvar idlwave-shell-path-query "print,'PATH:<'+transpose(expand_path(!PATH,/ARRAY))+'>' & print,'SYSDIR:<'+!dir+'>'"
639
640 "The command which gets !PATH and !DIR info from the shell.")
15e42531 641
ca660d22 642(defvar idlwave-shell-mode-line-info nil
5cba7601 643 "Additional info displayed in the mode line")
ca660d22 644
8c7b4ec8
EZ
645(defvar idlwave-shell-default-directory nil
646 "The default directory in the idlwave-shell buffer, of outside use.")
647
648(defvar idlwave-shell-last-save-and-action-file nil
649 "The last file which was compiled with `idlwave-shell-save-and-...'.")
650
651;; Highlighting uses overlays. When necessary, require the emulation.
652(if (not (fboundp 'make-overlay))
653 (condition-case nil
654 (require 'overlay)
655 (error nil)))
656
657(defvar idlwave-shell-stop-line-overlay nil
658 "The overlay for where IDL is currently stopped.")
15e42531 659(defvar idlwave-shell-is-stopped nil)
8c7b4ec8 660(defvar idlwave-shell-expression-overlay nil
f66f03de 661 "The overlay for the examined expression.")
5e72c6b2
S
662(defvar idlwave-shell-output-overlay nil
663 "The overlay for the last IDL output.")
664
8c7b4ec8
EZ
665;; If these were already overlays, delete them. This probably means that we
666;; are reloading this file.
667(if (overlayp idlwave-shell-stop-line-overlay)
668 (delete-overlay idlwave-shell-stop-line-overlay))
669(if (overlayp idlwave-shell-expression-overlay)
670 (delete-overlay idlwave-shell-expression-overlay))
5e72c6b2
S
671(if (overlayp idlwave-shell-output-overlay)
672 (delete-overlay idlwave-shell-output-overlay))
673
8c7b4ec8
EZ
674;; Set to nil initially
675(setq idlwave-shell-stop-line-overlay nil
5e72c6b2
S
676 idlwave-shell-expression-overlay nil
677 idlwave-shell-output-overlay nil)
8c7b4ec8
EZ
678
679;; Define the shell stop overlay. When left nil, the arrow will be used.
680(cond
681 ((or (null idlwave-shell-mark-stop-line)
682 (eq idlwave-shell-mark-stop-line 'arrow))
683 ;; Leave the overlay nil
684 nil)
685
686 ((eq idlwave-shell-mark-stop-line 'face)
687 ;; Try to use a face. If not possible, arrow will be used anyway
688 ;; So who can display faces?
689 (when (or (featurep 'xemacs) ; XEmacs can do also ttys
690 (fboundp 'tty-defined-colors) ; Emacs 21 as well
691 window-system) ; Window systems always
692 (progn
693 (setq idlwave-shell-stop-line-overlay (make-overlay 1 1))
5cba7601 694 (overlay-put idlwave-shell-stop-line-overlay
8c7b4ec8
EZ
695 'face idlwave-shell-stop-line-face))))
696
697 (t
698 ;; IDLWAVE may decide. Will use a face on window systems, arrow elsewhere
699 (if window-system
700 (progn
701 (setq idlwave-shell-stop-line-overlay (make-overlay 1 1))
5cba7601 702 (overlay-put idlwave-shell-stop-line-overlay
8c7b4ec8
EZ
703 'face idlwave-shell-stop-line-face)))))
704
5e72c6b2 705;; Now the expression and output overlays
8c7b4ec8
EZ
706(setq idlwave-shell-expression-overlay (make-overlay 1 1))
707(overlay-put idlwave-shell-expression-overlay
708 'face idlwave-shell-expression-face)
f66f03de
S
709(overlay-put idlwave-shell-expression-overlay
710 'priority 1)
5e72c6b2
S
711(setq idlwave-shell-output-overlay (make-overlay 1 1))
712(overlay-put idlwave-shell-output-overlay
713 'face idlwave-shell-output-face)
714
5cba7601 715(copy-face idlwave-shell-stop-line-face
f66f03de 716 'idlwave-shell-pending-stop)
5cba7601 717(copy-face idlwave-shell-electric-stop-line-face
f66f03de
S
718 'idlwave-shell-pending-electric-stop)
719(set-face-background 'idlwave-shell-pending-stop "gray70")
720(set-face-background 'idlwave-shell-pending-electric-stop "gray70")
721
722
723
8c7b4ec8
EZ
724(defvar idlwave-shell-bp-query "help,/breakpoints"
725 "Command to obtain list of breakpoints")
726
727(defvar idlwave-shell-command-output nil
728 "String for accumulating current command output.")
729
730(defvar idlwave-shell-post-command-hook nil
731 "Lisp list expression or function to run when an IDL command is finished.
732The current command is finished when the IDL prompt is displayed.
733This is evaluated if it is a list or called with funcall.")
734
5e72c6b2
S
735(defvar idlwave-shell-sentinel-hook nil
736 "Hook run when the idl process exits.")
737
8c7b4ec8
EZ
738(defvar idlwave-shell-hide-output nil
739 "If non-nil the process output is not inserted into the output
52a244eb
S
740buffer.")
741
742(defvar idlwave-shell-show-if-error nil
743 "If non-nil the process output is inserted into the output buffer if
744it contains an error message, even if hide-output is non-nil.")
8c7b4ec8
EZ
745
746(defvar idlwave-shell-accumulation nil
747 "Accumulate last line of output.")
748
749(defvar idlwave-shell-command-line-to-execute nil)
750(defvar idlwave-shell-cleanup-hook nil
751 "List of functions to do cleanup when the shell exits.")
752
753(defvar idlwave-shell-pending-commands nil
754 "List of commands to be sent to IDL.
755Each element of the list is list of \(CMD PCMD HIDE\), where CMD is a
756string to be sent to IDL and PCMD is a post-command to be placed on
757`idlwave-shell-post-command-hook'. If HIDE is non-nil, hide the output
758from command CMD. PCMD and HIDE are optional.")
759
760(defun idlwave-shell-buffer ()
761 "Name of buffer associated with IDL process.
762The name of the buffer is made by surrounding `idlwave-shell-process-name
763with `*'s."
764 (concat "*" idlwave-shell-process-name "*"))
765
766(defvar idlwave-shell-ready nil
767 "If non-nil can send next command to IDL process.")
768
769;;; The following are the types of messages we attempt to catch to
770;;; resync our idea of where IDL execution currently is.
5cba7601 771;;;
8c7b4ec8
EZ
772
773(defvar idlwave-shell-halt-frame nil
774 "The frame associated with halt/breakpoint messages.")
775
776(defvar idlwave-shell-step-frame nil
777 "The frame associated with step messages.")
778
779(defvar idlwave-shell-trace-frame nil
780 "The frame associated with trace messages.")
781
782(defconst idlwave-shell-halt-messages
52a244eb 783 '("^% Interrupted at:"
8c7b4ec8 784 "^% Stepped to:"
52a244eb 785 "^% Skipped to:"
8c7b4ec8
EZ
786 "^% Stop encountered:"
787 )
788 "*A list of regular expressions matching IDL messages.
789These are the messages containing file and line information where
790IDL is currently stopped.")
791
52a244eb 792
8c7b4ec8
EZ
793(defconst idlwave-shell-halt-messages-re
794 (mapconcat 'identity idlwave-shell-halt-messages "\\|")
795 "The regular expression computed from idlwave-shell-halt-messages")
796
52a244eb
S
797(defconst idlwave-shell-trace-message-re
798 "^% At " ;; First line of a trace message
799 "*A regular expression matching IDL trace messages. These are the
800messages containing file and line information of a current
801traceback.")
8c7b4ec8
EZ
802
803(defconst idlwave-shell-step-messages
804 '("^% Stepped to:"
805 )
806 "*A list of regular expressions matching stepped execution messages.
807These are IDL messages containing file and line information where
808IDL has currently stepped.")
809
810(defvar idlwave-shell-break-message "^% Breakpoint at:"
811 "*Regular expression matching an IDL breakpoint message line.")
812
52a244eb
S
813(defconst idlwave-shell-electric-debug-help
814 " ==> IDLWAVE Electric Debug Mode Help <==
5cba7601 815
52a244eb
S
816 Break Point Setting and Clearing:
817 b Set breakpoint ([C-u b] for conditional, [C-n b] nth hit, etc.).
818 d Clear nearby breakpoint.
819 a Clear all breakpoints.
820 i Set breakpoint in routine named here.
821 j Set breakpoint at beginning of containing routine.
822 \\ Toggle breakpoint disable
823 ] Go to next breakpoint in file.
824 [ Go to previous breakpoint in file.
825
826 Stepping, Continuing, and the Stack:
827 s or SPACE Step, into function calls.
828 n Step, over function calls.
829 k Skip one statement.
830 m Continue to end of function.
831 o Continue past end of function.
832 u Continue to end of block.
833 h Continue to line at cursor position.
834 r Continue execution to next breakpoint, if any.
835 + or = Show higher level in calling stack.
836 - or _ Show lower level in calling stack.
837
838 Examining Expressions (with prefix for examining the region):
839 p Print expression near point or in region ([C-u p]).
840 ? Help on expression near point or in region ([C-u ?]).
5cba7601 841 x Examine expression near point or in region ([C-u x]) with
52a244eb 842 letter completion of the examine type.
f66f03de 843 e Prompt for an expression to print.
52a244eb
S
844
845 Miscellaneous:
846 q Quit - end debugging session and return to the Shell's main level.
847 v Turn Electric Debugging Mode off (C-c C-d C-v to return).
848 t Print a calling-level traceback in the shell.
849 z Reset IDL.
850 C-? Show this help menu.")
8c7b4ec8
EZ
851
852(defvar idlwave-shell-bp-alist)
853;(defvar idlwave-shell-post-command-output)
854(defvar idlwave-shell-sources-alist)
855(defvar idlwave-shell-menu-def)
856(defvar idlwave-shell-mode-menu)
857(defvar idlwave-shell-initial-commands)
858(defvar idlwave-shell-syntax-error)
859(defvar idlwave-shell-other-error)
860(defvar idlwave-shell-error-buffer)
861(defvar idlwave-shell-error-last)
862(defvar idlwave-shell-bp-buffer)
863(defvar idlwave-shell-sources-query)
864(defvar idlwave-shell-mode-map)
ca660d22 865(defvar idlwave-shell-calling-stack-index)
25d24a50
S
866(defvar idlwave-shell-only-prompt-pattern nil)
867(defvar tool-bar-map)
8c7b4ec8
EZ
868
869(defun idlwave-shell-mode ()
870 "Major mode for interacting with an inferior IDL process.
871
8721. Shell Interaction
873 -----------------
874 RET after the end of the process' output sends the text from the
875 end of process to the end of the current line. RET before end of
876 process output copies the current line (except for the prompt) to the
877 end of the buffer.
878
879 Command history, searching of previous commands, command line
880 editing are available via the comint-mode key bindings, by default
05a1abfc
CD
881 mostly on the key `C-c'. Command history is also available with
882 the arrow keys UP and DOWN.
8c7b4ec8
EZ
883
8842. Completion
885 ----------
15e42531
CD
886 TAB and M-TAB do completion of IDL routines, classes and keywords -
887 similar to M-TAB in `idlwave-mode'. In executive commands and
888 strings, it completes file names. Abbreviations are also expanded
889 like in `idlwave-mode'.
8c7b4ec8
EZ
890
8913. Routine Info
892 ------------
893 `\\[idlwave-routine-info]' displays information about an IDL routine near point,
894 just like in `idlwave-mode'. The module used is the one at point or
895 the one whose argument list is being edited.
5cba7601 896 To update IDLWAVE's knowledge about compiled or edited modules, use
8c7b4ec8
EZ
897 \\[idlwave-update-routine-info].
898 \\[idlwave-find-module] find the source of a module.
899 \\[idlwave-resolve] tells IDL to compile an unresolved module.
15e42531
CD
900 \\[idlwave-context-help] shows the online help on the item at
901 point, if online help has been installed.
5cba7601 902
8c7b4ec8
EZ
903
9044. Debugging
905 ---------
906 A complete set of commands for compiling and debugging IDL programs
5cba7601 907 is available from the menu. Also keybindings starting with a
8c7b4ec8
EZ
908 `C-c C-d' prefix are available for most commands in the *idl* buffer
909 and also in source buffers. The best place to learn about the
910 keybindings is again the menu.
911
912 On Emacs versions where this is possible, a debugging toolbar is
913 installed.
914
915 When IDL is halted in the middle of a procedure, the corresponding
916 line of that procedure file is displayed with an overlay in another
917 window. Breakpoints are also highlighted in the source.
918
919 \\[idlwave-shell-resync-dirs] queries IDL in order to change Emacs current directory
920 to correspond to the IDL process current directory.
921
52a244eb
S
9225. Expression Examination
923 ----------------------
924
925 Expressions near point can be examined with print,
926 \\[idlwave-shell-print] or \\[idlwave-shell-mouse-print] with the
927 mouse, help, \\[idlwave-shell-help-expression] or
928 \\[idlwave-shell-mouse-help] with the mouse, or with a
929 configureable set of custom examine commands using
930 \\[idlwave-shell-examine-select]. The mouse examine commands can
931 also work by click and drag, to select an expression for
932 examination.
933
9346. Hooks
8c7b4ec8
EZ
935 -----
936 Turning on `idlwave-shell-mode' runs `comint-mode-hook' and
937 `idlwave-shell-mode-hook' (in that order).
938
52a244eb 9397. Documentation and Customization
8c7b4ec8
EZ
940 -------------------------------
941 Info documentation for this package is available. Use \\[idlwave-info]
942 to display (complain to your sysadmin if that does not work).
943 For Postscript and HTML versions of the documentation, check IDLWAVE's
855b42a2 944 homepage at URL `http://idlwave.org'.
8c7b4ec8
EZ
945 IDLWAVE has customize support - see the group `idlwave'.
946
52a244eb 9478. Keybindings
8c7b4ec8
EZ
948 -----------
949\\{idlwave-shell-mode-map}"
950
951 (interactive)
52a244eb
S
952 (idlwave-setup) ; Make sure config files and paths, etc. are available.
953 (unless (file-name-absolute-p idlwave-shell-command-history-file)
954 (setq idlwave-shell-command-history-file
955 (expand-file-name idlwave-shell-command-history-file
956 idlwave-config-directory)))
957
05a1abfc 958 ;; We don't do `kill-all-local-variables' here, because this is done by
52a244eb 959 ;; comint
8c7b4ec8
EZ
960 (setq comint-prompt-regexp idlwave-shell-prompt-pattern)
961 (setq comint-process-echoes t)
52a244eb 962
8c7b4ec8
EZ
963 ;; Can not use history expansion because "!" is used for system variables.
964 (setq comint-input-autoexpand nil)
5e72c6b2 965; (setq comint-input-ring-size 64)
8c7b4ec8
EZ
966 (make-local-variable 'comint-completion-addsuffix)
967 (set (make-local-variable 'completion-ignore-case) t)
968 (setq comint-completion-addsuffix '("/" . ""))
969 (setq comint-input-ignoredups t)
970 (setq major-mode 'idlwave-shell-mode)
971 (setq mode-name "IDL-Shell")
ca660d22
CD
972 (setq idlwave-shell-mode-line-info nil)
973 (setq mode-line-format
974 '(""
975 mode-line-modified
976 mode-line-buffer-identification
977 " "
978 global-mode-string
979 " %[("
980 mode-name
981 mode-line-process
982 minor-mode-alist
983 "%n"
984 ")%]-"
985 idlwave-shell-mode-line-info
986 "---"
987 (line-number-mode "L%l--")
988 (column-number-mode "C%c--")
989 (-3 . "%p")
990 "-%-"))
8c7b4ec8
EZ
991 ;; (make-local-variable 'idlwave-shell-bp-alist)
992 (setq idlwave-shell-halt-frame nil
993 idlwave-shell-trace-frame nil
994 idlwave-shell-command-output nil
995 idlwave-shell-step-frame nil)
996 (idlwave-shell-display-line nil)
ca660d22 997 (setq idlwave-shell-calling-stack-index 0)
52a244eb 998 (setq idlwave-shell-only-prompt-pattern
5cba7601
GM
999 (concat "\\`[ \t\n]*"
1000 (substring idlwave-shell-prompt-pattern 1)
52a244eb 1001 "[ \t\n]*\\'"))
15e42531 1002
76959b77
S
1003 (when idlwave-shell-query-for-class
1004 (add-to-list (make-local-variable 'idlwave-determine-class-special)
1005 'idlwave-shell-get-object-class)
1006 (setq idlwave-store-inquired-class t))
1007
8c7b4ec8
EZ
1008 ;; Make sure comint-last-input-end does not go to beginning of
1009 ;; buffer (in case there were other processes already in this buffer).
1010 (set-marker comint-last-input-end (point))
15e42531 1011 (setq idlwave-idlwave_routine_info-compiled nil)
8c7b4ec8
EZ
1012 (setq idlwave-shell-ready nil)
1013 (setq idlwave-shell-bp-alist nil)
1014 (idlwave-shell-update-bp-overlays) ; Throw away old overlays
6a8cc02d
S
1015 (setq idlwave-shell-post-command-hook nil ;clean up any old stuff
1016 idlwave-shell-sources-alist nil)
8c7b4ec8 1017 (setq idlwave-shell-default-directory default-directory)
15e42531 1018 (setq idlwave-shell-hide-output nil)
5e72c6b2 1019
f66f03de
S
1020 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1021 ;; (make-local-hook 'kill-buffer-hook)
8c7b4ec8
EZ
1022 (add-hook 'kill-buffer-hook 'idlwave-shell-kill-shell-buffer-confirm
1023 nil 'local)
15e42531
CD
1024 (add-hook 'kill-buffer-hook 'idlwave-shell-delete-temp-files nil 'local)
1025 (add-hook 'kill-emacs-hook 'idlwave-shell-delete-temp-files)
8c7b4ec8
EZ
1026 (use-local-map idlwave-shell-mode-map)
1027 (easy-menu-add idlwave-shell-mode-menu idlwave-shell-mode-map)
15e42531 1028
5e72c6b2
S
1029 ;; Set the optional comint variables
1030 (when idlwave-shell-comint-settings
1031 (let ((list idlwave-shell-comint-settings) entry)
1032 (while (setq entry (pop list))
1033 (set (make-local-variable (car entry)) (cdr entry)))))
05a1abfc 1034
5cba7601
GM
1035
1036 (unless (memq 'comint-carriage-motion
52a244eb
S
1037 (default-value 'comint-output-filter-functions))
1038 ;; Strip those pesky ctrl-m's.
1039 (add-hook 'comint-output-filter-functions
1040 (lambda (string)
1041 (when (string-match "\r" string)
5cba7601 1042 (let ((pmark (process-mark (get-buffer-process
52a244eb
S
1043 (current-buffer)))))
1044 (save-excursion
1045 ;; bare CR -> delete preceding line
1046 (goto-char comint-last-output-start)
1047 (while (search-forward "\r" pmark t)
1048 (delete-region (point) (line-beginning-position)))))))
1049 'append 'local)
1050 (add-hook 'comint-output-filter-functions 'comint-strip-ctrl-m nil 'local))
1051
1052 ;; Python-mode, bundled with many Emacs installs, quite cavalierly
1053 ;; adds this function to the global default hook. It interferes
1054 ;; with overlay-arrows.
1055 (remove-hook 'comint-output-filter-functions 'py-pdbtrack-track-stack-file)
1056
1057
15e42531
CD
1058 ;; IDLWAVE syntax, and turn on abbreviations
1059 (setq local-abbrev-table idlwave-mode-abbrev-table)
1060 (set-syntax-table idlwave-mode-syntax-table)
05a1abfc 1061 (set (make-local-variable 'comment-start) ";")
15e42531 1062 (setq abbrev-mode t)
5e72c6b2 1063
f66f03de
S
1064 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1065 ;; make-local-hook 'post-command-hook)
15e42531
CD
1066 (add-hook 'post-command-hook 'idlwave-command-hook nil t)
1067
5e72c6b2
S
1068 ;; Read the command history?
1069 (when (and idlwave-shell-save-command-history
1070 (stringp idlwave-shell-command-history-file))
1071 (set (make-local-variable 'comint-input-ring-file-name)
1072 idlwave-shell-command-history-file)
1073 (if (file-regular-p idlwave-shell-command-history-file)
1074 (comint-read-input-ring)))
1075
52a244eb
S
1076 ;; Turn off the non-debug toolbar buttons (open,save,etc.)
1077 (set (make-local-variable 'tool-bar-map) nil)
1078
15e42531 1079 ;; Run the hooks.
9a969196 1080 (run-mode-hooks 'idlwave-shell-mode-hook)
8c7b4ec8 1081 (idlwave-shell-send-command idlwave-shell-initial-commands nil 'hide)
52a244eb
S
1082 ;; Turn off IDL's ^d interpreting, and define a system
1083 ;; variable which knows the version of IDLWAVE
5cba7601 1084 (idlwave-shell-send-command
3938cb82 1085 (format "defsysv,'!idlwave_version','%s',1" idlwave-mode-version)
15e42531 1086 nil 'hide)
f66f03de
S
1087 ;; Read the paths, and save if they changed
1088 (idlwave-shell-send-command idlwave-shell-path-query
1089 'idlwave-shell-get-path-info
1090 'hide))
15e42531 1091
f66f03de 1092(defvar idlwave-system-directory)
52a244eb
S
1093(defun idlwave-shell-get-path-info (&optional no-write)
1094 "Get the path lists, writing to file unless NO-WRITE is set."
15e42531
CD
1095 (let* ((rpl (idlwave-shell-path-filter))
1096 (sysdir (car rpl))
52a244eb 1097 (dirs (cdr rpl))
f66f03de
S
1098 (old-path-alist idlwave-path-alist)
1099 (old-sys-dir idlwave-system-directory)
1100 path-changed sysdir-changed)
52a244eb
S
1101 (when sysdir
1102 (setq idlwave-system-directory sysdir)
5cba7601 1103 (if (setq sysdir-changed
f66f03de
S
1104 (not (string= idlwave-system-directory old-sys-dir)))
1105 (put 'idlwave-system-directory 'from-shell t)))
52a244eb 1106 ;; Preserve any existing flags
5cba7601 1107 (setq idlwave-path-alist
52a244eb
S
1108 (mapcar (lambda (x)
1109 (let ((old-entry (assoc x old-path-alist)))
1110 (if old-entry
1111 (cons x (cdr old-entry))
1112 (list x))))
1113 dirs))
f66f03de
S
1114 (if (setq path-changed (not (equal idlwave-path-alist old-path-alist)))
1115 (put 'idlwave-path-alist 'from-shell t))
5cba7601 1116 (if idlwave-path-alist
f66f03de
S
1117 (if (and (not no-write)
1118 idlwave-auto-write-paths
1119 (or sysdir-changed path-changed)
1120 (not idlwave-library-path))
52a244eb
S
1121 (idlwave-write-paths))
1122 ;; Fall back
1123 (setq idlwave-path-alist old-path-alist))))
8c7b4ec8
EZ
1124
1125(if (not (fboundp 'idl-shell))
1126 (fset 'idl-shell 'idlwave-shell))
1127
1128(defvar idlwave-shell-idl-wframe nil
1129 "Frame for displaying the idl shell window.")
1130(defvar idlwave-shell-display-wframe nil
1131 "Frame for displaying the idl source files.")
1132
8c7b4ec8 1133(defvar idlwave-shell-calling-stack-index 0)
ca660d22 1134(defvar idlwave-shell-calling-stack-routine nil)
8c7b4ec8
EZ
1135
1136(defun idlwave-shell-source-frame ()
1137 "Return the frame to be used for source display."
1138 (if idlwave-shell-use-dedicated-frame
1139 ;; We want separate frames for source and shell
1140 (if (frame-live-p idlwave-shell-display-wframe)
1141 ;; The frame exists, so we use it.
1142 idlwave-shell-display-wframe
1143 ;; The frame does not exist. We use the current frame.
5e72c6b2
S
1144 ;; However, if the current is the shell frame, we make a new frame,
1145 ;; or recycle the first existing visible frame
8c7b4ec8
EZ
1146 (setq idlwave-shell-display-wframe
1147 (if (eq (selected-frame) idlwave-shell-idl-wframe)
5e72c6b2
S
1148 (or
1149 (let ((flist (visible-frame-list))
1150 (frame (selected-frame)))
1151 (catch 'exit
1152 (while flist
5cba7601
GM
1153 (if (not (eq (car flist)
1154 idlwave-shell-idl-wframe))
5e72c6b2
S
1155 (throw 'exit (car flist))
1156 (setq flist (cdr flist))))))
1157 (make-frame))
8c7b4ec8
EZ
1158 (selected-frame))))))
1159
1160(defun idlwave-shell-shell-frame ()
1161 "Return the frame to be used for the shell buffer."
1162 (if idlwave-shell-use-dedicated-frame
1163 ;; We want a dedicated frame
1164 (if (frame-live-p idlwave-shell-idl-wframe)
1165 ;; It does exist, so we use it.
1166 idlwave-shell-idl-wframe
1167 ;; It does not exist. Check if we have a source frame.
1168 (if (not (frame-live-p idlwave-shell-display-wframe))
1169 ;; We do not have a source frame, so we use this one.
1170 (setq idlwave-shell-display-wframe (selected-frame)))
1171 ;; Return a new frame
5cba7601 1172 (setq idlwave-shell-idl-wframe
8c7b4ec8 1173 (make-frame idlwave-shell-frame-parameters)))))
5cba7601 1174
8c7b4ec8 1175;;;###autoload
5e72c6b2 1176(defun idlwave-shell (&optional arg quick)
8c7b4ec8
EZ
1177 "Run an inferior IDL, with I/O through buffer `(idlwave-shell-buffer)'.
1178If buffer exists but shell process is not running, start new IDL.
1179If buffer exists and shell process is running, just switch to the buffer.
1180
1181When called with a prefix ARG, or when `idlwave-shell-use-dedicated-frame'
1182is non-nil, the shell buffer and the source buffers will be in
1183separate frames.
1184
5e72c6b2
S
1185The command to run comes from variable `idlwave-shell-explicit-file-name',
1186with options taken from `idlwave-shell-command-line-options'.
8c7b4ec8
EZ
1187
1188The buffer is put in `idlwave-shell-mode', providing commands for sending
1189input and controlling the IDL job. See help on `idlwave-shell-mode'.
1190See also the variable `idlwave-shell-prompt-pattern'.
1191
1192\(Type \\[describe-mode] in the shell buffer for a list of commands.)"
1193 (interactive "P")
5e72c6b2
S
1194 (if (eq arg 'quick)
1195 (progn
1196 (let ((idlwave-shell-use-dedicated-frame nil))
1197 (idlwave-shell nil)
1198 (delete-other-windows))
1199 (and idlwave-shell-use-dedicated-frame
1200 (setq idlwave-shell-idl-wframe (selected-frame)))
5cba7601 1201 (add-hook 'idlwave-shell-sentinel-hook
5e72c6b2
S
1202 'save-buffers-kill-emacs t))
1203
1204 ;; A non-nil arg means, we want a dedicated frame. This will last
1205 ;; for the current editing session.
1206 (if arg (setq idlwave-shell-use-dedicated-frame t))
1207 (if (equal arg '(16)) (setq idlwave-shell-use-dedicated-frame nil))
5cba7601 1208
5e72c6b2
S
1209 ;; Check if the process still exists. If not, create it.
1210 (unless (comint-check-proc (idlwave-shell-buffer))
1211 (let* ((prg (or idlwave-shell-explicit-file-name "idl"))
1212 (buf (apply 'make-comint
1213 idlwave-shell-process-name prg nil
1214 (if (stringp idlwave-shell-command-line-options)
1215 (idlwave-split-string
1216 idlwave-shell-command-line-options)
1217 idlwave-shell-command-line-options)))
1218 (process (get-buffer-process buf)))
1219 (setq idlwave-idlwave_routine_info-compiled nil)
1220 (set-process-filter process 'idlwave-shell-filter)
1221 (set-process-sentinel process 'idlwave-shell-sentinel)
1222 (set-buffer buf)
1223 (idlwave-shell-mode)))
1224 (let ((window (idlwave-display-buffer (idlwave-shell-buffer) nil
1225 (idlwave-shell-shell-frame)))
1226 (current-window (selected-window)))
1227 (select-window window)
1228 (goto-char (point-max))
f66f03de
S
1229 (if idlwave-shell-use-dedicated-window
1230 (set-window-dedicated-p window t))
5e72c6b2
S
1231 (select-window current-window)
1232 (if idlwave-shell-ready
1233 (raise-frame (window-frame window)))
1234 (if (eq (selected-frame) (window-frame window))
52a244eb 1235 (select-window window))))
f66f03de 1236 ;; Save the paths at the end, if they are from the Shell and new.
5cba7601 1237 (add-hook 'idlwave-shell-sentinel-hook
52a244eb 1238 (lambda ()
5cba7601 1239 (if (and
52a244eb
S
1240 idlwave-auto-write-paths
1241 idlwave-path-alist
1242 (not idlwave-library-path)
1243 (get 'idlwave-path-alist 'from-shell))
1244 (idlwave-write-paths)))))
8c7b4ec8
EZ
1245
1246(defun idlwave-shell-recenter-shell-window (&optional arg)
1247 "Run `idlwave-shell', but make sure the current window stays selected."
1248 (interactive "P")
1249 (let ((window (selected-window)))
1250 (idlwave-shell arg)
1251 (select-window window)))
1252
52a244eb 1253(defun idlwave-shell-hide-p (type &optional list)
76959b77
S
1254 "Whether to hide this type of command.
1255Return either nil or 'hide."
52a244eb
S
1256 (let ((list (or list idlwave-shell-show-commands)))
1257 (if (listp list)
1258 (if (not (memq type list)) 'hide))))
1259
1260(defun idlwave-shell-add-or-remove-show (type)
1261 "Add or remove a show command from the list."
76959b77 1262 (if (listp idlwave-shell-show-commands)
52a244eb
S
1263 (setq idlwave-shell-show-commands
1264 (if (memq type idlwave-shell-show-commands)
1265 (delq type idlwave-shell-show-commands)
1266 (add-to-list'idlwave-shell-show-commands type)))
1267 (setq idlwave-shell-show-commands (list type))))
1268
76959b77 1269
5cba7601 1270(defun idlwave-shell-send-command (&optional cmd pcmd hide preempt
52a244eb 1271 show-if-error)
8c7b4ec8
EZ
1272 "Send a command to IDL process.
1273
52a244eb
S
1274\(CMD PCMD HIDE\) are placed at the end of `
1275idlwave-shell-pending-commands'. If IDL is ready the first command,
76959b77 1276CMD, in `idlwave-shell-pending-commands' is sent to the IDL process.
52a244eb 1277
76959b77 1278If optional second argument PCMD is non-nil it will be placed on
52a244eb
S
1279`idlwave-shell-post-command-hook' when CMD is executed.
1280
1281If the optional third argument HIDE is non-nil, then hide output from
1282CMD, unless it is the symbol 'mostly, in which case only output
1283beginning with \"%\" is hidden, and all other output (i.e., the
1284results of a PRINT command), is shown. This helps with, e.g.,
1285stepping through code with output.
1286
8c7b4ec8 1287If optional fourth argument PREEMPT is non-nil CMD is put at front of
76959b77
S
1288`idlwave-shell-pending-commands'. If PREEMPT is 'wait, wait for all
1289output to complete and the next prompt to arrive before returning
1290\(useful if you need an answer now\). IDL is considered ready if the
5cba7601 1291prompt is present and if `idlwave-shell-ready' is non-nil.
52a244eb 1292
6a8cc02d 1293If SHOW-IF-ERROR is non-nil, show the output if it contains an error
52a244eb 1294message, independent of what HIDE is set to."
76959b77
S
1295
1296; (setq hide nil) ; FIXME: turn this on for debugging only
5cba7601 1297; (if (null cmd)
76959b77 1298; (progn
5cba7601 1299; (message "SENDING Pending commands: %s"
76959b77 1300; (prin1-to-string idlwave-shell-pending-commands)))
3938cb82 1301; (message "SENDING %s|||%s" cmd pcmd))
5cba7601 1302 (if (and (symbolp idlwave-shell-show-commands)
76959b77
S
1303 (eq idlwave-shell-show-commands 'everything))
1304 (setq hide nil))
1305 (let ((save-buffer (current-buffer))
1306 buf proc)
8c7b4ec8
EZ
1307 ;; Get or make the buffer and its process
1308 (if (or (not (setq buf (get-buffer (idlwave-shell-buffer))))
1309 (not (setq proc (get-buffer-process buf))))
1310 (if (not idlwave-shell-automatic-start)
768b14f8 1311 (error "%s"
8c7b4ec8
EZ
1312 (substitute-command-keys
1313 "You need to first start an IDL shell with \\[idlwave-shell]"))
1314 (idlwave-shell-recenter-shell-window)
1315 (setq buf (get-buffer (idlwave-shell-buffer)))
1316 (if (or (not (setq buf (get-buffer (idlwave-shell-buffer))))
1317 (not (setq proc (get-buffer-process buf))))
1318 ;; Still nothing
1319 (error "Problem with autostarting IDL shell"))))
76959b77 1320 (when (or cmd idlwave-shell-pending-commands)
8c7b4ec8 1321 (set-buffer buf)
8c7b4ec8
EZ
1322 ;; To make this easy, always push CMD onto pending commands
1323 (if cmd
76959b77
S
1324 (setq idlwave-shell-pending-commands
1325 (if preempt
1326 ;; Put at front.
52a244eb 1327 (append (list (list cmd pcmd hide show-if-error))
76959b77
S
1328 idlwave-shell-pending-commands)
1329 ;; Put at end.
5cba7601 1330 (append idlwave-shell-pending-commands
52a244eb 1331 (list (list cmd pcmd hide show-if-error))))))
8c7b4ec8 1332 ;; Check if IDL ready
76959b77
S
1333 (let ((save-point (point-marker)))
1334 (goto-char (process-mark proc))
1335 (if (and idlwave-shell-ready
1336 ;; Check for IDL prompt
1337 (prog2
1338 (forward-line 0)
1339 ;; (beginning-of-line) ; Changed for Emacs 21
1340 (looking-at idlwave-shell-prompt-pattern)
1341 (goto-char (process-mark proc))))
1342 ;; IDL ready for command, execute it
1343 (let* ((lcmd (car idlwave-shell-pending-commands))
1344 (cmd (car lcmd))
1345 (pcmd (nth 1 lcmd))
52a244eb
S
1346 (hide (nth 2 lcmd))
1347 (show-if-error (nth 3 lcmd)))
76959b77
S
1348 ;; If this is an executive command, reset the stack pointer
1349 (if (eq (string-to-char cmd) ?.)
1350 (setq idlwave-shell-calling-stack-index 0))
1351 ;; Set post-command
1352 (setq idlwave-shell-post-command-hook pcmd)
1353 ;; Output hiding
1354 (setq idlwave-shell-hide-output hide)
52a244eb
S
1355 ;;Showing errors
1356 (setq idlwave-shell-show-if-error show-if-error)
76959b77
S
1357 ;; Pop command
1358 (setq idlwave-shell-pending-commands
1359 (cdr idlwave-shell-pending-commands))
1360 ;; Send command for execution
1361 (set-marker comint-last-input-start (point))
1362 (set-marker comint-last-input-end (point))
1363 (comint-simple-send proc cmd)
1364 (setq idlwave-shell-ready nil)
3938cb82
S
1365 (if (equal preempt 'wait) ; Get all the output at once
1366 (while (not idlwave-shell-ready)
1367 (when (not (accept-process-output proc 6)) ; long wait
1368 (setq idlwave-shell-pending-commands nil)
1369 (error "Process timed out"))))))
76959b77
S
1370 (goto-char save-point))
1371 (set-buffer save-buffer))))
8c7b4ec8 1372
6db31cbc 1373(defun idlwave-shell-send-char (c &optional error)
15e42531 1374 "Send one character to the shell, without a newline."
6db31cbc
RS
1375 (interactive "cChar to send to IDL: \np")
1376 (let ((errf (if error 'error 'message))
15e42531
CD
1377 buf proc)
1378 (if (or (not (setq buf (get-buffer (idlwave-shell-buffer))))
1379 (not (setq proc (get-buffer-process buf))))
1380 (funcall errf "Shell is not running"))
5cba7601 1381 (if (equal c ?\C-g)
15e42531
CD
1382 (funcall errf "Abort")
1383 (comint-send-string proc (char-to-string c)))))
1384
1385(defvar idlwave-shell-char-mode-active)
1386(defun idlwave-shell-input-mode-magic (string)
1387 "Check STRING for magic words and toggle character input mode.
1388See also the variable `idlwave-shell-input-mode-spells'."
1389 (cond
1390 ((string-match (car idlwave-shell-input-mode-spells) string)
1391 (call-interactively 'idlwave-shell-send-char))
1392 ((and (boundp 'idlwave-shell-char-mode-active)
1393 (string-match (nth 2 idlwave-shell-input-mode-spells) string))
1394 (setq idlwave-shell-char-mode-active 'exit))
1395 ((string-match (nth 1 idlwave-shell-input-mode-spells) string)
1396 ;; Set a timer which will soon start the character loop
1397 (if (fboundp 'start-itimer)
1398 (start-itimer "IDLWAVE Char Mode" 'idlwave-shell-char-mode-loop 0.5
1399 nil nil t 'no-error)
1400 (run-at-time 0.5 nil 'idlwave-shell-char-mode-loop 'no-error)))))
1401
1402(defvar keyboard-quit)
1403(defun idlwave-shell-char-mode-loop (&optional no-error)
1404 "Enter a loop which accepts single characters and sends them to IDL.
1405Characters are sent one by one, without newlines. The loop is blocking
1406and intercepts all input events to Emacs. You can use this command
1407to interact with the IDL command GET_KBRD.
1408The loop can be aborted by typing `C-g'. The loop also exits automatically
1409when the IDL prompt gets displayed again after the current IDL command."
1410 (interactive)
1411
1412 ;; First check if there is a shell waiting for input
1413 (let ((idlwave-shell-char-mode-active t)
1414 (errf (if no-error 'message 'error))
1415 buf proc c)
1416 (if (or (not (setq buf (get-buffer (idlwave-shell-buffer))))
1417 (not (setq proc (get-buffer-process buf))))
1418 (funcall errf "Shell is not running"))
1419 (if idlwave-shell-ready
1420 (funcall errf "No IDL program seems to be waiting for input"))
1421
5cba7601 1422 ;; OK, start the loop
15e42531
CD
1423 (message "Character mode on: Sending single chars (`C-g' to exit)")
1424 (message
1425 (catch 'exit
1426 (while t
1427 ;; Wait for input
1428 ;; FIXME: Is it too dangerous to inhibit quit here?
1429 (let ((inhibit-quit t))
1430 ;; We wait and check frequently if we should abort
1431 (while (sit-for 0.3)
1432 (and idlwave-shell-ready
1433 (throw 'exit "Character mode off (prompt displayed)"))
1434 (and (eq idlwave-shell-char-mode-active 'exit)
1435 (throw 'exit "Character mode off (closing spell incantation)")))
1436 ;; Interpret input as a character - ignore non-char input
1437 (condition-case nil
1438 (setq c (read-char))
05a1abfc 1439 (error (ding) (throw 'exit "Character mode off")))
15e42531
CD
1440 (cond
1441 ((null c) ; Non-char event: ignore
1442 (ding))
1443 ((equal c ?\C-g) ; Abort the loop
1444 (setq keyboard-quit nil)
1445 (ding)
1446 (throw 'exit "Character mode off (keyboard quit)"))
1447 (t ; Send the character and continue the loop
1448 (comint-send-string proc (char-to-string c))))
1449 (and (eq idlwave-shell-char-mode-active 'exit)
1450 (throw 'exit "Single char loop exited"))))))))
1451
76959b77 1452(defun idlwave-shell-move-or-history (up &optional arg)
05a1abfc 1453 "When in last line of process buffer, do `comint-previous-input'.
76959b77
S
1454Otherwise just move the line. Move down unless UP is non-nil."
1455 (let* ((proc-pos (marker-position
1456 (process-mark (get-buffer-process (current-buffer)))))
1457 (arg (or arg 1))
1458 (arg (if up arg (- arg))))
1459 (if (eq t idlwave-shell-arrows-do-history) (goto-char proc-pos))
1460 (if (and idlwave-shell-arrows-do-history
1461 (>= (1+ (save-excursion (end-of-line) (point))) proc-pos))
d105bfec 1462 (comint-previous-input arg)
7caf6803 1463 (forward-line (- arg)))))
76959b77
S
1464
1465(defun idlwave-shell-up-or-history (&optional arg)
1466"When in last line of process buffer, move to previous input.
1467 Otherwise just go up one line."
05a1abfc 1468 (interactive "p")
76959b77 1469 (idlwave-shell-move-or-history t arg))
05a1abfc
CD
1470
1471(defun idlwave-shell-down-or-history (&optional arg)
76959b77
S
1472"When in last line of process buffer, move to next input.
1473 Otherwise just go down one line."
05a1abfc 1474 (interactive "p")
76959b77 1475 (idlwave-shell-move-or-history nil arg))
8c7b4ec8 1476
76959b77
S
1477;; Newer versions of comint.el changed the name of comint-filter to
1478;; comint-output-filter.
8c7b4ec8
EZ
1479(defun idlwave-shell-comint-filter (process string) nil)
1480(if (fboundp 'comint-output-filter)
1481 (fset 'idlwave-shell-comint-filter (symbol-function 'comint-output-filter))
1482 (fset 'idlwave-shell-comint-filter (symbol-function 'comint-filter)))
1483
1484(defun idlwave-shell-is-running ()
1485 "Return t if the shell process is running."
1486 (eq (process-status idlwave-shell-process-name) 'run))
1487
52a244eb
S
1488(defun idlwave-shell-filter-hidden-output (output)
1489 "Filter hidden output, leaving the good stuff.
1490
1491Remove everything to the first newline, and all lines with % in front
1492of them, with optional follow-on lines starting with two spaces. This
1493works well enough, since any print output typically arrives before
1494error messages, etc."
1495 (setq output (substring output (string-match "\n" output)))
1496 (while (string-match "\\(\n\\|\\`\\)%.*\\(\n .*\\)*" output)
1497 (setq output (replace-match "" nil t output)))
5cba7601 1498 (unless
52a244eb
S
1499 (string-match idlwave-shell-only-prompt-pattern output)
1500 output))
1501
15e42531
CD
1502(defvar idlwave-shell-hidden-output-buffer " *idlwave-shell-hidden-output*"
1503 "Buffer containing hidden output from IDL commands.")
25d24a50 1504(defvar idlwave-shell-current-state nil)
5cba7601 1505
8c7b4ec8 1506(defun idlwave-shell-filter (proc string)
52a244eb 1507 "Watch for IDL prompt and filter incoming text.
8c7b4ec8
EZ
1508When the IDL prompt is received executes `idlwave-shell-post-command-hook'
1509and then calls `idlwave-shell-send-command' for any pending commands."
1510 ;; We no longer do the cleanup here - this is done by the process sentinel
3938cb82
S
1511 (if (eq (process-status idlwave-shell-process-name) 'run)
1512 ;; OK, process is still running, so we can use it.
1513 (let ((data (match-data)) p full-output)
1514 (unwind-protect
1515 (progn
1516 ;; Ring the bell if necessary
1517 (while (setq p (string-match "\C-G" string))
1518 (ding)
1519 (aset string p ?\C-j ))
1520 (if idlwave-shell-hide-output
1521 (save-excursion
1522 (while (setq p (string-match "\C-M" string))
1523 (aset string p ?\ ))
1524 (set-buffer
1525 (get-buffer-create idlwave-shell-hidden-output-buffer))
1526 (goto-char (point-max))
1527 (insert string))
1528 (idlwave-shell-comint-filter proc string))
1529 ;; Watch for magic - need to accumulate the current line
1530 ;; since it may not be sent all at once.
1531 (if (string-match "\n" string)
1532 (progn
1533 (if idlwave-shell-use-input-mode-magic
1534 (idlwave-shell-input-mode-magic
1535 (concat idlwave-shell-accumulation string)))
1536 (setq idlwave-shell-accumulation
5cba7601
GM
1537 (substring string
1538 (progn (string-match "\\(.*[\n\r]+\\)*"
3938cb82
S
1539 string)
1540 (match-end 0)))))
1541 (setq idlwave-shell-accumulation
1542 (concat idlwave-shell-accumulation string)))
5cba7601
GM
1543
1544
5e72c6b2 1545;;; Test/Debug code
f66f03de
S
1546 ;(with-current-buffer
1547 ; (get-buffer-create "*idlwave-shell-output*")
1548 ; (goto-char (point-max))
1549 ; (insert "\nReceived STRING\n===>\n" string "\n<====\n"))
5cba7601 1550
3938cb82
S
1551 ;; Check for prompt in current accumulating output
1552 (when (setq idlwave-shell-ready
1553 (string-match idlwave-shell-prompt-pattern
1554 idlwave-shell-accumulation))
1555 ;; Gather the command output
1556 (if idlwave-shell-hide-output
1557 (save-excursion
1558 (set-buffer idlwave-shell-hidden-output-buffer)
1559 (setq full-output (buffer-string))
1560 (goto-char (point-max))
1561 (re-search-backward idlwave-shell-prompt-pattern nil t)
1562 (goto-char (match-end 0))
1563 (setq idlwave-shell-command-output
5cba7601 1564 (buffer-substring-no-properties
dd5baa1a 1565 (point-min) (point)))
3938cb82
S
1566 (delete-region (point-min) (point)))
1567 (setq idlwave-shell-command-output
1568 (with-current-buffer (process-buffer proc)
f66f03de 1569 (buffer-substring-no-properties
3938cb82
S
1570 (save-excursion
1571 (goto-char (process-mark proc))
f66f03de 1572 (forward-line 0) ; Emacs 21 (beginning-of-line nil)
3938cb82
S
1573 (point))
1574 comint-last-input-end))))
1575
1576 ;; Scan for state and do post commands - bracket
1577 ;; them with idlwave-shell-ready=nil since they may
1578 ;; call idlwave-shell-send-command themselves.
1579 (let ((idlwave-shell-ready nil))
1580 (idlwave-shell-scan-for-state)
1581 ;; Show the output in the shell if it contains an error
76959b77 1582 (if idlwave-shell-hide-output
3938cb82
S
1583 (if (and idlwave-shell-show-if-error
1584 (eq idlwave-shell-current-state 'error))
1585 (idlwave-shell-comint-filter proc full-output)
5cba7601 1586 ;; If it's only *mostly* hidden, filter % lines,
3938cb82
S
1587 ;; and show anything that remains
1588 (if (eq idlwave-shell-hide-output 'mostly)
1589 (let ((filtered
5cba7601 1590 (idlwave-shell-filter-hidden-output
3938cb82 1591 full-output)))
5cba7601
GM
1592 (if filtered
1593 (idlwave-shell-comint-filter
3938cb82 1594 proc filtered))))))
5cba7601 1595
3938cb82
S
1596 ;; Call the post-command hook
1597 (if (listp idlwave-shell-post-command-hook)
1598 (progn
f66f03de
S
1599 ;;(message "Calling list")
1600 ;;(prin1 idlwave-shell-post-command-hook)
3938cb82 1601 (eval idlwave-shell-post-command-hook))
f66f03de 1602 ;;(message "Calling command function")
3938cb82
S
1603 (funcall idlwave-shell-post-command-hook))
1604
1605 ;; Reset to default state for next command.
1606 ;; Also we do not want to find this prompt again.
1607 (setq idlwave-shell-accumulation nil
1608 idlwave-shell-command-output nil
1609 idlwave-shell-post-command-hook nil
1610 idlwave-shell-hide-output nil
1611 idlwave-shell-show-if-error nil))
1612 ;; Done with post command. Do pending command if
1613 ;; any.
1614 (idlwave-shell-send-command)))
1615 (store-match-data data)))))
8c7b4ec8
EZ
1616
1617(defun idlwave-shell-sentinel (process event)
1618 "The sentinel function for the IDLWAVE shell process."
1619 (let* ((buf (idlwave-shell-buffer))
1620 (win (get-buffer-window buf)))
1621 (when (get-buffer buf)
1622 (save-excursion
1623 (set-buffer (idlwave-shell-buffer))
1624 (goto-char (point-max))
5e72c6b2
S
1625 (insert (format "\n\n Process %s %s" process event))
1626 (if (and idlwave-shell-save-command-history
1627 (stringp idlwave-shell-command-history-file))
1628 (condition-case nil
1629 (comint-write-input-ring)
1630 (error nil)))))
5cba7601 1631
8c7b4ec8
EZ
1632 (when (and (> (length (frame-list)) 1)
1633 (frame-live-p idlwave-shell-idl-wframe))
1634 (delete-frame idlwave-shell-idl-wframe)
1635 (setq idlwave-shell-idl-wframe nil
1636 idlwave-shell-display-wframe nil))
5e72c6b2
S
1637 (when (and (window-live-p win)
1638 (not (one-window-p 'nomini)))
8c7b4ec8 1639 (delete-window win))
5e72c6b2
S
1640 (idlwave-shell-cleanup)
1641 ;; Run the hook, if possible in the shell buffer.
1642 (if (get-buffer buf)
1643 (save-excursion
1644 (set-buffer buf)
1645 (run-hooks 'idlwave-shell-sentinel-hook))
1646 (run-hooks 'idlwave-shell-sentinel-hook))))
8c7b4ec8 1647
25d24a50
S
1648(defvar idlwave-shell-error-buffer " *idlwave-shell-errors*"
1649 "Buffer containing syntax errors from IDL compilations.")
1650
1651;; FIXME: the following two variables do not currently allow line breaks
1652;; in module and file names. I am not sure if it will be necessary to
1653;; change this. Currently it seems to work the way it is.
1654(defvar idlwave-shell-syntax-error
5cba7601
GM
1655 "^% Syntax error.\\s-*\n\\s-*At:\\s-*\\(.*\\),\\s-*Line\\s-*\\(.*\\)"
1656 "A regular expression to match an IDL syntax error.
25d24a50
S
1657The 1st pair matches the file name, the second pair matches the line
1658number.")
1659
1660(defvar idlwave-shell-other-error
1661 "^% .*\n\\s-*At:\\s-*\\(.*\\),\\s-*Line\\s-*\\(.*\\)"
1662 "A regular expression to match any IDL error.")
1663
5cba7601 1664(defvar idlwave-shell-halting-error
25d24a50
S
1665 "^% .*\n\\([^%].*\n\\)*% Execution halted at:\\(\\s-*\\S-+\\s-*[0-9]+\\s-*.*\\)\n"
1666 "A regular expression to match errors which halt execution.")
1667
5cba7601 1668(defvar idlwave-shell-cant-continue-error
25d24a50
S
1669 "^% Can't continue from this point.\n"
1670 "A regular expression to match errors stepping errors.")
1671
1672(defvar idlwave-shell-file-line-message
5cba7601 1673 (concat
25d24a50
S
1674 "\\(" ; program name group (1)
1675 "\\$MAIN\\$\\|" ; main level routine
1676 "\\<[a-zA-Z][a-zA-Z0-9_$:]*" ; start with a letter followed by [..]
1677 "\\([ \t]*\n[ \t]*[a-zA-Z0-9_$:]+\\)*"; continuation lines program name (2)
1678 "\\)" ; end program name group (1)
1679 "[ \t\n]+" ; white space
1680 "\\(" ; line number group (3)
1681 "[0-9]+" ; the line number (the fix point)
1682 "\\([ \t]*\n[ \t]*[0-9]+\\)*" ; continuation lines number (4)
1683 "\\)" ; end line number group (3)
1684 "[ \t\n]+" ; white space
1685 "\\(" ; file name group (5)
1686 "[^ \t\n]+" ; file names can contain any non-white
1687 "\\([ \t]*\n[ \t]*[^ \t\n]+\\)*" ; continuation lines file name (6)
1688 "\\)" ; end line number group (5)
1689 )
1690 "*A regular expression to parse out the file name and line number.
5cba7601 1691The 1st group should match the subroutine name.
25d24a50
S
1692The 3rd group is the line number.
1693The 5th group is the file name.
1694All parts may contain linebreaks surrounded by spaces. This is important
1695in IDL5 which inserts random linebreaks in long module and file names.")
1696
f66f03de
S
1697(defvar idlwave-shell-electric-debug-mode) ; defined by easy-mmode
1698
8c7b4ec8 1699(defun idlwave-shell-scan-for-state ()
52a244eb
S
1700 "Scan for state info. Looks for messages in output from last IDL
1701command indicating where IDL has stopped. The types of messages we are
1702interested in are execution halted, stepped, breakpoint, interrupted
1703at and trace messages. For breakpoint messages process any attached
1704count or command parameters. Update the stop line if a message is
1705found. The variable `idlwave-shell-current-state' is set to 'error,
1706'halt, or 'breakpoint, which describes the status, or nil for none of
1707the above."
1708 (let (trace)
1709 (cond
1710 ;; Make sure we have output
1711 ((not idlwave-shell-command-output))
5cba7601 1712
52a244eb 1713 ;; First Priority: Syntax and other errors
5cba7601 1714 ((or
52a244eb
S
1715 (string-match idlwave-shell-syntax-error
1716 idlwave-shell-command-output)
1717 (string-match idlwave-shell-other-error
1718 idlwave-shell-command-output))
f66f03de
S
1719 (with-current-buffer
1720 (get-buffer-create idlwave-shell-error-buffer)
52a244eb
S
1721 (erase-buffer)
1722 (insert idlwave-shell-command-output)
1723 (goto-char (point-min))
1724 (setq idlwave-shell-error-last (point)))
1725 (setq idlwave-shell-current-state 'error)
1726 (idlwave-shell-goto-next-error))
5cba7601 1727
52a244eb
S
1728 ;; Second Priority: Halting errors
1729 ((string-match idlwave-shell-halting-error
1730 idlwave-shell-command-output)
1731 ;; Grab the file and line state info.
1732 (setq idlwave-shell-calling-stack-index 0)
1733 (setq idlwave-shell-halt-frame
5cba7601
GM
1734 (idlwave-shell-parse-line
1735 (substring idlwave-shell-command-output
52a244eb
S
1736 (match-beginning 2)))
1737 idlwave-shell-current-state 'error)
1738 (idlwave-shell-display-line (idlwave-shell-pc-frame)))
5cba7601 1739
52a244eb
S
1740 ;; Third Priority: Various types of innocuous HALT and
1741 ;; TRACEBACK messages.
1742 ((or (setq trace (string-match idlwave-shell-trace-message-re
1743 idlwave-shell-command-output))
1744 (string-match idlwave-shell-halt-messages-re
1745 idlwave-shell-command-output))
1746 ;; Grab the file and line state info.
1747 (setq idlwave-shell-calling-stack-index 0)
1748 (setq idlwave-shell-halt-frame
5cba7601 1749 (idlwave-shell-parse-line
52a244eb
S
1750 (substring idlwave-shell-command-output (match-end 0))))
1751 (setq idlwave-shell-current-state 'halt)
1752 ;; Don't debug trace messages
5cba7601 1753 (idlwave-shell-display-line
f66f03de
S
1754 (idlwave-shell-pc-frame) nil
1755 (if trace 'disable
1756 (if idlwave-shell-electric-debug-mode 'force))))
5cba7601
GM
1757
1758 ;; Fourth Priority: Breakpoints
52a244eb
S
1759 ((string-match idlwave-shell-break-message
1760 idlwave-shell-command-output)
1761 (setq idlwave-shell-calling-stack-index 0)
5cba7601
GM
1762 (setq idlwave-shell-halt-frame
1763 (idlwave-shell-parse-line
52a244eb
S
1764 (substring idlwave-shell-command-output (match-end 0))))
1765 ;; We used to count hits on breakpoints
1766 ;; this is no longer supported since IDL breakpoints
1767 ;; have learned counting.
1768 ;; Do breakpoint command processing
5cba7601 1769 (let ((bp (assoc
52a244eb
S
1770 (list
1771 (nth 0 idlwave-shell-halt-frame)
1772 (nth 1 idlwave-shell-halt-frame))
1773 idlwave-shell-bp-alist)))
1774 ;(message "Scanning with %s" bp)
1775 (if bp
1776 (let ((cmd (idlwave-shell-bp-get bp 'cmd)))
1777 (if cmd ;; Execute any breakpoint command
1778 (if (listp cmd) (eval cmd) (funcall cmd))))
1779 ;; A breakpoint that we did not know about - perhaps it was
1780 ;; set by the user... Let's update our list.
1781 (idlwave-shell-bp-query)))
5cba7601 1782 (setq idlwave-shell-current-state 'breakpoint)
52a244eb 1783 (idlwave-shell-display-line (idlwave-shell-pc-frame)))
5cba7601 1784
52a244eb
S
1785 ;; Last Priority: Can't Step errors
1786 ((string-match idlwave-shell-cant-continue-error
1787 idlwave-shell-command-output)
1788 (setq idlwave-shell-current-state 'breakpoint))
1789
1790 ;; Otherwise, no particular state
1791 (t (setq idlwave-shell-current-state nil)))))
8c7b4ec8 1792
3938cb82 1793
52a244eb 1794(defun idlwave-shell-parse-line (string &optional skip-main)
f66f03de
S
1795 "Parse IDL message for the subroutine, file name and line number."
1796;We need to work hard here to remove the stupid line breaks inserted by
1797;IDL5. These line breaks can be right in the middle of procedure
1798;or file names.
1799;It is very difficult to come up with a robust solution. This one seems
5cba7601 1800;to be pretty good though.
f66f03de
S
1801;
1802;Here is in what ways it improves over the previous solution:
1803;
1804;1. The procedure name can be split and will be restored.
1805;2. The number can be split. I have never seen this, but who knows.
1806;3. We do not require the `.pro' extension for files.
1807;
1808;This function can still break when the file name ends on an end line
1809;and the message line contains an additional line with garbage. Then
1810;the first part of that garbage will be added to the file name.
1811;However, the function checks the existence of the files with and
1812;without this last part - thus the function only breaks if file name
1813;plus garbage match an existing regular file. This is hopefully very
1814;unlikely.
1815;
1816;If optional arg SKIP-MAIN is non-nil, don't parse $MAIN$ routine stop
1817;statements.
8c7b4ec8
EZ
1818
1819 (let (number procedure file)
52a244eb
S
1820 (when (and (not (if skip-main (string-match ":\\s-*\\$MAIN" string)))
1821 (string-match idlwave-shell-file-line-message string))
8c7b4ec8
EZ
1822 (setq procedure (match-string 1 string)
1823 number (match-string 3 string)
1824 file (match-string 5 string))
5cba7601 1825
8c7b4ec8
EZ
1826 ;; Repair the strings
1827 (setq procedure (idlwave-shell-repair-string procedure))
1828 (setq number (idlwave-shell-repair-string number))
1829 (setq file (idlwave-shell-repair-file-name file))
1830
1831 ;; If we have a file, return the frame list
1832 (if file
1833 (list (idlwave-shell-file-name file)
027a4b6b 1834 (string-to-number number)
8c7b4ec8
EZ
1835 procedure)
1836 ;; No success finding a file
1837 nil))))
1838
1839(defun idlwave-shell-repair-string (string)
1840 "Repair a string by taking out all linebreaks. This is destructive!"
1841 (while (string-match "[ \t]*\n[ \t]*" string)
1842 (setq string (replace-match "" t t string)))
1843 string)
1844
1845(defun idlwave-shell-repair-file-name (file)
1846 "Repair a file name string by taking out all linebreaks.
1847The last line of STRING may be garbage - we check which one makes a valid
1848file name."
1849 (let ((file1 "") (file2 "") (start 0))
1850 ;; We scan no further than to the next "^%" line
5cba7601 1851 (if (string-match "^%" file)
8c7b4ec8
EZ
1852 (setq file (substring file 0 (match-beginning 0))))
1853 ;; Take out the line breaks
1854 (while (string-match "[ \t]*\n[ \t]*" file start)
1855 (setq file1 (concat file1 (substring file start (match-beginning 0)))
1856 start (match-end 0)))
1857 (setq file2 (concat file1 (substring file start)))
1858 (cond
1859 ((file-regular-p file2) file2)
1860 ((file-regular-p file1) file1)
1861 ;; If we cannot veryfy the existence of the file, we return the shorter
1862 ;; name. The idea behind this is that this may be a relative file name
1863 ;; and our idea about the current working directory may be wrong.
1864 ;; If it is a relative file name, it hopefully is short.
1865 ((not (string= "" file1)) file1)
1866 ((not (string= "" file2)) file2)
1867 (t nil))))
1868
1869(defun idlwave-shell-cleanup ()
1870 "Do necessary cleanup for a terminated IDL process."
1871 (setq idlwave-shell-step-frame nil
1872 idlwave-shell-halt-frame nil
1873 idlwave-shell-pending-commands nil
1874 idlwave-shell-command-line-to-execute nil
1875 idlwave-shell-bp-alist nil
15e42531 1876 idlwave-shell-calling-stack-index 0
8a36f093 1877 idlwave-idlwave_routine_info-compiled nil)
15e42531 1878 (idlwave-shell-delete-temp-files)
8c7b4ec8
EZ
1879 (idlwave-shell-display-line nil)
1880 (idlwave-shell-update-bp-overlays) ; kill old overlays
15e42531 1881 (idlwave-shell-kill-buffer idlwave-shell-hidden-output-buffer)
8c7b4ec8
EZ
1882 (idlwave-shell-kill-buffer idlwave-shell-bp-buffer)
1883 (idlwave-shell-kill-buffer idlwave-shell-error-buffer)
1884 ;; (idlwave-shell-kill-buffer (idlwave-shell-buffer))
1885 (and (get-buffer (idlwave-shell-buffer))
1886 (bury-buffer (get-buffer (idlwave-shell-buffer))))
1887 (run-hooks 'idlwave-shell-cleanup-hook))
1888
1889(defun idlwave-shell-kill-buffer (buf)
1890 "Kill buffer BUF if it exists."
1891 (if (setq buf (get-buffer buf))
1892 (kill-buffer buf)))
1893
1894(defun idlwave-shell-kill-shell-buffer-confirm ()
1895 (when (idlwave-shell-is-running)
1896 (ding)
1897 (unless (y-or-n-p "IDL shell is running. Are you sure you want to kill the buffer? ")
1898 (error "Abort"))
1899 (message "Killing buffer *idl* and the associated process")))
1900
05a1abfc
CD
1901(defun idlwave-shell-window (n)
1902 "Issue a `window,N' command to IDL, with special window size.
1903The size is given by `idlwave-shell-graphics-window-size'."
1904 (interactive "P")
1905 (let ((n (if n (prefix-numeric-value n) 0)))
5cba7601 1906 (idlwave-shell-send-command
05a1abfc 1907 (apply 'format "window,%d,xs=%d,ys=%d"
76959b77 1908 n idlwave-shell-graphics-window-size)
52a244eb 1909 nil (idlwave-shell-hide-p 'misc) nil t)))
05a1abfc 1910
8c7b4ec8 1911(defun idlwave-shell-resync-dirs ()
76959b77
S
1912 "Resync the buffer's idea of the current directory.
1913This command queries IDL with the command bound to
1914`idlwave-shell-dirstack-query', reads the output for the new
1915directory."
8c7b4ec8
EZ
1916 (interactive)
1917 (idlwave-shell-send-command idlwave-shell-dirstack-query
1918 'idlwave-shell-filter-directory
76959b77 1919 'hide 'wait))
8c7b4ec8
EZ
1920
1921(defun idlwave-shell-retall (&optional arg)
52a244eb
S
1922 "Return from the entire calling stack.
1923Also get rid of widget events in the queue."
8c7b4ec8 1924 (interactive "P")
52a244eb 1925 (save-selected-window
5cba7601
GM
1926 ;;if (widget_info(/MANAGED))[0] gt 0 then for i=0,n_elements(widget_info(/MANAGED))-1 do widget_control,(widget_info(/MANAGED))[i],/clear_events &
1927 (idlwave-shell-send-command "retall" nil
1928 (if (idlwave-shell-hide-p 'misc) 'mostly)
52a244eb
S
1929 nil t)
1930 (idlwave-shell-display-line nil)))
8c7b4ec8
EZ
1931
1932(defun idlwave-shell-closeall (&optional arg)
1933 "Close all open files."
1934 (interactive "P")
5cba7601 1935 (idlwave-shell-send-command "close,/all" nil
52a244eb 1936 (idlwave-shell-hide-p 'misc) nil t))
8c7b4ec8
EZ
1937
1938(defun idlwave-shell-quit (&optional arg)
1939 "Exit the idl process after confirmation.
1940With prefix ARG, exit without confirmation."
1941 (interactive "P")
1942 (if (not (idlwave-shell-is-running))
1943 (error "Shell is not running")
1944 (if (or arg (y-or-n-p "Exit the IDLWAVE Shell? "))
1945 (condition-case nil
1946 (idlwave-shell-send-command "exit")
1947 (error nil)))))
1948
ca660d22 1949(defun idlwave-shell-reset (&optional hidden)
76959b77 1950 "Reset IDL. Return to main level and destroy the leftover variables.
5cba7601 1951This issues the following commands:
8c7b4ec8
EZ
1952RETALL
1953WIDGET_CONTROL,/RESET
1954CLOSE, /ALL
1955HEAP_GC, /VERBOSE"
1956 ;; OBJ_DESTROY, OBJ_VALID() FIXME: should this be added?
1957 (interactive "P")
5cba7601 1958 (when (or idlwave-shell-reset-no-prompt
f66f03de
S
1959 (yes-or-no-p "Really Reset IDL and discard current session? "))
1960 (message "Resetting IDL")
1961 (setq idlwave-shell-calling-stack-index 0)
1962 ;; Give widget exit handlers a chance
1963 (idlwave-shell-send-command "retall" nil hidden)
1964 (idlwave-shell-send-command "widget_control,/reset" nil hidden)
1965 (idlwave-shell-send-command "close,/all" nil hidden)
1966 ;; (idlwave-shell-send-command "obj_destroy, obj_valid()" nil hidden)
1967 (idlwave-shell-send-command "heap_gc,/verbose" nil hidden)
1968 (idlwave-shell-display-line nil)))
8c7b4ec8 1969
15e42531
CD
1970(defun idlwave-shell-path-filter ()
1971 ;; Convert the output of the path query into a list of directories
1972 (let ((path-string idlwave-shell-command-output)
1973 (case-fold-search t)
1974 (start 0)
1975 dirs sysdir)
05a1abfc 1976 (while (string-match "^PATH:[ \t]*<\\(.*\\)>[ \t]*\n" path-string start)
15e42531
CD
1977 (push (match-string 1 path-string) dirs)
1978 (setq start (match-end 0)))
1979 (setq dirs (mapcar 'file-name-as-directory dirs))
05a1abfc 1980 (if (string-match "^SYSDIR:[ \t]*<\\(.*\\)>[ \t]*\n" path-string)
15e42531
CD
1981 (setq sysdir (file-name-as-directory
1982 (match-string 1 path-string))))
1983 (cons sysdir (nreverse dirs))))
1984
1985(defun idlwave-shell-routine-info-filter ()
1986 "Function which parses the special output from idlwave_routine_info.pro."
1987 (let ((text idlwave-shell-command-output)
1988 (start 0)
1989 sep sep-re file type spec specs name cs key keys class entry)
52a244eb 1990 ;; (message "GOT: %s" text) ;??????????????????????
15e42531
CD
1991 ;; Initialize variables
1992 (setq idlwave-compiled-routines nil
1993 idlwave-unresolved-routines nil)
1994 ;; Cut out the correct part of the output.
1995 (if (string-match
1996 "^>>>BEGIN OF IDLWAVE ROUTINE INFO (\"\\(.+\\)\" IS THE SEPARATOR.*"
1997 text)
1998 (setq sep (match-string 1 text)
1999 sep-re (concat (regexp-quote sep) " *")
2000 text (substring text (match-end 0)))
2001 ;; Set dummy values and kill the text
2002 (setq sep "@" sep-re "@ *" text "")
52a244eb 2003 (if idlwave-idlwave_routine_info-compiled
5cba7601
GM
2004 (message
2005 "Routine Info warning: No match for BEGIN line in \n>>>\n%s\n<<<\n"
52a244eb 2006 idlwave-shell-command-output)))
15e42531
CD
2007 (if (string-match "^>>>END OF IDLWAVE ROUTINE INFO.*" text)
2008 (setq text (substring text 0 (match-beginning 0)))
52a244eb 2009 (if idlwave-idlwave_routine_info-compiled
5cba7601
GM
2010 (message
2011 "Routine Info warning: No match for END line in \n>>>\n%s\n<<<\n"
52a244eb 2012 idlwave-shell-command-output)))
15e42531
CD
2013 ;; Match the output lines
2014 (while (string-match "^IDLWAVE-\\(PRO\\|FUN\\): \\(.*\\)" text start)
2015 (setq start (match-end 0))
2016 (setq type (match-string 1 text)
2017 spec (match-string 2 text)
2018 specs (idlwave-split-string spec sep-re)
2019 name (nth 0 specs)
2020 class (if (equal (nth 1 specs) "") nil (nth 1 specs))
2021 file (nth 2 specs)
2022 cs (nth 3 specs)
2023 key (nth 4 specs)
2024 keys (if (and (stringp key)
2025 (not (string-match "\\` *\\'" key)))
5cba7601 2026 (mapcar 'list
15e42531
CD
2027 (delete "" (idlwave-split-string key " +")))))
2028 (setq name (idlwave-sintern-routine-or-method name class t)
2029 class (idlwave-sintern-class class t)
2030 file (if (equal file "") nil file)
5cba7601 2031 keys (mapcar (lambda (x)
15e42531 2032 (list (idlwave-sintern-keyword (car x) t))) keys))
5cba7601 2033
15e42531
CD
2034 ;; In the following ignore routines already defined in buffers,
2035 ;; assuming that if the buffer stuff differs, it is a "new"
52a244eb 2036 ;; version, not yet compiled, and should take precedence.
15e42531
CD
2037 ;; We could do the same for the library to avoid duplicates -
2038 ;; but I think frequently a user might have several versions of
5cba7601 2039 ;; the same function in different programs, and in this case the
52a244eb 2040 ;; compiled one will be the best guess of all versions.
15e42531 2041 ;; Therefore, we leave duplicates of library routines in.
15e42531
CD
2042 (cond ((string= name "$MAIN$")) ; ignore this one
2043 ((and (string= type "PRO")
2044 ;; FIXME: is it OK to make the buffer routines dominate?
2045 (or t (null file)
5cba7601 2046 (not (idlwave-rinfo-assq name 'pro class
15e42531
CD
2047 idlwave-buffer-routines)))
2048 ;; FIXME: is it OK to make the library routines dominate?
5cba7601 2049 ;;(not (idlwave-rinfo-assq name 'pro class
15e42531
CD
2050 ;; idlwave-library-routines))
2051 )
5cba7601
GM
2052 (setq entry (list name 'pro class
2053 (cons 'compiled
52a244eb
S
2054 (if file
2055 (list
2056 (file-name-nondirectory file)
5cba7601 2057 (idlwave-sintern-dir
52a244eb
S
2058 (file-name-directory file)))))
2059 cs (cons nil keys)))
5cba7601 2060 (if file
15e42531
CD
2061 (push entry idlwave-compiled-routines)
2062 (push entry idlwave-unresolved-routines)))
5cba7601 2063
15e42531
CD
2064 ((and (string= type "FUN")
2065 ;; FIXME: is it OK to make the buffer routines dominate?
2066 (or t (not file)
5cba7601 2067 (not (idlwave-rinfo-assq name 'fun class
15e42531
CD
2068 idlwave-buffer-routines)))
2069 ;; FIXME: is it OK to make the library routines dominate?
5cba7601 2070 ;; (not (idlwave-rinfo-assq name 'fun class
15e42531
CD
2071 ;; idlwave-library-routines))
2072 )
5cba7601 2073 (setq entry (list name 'fun class
52a244eb
S
2074 (cons 'compiled
2075 (if file
2076 (list
2077 (file-name-nondirectory file)
5cba7601 2078 (idlwave-sintern-dir
52a244eb
S
2079 (file-name-directory file)))))
2080 cs (cons nil keys)))
15e42531
CD
2081 (if file
2082 (push entry idlwave-compiled-routines)
2083 (push entry idlwave-unresolved-routines))))))
2084 ;; Reverse the definitions so that they are alphabetically sorted.
2085 (setq idlwave-compiled-routines (nreverse idlwave-compiled-routines)
2086 idlwave-unresolved-routines (nreverse idlwave-unresolved-routines)))
2087
8c7b4ec8
EZ
2088(defun idlwave-shell-filter-directory ()
2089 "Get the current directory from `idlwave-shell-command-output'.
2090Change the default directory for the process buffer to concur."
2091 (save-excursion
2092 (set-buffer (idlwave-shell-buffer))
dd5baa1a 2093 (if (string-match ",___cur[\n\r ]+\\([^\n\r]+\\)[\n\r]"
8c7b4ec8 2094 idlwave-shell-command-output)
5cba7601 2095 (let ((dir (substring idlwave-shell-command-output
8c7b4ec8 2096 (match-beginning 1) (match-end 1))))
76959b77 2097; (message "Setting Emacs working dir to %s" dir)
8c7b4ec8
EZ
2098 (setq idlwave-shell-default-directory dir)
2099 (setq default-directory (file-name-as-directory dir))))))
2100
76959b77
S
2101(defvar idlwave-shell-get-object-class nil)
2102(defun idlwave-shell-get-object-class (apos)
2103 "Query the shell for the class of the object before point."
2104 (let ((bos (save-excursion (idlwave-start-of-substatement 'pre) (point)))
2105 (bol (save-excursion (forward-line 0) (point)))
2106 expression)
2107 (save-excursion
2108 (goto-char apos)
5cba7601 2109 (setq expression (buffer-substring
76959b77
S
2110 (catch 'exit
2111 (while t
5cba7601 2112 (if (not (re-search-backward
76959b77
S
2113 "[^][.A-Za-z0-9_() ]" bos t))
2114 (throw 'exit bos)) ;ran into bos
2115 (if (not (idlwave-is-pointer-dereference bol))
2116 (throw 'exit (1+ (point))))))
2117 apos)))
2118 (when (not (string= expression ""))
2119 (setq idlwave-shell-get-object-class nil)
2120 (idlwave-shell-send-command
5cba7601 2121 (concat "if obj_valid(" expression ") then print,obj_class("
3938cb82 2122 expression ")")
76959b77
S
2123 'idlwave-shell-parse-object-class
2124 'hide 'wait)
2125 ;; If we don't know anything about the class, update shell routines
2126 (if (and idlwave-shell-get-object-class
25d24a50
S
2127 (not (assoc-string idlwave-shell-get-object-class
2128 (idlwave-class-alist) t)))
76959b77
S
2129 (idlwave-shell-maybe-update-routine-info))
2130 idlwave-shell-get-object-class)))
2131
2132(defun idlwave-shell-parse-object-class ()
2133 "Parse the output of the obj_class command."
3938cb82 2134 (let ((match "obj_class([^\n\r]+[\n\r ]"))
5cba7601 2135 (if (string-match (concat match "\\([A-Za-z_0-9]+\\) *[\n\r]\\("
3938cb82
S
2136 idlwave-shell-prompt-pattern "\\)")
2137 idlwave-shell-command-output)
5cba7601 2138 (setq idlwave-shell-get-object-class
76959b77
S
2139 (match-string 1 idlwave-shell-command-output)))))
2140
52a244eb
S
2141(defvar idlwave-sint-sysvars nil)
2142(idlwave-new-sintern-type 'execcomm)
76959b77 2143
8c7b4ec8
EZ
2144(defun idlwave-shell-complete (&optional arg)
2145 "Do completion in the idlwave-shell buffer.
2146Calls `idlwave-shell-complete-filename' after some executive commands or
2147in strings. Otherwise, calls `idlwave-complete' to complete modules and
2148keywords."
8c7b4ec8 2149 (interactive "P")
52a244eb 2150 (let (exec-cmd)
8c7b4ec8 2151 (cond
5cba7601 2152 ((and
52a244eb
S
2153 (setq exec-cmd (idlwave-shell-executive-command))
2154 (cdr exec-cmd)
2155 (member (upcase (cdr exec-cmd))
2156 '(".R" ".RU" ".RUN" ".RN" ".RNE" ".RNEW"
2157 ".COM" ".COMP" ".COMPI" ".COMPIL" ".COMPILE")))
8c7b4ec8 2158 ;; We are in a command line with an executive command
52a244eb
S
2159 (idlwave-shell-complete-filename))
2160
2161 ((car-safe exec-cmd)
5cba7601 2162 (setq idlwave-completion-help-info
52a244eb
S
2163 '(idlwave-shell-complete-execcomm-help))
2164 (idlwave-complete-in-buffer 'execcomm 'execcomm
2165 idlwave-executive-commands-alist nil
2166 "Select an executive command"
2167 "system variable"))
76959b77
S
2168
2169 ((idlwave-shell-batch-command)
2170 (idlwave-shell-complete-filename))
2171
52a244eb
S
2172 ((idlwave-shell-shell-command)
2173 (idlwave-shell-complete-filename))
2174
15e42531
CD
2175 ((and (idlwave-shell-filename-string)
2176 (save-excursion
2177 (beginning-of-line)
2178 (let ((case-fold-search t))
76959b77
S
2179 (not (looking-at ".*obj_new")))))
2180 (idlwave-shell-complete-filename))
5cba7601 2181
8c7b4ec8
EZ
2182 (t
2183 ;; Default completion of modules and keywords
15e42531 2184 (idlwave-complete arg)))))
8c7b4ec8 2185
52a244eb 2186;; Get rid of opaque dynamic variable passing of link?
25d24a50 2187(defvar link) ;dynamic variable
52a244eb
S
2188(defun idlwave-shell-complete-execcomm-help (mode word)
2189 (let ((word (or (nth 1 idlwave-completion-help-info) word))
25d24a50 2190 (entry (assoc-string word idlwave-executive-commands-alist t)))
52a244eb
S
2191 (cond
2192 ((eq mode 'test)
2193 (and (stringp word) entry (cdr entry)))
2194 ((eq mode 'set)
2195 (if entry (setq link (cdr entry)))) ;; setting dynamic variable!!!
2196 (t (error "This should not happen")))))
2197
8c7b4ec8
EZ
2198(defun idlwave-shell-complete-filename (&optional arg)
2199 "Complete a file name at point if after a file name.
2200We assume that we are after a file name when completing one of the
76959b77
S
2201args of an executive .run, .rnew or .compile."
2202 ;; CWD might have changed, resync, to set default directory
5cba7601 2203 (idlwave-shell-resync-dirs)
76959b77
S
2204 (let ((comint-file-name-chars idlwave-shell-file-name-chars))
2205 (comint-dynamic-complete-as-filename)))
8c7b4ec8
EZ
2206
2207(defun idlwave-shell-executive-command ()
2208 "Return the name of the current executive command, if any."
2209 (save-excursion
2210 (idlwave-beginning-of-statement)
52a244eb
S
2211 (cons (looking-at "[ \t]*\\.")
2212 (if (looking-at "[ \t]*[.]\\([^ \t\n\r]+\\)[ \t]")
2213 (match-string 1)))))
8c7b4ec8
EZ
2214
2215(defun idlwave-shell-filename-string ()
2216 "Return t if in a string and after what could be a file name."
2217 (let ((limit (save-excursion (beginning-of-line) (point))))
2218 (save-excursion
2219 ;; Skip backwards over file name chars
2220 (skip-chars-backward idlwave-shell-file-name-chars limit)
2221 ;; Check of the next char is a string delimiter
2222 (memq (preceding-char) '(?\' ?\")))))
2223
76959b77
S
2224(defun idlwave-shell-batch-command ()
2225 "Returns t if we're in a batch command statement like @foo"
2226 (let ((limit (save-excursion (beginning-of-line) (point))))
2227 (save-excursion
2228 ;; Skip backwards over filename
2229 (skip-chars-backward idlwave-shell-file-name-chars limit)
2230 (skip-chars-backward " \t" limit)
2231 (and (eq (preceding-char) ?@) (not (idlwave-in-quote))))))
2232
52a244eb
S
2233(defun idlwave-shell-shell-command ()
2234 "Returns t if we're in a shell command statement like $ls"
2235 (save-excursion
2236 (idlwave-beginning-of-statement)
2237 (looking-at "\\$")))
2238
2239;; Debugging Commands ------------------------------------------------------
8c7b4ec8
EZ
2240
2241(defun idlwave-shell-redisplay (&optional hide)
2242 "Tries to resync the display with where execution has stopped.
5cba7601 2243Issues a \"help,/trace\" command followed by a call to
8c7b4ec8
EZ
2244`idlwave-shell-display-line'. Also updates the breakpoint
2245overlays."
2246 (interactive)
ca660d22 2247 (setq idlwave-shell-calling-stack-index 0)
8c7b4ec8
EZ
2248 (idlwave-shell-send-command
2249 "help,/trace"
2250 '(idlwave-shell-display-line
2251 (idlwave-shell-pc-frame))
2252 hide)
2253 (idlwave-shell-bp-query))
2254
2255(defun idlwave-shell-display-level-in-calling-stack (&optional hide)
5cba7601 2256 (idlwave-shell-send-command
8c7b4ec8 2257 "help,/trace"
ca660d22
CD
2258 `(progn
2259 ;; scanning for the state will reset the stack level - restore it
2260 (setq idlwave-shell-calling-stack-index
2261 ,idlwave-shell-calling-stack-index)
2262 ;; parse the stack and visit the selected frame
2263 (idlwave-shell-parse-stack-and-display))
8c7b4ec8
EZ
2264 hide))
2265
2266(defun idlwave-shell-parse-stack-and-display ()
2267 (let* ((lines (delete "" (idlwave-split-string
2268 idlwave-shell-command-output "^%")))
2269 (stack (delq nil (mapcar 'idlwave-shell-parse-line lines)))
2270 (nmax (1- (length stack)))
2271 (nmin 0) message)
8c7b4ec8
EZ
2272 (cond
2273 ((< nmax nmin)
15e42531
CD
2274 (setq idlwave-shell-calling-stack-index 0)
2275 (ding)
2276 (message "Problem with calling stack"))
8c7b4ec8 2277 ((> idlwave-shell-calling-stack-index nmax)
ca660d22 2278 (ding)
8c7b4ec8 2279 (setq idlwave-shell-calling-stack-index nmax
ca660d22
CD
2280 message (format "%d is the highest calling stack level - can't go further up"
2281 (- nmax))))
8c7b4ec8 2282 ((< idlwave-shell-calling-stack-index nmin)
ca660d22 2283 (ding)
8c7b4ec8 2284 (setq idlwave-shell-calling-stack-index nmin
ca660d22
CD
2285 message (format "%d is the current calling stack level - can't go further down"
2286 (- nmin)))))
5cba7601 2287 (setq idlwave-shell-calling-stack-routine
ca660d22 2288 (nth 2 (nth idlwave-shell-calling-stack-index stack)))
52a244eb 2289
f66f03de 2290 ;; force edebug for this frame if we're in that mode already
5cba7601 2291 (idlwave-shell-display-line
52a244eb 2292 (nth idlwave-shell-calling-stack-index stack) nil
f66f03de 2293 (if idlwave-shell-electric-debug-mode 'force))
5cba7601 2294 (message "%s" (or message
f66f03de
S
2295 (format "In routine %s (stack level %d)"
2296 idlwave-shell-calling-stack-routine
2297 (- idlwave-shell-calling-stack-index))))))
8c7b4ec8
EZ
2298
2299(defun idlwave-shell-stack-up ()
2300 "Display the source code one step up the calling stack."
2301 (interactive)
2302 (incf idlwave-shell-calling-stack-index)
2303 (idlwave-shell-display-level-in-calling-stack 'hide))
2304(defun idlwave-shell-stack-down ()
2305 "Display the source code one step down the calling stack."
2306 (interactive)
2307 (decf idlwave-shell-calling-stack-index)
2308 (idlwave-shell-display-level-in-calling-stack 'hide))
2309
2310(defun idlwave-shell-goto-frame (&optional frame)
2311 "Set buffer to FRAME with point at the frame line.
2312If the optional argument FRAME is nil then idlwave-shell-pc-frame is
2313used. Does nothing if the resulting frame is nil."
2314 (if frame ()
2315 (setq frame (idlwave-shell-pc-frame)))
2316 (cond
2317 (frame
15e42531 2318 (set-buffer (idlwave-find-file-noselect (car frame) 'shell))
8c7b4ec8 2319 (widen)
e6ce8c42
GM
2320 (goto-char (point-min))
2321 (forward-line (1- (nth 1 frame))))))
8c7b4ec8
EZ
2322
2323(defun idlwave-shell-pc-frame ()
2324 "Returns the frame for IDL execution."
2325 (and idlwave-shell-halt-frame
5cba7601 2326 (list (nth 0 idlwave-shell-halt-frame)
ca660d22
CD
2327 (nth 1 idlwave-shell-halt-frame)
2328 (nth 2 idlwave-shell-halt-frame))))
8c7b4ec8
EZ
2329
2330(defun idlwave-shell-valid-frame (frame)
2331 "Check that frame is for an existing file."
2332 (file-readable-p (car frame)))
2333
f66f03de
S
2334(defun idlwave-shell-stop-line-pending ()
2335 ;; Temporarily change the color of the stop line overlay
2336 (if idlwave-shell-stop-line-overlay
2337 (overlay-put idlwave-shell-stop-line-overlay 'face
2338 (if idlwave-shell-electric-debug-mode
2339 'idlwave-shell-pending-electric-stop
2340 'idlwave-shell-pending-stop))))
8c7b4ec8 2341
f66f03de
S
2342(defvar idlwave-shell-suppress-electric-debug nil)
2343(defun idlwave-shell-display-line (frame &optional col debug)
2344 "display frame file in other window with overlay arrow.
2345
2346frame is a list of file name, line number, and subroutine name. if
2347frame is nil then remove overlay. if col is set, move point to that
2348column in the line. if debug is non-nil, enable the electric debug
2349mode. if it is 'disable, do not enable no matter what the setting of
2350'idlwave-shell-automatic-electric-debug'. if it is 'force, enable no
2351matter what the settings of that variable."
8c7b4ec8 2352 (if (not frame)
f66f03de 2353 ;; remove stop-line overlay from old position
5cba7601 2354 (progn
8c7b4ec8 2355 (setq overlay-arrow-string nil)
ca660d22 2356 (setq idlwave-shell-mode-line-info nil)
15e42531 2357 (setq idlwave-shell-is-stopped nil)
8c7b4ec8 2358 (if idlwave-shell-stop-line-overlay
52a244eb 2359 (delete-overlay idlwave-shell-stop-line-overlay))
f66f03de
S
2360 ;; turn off electric debug everywhere, if it's on
2361 (idlwave-shell-electric-debug-all-off))
8c7b4ec8 2362 (if (not (idlwave-shell-valid-frame frame))
f66f03de 2363 ;; fixme: errors are dangerous in shell filters. but i think i
15e42531 2364 ;; have never encountered this one.
a867ead0 2365 (error "invalid frame - unable to access file: %s" (car frame))
8c7b4ec8
EZ
2366;;;
2367;;; buffer : the buffer to display a line in.
2368;;; select-shell: current buffer is the shell.
5cba7601 2369;;;
ca660d22
CD
2370 (setq idlwave-shell-mode-line-info
2371 (if (nth 2 frame)
5cba7601 2372 (format "[%d:%s]"
ca660d22
CD
2373 (- idlwave-shell-calling-stack-index)
2374 (nth 2 frame))))
15e42531 2375 (let* ((buffer (idlwave-find-file-noselect (car frame) 'shell))
8c7b4ec8 2376 (select-shell (equal (buffer-name) (idlwave-shell-buffer)))
52a244eb 2377 window pos electric)
8c7b4ec8 2378
f66f03de 2379 ;; first make sure the shell window is visible
8c7b4ec8
EZ
2380 (idlwave-display-buffer (idlwave-shell-buffer)
2381 nil (idlwave-shell-shell-frame))
2382
f66f03de 2383 ;; now display the buffer and remember which window it is.
8c7b4ec8
EZ
2384 (setq window (idlwave-display-buffer buffer
2385 nil (idlwave-shell-source-frame)))
2386
f66f03de 2387 ;; enter the buffer and mark the line
8c7b4ec8
EZ
2388 (save-excursion
2389 (set-buffer buffer)
2390 (save-restriction
2391 (widen)
e6ce8c42
GM
2392 (goto-char (point-min))
2393 (forward-line (1- (nth 1 frame)))
8c7b4ec8 2394 (setq pos (point))
15e42531 2395 (setq idlwave-shell-is-stopped t)
5cba7601 2396
8c7b4ec8 2397 (if idlwave-shell-stop-line-overlay
f66f03de 2398 (progn
5cba7601 2399 ;; restore face and move overlay
f66f03de
S
2400 (overlay-put idlwave-shell-stop-line-overlay 'face
2401 (if idlwave-shell-electric-debug-mode
5cba7601 2402 idlwave-shell-electric-stop-line-face
f66f03de
S
2403 idlwave-shell-stop-line-face))
2404 (move-overlay idlwave-shell-stop-line-overlay
2405 (point) (save-excursion (end-of-line) (point))
2406 (current-buffer)))
2407 ;; use the arrow instead, but only if marking is wanted.
8c7b4ec8
EZ
2408 (if idlwave-shell-mark-stop-line
2409 (setq overlay-arrow-string idlwave-shell-overlay-arrow))
2410 (or overlay-arrow-position ; create the marker if necessary
2411 (setq overlay-arrow-position (make-marker)))
52a244eb 2412 (set-marker overlay-arrow-position (point) buffer)))
13ae1076 2413
f66f03de 2414 ;; if the point is outside the restriction, widen the buffer.
8c7b4ec8
EZ
2415 (if (or (< pos (point-min)) (> pos (point-max)))
2416 (progn
2417 (widen)
2418 (goto-char pos)))
2419
f66f03de 2420 ;; if we have the column of the error, move the cursor there.
8c7b4ec8 2421 (if col (move-to-column col))
52a244eb 2422 (setq pos (point))
5cba7601 2423
f66f03de 2424 ;; enter electric debug mode, if not prohibited and not in
52a244eb 2425 ;; it already
f66f03de
S
2426 (when (and (not idlwave-shell-electric-debug-mode)
2427 (or (eq debug 'force)
5cba7601 2428 (and
f66f03de 2429 (not (eq debug 'disable)) ;; explicitly disabled
5cba7601 2430 (or
f66f03de 2431 (eq idlwave-shell-automatic-electric-debug t)
5cba7601
GM
2432 (and
2433 (eq idlwave-shell-automatic-electric-debug
f66f03de
S
2434 'breakpoint)
2435 (not (eq idlwave-shell-current-state 'error))))
2436 (not idlwave-shell-suppress-electric-debug))))
2437 (idlwave-shell-electric-debug-mode t))
2438 (setq electric idlwave-shell-electric-debug-mode))
5cba7601 2439
8c7b4ec8 2440 ;; Make sure pos is really displayed in the window.
52a244eb 2441 (set-window-point window pos)
5cba7601
GM
2442
2443 ;; If we came from the shell, go back there. Otherwise select
f66f03de 2444 ;; the window where the error/halt is displayed.
52a244eb 2445 (if (or (and idlwave-shell-electric-zap-to-file electric)
5cba7601 2446 (and (equal (buffer-name) (idlwave-shell-buffer))
52a244eb 2447 (not select-shell)))
8c7b4ec8
EZ
2448 (select-window window))))))
2449
2450
2451(defun idlwave-shell-step (arg)
2452 "Step one source line. If given prefix argument ARG, step ARG source lines."
2453 (interactive "p")
2454 (or (not arg) (< arg 1)
2455 (setq arg 1))
f66f03de 2456 (idlwave-shell-stop-line-pending)
5cba7601 2457 (idlwave-shell-send-command
76959b77 2458 (concat ".s " (if (integerp arg) (int-to-string arg) arg))
52a244eb 2459 nil (if (idlwave-shell-hide-p 'debug) 'mostly) nil t))
8c7b4ec8
EZ
2460
2461(defun idlwave-shell-stepover (arg)
2462 "Stepover one source line.
5cba7601 2463If given prefix argument ARG, step ARG source lines.
8c7b4ec8
EZ
2464Uses IDL's stepover executive command which does not enter called functions."
2465 (interactive "p")
2466 (or (not arg) (< arg 1)
2467 (setq arg 1))
f66f03de 2468 (idlwave-shell-stop-line-pending)
5cba7601 2469 (idlwave-shell-send-command
76959b77 2470 (concat ".so " (if (integerp arg) (int-to-string arg) arg))
52a244eb 2471 nil (if (idlwave-shell-hide-p 'debug) 'mostly) nil t))
8c7b4ec8 2472
5cba7601 2473(defun idlwave-shell-break-here (&optional count cmd condition disabled
3938cb82 2474 no-show)
5cba7601 2475 "Set breakpoint at current line.
8c7b4ec8
EZ
2476
2477If Count is nil then an ordinary breakpoint is set. We treat a count
2478of 1 as a temporary breakpoint using the ONCE keyword. Counts greater
2479than 1 use the IDL AFTER=count keyword to break only after reaching
2480the statement count times.
2481
027a4b6b 2482Optional argument CMD is a list or function to evaluate upon reaching
3938cb82
S
2483the breakpoint. CONDITION is a break condition, and DISABLED, if
2484non-nil disables the breakpoint"
8c7b4ec8 2485 (interactive "P")
76959b77 2486 (when (listp count)
5cba7601 2487 (if (equal (car count) 4)
76959b77
S
2488 (setq condition (read-string "Break Condition: ")))
2489 (setq count nil))
8c7b4ec8
EZ
2490 (idlwave-shell-set-bp
2491 ;; Create breakpoint
2492 (idlwave-shell-bp (idlwave-shell-current-frame)
3938cb82 2493 (list count cmd condition disabled)
52a244eb
S
2494 (idlwave-shell-current-module))
2495 no-show))
8c7b4ec8
EZ
2496
2497(defun idlwave-shell-set-bp-check (bp)
2498 "Check for failure to set breakpoint.
2499This is run on `idlwave-shell-post-command-hook'.
2500Offers to recompile the procedure if we failed. This usually fixes
2501the problem with not being able to set the breakpoint."
2502 ;; Scan for message
3938cb82
S
2503 (if idlwave-shell-command-output
2504 (cond
2505 ((string-match "% BREAKPOINT: *Unable to find code"
2506 idlwave-shell-command-output)
2507 ;; Offer to recompile
8c7b4ec8
EZ
2508 (if (progn
2509 (beep)
5cba7601 2510 (y-or-n-p
8c7b4ec8 2511 (concat "Okay to recompile file "
f66f03de 2512 (idlwave-shell-bp-get bp 'file) "?")))
8c7b4ec8
EZ
2513 ;; Recompile
2514 (progn
2515 ;; Clean up before retrying
2516 (idlwave-shell-command-failure)
2517 (idlwave-shell-send-command
5cba7601 2518 (concat ".run \"" (idlwave-shell-bp-get bp 'file) "\"") nil
52a244eb 2519 (if (idlwave-shell-hide-p 'run) 'mostly) nil t)
8c7b4ec8
EZ
2520 ;; Try setting breakpoint again
2521 (idlwave-shell-set-bp bp))
2522 (beep)
2523 (message "Unable to set breakpoint.")
3938cb82
S
2524 (idlwave-shell-command-failure))
2525 nil)
2526
2527 ((string-match "% Syntax error" idlwave-shell-command-output)
2528 (message "Syntax error in condition.")
2529 (idlwave-shell-command-failure)
2530 nil)
5cba7601 2531
3938cb82 2532 (t 'okay))))
8c7b4ec8
EZ
2533
2534(defun idlwave-shell-command-failure ()
2535 "Do any necessary clean up when an IDL command fails.
2536Call this from a function attached to `idlwave-shell-post-command-hook'
2537that detects the failure of a command.
2538For example, this is called from `idlwave-shell-set-bp-check' when a
2539breakpoint can not be set."
2540 ;; Clear pending commands
2541 (setq idlwave-shell-pending-commands nil))
2542
52a244eb 2543(defun idlwave-shell-cont (&optional no-show)
8c7b4ec8
EZ
2544 "Continue executing."
2545 (interactive)
f66f03de 2546 (idlwave-shell-stop-line-pending)
5cba7601 2547 (idlwave-shell-send-command ".c" (unless no-show
52a244eb 2548 '(idlwave-shell-redisplay 'hide))
5cba7601 2549 (if (idlwave-shell-hide-p 'debug) 'mostly)
52a244eb 2550 nil t))
8c7b4ec8
EZ
2551
2552(defun idlwave-shell-go ()
2553 "Run .GO. This starts the main program of the last compiled file."
2554 (interactive)
f66f03de 2555 (idlwave-shell-stop-line-pending)
76959b77 2556 (idlwave-shell-send-command ".go" '(idlwave-shell-redisplay 'hide)
52a244eb
S
2557 (if (idlwave-shell-hide-p 'debug) 'mostly)
2558 nil t))
8c7b4ec8
EZ
2559
2560(defun idlwave-shell-return ()
2561 "Run .RETURN (continue to next return, but stay in subprogram)."
2562 (interactive)
f66f03de 2563 (idlwave-shell-stop-line-pending)
76959b77 2564 (idlwave-shell-send-command ".return" '(idlwave-shell-redisplay 'hide)
52a244eb
S
2565 (if (idlwave-shell-hide-p 'debug) 'mostly)
2566 nil t))
8c7b4ec8
EZ
2567
2568(defun idlwave-shell-skip ()
2569 "Run .SKIP (skip one line, then step)."
2570 (interactive)
5cba7601 2571 (idlwave-shell-stop-line-pending)
76959b77 2572 (idlwave-shell-send-command ".skip" '(idlwave-shell-redisplay 'hide)
52a244eb
S
2573 (if (idlwave-shell-hide-p 'debug) 'mostly)
2574 nil t))
8c7b4ec8 2575
815c75b5 2576(defun idlwave-shell-clear-bp (bp &optional no-query)
8c7b4ec8
EZ
2577 "Clear breakpoint BP.
2578Clears in IDL and in `idlwave-shell-bp-alist'."
2579 (let ((index (idlwave-shell-bp-get bp)))
2580 (if index
2581 (progn
2582 (idlwave-shell-send-command
52a244eb
S
2583 (concat "breakpoint,/clear," (int-to-string index))
2584 nil (idlwave-shell-hide-p 'breakpoint) nil t)
815c75b5 2585 (unless no-query (idlwave-shell-bp-query))))))
8c7b4ec8
EZ
2586
2587(defun idlwave-shell-current-frame ()
2588 "Return a list containing the current file name and line point is in.
2589If in the IDL shell buffer, returns `idlwave-shell-pc-frame'."
2590 (if (eq (current-buffer) (get-buffer (idlwave-shell-buffer)))
2591 ;; In IDL shell
2592 (idlwave-shell-pc-frame)
2593 ;; In source
2594 (list (idlwave-shell-file-name (buffer-file-name))
2595 (save-restriction
2596 (widen)
2597 (save-excursion
2598 (beginning-of-line)
2599 (1+ (count-lines 1 (point))))))))
2600
2601(defun idlwave-shell-current-module ()
2602 "Return the name of the module for the current file.
2603Returns nil if unable to obtain a module name."
2604 (if (eq (current-buffer) (get-buffer (idlwave-shell-buffer)))
2605 ;; In IDL shell
2606 (nth 2 idlwave-shell-halt-frame)
2607 ;; In pro file
2608 (save-restriction
2609 (widen)
2610 (save-excursion
2611 (if (idlwave-prev-index-position)
6a8cc02d
S
2612 (let* ((module (idlwave-what-module))
2613 (name (idlwave-make-full-name (nth 2 module) (car module)))
2614 (type (nth 1 module)))
2615 (list (upcase name) type)))))))
8c7b4ec8
EZ
2616
2617(defun idlwave-shell-clear-current-bp ()
2618 "Remove breakpoint at current line.
2619This command can be called from the shell buffer if IDL is currently stopped
2620at a breakpoint."
2621 (interactive)
52a244eb
S
2622 (let ((bp (idlwave-shell-find-current-bp)))
2623 (if bp (idlwave-shell-clear-bp bp))))
8c7b4ec8 2624
52a244eb
S
2625
2626(defun idlwave-shell-toggle-enable-current-bp (&optional bp force
2627 no-update)
6a8cc02d
S
2628 "Disable or enable current breakpoint or a breakpoint passed in BP.
2629If FORCE is 'disable or 'enable, for that condition instead of
2630toggling. If NO-UPDATE is non-nil, don't update the breakpoint
2631list after toggling."
52a244eb
S
2632 (interactive)
2633 (let* ((bp (or bp (idlwave-shell-find-current-bp)))
2634 (disabled (idlwave-shell-bp-get bp 'disabled)))
2635 (cond ((eq force 'disable) (setq disabled nil))
2636 ((eq force 'enable) (setq disabled t)))
2637 (when bp
2638 (setf (nth 3 (cdr (cdr bp))) (not disabled))
5cba7601 2639 (idlwave-shell-send-command
76959b77 2640 (concat "breakpoint,"
52a244eb
S
2641 (if disabled "/enable," "/disable,")
2642 (int-to-string (idlwave-shell-bp-get bp)))
2643 nil (idlwave-shell-hide-p 'breakpoint) nil t)
2644 (unless no-update (idlwave-shell-bp-query)))))
13ae1076 2645
52a244eb
S
2646(defun idlwave-shell-enable-all-bp (&optional enable no-update bpl)
2647 "Disable all breakpoints we know about which need disabling.
2648If ENABLE is non-nil, enable them instead."
2649 (let ((bpl (or bpl idlwave-shell-bp-alist)) disabled modified)
2650 (while bpl
2651 (setq disabled (idlwave-shell-bp-get (car bpl) 'disabled))
2652 (when (idlwave-xor (not disabled) (eq enable 'enable))
5cba7601 2653 (idlwave-shell-toggle-enable-current-bp
52a244eb
S
2654 (car bpl) (if (eq enable 'enable) 'enable 'disable) no-update)
2655 (push (car bpl) modified))
2656 (setq bpl (cdr bpl)))
2657 (unless no-update (idlwave-shell-bp-query))
2658 modified))
5cba7601 2659
8c7b4ec8
EZ
2660(defun idlwave-shell-to-here ()
2661 "Set a breakpoint with count 1 then continue."
2662 (interactive)
f66f03de 2663 ;; temporarily disable all other breakpoints
52a244eb 2664 (let ((disabled (idlwave-shell-enable-all-bp 'disable 'no-update)))
3938cb82 2665 (idlwave-shell-break-here 1 nil nil nil 'no-show)
52a244eb
S
2666 (idlwave-shell-cont 'no-show)
2667 (idlwave-shell-enable-all-bp 'enable 'no-update disabled))
2668 (idlwave-shell-redisplay)) ; sync up everything at the end
2669
2670(defun idlwave-shell-break-this-module (&optional arg)
2671 (interactive "P")
2672 (save-excursion
2673 (idlwave-beginning-of-subprogram)
2674 (idlwave-shell-break-here arg)))
8c7b4ec8 2675
52a244eb 2676(defun idlwave-shell-break-in ()
8c7b4ec8
EZ
2677 "Look for a module name near point and set a break point for it.
2678The command looks for an identifier near point and sets a breakpoint
52a244eb
S
2679for the first line of the corresponding module. If MODULE is `t', set
2680in the current routine."
8c7b4ec8 2681 (interactive)
6a8cc02d
S
2682 (let* ((module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
2683 (type (nth 1 module))
2684 (name (car module))
2685 (class (nth 2 module)))
3938cb82 2686 (if module
5cba7601 2687 (progn
569abf86 2688 (setq module (idlwave-make-full-name class name))
6a8cc02d
S
2689 (idlwave-shell-module-source-query module type)
2690 (idlwave-shell-set-bp-in-module name type class))
3938cb82
S
2691 (error "No identifier at point"))))
2692
8c7b4ec8 2693
6a8cc02d 2694(defun idlwave-shell-set-bp-in-module (name type class)
8c7b4ec8
EZ
2695 "Set breakpoint in module. Assumes that `idlwave-shell-sources-alist'
2696contains an entry for that module."
569abf86 2697 (let* ((module (idlwave-make-full-name class name))
5cba7601 2698 (source-file
569abf86
S
2699 (car-safe (cdr-safe
2700 (or
2701 (assoc (upcase module)
2702 idlwave-shell-sources-alist)
5cba7601 2703 (nth 3 (idlwave-best-rinfo-assoc name type class
569abf86
S
2704 (idlwave-routines)))))))
2705 buf)
8c7b4ec8
EZ
2706 (if (or (not source-file)
2707 (not (file-regular-p source-file))
2708 (not (setq buf
2709 (or (idlwave-get-buffer-visiting source-file)
2710 (find-file-noselect source-file)))))
2711 (progn
2712 (message "The source file for module %s is probably not compiled"
2713 module)
2714 (beep))
2715 (save-excursion
2716 (set-buffer buf)
2717 (save-excursion
2718 (goto-char (point-min))
2719 (let ((case-fold-search t))
5cba7601 2720 (if (re-search-forward
8c7b4ec8
EZ
2721 (concat "^[ \t]*\\(pro\\|function\\)[ \t]+"
2722 (downcase module)
2723 "[ \t\n,]") nil t)
2724 (progn
2725 (goto-char (match-beginning 1))
2726 (message "Setting breakpoint for module %s" module)
2727 (idlwave-shell-break-here))
2728 (message "Cannot find module %s in file %s" module source-file)
2729 (beep))))))))
2730
2731(defun idlwave-shell-up ()
2732 "Run to end of current block.
2733Sets a breakpoint with count 1 at end of block, then continues."
2734 (interactive)
2735 (if (idlwave-shell-pc-frame)
2736 (save-excursion
2737 (idlwave-shell-goto-frame)
2738 ;; find end of subprogram
2739 (let ((eos (save-excursion
2740 (idlwave-beginning-of-subprogram)
2741 (idlwave-forward-block)
2742 (point))))
2743 (idlwave-backward-up-block -1)
2744 ;; move beyond end block line - IDL will not break there.
2745 ;; That is, you can put a breakpoint there but when IDL does
2746 ;; break it will report that it is at the next line.
2747 (idlwave-next-statement)
2748 (idlwave-end-of-statement)
2749 ;; Make sure we are not beyond subprogram
2750 (if (< (point) eos)
2751 ;; okay
2752 ()
2753 ;; Move back inside subprogram
2754 (goto-char eos)
2755 (idlwave-previous-statement))
2756 (idlwave-shell-to-here)))))
2757
2758(defun idlwave-shell-out ()
2759 "Attempt to run until this procedure exits.
2760Runs to the last statement and then steps 1 statement. Use the .out command."
2761 (interactive)
5cba7601 2762 (idlwave-shell-send-command ".o" nil
52a244eb
S
2763 (if (idlwave-shell-hide-p 'debug) 'mostly)
2764 nil t))
2765
2766(defun idlwave-shell-goto-previous-bp ()
2767 "Move to the previous breakpoint in the buffer."
2768 (interactive)
2769 (idlwave-shell-move-to-bp -1))
2770(defun idlwave-shell-goto-next-bp ()
2771 "Move to the next breakpoint in the buffer."
2772 (interactive)
2773 (idlwave-shell-move-to-bp 1))
2774
2775(defun idlwave-shell-move-to-bp (dir)
2776 "Move to the next or previous breakpoint, depending on direction DIR."
2777 (let* ((frame (idlwave-shell-current-frame))
2778 (file (car frame))
2779 (orig-bp-line (nth 1 frame))
2780 (bp-alist idlwave-shell-bp-alist)
2781 (orig-func (if (> dir 0) '> '<))
2782 (closer-func (if (> dir 0) '< '>))
2783 bp got-bp bp-line cur-line)
2784 (while (setq bp (pop bp-alist))
2785 (when (string= file (car (car bp)))
2786 (setq got-bp 1)
2787 (setq cur-line (nth 1 (car bp)))
2788 (if (and
2789 (funcall orig-func cur-line orig-bp-line)
2790 (or (not bp-line) (funcall closer-func cur-line bp-line)))
2791 (setq bp-line cur-line))))
75036288 2792 (unless bp-line (error "No further breakpoints"))
5f68c1b7
GM
2793 (goto-char (point-min))
2794 (forward-line (1- bp-line))))
52a244eb
S
2795
2796;; Examine Commands ------------------------------------------------------
8c7b4ec8 2797
15e42531 2798(defun idlwave-shell-help-expression (arg)
8c7b4ec8 2799 "Print help on current expression. See `idlwave-shell-print'."
15e42531
CD
2800 (interactive "P")
2801 (idlwave-shell-print arg 'help))
8c7b4ec8 2802
5e72c6b2
S
2803(defmacro idlwave-shell-mouse-examine (help &optional ev)
2804 "Create a function for generic examination of expressions."
2805 `(lambda (event)
2806 "Expansion function for expression examination."
2807 (interactive "e")
f66f03de
S
2808 (let* ((drag-track (fboundp 'mouse-drag-track))
2809 (transient-mark-mode t)
2810 (zmacs-regions t)
5cba7601
GM
2811 (tracker (if (featurep 'xemacs)
2812 (if (fboundp
f66f03de
S
2813 'default-mouse-track-event-is-with-button)
2814 'idlwave-xemacs-hack-mouse-track
2815 'mouse-track)
2816 ;; Emacs 22 no longer completes the drag with
2817 ;; mouse-drag-region, without an additional
2818 ;; event. mouse-drag-track does so.
2819 (if drag-track 'mouse-drag-track 'mouse-drag-region))))
5e72c6b2 2820 (funcall tracker event)
52a244eb 2821 (idlwave-shell-print (if (idlwave-region-active-p) '(4) nil)
5e72c6b2
S
2822 ,help ,ev))))
2823
52a244eb
S
2824;;; Begin terrible hack section -- XEmacs tests for button2 explicitly
2825;;; on drag events, calling drag-n-drop code if detected. Ughhh...
2826(defun idlwave-default-mouse-track-event-is-with-button (event n)
2827 t)
2828
2829(defun idlwave-xemacs-hack-mouse-track (event)
f66f03de 2830 (if (featurep 'xemacs)
5cba7601 2831 (let ((oldfunc (symbol-function
f66f03de 2832 'default-mouse-track-event-is-with-button)))
c4ae5fdd
RS
2833 (unwind-protect
2834 (progn
5cba7601 2835 (fset 'default-mouse-track-event-is-with-button
c4ae5fdd
RS
2836 'idlwave-default-mouse-track-event-is-with-button)
2837 (mouse-track event))
2838 (fset 'default-mouse-track-event-is-with-button oldfunc)))))
52a244eb
S
2839;;; End terrible hack section
2840
8c7b4ec8 2841(defun idlwave-shell-mouse-print (event)
5e72c6b2 2842 "Print value of variable at the mouse position, with `help'"
8c7b4ec8 2843 (interactive "e")
5e72c6b2 2844 (funcall (idlwave-shell-mouse-examine nil) event))
8c7b4ec8
EZ
2845
2846(defun idlwave-shell-mouse-help (event)
5e72c6b2 2847 "Print value of variable at the mouse position, with `print'."
8c7b4ec8 2848 (interactive "e")
5e72c6b2
S
2849 (funcall (idlwave-shell-mouse-examine 'help) event))
2850
2851(defun idlwave-shell-examine-select (event)
2852 "Pop-up a list to select from for examining the expression"
2853 (interactive "e")
2854 (funcall (idlwave-shell-mouse-examine nil event) event))
2855
2856(defmacro idlwave-shell-examine (help)
2857 "Create a function for key-driven expression examination."
2858 `(lambda ()
2859 (interactive)
2860 (idlwave-shell-print nil ,help)))
2861
5e72c6b2 2862(defvar idlwave-shell-examine-label nil
52a244eb
S
2863 "Label to include with examine text if in a separate buffer.")
2864(defvar idlwave-shell-examine-completion-list nil)
5e72c6b2 2865
52a244eb 2866(defun idlwave-shell-print (arg &optional help ev complete-help-type)
5cba7601 2867 "Print current expression.
5e72c6b2
S
2868
2869With HELP non-nil, show help on expression. If HELP is a string,
2870the expression will be put in place of ___, e.g.:
2871
2872 print,size(___,/DIMENSIONS)
2873
52a244eb
S
2874HELP can also be a cons cell ( NAME . STRING ) in which case NAME will
2875be used to label the help print-out.
2876
5e72c6b2 2877Otherwise, print is called on the expression.
8c7b4ec8 2878
8c7b4ec8 2879An expression is an identifier plus 1 pair of matched parentheses
5e72c6b2
S
2880directly following the identifier - an array or function call.
2881Alternatively, an expression is the contents of any matched
2882parentheses when the open parenthesis is not directly preceded by an
8c7b4ec8
EZ
2883identifier. If point is at the beginning or within an expression
2884return the inner-most containing expression, otherwise, return the
15e42531
CD
2885preceding expression.
2886
52a244eb
S
2887With prefix arg, or if transient mode set and the region is defined,
2888use the current region as the expression.
5e72c6b2 2889
52a244eb 2890With double prefix arg ARG prompt for an expression.
5e72c6b2
S
2891
2892If EV is a valid event passed, pop-up a list from
52a244eb
S
2893idlw-shell-examine-alist from which to select the help command text.
2894If instead COMPLETE-HELP-TYPE is non-nil, choose from
2895idlw-shell-examine-alist via mini-buffer shortcut key."
15e42531 2896 (interactive "P")
f66f03de
S
2897
2898 ;; For speed: assume the helper routine hasn't been lost, e.g. with
2899 ;; .FULL_RESET_SESSION. We'll recover if necessary
2900 (unless idlwave-idlwave_routine_info-compiled
2901 (idlwave-shell-compile-helper-routines))
8c7b4ec8 2902 (save-excursion
5e72c6b2
S
2903 (let* ((process (get-buffer-process (current-buffer)))
2904 (process-mark (if process (process-mark process)))
5cba7601 2905 (stack-label
5e72c6b2
S
2906 (if (and (integerp idlwave-shell-calling-stack-index)
2907 (> idlwave-shell-calling-stack-index 0))
5cba7601
GM
2908 (format " [-%d:%s]"
2909 idlwave-shell-calling-stack-index
5e72c6b2 2910 idlwave-shell-calling-stack-routine)))
f66f03de 2911 expr beg end cmd)
5e72c6b2 2912 (cond
52a244eb
S
2913 ((equal arg '(16))
2914 (setq expr (read-string "Expression: ")))
2915 ((and (or arg (idlwave-region-active-p))
5e72c6b2
S
2916 (< (- (region-end) (region-beginning)) 2000))
2917 (setq beg (region-beginning)
2918 end (region-end)))
5e72c6b2 2919 (t
76959b77 2920 (idlwave-with-special-syntax
05a1abfc
CD
2921 ;; Move to beginning of current or previous expression
2922 (if (looking-at "\\<\\|(")
2923 ;; At beginning of expression, don't move backwards unless
2924 ;; this is at the end of an indentifier.
2925 (if (looking-at "\\>")
2926 (backward-sexp))
2927 (backward-sexp))
2928 (if (looking-at "\\>")
2929 ;; Move to beginning of identifier - must be an array or
2930 ;; function expression.
2931 (backward-sexp))
2932 ;; Move to end of expression
2933 (setq beg (point))
2934 (forward-sexp)
2935 (while (looking-at "\\>[[(]\\|\\.")
2936 ;; an array
2937 (forward-sexp))
5e72c6b2 2938 (setq end (point)))))
5cba7601 2939
5e72c6b2
S
2940 ;; Get expression, but first move the begin mark if a
2941 ;; process-mark is inside the region, to keep the overlay from
2942 ;; wandering in the Shell.
2943 (when (and beg end)
2944 (if (and process-mark (> process-mark beg) (< process-mark end))
2945 (setq beg (marker-position process-mark)))
2946 (setq expr (buffer-substring beg end)))
2947
2948 ;; Show the overlay(s) and attach any necessary hooks and filters
ca660d22 2949 (when (and beg end idlwave-shell-expression-overlay)
5cba7601 2950 (move-overlay idlwave-shell-expression-overlay beg end
ca660d22 2951 (current-buffer))
5cba7601 2952 (add-hook 'pre-command-hook
5e72c6b2 2953 'idlwave-shell-delete-expression-overlay))
5e72c6b2
S
2954 (add-hook 'pre-command-hook
2955 'idlwave-shell-delete-output-overlay)
5cba7601 2956
5e72c6b2
S
2957 ;; Remove empty or comment-only lines
2958 (while (string-match "\n[ \t]*\\(;.*\\)?\r*\n" expr)
2959 (setq expr (replace-match "\n" t t expr)))
2960 ;; Concatenate continuation lines
3938cb82 2961 (while (string-match "[ \t]*\\$[ \t]*\\(;.*\\)?\\(\n[ \t]*\\|$\\)" expr)
5e72c6b2
S
2962 (setq expr (replace-match "" t t expr)))
2963 ;; Remove final newline
2964 (if (string-match "\n[ \t\r]*\\'" expr)
2965 (setq expr (replace-match "" t t expr)))
5cba7601 2966
52a244eb
S
2967 (catch 'exit
2968 ;; Pop-up or complete on the examine selection list, if appropriate
2969 (if (or
2970 complete-help-type
2971 (and ev idlwave-shell-examine-alist)
2972 (consp help))
5cba7601 2973 (let ((help-cons
52a244eb 2974 (if (consp help) help
5cba7601 2975 (assoc
52a244eb
S
2976 ;; A cons from either a pop-up or mini-buffer completion
2977 (if complete-help-type
2978 (idlwave-one-key-select 'idlwave-shell-examine-alist
2979 "Examine with: " 1.5)
2980;; (idlwave-completing-read
5cba7601 2981;; "Examine with: "
52a244eb
S
2982;; idlwave-shell-examine-alist nil nil nil
2983;; 'idlwave-shell-examine-completion-list
2984;; "Print")
5cba7601
GM
2985 (idlwave-popup-select
2986 ev
2987 (mapcar 'car idlwave-shell-examine-alist)
52a244eb
S
2988 "Examine with"))
2989 idlwave-shell-examine-alist))))
2990 (setq help (cdr help-cons))
2991 (if (null help) (throw 'exit nil))
2992 (if idlwave-shell-separate-examine-output
5cba7601
GM
2993 (setq idlwave-shell-examine-label
2994 (concat
52a244eb
S
2995 (format "==>%s<==\n%s:" expr (car help-cons))
2996 stack-label "\n"))))
2997 ;; The regular help label (no popups, cons cells, etc.)
2998 (setq idlwave-shell-examine-label
2999 (concat
5cba7601 3000 (format "==>%s<==\n%s:" expr
52a244eb
S
3001 (cond ((null help) "print")
3002 ((stringp help) help)
3003 (t (symbol-name help))))
3004 stack-label "\n")))
3005
3006 ;; Send the command
3007 (if stack-label
3008 (setq expr (idlwave-retrieve-expression-from-level
3009 expr
3010 idlwave-shell-calling-stack-index)))
3011 (setq cmd (idlwave-shell-help-statement help expr))
3012 ;;(idlwave-shell-recenter-shell-window)
5cba7601
GM
3013 (idlwave-shell-send-command
3014 cmd
f66f03de 3015 'idlwave-shell-check-compiled-and-display
52a244eb 3016 (if idlwave-shell-separate-examine-output 'hide))))))
5e72c6b2
S
3017
3018(defvar idlwave-shell-examine-window-alist nil
3019 "Variable to hold the win/height pairs for all *Examine* windows.")
3020
ddd709d1
S
3021(defvar idlwave-shell-examine-map (make-sparse-keymap))
3022(define-key idlwave-shell-examine-map "q" 'idlwave-shell-examine-display-quit)
3023(define-key idlwave-shell-examine-map "c" 'idlwave-shell-examine-display-clear)
3024
f66f03de
S
3025
3026(defun idlwave-shell-check-compiled-and-display ()
3027 "Check examine output for warning about undefined procedure/function."
3028 (if (string-match "% Attempt to call undefined" idlwave-shell-command-output)
3029 (idlwave-shell-compile-helper-routines))
3030 (if idlwave-shell-separate-examine-output
3031 (idlwave-shell-examine-display)
3032 (idlwave-shell-examine-highlight)))
3033
5e72c6b2
S
3034(defun idlwave-shell-examine-display ()
3035 "View the examine command output in a separate buffer."
3036 (let (win cur-beg cur-end)
3037 (save-excursion
3038 (set-buffer (get-buffer-create "*Examine*"))
3039 (use-local-map idlwave-shell-examine-map)
3040 (setq buffer-read-only nil)
3041 (goto-char (point-max))
3042 (save-restriction
3043 (narrow-to-region (point) (point))
3044 (if (string-match "^% Syntax error." idlwave-shell-command-output)
3045 (insert "% Syntax error.\n")
3046 (insert idlwave-shell-command-output)
3047 ;; Just take the last bit between the prompts (if more than one).
3048 (let* ((end (or
3049 (re-search-backward idlwave-shell-prompt-pattern nil t)
3050 (point-max)))
5cba7601 3051 (beg (progn
5e72c6b2 3052 (goto-char
5cba7601 3053 (or (progn (if (re-search-backward
5e72c6b2
S
3054 idlwave-shell-prompt-pattern nil t)
3055 (match-end 0)))
3056 (point-min)))
3057 (re-search-forward "\n")))
3058 (str (buffer-substring beg end)))
3059 (delete-region (point-min) (point-max))
3060 (insert str)
3061 (if idlwave-shell-examine-label
3062 (progn (goto-char (point-min))
3063 (insert idlwave-shell-examine-label)
3064 (setq idlwave-shell-examine-label nil)))))
3065 (setq cur-beg (point-min)
3066 cur-end (point-max))
3067 (setq buffer-read-only t)
3068 (move-overlay idlwave-shell-output-overlay cur-beg cur-end
3069 (current-buffer))
5cba7601 3070
5e72c6b2
S
3071 ;; Look for the examine buffer in all windows. If one is
3072 ;; found in a frame all by itself, use that, otherwise, switch
3073 ;; to or create an examine window in this frame, and resize if
3074 ;; it's a newly created window
3075 (let* ((winlist (get-buffer-window-list "*Examine*" nil 'visible)))
5cba7601
GM
3076 (setq win (idlwave-display-buffer
3077 "*Examine*"
5e72c6b2
S
3078 nil
3079 (let ((list winlist) thiswin)
3080 (catch 'exit
3081 (save-selected-window
3082 (while (setq thiswin (pop list))
3083 (select-window thiswin)
5cba7601 3084 (if (one-window-p)
5e72c6b2
S
3085 (throw 'exit (window-frame thiswin)))))))))
3086 (set-window-start win (point-min)) ; Ensure the point is visible.
3087 (save-selected-window
3088 (select-window win)
3089 (let ((elt (assoc win idlwave-shell-examine-window-alist)))
3090 (when (and (not (one-window-p))
3091 (or (not (memq win winlist)) ;a newly created window
3092 (eq (window-height) (cdr elt))))
3093 ;; Autosize it.
3094 (enlarge-window (- (/ (frame-height) 2)
3095 (window-height)))
3096 (shrink-window-if-larger-than-buffer)
3097 ;; Clean the window list of dead windows
3098 (setq idlwave-shell-examine-window-alist
3099 (delq nil
3100 (mapcar (lambda (x) (if (window-live-p (car x)) x))
3101 idlwave-shell-examine-window-alist)))
3102 ;; And add the new value.
3103 (if (setq elt (assoc win idlwave-shell-examine-window-alist))
3104 (setcdr elt (window-height))
5cba7601 3105 (add-to-list 'idlwave-shell-examine-window-alist
5e72c6b2
S
3106 (cons win (window-height)))))))))
3107 ;; Recenter for maximum output, after widened
3108 (save-selected-window
3109 (select-window win)
3110 (goto-char (point-max))
3111 (skip-chars-backward "\n")
3112 (recenter -1)))))
3113
5e72c6b2
S
3114(defun idlwave-shell-examine-display-quit ()
3115 (interactive)
3116 (let ((win (selected-window)))
3117 (if (one-window-p)
3118 (delete-frame (window-frame win))
3119 (delete-window win))))
3120
3121(defun idlwave-shell-examine-display-clear ()
3122 (interactive)
5cba7601 3123 (save-excursion
5e72c6b2
S
3124 (let ((buf (get-buffer "*Examine*")))
3125 (when (bufferp buf)
3126 (set-buffer buf)
3127 (setq buffer-read-only nil)
3128 (erase-buffer)
3129 (setq buffer-read-only t)))))
ca660d22 3130
52a244eb 3131(defun idlwave-retrieve-expression-from-level (expr level)
ca660d22
CD
3132 "Return IDL command to print the expression EXPR from stack level LEVEL.
3133
52a244eb
S
3134It does not seem possible to evaluate an expression on a different
3135level than the current. Therefore, this function retrieves variables
3136by reference from other levels, and then includes that variable in
3137place of the chosen one.
3138
3139Since this function depends upon the undocumented IDL routine
3140routine_names, there is no guarantee that this will work with future
3141versions of IDL."
3142 (let ((fetch (- 0 level))
ca660d22 3143 (start 0)
3938cb82 3144 var fetch-start fetch-end pre post)
ca660d22 3145
52a244eb 3146 ;; FIXME: In the following we try to find the variables in expression
5e72c6b2
S
3147 ;; This is quite empirical - I don't know in what situations this will
3148 ;; break. We will look for identifiers and exclude cases where we
3149 ;; know it is not a variable. To distinguish array references from
3150 ;; function calls, we require that arrays use [] instead of ()
5cba7601 3151
5e72c6b2 3152 (while (string-match
52a244eb 3153 "\\(\\`\\|[^a-zA-Z0-9$_][ \t]*\\)\\([a-zA-Z][a-zA-Z0-9$_]*\\)\\([ \t]*[^a-zA-Z0-9$_]\\|\\'\\)" expr start)
5e72c6b2 3154 (setq var (match-string 2 expr)
3938cb82 3155 start (match-end 2)
5e72c6b2
S
3156 pre (substring expr 0 (match-beginning 2))
3157 post (substring expr (match-end 2)))
5cba7601 3158 (cond
3938cb82
S
3159 ((or
3160 ;; Exclude identifiers which are not variables
3161 (string-match ",[ \t$\n]*/\\'" pre) ;; a `/' KEYWORD
3162 (and (string-match "[,(][ \t\n]*\\'" pre)
3163 (string-match "\\`[ \t]*=" post)) ;; a `=' KEYWORD
3164 (string-match "\\`(" post) ;; a function
3165 (string-match "->[ \t]*\\'" pre) ;; a method
3166 (string-match "\\.\\'" pre))) ;; structure member
3167
3168 ;; Skip over strings
52a244eb 3169 ((and (string-match "\\([\"\']\\)[^\1]*$" pre)
5cba7601 3170 (string-match (concat "^[^" (match-string 1 pre) "]*"
3938cb82
S
3171 (match-string 1 pre)) post))
3172 (setq start (+ start (match-end 0))))
3173
5cba7601 3174
3938cb82 3175 ;; seems to be a variable - delimit its name
5cba7601 3176 (t
3938cb82
S
3177 (put-text-property start (- start (length var)) 'fetch t expr))))
3178
3179 (setq start 0)
3180 (while (setq fetch-start
3181 (next-single-property-change start 'fetch expr))
3182 (if (get-text-property start 'fetch expr) ; it's on in range
3183 (setq fetch-end fetch-start ;it's off in range
3184 fetch-start start)
3185 (setq fetch-end (next-single-property-change fetch-start 'fetch expr)))
3186 (unless fetch-end (setq fetch-end (length expr)))
3187 (remove-text-properties fetch-start fetch-end '(fetch) expr)
3188 (setq expr (concat (substring expr 0 fetch-start)
5cba7601 3189 (format "(routine_names('%s',fetch=%d))"
3938cb82
S
3190 (substring expr fetch-start fetch-end)
3191 fetch)
3192 (substring expr fetch-end)))
3193 (setq start fetch-end))
3194 (if (get-text-property 0 'fetch expr) ; Full expression, left over
3195 (setq expr (format "(routine_names('%s',fetch=%d))" expr fetch)))
52a244eb
S
3196 expr))
3197
8c7b4ec8 3198
5e72c6b2
S
3199(defun idlwave-shell-help-statement (help expr)
3200 "Construct a help statement for printing expression EXPR.
3201
3202HELP can be non-nil for `help,', nil for 'print,' or any string into which
3203to insert expression in place of the marker ___, e.g.: print,
3204size(___,/DIMENSIONS)"
3205 (cond
f66f03de 3206 ((null help)
5cba7601 3207 (concat "idlwave_print_safe, " expr ","
f66f03de 3208 (number-to-string idlwave-shell-max-print-length)))
5cba7601 3209 ((stringp help)
5e72c6b2
S
3210 (if (string-match "\\(^\\|[^_]\\)\\(___\\)\\([^_]\\|$\\)" help)
3211 (concat (substring help 0 (match-beginning 2))
3212 expr
3213 (substring help (match-end 2)))))
5cba7601 3214 (t
f66f03de 3215 (concat "help, " expr))))
5cba7601 3216
5e72c6b2
S
3217
3218(defun idlwave-shell-examine-highlight ()
3219 "Highlight the most recent IDL output."
3220 (let* ((buffer (get-buffer (idlwave-shell-buffer)))
3221 (process (get-buffer-process buffer))
3222 (process-mark (if process (process-mark process)))
3223 output-begin output-end)
5cba7601 3224 (save-excursion
5e72c6b2
S
3225 (set-buffer buffer)
3226 (goto-char process-mark)
3227 (beginning-of-line)
3228 (setq output-end (point))
3229 (re-search-backward idlwave-shell-prompt-pattern nil t)
3230 (beginning-of-line 2)
3231 (setq output-begin (point)))
5cba7601 3232
5e72c6b2
S
3233 ;; First make sure the shell window is visible
3234 (idlwave-display-buffer (idlwave-shell-buffer)
3235 nil (idlwave-shell-shell-frame))
3236 (if (and idlwave-shell-output-overlay process-mark)
5cba7601 3237 (move-overlay idlwave-shell-output-overlay
5e72c6b2
S
3238 output-begin output-end buffer))))
3239
3240(defun idlwave-shell-delete-output-overlay ()
52a244eb
S
3241 (unless (or (eq this-command 'idlwave-shell-mouse-nop)
3242 (eq this-command 'handle-switch-frame))
5e72c6b2
S
3243 (condition-case nil
3244 (if idlwave-shell-output-overlay
3245 (delete-overlay idlwave-shell-output-overlay))
3246 (error nil))
3247 (remove-hook 'pre-command-hook 'idlwave-shell-delete-output-overlay)))
5cba7601 3248
8c7b4ec8 3249(defun idlwave-shell-delete-expression-overlay ()
52a244eb
S
3250 (unless (or (eq this-command 'idlwave-shell-mouse-nop)
3251 (eq this-command 'handle-switch-frame))
5e72c6b2
S
3252 (condition-case nil
3253 (if idlwave-shell-expression-overlay
3254 (delete-overlay idlwave-shell-expression-overlay))
3255 (error nil))
3256 (remove-hook 'pre-command-hook 'idlwave-shell-delete-expression-overlay)))
8c7b4ec8
EZ
3257
3258(defvar idlwave-shell-bp-alist nil
3259 "Alist of breakpoints.
3260A breakpoint is a cons cell \(\(file line\) . \(\(index module\) data\)\)
3261
52a244eb 3262The car is the `frame' for the breakpoint:
8c7b4ec8
EZ
3263file - full path file name.
3264line - line number of breakpoint - integer.
3265
3266The first element of the cdr is a list of internal IDL data:
3267index - the index number of the breakpoint internal to IDL.
3268module - the module for breakpoint internal to IDL.
3269
3270Remaining elements of the cdr:
3271data - Data associated with the breakpoint by idlwave-shell currently
52a244eb 3272contains four items:
8c7b4ec8
EZ
3273
3274count - number of times to execute breakpoint. When count reaches 0
52a244eb
S
3275 the breakpoint is cleared and removed from the alist.
3276
5cba7601 3277command - command to execute when breakpoint is reached, either a
52a244eb
S
3278 lisp function to be called with `funcall' with no arguments or a
3279 list to be evaluated with `eval'.
3280
3281condition - any condition to apply to the breakpoint.
3282
3283disabled - whether the bp is disabled")
8c7b4ec8
EZ
3284
3285(defun idlwave-shell-run-region (beg end &optional n)
3286 "Compile and run the region using the IDL process.
3287Copies the region to a temporary file `idlwave-shell-temp-pro-file'
3288and issues the IDL .run command for the file. Because the
3289region is compiled and run as a main program there is no
3290problem with begin-end blocks extending over multiple
3291lines - which would be a problem if `idlwave-shell-evaluate-region'
3292was used. An END statement is appended to the region if necessary.
3293
3294If there is a prefix argument, display IDL process."
3295 (interactive "r\nP")
3296 (let ((oldbuf (current-buffer)))
3297 (save-excursion
3298 (set-buffer (idlwave-find-file-noselect
5e72c6b2
S
3299 (idlwave-shell-temp-file 'pro) 'tmp))
3300 (set (make-local-variable 'comment-start-skip) ";+[ \t]*")
3301 (set (make-local-variable 'comment-start) ";")
8c7b4ec8
EZ
3302 (erase-buffer)
3303 (insert-buffer-substring oldbuf beg end)
3304 (if (not (save-excursion
3305 (idlwave-previous-statement)
3306 (idlwave-look-at "\\<end\\>")))
3307 (insert "\nend\n"))
3308 (save-buffer 0)))
5cba7601 3309 (idlwave-shell-send-command (concat ".run \""
f66f03de 3310 idlwave-shell-temp-pro-file "\"")
5cba7601 3311 nil
52a244eb
S
3312 (if (idlwave-shell-hide-p 'run) 'mostly)
3313 nil t)
8c7b4ec8 3314 (if n
5cba7601 3315 (idlwave-display-buffer (idlwave-shell-buffer)
8c7b4ec8
EZ
3316 nil (idlwave-shell-shell-frame))))
3317
3318(defun idlwave-shell-evaluate-region (beg end &optional n)
3319 "Send region to the IDL process.
3320If there is a prefix argument, display IDL process.
3321Does not work for a region with multiline blocks - use
3322`idlwave-shell-run-region' for this."
3323 (interactive "r\nP")
3324 (idlwave-shell-send-command (buffer-substring beg end))
3325 (if n
5cba7601 3326 (idlwave-display-buffer (idlwave-shell-buffer)
8c7b4ec8
EZ
3327 nil (idlwave-shell-shell-frame))))
3328
15e42531
CD
3329(defun idlwave-shell-delete-temp-files ()
3330 "Delete the temporary files and kill associated buffers."
3331 (if (stringp idlwave-shell-temp-pro-file)
3332 (condition-case nil
3333 (let ((buf (idlwave-get-buffer-visiting
3334 idlwave-shell-temp-pro-file)))
3335 (if (buffer-live-p buf)
3336 (kill-buffer buf))
3337 (delete-file idlwave-shell-temp-pro-file))
3338 (error nil)))
3339 (if (stringp idlwave-shell-temp-rinfo-save-file)
3340 (condition-case nil
3341 (delete-file idlwave-shell-temp-rinfo-save-file)
3342 (error nil))))
3343
8c7b4ec8 3344(defun idlwave-display-buffer (buf not-this-window-p &optional frame)
76959b77
S
3345 (if (featurep 'xemacs)
3346 ;; The XEmacs version enforces the frame
3347 (display-buffer buf not-this-window-p frame)
3348 ;; For Emacs, we need to force the frame ourselves.
3349 (let ((this-frame (selected-frame)))
52a244eb
S
3350 (save-excursion ;; make sure we end up in the same buffer
3351 (if (frame-live-p frame)
3352 (select-frame frame))
3353 (if (eq this-frame (selected-frame))
3354 ;; same frame: use display buffer, to make sure the current
3355 ;; window stays.
3356 (display-buffer buf)
3357 ;; different frame
3358 (if (one-window-p)
3359 ;; only window: switch
3360 (progn
3361 (switch-to-buffer buf)
3362 (selected-window)) ; must return the window.
3363 ;; several windows - use display-buffer
3364 (display-buffer buf not-this-window-p)))))))
76959b77
S
3365; (if (not (frame-live-p frame)) (setq frame nil))
3366; (display-buffer buf not-this-window-p frame))
8c7b4ec8 3367
15e42531 3368(defvar idlwave-shell-bp-buffer " *idlwave-shell-bp*"
8c7b4ec8
EZ
3369 "Scratch buffer for parsing IDL breakpoint lists and other stuff.")
3370
52a244eb 3371(defun idlwave-shell-bp-query (&optional no-show)
8c7b4ec8
EZ
3372 "Reconcile idlwave-shell's breakpoint list with IDL's.
3373Queries IDL using the string in `idlwave-shell-bp-query'."
3374 (interactive)
3375 (idlwave-shell-send-command idlwave-shell-bp-query
52a244eb
S
3376 `(progn
3377 (idlwave-shell-filter-bp (quote ,no-show)))
8c7b4ec8
EZ
3378 'hide))
3379
3380(defun idlwave-shell-bp-get (bp &optional item)
6a8cc02d
S
3381 "Get a value for a breakpoint. BP has the form of elements in
3382idlwave-shell-bp-alist. Optional second arg ITEM is the
3383particular value to retrieve. ITEM can be 'file, 'line, 'index,
3384'module, 'count, 'cmd, 'condition, 'disabled, 'type, or
3385'data. 'data returns a list of 'count, 'cmd and 'condition.
3386Defaults to 'index."
8c7b4ec8
EZ
3387 (cond
3388 ;; Frame
3389 ((eq item 'line) (nth 1 (car bp)))
3390 ((eq item 'file) (nth 0 (car bp)))
3391 ;; idlwave-shell breakpoint data
3392 ((eq item 'data) (cdr (cdr bp)))
3393 ((eq item 'count) (nth 0 (cdr (cdr bp))))
3394 ((eq item 'cmd) (nth 1 (cdr (cdr bp))))
76959b77 3395 ((eq item 'condition) (nth 2 (cdr (cdr bp))))
52a244eb 3396 ((eq item 'disabled) (nth 3 (cdr (cdr bp))))
8c7b4ec8 3397 ;; IDL breakpoint info
5cba7601 3398 ((eq item 'module)
6a8cc02d
S
3399 (let ((module (nth 1 (car (cdr bp)))))
3400 (if (listp module) (car module) module)))
3401 ((eq item 'type)
3402 (let ((module (nth 1 (car (cdr bp)))))
3403 (if (listp module) (nth 1 module))))
8c7b4ec8
EZ
3404 ;; index - default
3405 (t (nth 0 (car (cdr bp))))))
3406
52a244eb
S
3407(defun idlwave-shell-filter-bp (&optional no-show)
3408 "Get the breakpoints from `idlwave-shell-command-output'. Create
3409`idlwave-shell-bp-alist' updating breakpoint count and command data
3410from previous breakpoint list. If NO-SHOW is set, don't update the
3411breakpoint overlays."
8c7b4ec8
EZ
3412 (save-excursion
3413 (set-buffer (get-buffer-create idlwave-shell-bp-buffer))
3414 (erase-buffer)
3415 (insert idlwave-shell-command-output)
3416 (goto-char (point-min))
15e42531 3417 (let ((old-bp-alist idlwave-shell-bp-alist)
5e72c6b2
S
3418 ;; Searching the breakpoints
3419 ;; In IDL 5.5, the breakpoint reporting format changed.
3420 (bp-re54 "^[ \t]*\\([0-9]+\\)[ \t]+\\(\\S-+\\)?[ \t]+\\([0-9]+\\)[ \t]+\\(\\S-+\\)")
5cba7601
GM
3421 (bp-re55
3422 (concat
52a244eb
S
3423 "^\\s-*\\([0-9]+\\)" ; 1 index
3424 "\\s-+\\([0-9]+\\)" ; 2 line number
3425 "\\s-+\\(Uncompiled\\|" ; 3-6 either uncompiled or routine name
3426 "\\(\\(Func=\\|Pro=\\)\\(\\$?[a-zA-Z][a-zA-Z0-9$_:]*\\$?\\)\\)\\)"
3427 "\\(\\s-*,\\s-*After=[0-9]+/\\([0-9]+\\)?\\)?" ; 7-8 After part
3428 "\\(\\s-*,\\s-*\\(BreakOnce\\)\\)?" ; 9-10 BreakOnce
3429 "\\(\\s-*,\\s-*\\(Condition='\\(.*\\)'\\)\n?\\)?" ; 11-13 Condition
3430 "\\(\\s-*,\\s-*\\(Disabled\\)\n?\\)?" ; 14-15 Disabled
3431 "\\s-+\\(\\S-+\\)")) ; 16 File name
13ae1076 3432 file line index module
52a244eb 3433 count condition disabled
5e72c6b2 3434 bp-re indmap)
8c7b4ec8 3435 (setq idlwave-shell-bp-alist (list nil))
5e72c6b2 3436 ;; Search for either header type, and set the correct regexp
5cba7601 3437 (when (or
5e72c6b2 3438 (if (re-search-forward "^\\s-*Index.*\n\\s-*-" nil t)
5cba7601 3439 (setq bp-re bp-re54 ; versions <= 5.4
52a244eb 3440 indmap '(1 2 3 4))) ;index module line file
5cba7601 3441 (if (re-search-forward
5e72c6b2
S
3442 "^\\s-*Index\\s-*Line\\s-*Attributes\\s-*File" nil t)
3443 (setq bp-re bp-re55 ; versions >= 5.5
52a244eb
S
3444 indmap '(1 6 2 16)))) ; index module line file
3445 ;; There seems to be a breakpoint listing here, parse breakpoint lines.
5e72c6b2 3446 (while (re-search-forward bp-re nil t)
027a4b6b 3447 (setq index (string-to-number (match-string (nth 0 indmap)))
5e72c6b2 3448 module (match-string (nth 1 indmap))
027a4b6b 3449 line (string-to-number (match-string (nth 2 indmap)))
5e72c6b2 3450 file (idlwave-shell-file-name (match-string (nth 3 indmap))))
52a244eb 3451 (if (eq bp-re bp-re55)
3d1ead4b 3452 (setq count (if (match-string 10) 1
52a244eb 3453 (if (match-string 8)
027a4b6b 3454 (string-to-number (match-string 8))))
52a244eb
S
3455 condition (match-string 13)
3456 disabled (not (null (match-string 15)))))
3d1ead4b 3457
15e42531
CD
3458 ;; Add the breakpoint info to the list
3459 (nconc idlwave-shell-bp-alist
3460 (list (cons (list file line)
3461 (list
3462 (list index module)
52a244eb
S
3463 ;; bp data: count, command, condition, disabled
3464 count nil condition disabled))))))
8c7b4ec8 3465 (setq idlwave-shell-bp-alist (cdr idlwave-shell-bp-alist))
52a244eb 3466 ;; Update breakpoint data
3d1ead4b
GM
3467 (if (eq bp-re bp-re54)
3468 (mapc 'idlwave-shell-update-bp old-bp-alist)
3469 (mapc 'idlwave-shell-update-bp-command-only old-bp-alist))))
8c7b4ec8 3470 ;; Update the breakpoint overlays
52a244eb 3471 (unless no-show (idlwave-shell-update-bp-overlays))
8c7b4ec8
EZ
3472 ;; Return the new list
3473 idlwave-shell-bp-alist)
3474
52a244eb
S
3475(defun idlwave-shell-update-bp-command-only (bp)
3476 (idlwave-shell-update-bp bp t))
3477
3478(defun idlwave-shell-update-bp (bp &optional command-only)
8c7b4ec8
EZ
3479 "Update BP data in breakpoint list.
3480If BP frame is in `idlwave-shell-bp-alist' updates the breakpoint data."
3481 (let ((match (assoc (car bp) idlwave-shell-bp-alist)))
5cba7601
GM
3482 (if match
3483 (if command-only
52a244eb
S
3484 (setf (nth 1 (cdr (cdr match))) (nth 1 (cdr (cdr match))))
3485 (setcdr (cdr match) (cdr (cdr bp)))))))
8c7b4ec8
EZ
3486
3487(defun idlwave-shell-set-bp-data (bp data)
3488 "Set the data of BP to DATA."
3489 (setcdr (cdr bp) data))
3490
3491(defun idlwave-shell-bp (frame &optional data module)
3492 "Create a breakpoint structure containing FRAME and DATA. Second
3493and third args, DATA and MODULE, are optional. Returns a breakpoint
3494of the format used in `idlwave-shell-bp-alist'. Can be used in commands
3495attempting match a breakpoint in `idlwave-shell-bp-alist'."
6a8cc02d
S
3496 (cons frame ;; (file line)
3497 (cons (list nil module) ;; (index_id (module type) | module)
3498 data))) ;; (count command condition disabled)
8c7b4ec8
EZ
3499
3500(defvar idlwave-shell-old-bp nil
3501 "List of breakpoints previous to setting a new breakpoint.")
3502
3503(defun idlwave-shell-sources-bp (bp)
3504 "Check `idlwave-shell-sources-alist' for source of breakpoint using BP.
3505If an equivalency is found, return the IDL internal source name.
3506Otherwise return the filename in bp."
3507 (let*
3508 ((bp-file (idlwave-shell-bp-get bp 'file))
3509 (bp-module (idlwave-shell-bp-get bp 'module))
5cba7601 3510 (internal-file-list
3938cb82
S
3511 (if bp-module
3512 (cdr (assoc bp-module idlwave-shell-sources-alist)))))
8c7b4ec8
EZ
3513 (if (and internal-file-list
3514 (equal bp-file (nth 0 internal-file-list)))
3515 (nth 1 internal-file-list)
3516 bp-file)))
3517
52a244eb 3518(defun idlwave-shell-set-bp (bp &optional no-show)
5cba7601 3519 "Try to set a breakpoint BP.
8c7b4ec8
EZ
3520The breakpoint will be placed at the beginning of the statement on the
3521line specified by BP or at the next IDL statement if that line is not
52a244eb 3522a statement. Determines IDL's internal representation for the
ddd709d1 3523breakpoint, which may have occurred at a different line than
52a244eb 3524specified. If NO-SHOW is non-nil, don't do any updating."
8c7b4ec8 3525 ;; Get and save the old breakpoints
5cba7601 3526 (idlwave-shell-send-command
8c7b4ec8 3527 idlwave-shell-bp-query
52a244eb
S
3528 `(progn
3529 (idlwave-shell-filter-bp (quote ,no-show))
3530 (setq idlwave-shell-old-bp idlwave-shell-bp-alist))
8c7b4ec8 3531 'hide)
8c7b4ec8 3532
3938cb82 3533 ;; Get sources for this routine in the sources list
6a8cc02d
S
3534 (idlwave-shell-module-source-query (idlwave-shell-bp-get bp 'module)
3535 (idlwave-shell-bp-get bp 'type))
8c7b4ec8 3536 (let*
fbc232f4 3537 ((count (idlwave-shell-bp-get bp 'count))
76959b77 3538 (condition (idlwave-shell-bp-get bp 'condition))
3938cb82 3539 (disabled (idlwave-shell-bp-get bp 'disabled))
fbc232f4
S
3540 (key (concat (if (and count (numberp count))
3541 (cond
3542 ((= count 1) ",/once")
3543 ((> count 1) (format ",after=%d" count))))
3544 (if condition (concat ",CONDITION=\"" condition "\""))
3545 ;; IDL can't simultaneously set a condition/count
3546 ;; and disable a breakpoint, but it does keep both
3547 ;; of these when resetting the same BP. We assume
3548 ;; DISABLE and CONDITION/COUNT are not set
3549 ;; together for a newly created breakpoint.
3550 (if (and disabled (not condition) (not count))
3551 ",/DISABLE")))
8c7b4ec8
EZ
3552 (line (idlwave-shell-bp-get bp 'line)))
3553 (idlwave-shell-send-command
5cba7601 3554 (concat "breakpoint,'"
8c7b4ec8
EZ
3555 (idlwave-shell-sources-bp bp) "',"
3556 (if (integerp line) (setq line (int-to-string line)))
3557 key)
3938cb82 3558 ;; Check for failure and adjust breakpoint to match IDL's list
8a946354 3559 `(progn
52a244eb 3560 (if (idlwave-shell-set-bp-check (quote ,bp))
3938cb82 3561 (idlwave-shell-set-bp-adjust (quote ,bp) (quote ,no-show))))
76959b77
S
3562 ;; hide output?
3563 (idlwave-shell-hide-p 'breakpoint)
52a244eb 3564 'preempt t)))
8c7b4ec8 3565
3938cb82 3566(defun idlwave-shell-set-bp-adjust (bp &optional no-show)
8c7b4ec8 3567 "Find the breakpoint in IDL's internal list of breakpoints."
5cba7601 3568 (idlwave-shell-send-command
3938cb82
S
3569 idlwave-shell-bp-query
3570 `(progn
3571 (idlwave-shell-filter-bp 'no-show)
3572 (idlwave-shell-new-bp (quote ,bp))
3573 (unless (quote ,no-show)
3574 (idlwave-shell-update-bp-overlays)))
3575 'hide
3576 'preempt))
8c7b4ec8
EZ
3577
3578(defun idlwave-shell-find-bp (frame)
3579 "Return breakpoint from `idlwave-shell-bp-alist' for frame.
3580Returns nil if frame not found."
3581 (assoc frame idlwave-shell-bp-alist))
3582
52a244eb
S
3583(defun idlwave-shell-find-current-bp ()
3584 "Find breakpoint here, or at halt location."
3585 (let ((bp (idlwave-shell-find-bp (idlwave-shell-current-frame))))
3586 (when (not bp)
3587 ;; Try moving to beginning of halted-at statement
3588 (save-excursion
3589 (idlwave-shell-goto-frame)
3590 (idlwave-beginning-of-statement)
3591 (setq bp (idlwave-shell-find-bp (idlwave-shell-current-frame))))
3592 (unless bp
3593 (beep)
3594 (message "Cannot identify breakpoint for this line")))
3595 bp))
3596
8c7b4ec8
EZ
3597(defun idlwave-shell-new-bp (bp)
3598 "Find the new breakpoint in IDL's list and update with DATA.
3599The actual line number for a breakpoint in IDL may be different than
3600the line number used with the IDL breakpoint command.
3601Looks for a new breakpoint index number in the list. This is
3602considered the new breakpoint if the file name of frame matches."
3603 (let ((obp-index (mapcar 'idlwave-shell-bp-get idlwave-shell-old-bp))
3604 (bpl idlwave-shell-bp-alist))
3605 (while (and (member (idlwave-shell-bp-get (car bpl)) obp-index)
3606 (setq bpl (cdr bpl))))
3607 (if (and
3608 (not bpl)
3609 ;; No additional breakpoint.
3610 ;; Need to check if we are just replacing a breakpoint.
3611 (setq bpl (assoc (car bp) idlwave-shell-bp-alist)))
3612 (setq bpl (list bpl)))
3613 (if (and bpl
3614 (equal (idlwave-shell-bp-get (setq bpl (car bpl)) 'file)
3615 (idlwave-shell-bp-get bp 'file)))
3616 ;; Got the breakpoint - add count, command to it.
3617 ;; This updates `idlwave-shell-bp-alist' because a deep copy was
3618 ;; not done for bpl.
3619 (idlwave-shell-set-bp-data bpl (idlwave-shell-bp-get bp 'data))
3620 (beep)
3621 (message "Failed to identify breakpoint in IDL"))))
3622
3623(defvar idlwave-shell-bp-overlays nil
52a244eb 3624 "Alist of overlays marking breakpoints")
25d24a50 3625(defvar idlwave-shell-bp-glyph)
8c7b4ec8 3626
3938cb82 3627(defvar idlwave-shell-debug-line-map (make-sparse-keymap))
5cba7601 3628(define-key idlwave-shell-debug-line-map
3938cb82
S
3629 (if (featurep 'xemacs) [button3] [mouse-3])
3630 'idlwave-shell-mouse-active-bp)
3631
8c7b4ec8
EZ
3632(defun idlwave-shell-update-bp-overlays ()
3633 "Update the overlays which mark breakpoints in the source code.
3634Existing overlays are recycled, in order to minimize consumption."
8c7b4ec8 3635 (when idlwave-shell-mark-breakpoints
52a244eb
S
3636 (let ((ov-alist (copy-alist idlwave-shell-bp-overlays))
3637 (bp-list idlwave-shell-bp-alist)
3638 (use-glyph (and (memq idlwave-shell-mark-breakpoints '(t glyph))
3639 idlwave-shell-bp-glyph))
3640 ov ov-list bp buf old-buffers win)
3641
8c7b4ec8 3642 ;; Delete the old overlays from their buffers
5cba7601 3643 (if ov-alist
52a244eb
S
3644 (while (setq ov-list (pop ov-alist))
3645 (while (setq ov (pop (cdr ov-list)))
3646 (add-to-list 'old-buffers (overlay-buffer ov))
3647 (delete-overlay ov))))
5cba7601 3648
52a244eb 3649 (setq ov-alist idlwave-shell-bp-overlays
5cba7601 3650 idlwave-shell-bp-overlays
52a244eb
S
3651 (if idlwave-shell-bp-glyph
3652 (mapcar 'list (mapcar 'car idlwave-shell-bp-glyph))
3653 (list (list 'bp))))
8c7b4ec8
EZ
3654 (while (setq bp (pop bp-list))
3655 (save-excursion
3656 (idlwave-shell-goto-frame (car bp))
3657 (let* ((end (progn (end-of-line 1) (point)))
3658 (beg (progn (beginning-of-line 1) (point)))
52a244eb
S
3659 (condition (idlwave-shell-bp-get bp 'condition))
3660 (count (idlwave-shell-bp-get bp 'count))
3661 (disabled (idlwave-shell-bp-get bp 'disabled))
3662 (type (if idlwave-shell-bp-glyph
3663 (cond
3664 (condition 'bp-cond )
3665 (count
3666 (cond
3667 ((<= count 0) 'bp)
3668 ((<= count 4)
3669 (intern
3670 (concat "bp-" (number-to-string count))))
3671 (t 'bp-n)))
3672 (t 'bp))
3673 'bp))
5cba7601 3674 (help-list
52a244eb
S
3675 (delq nil
3676 (list
3677 (if count
3938cb82 3678 (concat "after:" (int-to-string count)))
52a244eb 3679 (if condition
3938cb82 3680 (concat "condition:" condition))
52a244eb 3681 (if disabled "disabled"))))
5cba7601
GM
3682 (help-text (concat
3683 "BP "
3938cb82 3684 (int-to-string (idlwave-shell-bp-get bp))
5cba7601
GM
3685 (if help-list
3686 (concat
3687 " - "
3938cb82
S
3688 (mapconcat 'identity help-list ", ")))
3689 (if (and (not count) (not condition))
3690 " (use mouse-3 for breakpoint actions)")))
52a244eb
S
3691 (full-type (if disabled
3692 (intern (concat (symbol-name type)
3693 "-disabled"))
3694 type))
3695 (ov-existing (assq full-type ov-alist))
3696 (ov (or (and (cdr ov-existing)
3697 (pop (cdr ov-existing)))
3938cb82 3698 (idlwave-shell-make-new-bp-overlay type disabled)))
52a244eb 3699 match)
3938cb82
S
3700 (if idlwave-shell-breakpoint-popup-menu
3701 (overlay-put ov 'help-echo help-text))
8c7b4ec8 3702 (move-overlay ov beg end)
52a244eb
S
3703 (if (setq match (assq full-type idlwave-shell-bp-overlays))
3704 (push ov (cdr match))
3705 (nconc idlwave-shell-bp-overlays
3706 (list (list full-type ov)))))
3707 ;; Take care of margins if using a glyph
3708 (when use-glyph
5cba7601 3709 (if old-buffers
52a244eb
S
3710 (setq old-buffers (delq (current-buffer) old-buffers)))
3711 (if (fboundp 'set-specifier) ;; XEmacs
3712 (set-specifier left-margin-width (cons (current-buffer) 2))
815c75b5
S
3713 (if (< left-margin-width 2)
3714 (setq left-margin-width 2)))
3715 (let ((window (get-buffer-window (current-buffer) 0)))
3716 (if window
5cba7601 3717 (set-window-margins
815c75b5 3718 window left-margin-width right-margin-width))))))
52a244eb
S
3719 (if use-glyph
3720 (while (setq buf (pop old-buffers))
3721 (with-current-buffer buf
3722 (if (fboundp 'set-specifier) ;; XEmacs
3723 (set-specifier left-margin-width (cons (current-buffer) 0))
3724 (setq left-margin-width 0))
815c75b5
S
3725 (let ((window (get-buffer-window buf 0)))
3726 (if window
5cba7601 3727 (set-window-margins
815c75b5 3728 window left-margin-width right-margin-width)))))))))
52a244eb 3729
3938cb82 3730(defun idlwave-shell-make-new-bp-overlay (&optional type disabled)
5cba7601 3731 "Make a new overlay for highlighting breakpoints.
52a244eb
S
3732
3733This stuff is strongly dependant upon the version of Emacs. If TYPE
3734is passed, make an overlay of that type ('bp or 'bp-cond, currently
3938cb82 3735only for glyphs)."
52a244eb
S
3736 (let ((ov (make-overlay 1 1))
3737 (use-glyph (and (memq idlwave-shell-mark-breakpoints '(t glyph))
3738 idlwave-shell-bp-glyph))
3739 (type (or type 'bp))
5cba7601 3740 (face (if disabled
52a244eb
S
3741 idlwave-shell-disabled-breakpoint-face
3742 idlwave-shell-breakpoint-face)))
8c7b4ec8
EZ
3743 (if (featurep 'xemacs)
3744 ;; This is XEmacs
3745 (progn
3938cb82
S
3746 (when idlwave-shell-breakpoint-popup-menu
3747 (set-extent-property ov 'mouse-face 'highlight)
3748 (set-extent-property ov 'keymap idlwave-shell-debug-line-map))
3749
5cba7601 3750 (cond
52a244eb 3751 ;; tty's cannot display glyphs
8c7b4ec8 3752 ((eq (console-type) 'tty)
52a244eb 3753 (set-extent-property ov 'face face))
5cba7601 3754
52a244eb
S
3755 ;; use the glyph
3756 (use-glyph
3757 (let ((glyph (cdr (assq type idlwave-shell-bp-glyph))))
3758 (if disabled (setq glyph (car glyph)) (setq glyph (nth 1 glyph)))
3759 (set-extent-property ov 'begin-glyph glyph)
3760 (set-extent-property ov 'begin-glyph-layout 'outside-margin)))
3761
3762 ;; use the face
8c7b4ec8 3763 (idlwave-shell-mark-breakpoints
52a244eb
S
3764 (set-extent-property ov 'face face))
3765
3766 ;; no marking
3767 (t nil))
8c7b4ec8
EZ
3768 (set-extent-priority ov -1)) ; make stop line face prevail
3769 ;; This is Emacs
3938cb82
S
3770 (when idlwave-shell-breakpoint-popup-menu
3771 (overlay-put ov 'mouse-face 'highlight)
3772 (overlay-put ov 'keymap idlwave-shell-debug-line-map))
8c7b4ec8
EZ
3773 (cond
3774 (window-system
52a244eb
S
3775 (if use-glyph
3776 (let ((image-props (cdr (assq type idlwave-shell-bp-glyph)))
3777 string)
5cba7601 3778
52a244eb 3779 (if disabled (setq image-props
5cba7601 3780 (append image-props
52a244eb 3781 (list :conversion 'disabled))))
5cba7601
GM
3782 (setq string
3783 (propertize "@"
3784 'display
52a244eb 3785 (list (list 'margin 'left-margin)
3938cb82 3786 image-props)))
8c7b4ec8 3787 (overlay-put ov 'before-string string))
52a244eb
S
3788 ;; just the face
3789 (overlay-put ov 'face face)))
3790
3791 ;; use a face
8c7b4ec8 3792 (idlwave-shell-mark-breakpoints
52a244eb
S
3793 (overlay-put ov 'face face))
3794
3795 ;; No marking
3796 (t nil)))
8c7b4ec8
EZ
3797 ov))
3798
3938cb82
S
3799(defun idlwave-shell-mouse-active-bp (ev)
3800 "Does right-click mouse action on breakpoint lines."
3801 (interactive "e")
3802 (if ev (mouse-set-point ev))
3803 (let ((bp (idlwave-shell-find-bp (idlwave-shell-current-frame)))
3804 index condition count select cmd disabled)
3805 (unless bp
3806 (error "Breakpoint not found"))
3807 (setq index (int-to-string (idlwave-shell-bp-get bp))
3808 condition (idlwave-shell-bp-get bp 'condition)
3809 cmd (idlwave-shell-bp-get bp 'cmd)
3810 count (idlwave-shell-bp-get bp 'count)
3811 disabled (idlwave-shell-bp-get bp 'disabled))
5cba7601
GM
3812 (setq select (idlwave-popup-select
3813 ev
3814 (delq nil
3938cb82
S
3815 (list (if disabled "Enable" "Disable")
3816 "Clear"
3817 "Clear All"
3818 (if condition "Remove Condition" "Add Condition")
3819 (if condition "Change Condition")
5cba7601 3820 (if count "Remove Repeat Count"
3938cb82
S
3821 "Add Repeat Count")
3822 (if count "Change Repeat Count")))
3823 (concat "BreakPoint " index)))
5cba7601
GM
3824 (if select
3825 (cond
3938cb82
S
3826 ((string-equal select "Clear All")
3827 (idlwave-shell-clear-all-bp))
3828 ((string-equal select "Clear")
3829 (idlwave-shell-clear-current-bp))
3830 ((string-match "Condition" select)
5cba7601 3831 (idlwave-shell-break-here count cmd
3938cb82
S
3832 (if (or (not condition)
3833 (string-match "Change" select))
3834 (read-string "Break Condition: "))
3835 disabled))
3836 ((string-match "Count" select)
3837 (idlwave-shell-break-here (if (or (not count)
3838 (string-match "Change" select))
3839 (string-to-number
3840 (read-string "Break After Count: ")))
3841 cmd condition disabled))
3842 ((string-match "able$" select)
3843 (idlwave-shell-toggle-enable-current-bp))
5cba7601 3844 (t
3938cb82 3845 (message "Unimplemented: %s" select))))))
5cba7601 3846
8c7b4ec8
EZ
3847(defun idlwave-shell-edit-default-command-line (arg)
3848 "Edit the current execute command."
3849 (interactive "P")
3850 (setq idlwave-shell-command-line-to-execute
3851 (read-string "IDL> " idlwave-shell-command-line-to-execute)))
3852
3853(defun idlwave-shell-execute-default-command-line (arg)
3854 "Execute a command line. On first use, ask for the command.
52a244eb 3855Also with prefix arg, ask for the command. You can also use the command
8c7b4ec8
EZ
3856`idlwave-shell-edit-default-command-line' to edit the line."
3857 (interactive "P")
5cba7601 3858 (cond
52a244eb
S
3859 ((equal arg '(16))
3860 (setq idlwave-shell-command-line-to-execute nil))
3861 ((equal arg '(4))
5cba7601 3862 (setq idlwave-shell-command-line-to-execute
52a244eb 3863 (read-string "IDL> " idlwave-shell-command-line-to-execute))))
ca660d22 3864 (idlwave-shell-reset 'hidden)
5cba7601 3865 (idlwave-shell-send-command
52a244eb
S
3866 (or idlwave-shell-command-line-to-execute
3867 (with-current-buffer (idlwave-shell-buffer)
3868 (ring-ref comint-input-ring 0)))
3869 '(idlwave-shell-redisplay 'hide)))
8c7b4ec8
EZ
3870
3871(defun idlwave-shell-save-and-run ()
3872 "Save file and run it in IDL.
3873Runs `save-buffer' and sends a '.RUN' command for the associated file to IDL.
3874When called from the shell buffer, re-run the file which was last handled by
5cba7601 3875one of the save-and-.. commands."
8c7b4ec8
EZ
3876 (interactive)
3877 (idlwave-shell-save-and-action 'run))
3878
3879(defun idlwave-shell-save-and-compile ()
3880 "Save file and run it in IDL.
3881Runs `save-buffer' and sends '.COMPILE' command for the associated file to IDL.
3882When called from the shell buffer, re-compile the file which was last handled by
3883one of the save-and-.. commands."
3884 (interactive)
3885 (idlwave-shell-save-and-action 'compile))
3886
3887(defun idlwave-shell-save-and-batch ()
3888 "Save file and batch it in IDL.
3889Runs `save-buffer' and sends a '@file' command for the associated file to IDL.
3890When called from the shell buffer, re-batch the file which was last handled by
5cba7601 3891one of the save-and-.. commands."
8c7b4ec8
EZ
3892 (interactive)
3893 (idlwave-shell-save-and-action 'batch))
3894
3895(defun idlwave-shell-save-and-action (action)
3896 "Save file and compile it in IDL.
3897Runs `save-buffer' and sends a '.RUN' command for the associated file to IDL.
3898When called from the shell buffer, re-compile the file which was last
3899handled by this command."
3900 ;; Remove the stop overlay.
3901 (if idlwave-shell-stop-line-overlay
3902 (delete-overlay idlwave-shell-stop-line-overlay))
52a244eb
S
3903 (if idlwave-shell-is-stopped
3904 (idlwave-shell-electric-debug-all-off))
15e42531 3905 (setq idlwave-shell-is-stopped nil)
8c7b4ec8
EZ
3906 (setq overlay-arrow-string nil)
3907 (let (buf)
3908 (cond
3909 ((eq major-mode 'idlwave-mode)
3910 (save-buffer)
3911 (setq idlwave-shell-last-save-and-action-file (buffer-file-name)))
3912 (idlwave-shell-last-save-and-action-file
3913 (if (setq buf (idlwave-get-buffer-visiting
3914 idlwave-shell-last-save-and-action-file))
3915 (save-excursion
3916 (set-buffer buf)
3917 (save-buffer))))
3918 (t (setq idlwave-shell-last-save-and-action-file
3919 (read-file-name "File: ")))))
3920 (if (file-regular-p idlwave-shell-last-save-and-action-file)
3921 (progn
3922 (idlwave-shell-send-command
3923 (concat (cond ((eq action 'run) ".run ")
3924 ((eq action 'compile) ".compile ")
3925 ((eq action 'batch) "@")
3926 (t (error "Unknown action %s" action)))
f66f03de
S
3927 "\""
3928 idlwave-shell-last-save-and-action-file
3929 "\"")
3930 `(idlwave-shell-maybe-update-routine-info nil
3931 ,idlwave-shell-last-save-and-action-file)
52a244eb 3932 (if (idlwave-shell-hide-p 'run) 'mostly) nil t)
8c7b4ec8 3933 (idlwave-shell-bp-query))
5cba7601 3934 (let ((msg (format "No such file %s"
8c7b4ec8
EZ
3935 idlwave-shell-last-save-and-action-file)))
3936 (setq idlwave-shell-last-save-and-action-file nil)
3937 (error msg))))
3938
f66f03de 3939(defun idlwave-shell-maybe-update-routine-info (&optional wait file)
15e42531
CD
3940 "Update the routine info if the shell is not stopped at an error."
3941 (if (and (not idlwave-shell-is-stopped)
3942 (or (eq t idlwave-auto-routine-info-updates)
3943 (memq 'compile-buffer idlwave-auto-routine-info-updates))
3944 idlwave-query-shell-for-routine-info
3945 idlwave-routines)
f66f03de 3946 (idlwave-shell-update-routine-info t nil wait file)))
15e42531 3947
5e72c6b2 3948(defvar idlwave-shell-sources-query "help,/source,/full"
8c7b4ec8
EZ
3949 "IDL command to obtain source files for compiled procedures.")
3950
3951(defvar idlwave-shell-sources-alist nil
3952 "Alist of IDL procedure names and compiled source files.
3953Elements of the alist have the form:
3954
3955 (module name . (source-file-truename idlwave-internal-filename)).")
3956
6a8cc02d
S
3957(defun idlwave-shell-module-source-query (module &optional type)
3958 "Determine the source file for a given module.
3959Query as a function if TYPE set to something beside 'pro."
3938cb82 3960 (if module
5cba7601 3961 (idlwave-shell-send-command
6a8cc02d
S
3962 (format "print,(routine_info('%s',/SOURCE%s)).PATH" module
3963 (if (eq type 'pro) "" ",/FUNCTIONS"))
3938cb82 3964 `(idlwave-shell-module-source-filter ,module)
6a8cc02d 3965 'hide 'wait)))
3938cb82
S
3966
3967(defun idlwave-shell-module-source-filter (module)
3968 "Get module source, and update idlwave-shell-sources-alist."
3969 (let ((old (assoc (upcase module) idlwave-shell-sources-alist))
3970 filename)
6a8cc02d
S
3971 (when (string-match "\.PATH *[\n\r]\\([^%][^\r\n]+\\)[\n\r]"
3972 idlwave-shell-command-output)
5cba7601 3973 (setq filename (substring idlwave-shell-command-output
6a8cc02d
S
3974 (match-beginning 1) (match-end 1)))
3975 (if old
3976 (setcdr old (list (idlwave-shell-file-name filename) filename))
3977 (setq idlwave-shell-sources-alist
5cba7601 3978 (append idlwave-shell-sources-alist
6a8cc02d 3979 (list (cons (upcase module)
5cba7601 3980 (list (idlwave-shell-file-name filename)
6a8cc02d 3981 filename)))))))))
5cba7601 3982
8c7b4ec8 3983(defun idlwave-shell-sources-query ()
3938cb82 3984 "Determine source files for all IDL compiled procedures.
8c7b4ec8 3985Queries IDL using the string in `idlwave-shell-sources-query'."
3938cb82 3986 (interactive)
8c7b4ec8
EZ
3987 (idlwave-shell-send-command idlwave-shell-sources-query
3988 'idlwave-shell-sources-filter
3989 'hide))
3990
3991(defun idlwave-shell-sources-filter ()
3992 "Get source files from `idlwave-shell-sources-query' output.
5cba7601 3993Create `idlwave-shell-sources-alist' consisting of
8c7b4ec8
EZ
3994list elements of the form:
3995 (module name . (source-file-truename idlwave-internal-filename))."
3996 (save-excursion
3997 (set-buffer (get-buffer-create idlwave-shell-bp-buffer))
3998 (erase-buffer)
3999 (insert idlwave-shell-command-output)
4000 (goto-char (point-min))
4001 (let (cpro cfun)
4002 (if (re-search-forward "Compiled Procedures:" nil t)
4003 (progn
4004 (forward-line) ; Skip $MAIN$
4005 (setq cpro (point))))
4006 (if (re-search-forward "Compiled Functions:" nil t)
4007 (progn
4008 (setq cfun (point))
4009 (setq idlwave-shell-sources-alist
4010 (append
4011 ;; compiled procedures
4012 (progn
4013 (beginning-of-line)
4014 (narrow-to-region cpro (point))
4015 (goto-char (point-min))
4016 (idlwave-shell-sources-grep))
4017 ;; compiled functions
4018 (progn
4019 (widen)
4020 (goto-char cfun)
4021 (idlwave-shell-sources-grep)))))))))
4022
4023(defun idlwave-shell-sources-grep ()
4024 (save-excursion
4025 (let ((al (list nil)))
4026 (while (and
4027 (not (progn (forward-line) (eobp)))
4028 (re-search-forward
4029 "\\s-*\\(\\S-+\\)\\s-+\\(\\S-+\\)" nil t))
4030 (nconc al
4031 (list
4032 (cons
4033 (buffer-substring ; name
4034 (match-beginning 1) (match-end 1))
4035 (let ((internal-filename
4036 (buffer-substring ; source
4037 (match-beginning 2) (match-end 2))))
4038 (list
4039 (idlwave-shell-file-name internal-filename)
4040 internal-filename))
4041 ))))
4042 (cdr al))))
4043
8c7b4ec8
EZ
4044(defun idlwave-shell-clear-all-bp ()
4045 "Remove all breakpoints in IDL."
4046 (interactive)
4047 (idlwave-shell-send-command
4048 idlwave-shell-bp-query
4049 '(progn
4050 (idlwave-shell-filter-bp)
815c75b5
S
4051 (mapcar (lambda (x) (idlwave-shell-clear-bp x 'no-query))
4052 idlwave-shell-bp-alist)
4053 (idlwave-shell-bp-query))
8c7b4ec8
EZ
4054 'hide))
4055
4056(defun idlwave-shell-list-all-bp ()
4057 "List all breakpoints in IDL."
4058 (interactive)
4059 (idlwave-shell-send-command
4060 idlwave-shell-bp-query))
4061
4062(defvar idlwave-shell-error-last 0
4063 "Position of last syntax error in `idlwave-shell-error-buffer'.")
4064
4065(defun idlwave-shell-goto-next-error ()
4066 "Move point to next IDL syntax error."
4067 (interactive)
4068 (let (frame col)
4069 (save-excursion
4070 (set-buffer idlwave-shell-error-buffer)
4071 (goto-char idlwave-shell-error-last)
52a244eb
S
4072 (if (or
4073 (re-search-forward idlwave-shell-syntax-error nil t)
4074 (re-search-forward idlwave-shell-other-error nil t))
8c7b4ec8
EZ
4075 (progn
4076 (setq frame
4077 (list
4078 (save-match-data
4079 (idlwave-shell-file-name
5cba7601 4080 (buffer-substring (match-beginning 1 )
52a244eb 4081 (match-end 1))))
027a4b6b 4082 (string-to-number
8c7b4ec8
EZ
4083 (buffer-substring (match-beginning 2)
4084 (match-end 2)))))
4085 ;; Try to find the column of the error
4086 (save-excursion
4087 (setq col
4088 (if (re-search-backward "\\^" nil t)
4089 (current-column)
4090 0)))))
4091 (setq idlwave-shell-error-last (point)))
4092 (if frame
4093 (progn
f66f03de 4094 (idlwave-shell-display-line frame col 'disable))
8c7b4ec8
EZ
4095 (beep)
4096 (message "No more errors."))))
4097
4098(defun idlwave-shell-file-name (name)
15e42531 4099 "If `idlwave-shell-use-truename' is non-nil, convert file name to true name.
8c7b4ec8
EZ
4100Otherwise, just expand the file name."
4101 (let ((def-dir (if (eq major-mode 'idlwave-shell-mode)
4102 default-directory
4103 idlwave-shell-default-directory)))
5e72c6b2
S
4104 (if idlwave-shell-use-truename
4105 (file-truename name def-dir)
8c7b4ec8
EZ
4106 (expand-file-name name def-dir))))
4107
52a244eb 4108;; Keybindings ------------------------------------------------------------
8c7b4ec8
EZ
4109
4110(defvar idlwave-shell-mode-map (copy-keymap comint-mode-map)
4111 "Keymap for idlwave-mode.")
52a244eb 4112(defvar idlwave-shell-electric-debug-mode-map (make-sparse-keymap))
8c7b4ec8
EZ
4113(defvar idlwave-shell-mode-prefix-map (make-sparse-keymap))
4114(fset 'idlwave-shell-mode-prefix-map idlwave-shell-mode-prefix-map)
52a244eb
S
4115(defvar idlwave-mode-prefix-map (make-sparse-keymap))
4116(fset 'idlwave-mode-prefix-map idlwave-mode-prefix-map)
4117
4118(defun idlwave-shell-define-key-both (key hook)
4119 "Define a key in both the shell and buffer mode maps."
4120 (define-key idlwave-mode-map key hook)
4121 (define-key idlwave-shell-mode-map key hook))
8c7b4ec8
EZ
4122
4123;(define-key idlwave-shell-mode-map "\M-?" 'comint-dynamic-list-completions)
4124;(define-key idlwave-shell-mode-map "\t" 'comint-dynamic-complete)
6a8cc02d 4125
dd5baa1a 4126(define-key idlwave-shell-mode-map "\C-w" 'comint-kill-region)
8c7b4ec8
EZ
4127(define-key idlwave-shell-mode-map "\t" 'idlwave-shell-complete)
4128(define-key idlwave-shell-mode-map "\M-\t" 'idlwave-shell-complete)
4129(define-key idlwave-shell-mode-map "\C-c\C-s" 'idlwave-shell)
4130(define-key idlwave-shell-mode-map "\C-c?" 'idlwave-routine-info)
76959b77 4131(define-key idlwave-shell-mode-map "\C-g" 'idlwave-keyboard-quit)
15e42531 4132(define-key idlwave-shell-mode-map "\M-?" 'idlwave-context-help)
5cba7601 4133(define-key idlwave-shell-mode-map [(control meta ?\?)]
dd5baa1a 4134 'idlwave-help-assistant-help-with-topic)
8c7b4ec8 4135(define-key idlwave-shell-mode-map "\C-c\C-i" 'idlwave-update-routine-info)
15e42531
CD
4136(define-key idlwave-shell-mode-map "\C-c\C-y" 'idlwave-shell-char-mode-loop)
4137(define-key idlwave-shell-mode-map "\C-c\C-x" 'idlwave-shell-send-char)
8c7b4ec8
EZ
4138(define-key idlwave-shell-mode-map "\C-c=" 'idlwave-resolve)
4139(define-key idlwave-shell-mode-map "\C-c\C-v" 'idlwave-find-module)
15e42531 4140(define-key idlwave-shell-mode-map "\C-c\C-k" 'idlwave-kill-autoloaded-buffers)
8c7b4ec8
EZ
4141(define-key idlwave-shell-mode-map idlwave-shell-prefix-key
4142 'idlwave-shell-debug-map)
05a1abfc
CD
4143(define-key idlwave-shell-mode-map [(up)] 'idlwave-shell-up-or-history)
4144(define-key idlwave-shell-mode-map [(down)] 'idlwave-shell-down-or-history)
15e42531
CD
4145(define-key idlwave-mode-map "\C-c\C-y" 'idlwave-shell-char-mode-loop)
4146(define-key idlwave-mode-map "\C-c\C-x" 'idlwave-shell-send-char)
5e72c6b2
S
4147
4148;; The mouse bindings for PRINT and HELP
4149(idlwave-shell-define-key-both
5cba7601
GM
4150 (if (featurep 'xemacs)
4151 [(shift button2)]
5e72c6b2
S
4152 [(shift down-mouse-2)])
4153 'idlwave-shell-mouse-print)
4154(idlwave-shell-define-key-both
5cba7601
GM
4155 (if (featurep 'xemacs)
4156 [(control meta button2)]
5e72c6b2 4157 [(control meta down-mouse-2)])
15e42531 4158 'idlwave-shell-mouse-help)
5e72c6b2
S
4159(idlwave-shell-define-key-both
4160 (if (featurep 'xemacs)
4161 [(control shift button2)]
4162 [(control shift down-mouse-2)])
4163 'idlwave-shell-examine-select)
4164;; Add this one from the idlwave-mode-map
5cba7601 4165(define-key idlwave-shell-mode-map
5e72c6b2
S
4166 (if (featurep 'xemacs)
4167 [(shift button3)]
4168 [(shift mouse-3)])
15e42531
CD
4169 'idlwave-mouse-context-help)
4170
5e72c6b2 4171;; For Emacs, we need to turn off the button release events.
5cba7601 4172(defun idlwave-shell-mouse-nop (event)
5e72c6b2
S
4173 (interactive "e"))
4174(unless (featurep 'xemacs)
4175 (idlwave-shell-define-key-both
4176 [(shift mouse-2)] 'idlwave-shell-mouse-nop)
4177 (idlwave-shell-define-key-both
4178 [(shift control mouse-2)] 'idlwave-shell-mouse-nop)
4179 (idlwave-shell-define-key-both
4180 [(control meta mouse-2)] 'idlwave-shell-mouse-nop))
8c7b4ec8 4181
5cba7601 4182
8c7b4ec8 4183;; The following set of bindings is used to bind the debugging keys.
52a244eb
S
4184;; If `idlwave-shell-activate-prefix-keybindings' is non-nil, the
4185;; first key in the list gets bound the C-c C-d prefix map. If
4186;; `idlwave-shell-debug-modifiers' is non-nil, the second key in the
4187;; list gets bound with the specified modifiers in both
4188;; `idlwave-mode-map' and `idlwave-shell-mode-map'. The next list
4189;; item, if non-nil, means to bind this as a single key in the
4190;; electric-debug-mode-map.
5cba7601 4191;;
52a244eb 4192;; [C-c C-d]-binding debug-modifier-key command bind-electric-debug buf-only
5cba7601
GM
4193;; Used keys: abcdef hijklmnopqrstuvwxyz
4194;; Unused keys: g
05a1abfc 4195(let* ((specs
52a244eb
S
4196 '(([(control ?b)] ?b idlwave-shell-break-here t t)
4197 ([(control ?i)] ?i idlwave-shell-break-in t t)
4198 ([(control ?j)] ?j idlwave-shell-break-this-module t t)
4199 ([(control ?d)] ?d idlwave-shell-clear-current-bp t)
4200 ([(control ?a)] ?a idlwave-shell-clear-all-bp t)
4201 ([(control ?\\)] ?\\ idlwave-shell-toggle-enable-current-bp t)
4202 ([(control ?s)] ?s idlwave-shell-step t)
4203 ([(control ?n)] ?n idlwave-shell-stepover t)
4204 ([(control ?k)] ?k idlwave-shell-skip t)
4205 ([(control ?u)] ?u idlwave-shell-up t)
4206 ([(control ?o)] ?o idlwave-shell-out t)
4207 ([(control ?m)] ?m idlwave-shell-return t)
4208 ([(control ?h)] ?h idlwave-shell-to-here t t)
4209 ([(control ?r)] ?r idlwave-shell-cont t)
05a1abfc 4210 ([(control ?y)] ?y idlwave-shell-execute-default-command-line)
52a244eb 4211 ([(control ?z)] ?z idlwave-shell-reset t)
05a1abfc 4212 ([(control ?q)] ?q idlwave-shell-quit)
52a244eb
S
4213 ([(control ?p)] ?p idlwave-shell-print t)
4214 ([( ??)] ?? idlwave-shell-help-expression t)
4215 ([(control ?v)] ?v idlwave-shell-toggle-electric-debug-mode t t)
05a1abfc 4216 ([(control ?x)] ?x idlwave-shell-goto-next-error)
52a244eb
S
4217 ([(control ?c)] ?c idlwave-shell-save-and-run t)
4218 ([( ?@)] ?@ idlwave-shell-save-and-batch)
05a1abfc
CD
4219 ([(control ?e)] ?e idlwave-shell-run-region)
4220 ([(control ?w)] ?w idlwave-shell-resync-dirs)
52a244eb 4221 ([(control ?l)] ?l idlwave-shell-redisplay t)
05a1abfc
CD
4222 ([(control ?t)] ?t idlwave-shell-toggle-toolbar)
4223 ([(control up)] up idlwave-shell-stack-up)
4224 ([(control down)] down idlwave-shell-stack-down)
52a244eb
S
4225 ([( ?[)] ?[ idlwave-shell-goto-previous-bp t t)
4226 ([( ?])] ?] idlwave-shell-goto-next-bp t t)
05a1abfc
CD
4227 ([(control ?f)] ?f idlwave-shell-window)))
4228 (mod (cond ((and idlwave-shell-debug-modifiers
4229 (listp idlwave-shell-debug-modifiers)
4230 (not (equal '() idlwave-shell-debug-modifiers)))
4231 idlwave-shell-debug-modifiers)
4232 (idlwave-shell-activate-alt-keybindings
4233 '(alt))))
4234 (shift (memq 'shift mod))
4235 (mod-noshift (delete 'shift (copy-sequence mod)))
25d24a50 4236 s k1 c2 k2 cmd electric only-buffer cannotshift)
8c7b4ec8
EZ
4237 (while (setq s (pop specs))
4238 (setq k1 (nth 0 s)
05a1abfc 4239 c2 (nth 1 s)
52a244eb
S
4240 cmd (nth 2 s)
4241 electric (nth 3 s)
4242 only-buffer (nth 4 s)
5cba7601
GM
4243 cannotshift (and shift (characterp c2) (eq c2 (upcase c2))))
4244
52a244eb
S
4245 ;; The regular prefix keymap.
4246 (when (and idlwave-shell-activate-prefix-keybindings k1)
5cba7601 4247 (unless only-buffer
52a244eb
S
4248 (define-key idlwave-shell-mode-prefix-map k1 cmd))
4249 (define-key idlwave-mode-prefix-map k1 cmd))
4250 ;; The debug modifier map
05a1abfc
CD
4251 (when (and mod window-system)
4252 (if (char-or-string-p c2)
4253 (setq k2 (vector (append mod-noshift
4254 (list (if shift (upcase c2) c2)))))
4255 (setq k2 (vector (append mod (list c2)))))
52a244eb
S
4256 (unless cannotshift
4257 (define-key idlwave-mode-map k2 cmd)
4258 (unless only-buffer (define-key idlwave-shell-mode-map k2 cmd))))
4259 ;; The electric debug single-keystroke map
4260 (if (and electric (char-or-string-p c2))
5cba7601 4261 (define-key idlwave-shell-electric-debug-mode-map (char-to-string c2)
52a244eb
S
4262 cmd))))
4263
4264;; A few extras in the electric debug map
4265(define-key idlwave-shell-electric-debug-mode-map " " 'idlwave-shell-step)
4266(define-key idlwave-shell-electric-debug-mode-map "+" 'idlwave-shell-stack-up)
4267(define-key idlwave-shell-electric-debug-mode-map "=" 'idlwave-shell-stack-up)
5cba7601 4268(define-key idlwave-shell-electric-debug-mode-map "-"
52a244eb 4269 'idlwave-shell-stack-down)
5cba7601 4270(define-key idlwave-shell-electric-debug-mode-map "_"
52a244eb 4271 'idlwave-shell-stack-down)
5cba7601 4272(define-key idlwave-shell-electric-debug-mode-map "e"
f66f03de 4273 '(lambda () (interactive) (idlwave-shell-print '(16))))
52a244eb 4274(define-key idlwave-shell-electric-debug-mode-map "q" 'idlwave-shell-retall)
5cba7601 4275(define-key idlwave-shell-electric-debug-mode-map "t"
52a244eb
S
4276 '(lambda () (interactive) (idlwave-shell-send-command "help,/TRACE")))
4277(define-key idlwave-shell-electric-debug-mode-map [(control ??)]
4278 'idlwave-shell-electric-debug-help)
5cba7601
GM
4279(define-key idlwave-shell-electric-debug-mode-map "x"
4280 '(lambda (arg) (interactive "P")
52a244eb
S
4281 (idlwave-shell-print arg nil nil t)))
4282
4283
4284; Enter the prefix map in two places.
4285(fset 'idlwave-debug-map idlwave-mode-prefix-map)
8c7b4ec8
EZ
4286(fset 'idlwave-shell-debug-map idlwave-shell-mode-prefix-map)
4287
52a244eb
S
4288;; The Electric Debug Minor Mode --------------------------------------------
4289
4290(defun idlwave-shell-toggle-electric-debug-mode ()
4291 "Toggle electric-debug-mode, suppressing re-entry into mode if turned off."
4292 (interactive)
4293 ;; If turning it off, make sure it stays off throughout the debug
4294 ;; session until we return or hit $MAIN$. Cancel this suppression
4295 ;; if it's explicitly turned on.
4296 (if idlwave-shell-electric-debug-mode
f66f03de
S
4297 (progn ;; Turn it off, and make sure it stays off.
4298 (setq idlwave-shell-suppress-electric-debug t)
4299 (idlwave-shell-electric-debug-mode 0))
4300 (setq idlwave-shell-suppress-electric-debug nil)
4301 (idlwave-shell-electric-debug-mode t)))
52a244eb 4302
5cba7601 4303(defvar idlwave-shell-electric-debug-read-only)
25d24a50
S
4304(defvar idlwave-shell-electric-debug-buffers nil)
4305
0f01161d 4306(define-minor-mode idlwave-shell-electric-debug-mode
52a244eb 4307 "Toggle Electric Debug mode.
5cba7601 4308With no argument, this command toggles the mode.
52a244eb
S
4309Non-null prefix argument turns on the mode.
4310Null prefix argument turns off the mode.
4311
4312When Electric Debug mode is enabled, the many debugging commands are
4313available as single key sequences."
f66f03de
S
4314nil
4315" *Debugging*"
4316idlwave-shell-electric-debug-mode-map)
52a244eb 4317
5cba7601 4318(add-hook
52a244eb
S
4319 'idlwave-shell-electric-debug-mode-on-hook
4320 (lambda ()
4321 (set (make-local-variable 'idlwave-shell-electric-debug-read-only)
4322 buffer-read-only)
4323 (setq buffer-read-only t)
4324 (add-to-list 'idlwave-shell-electric-debug-buffers (current-buffer))
4325 (if idlwave-shell-stop-line-overlay
5cba7601 4326 (overlay-put idlwave-shell-stop-line-overlay 'face
52a244eb
S
4327 idlwave-shell-electric-stop-line-face))
4328 (if (facep 'fringe)
4329 (set-face-foreground 'fringe idlwave-shell-electric-stop-color
4330 (selected-frame)))))
4331
5cba7601 4332(add-hook
52a244eb
S
4333 'idlwave-shell-electric-debug-mode-off-hook
4334 (lambda ()
4335 ;; Return to previous read-only state
4336 (setq buffer-read-only (if (boundp 'idlwave-shell-electric-debug-read-only)
4337 idlwave-shell-electric-debug-read-only))
4338 (setq idlwave-shell-electric-debug-buffers
4339 (delq (current-buffer) idlwave-shell-electric-debug-buffers))
4340 (if idlwave-shell-stop-line-overlay
5cba7601 4341 (overlay-put idlwave-shell-stop-line-overlay 'face
52a244eb
S
4342 idlwave-shell-stop-line-face)
4343 (if (facep 'fringe)
4344 (set-face-foreground 'fringe (face-foreground 'default))))))
4345
4346;; easy-mmode defines electric-debug-mode for us, so we need to advise it.
4347(defadvice idlwave-shell-electric-debug-mode (after print-enter activate)
4348 "Print out an entrance message"
4349 (when idlwave-shell-electric-debug-mode
4350 (message
4351 "Electric Debugging mode entered. Press [C-?] for help, [q] to quit"))
4352 (force-mode-line-update))
4353
4354;; Turn it off in all relevant buffers
3938cb82 4355(defvar idlwave-shell-electric-debug-buffers nil)
52a244eb
S
4356(defun idlwave-shell-electric-debug-all-off ()
4357 (setq idlwave-shell-suppress-electric-debug nil)
4358 (let ((buffers idlwave-shell-electric-debug-buffers)
4359 buf)
4360 (save-excursion
4361 (while (setq buf (pop buffers))
4362 (when (buffer-live-p buf)
4363 (set-buffer buf)
4364 (when (and (eq major-mode 'idlwave-mode)
4365 buffer-file-name
4366 idlwave-shell-electric-debug-mode)
f66f03de 4367 (idlwave-shell-electric-debug-mode 0))))))
52a244eb
S
4368 (setq idlwave-shell-electric-debug-buffers nil))
4369
4370;; Show the help text
4371(defun idlwave-shell-electric-debug-help ()
4372 (interactive)
5cba7601 4373 (with-output-to-temp-buffer "*IDLWAVE Electric Debug Help*"
52a244eb
S
4374 (princ idlwave-shell-electric-debug-help))
4375 (let* ((current-window (selected-window))
4376 (window (get-buffer-window "*IDLWAVE Electric Debug Help*"))
4377 (window-lines (window-height window)))
4378 (select-window window)
4379 (enlarge-window (1+ (- (count-lines 1 (point-max)) window-lines)))
4380 (select-window current-window)))
4381
8c7b4ec8 4382
52a244eb 4383;; The Menus --------------------------------------------------------------
8c7b4ec8 4384(defvar idlwave-shell-menu-def
52a244eb
S
4385 `("Debug"
4386 ["Electric Debug Mode"
4387 idlwave-shell-electric-debug-mode
5cba7601 4388 :style toggle :selected idlwave-shell-electric-debug-mode
52a244eb 4389 :included (eq major-mode 'idlwave-mode) :keys "C-c C-d C-v"]
8c7b4ec8 4390 "--"
15e42531
CD
4391 ("Compile & Run"
4392 ["Save and .RUN" idlwave-shell-save-and-run
4393 (or (eq major-mode 'idlwave-mode)
4394 idlwave-shell-last-save-and-action-file)]
4395 ["Save and .COMPILE" idlwave-shell-save-and-compile
4396 (or (eq major-mode 'idlwave-mode)
4397 idlwave-shell-last-save-and-action-file)]
4398 ["Save and @Batch" idlwave-shell-save-and-batch
4399 (or (eq major-mode 'idlwave-mode)
4400 idlwave-shell-last-save-and-action-file)]
52a244eb 4401 "--"
15e42531
CD
4402 ["Goto Next Error" idlwave-shell-goto-next-error t]
4403 "--"
5cba7601 4404 ["Compile and Run Region" idlwave-shell-run-region
52a244eb 4405 (eq major-mode 'idlwave-mode)]
5cba7601 4406 ["Evaluate Region" idlwave-shell-evaluate-region
52a244eb 4407 (eq major-mode 'idlwave-mode)]
15e42531
CD
4408 "--"
4409 ["Execute Default Cmd" idlwave-shell-execute-default-command-line t]
4410 ["Edit Default Cmd" idlwave-shell-edit-default-command-line t])
4411 ("Breakpoints"
5cba7601 4412 ["Set Breakpoint" idlwave-shell-break-here
aed19764 4413 :keys "C-c C-d C-b" :active (eq major-mode 'idlwave-mode)]
52a244eb
S
4414 ("Set Special Breakpoint"
4415 ["Set After Count Breakpoint"
4416 (progn
027a4b6b 4417 (let ((count (string-to-number (read-string "Break after count: "))))
52a244eb
S
4418 (if (integerp count) (idlwave-shell-break-here count))))
4419 :active (eq major-mode 'idlwave-mode)]
4420 ["Set Condition Breakpoint"
4421 (idlwave-shell-break-here '(4))
4422 :active (eq major-mode 'idlwave-mode)])
5cba7601 4423 ["Break in Module" idlwave-shell-break-in
52a244eb
S
4424 :keys "C-c C-d C-i" :active (eq major-mode 'idlwave-mode)]
4425 ["Break in this Module" idlwave-shell-break-this-module
4426 :keys "C-c C-d C-j" :active (eq major-mode 'idlwave-mode)]
15e42531
CD
4427 ["Clear Breakpoint" idlwave-shell-clear-current-bp t]
4428 ["Clear All Breakpoints" idlwave-shell-clear-all-bp t]
52a244eb 4429 ["Disable/Enable Breakpoint" idlwave-shell-toggle-enable-current-bp t]
5cba7601 4430 ["Goto Previous Breakpoint" idlwave-shell-goto-previous-bp
52a244eb 4431 :keys "C-c C-d [" :active (eq major-mode 'idlwave-mode)]
5cba7601 4432 ["Goto Next Breakpoint" idlwave-shell-goto-next-bp
52a244eb
S
4433 :keys "C-c C-d ]" :active (eq major-mode 'idlwave-mode)]
4434 ["List All Breakpoints" idlwave-shell-list-all-bp t]
4435 ["Resync Breakpoints" idlwave-shell-bp-query t])
05a1abfc 4436 ("Continue/Step"
15e42531
CD
4437 ["Step (into)" idlwave-shell-step t]
4438 ["Step (over)" idlwave-shell-stepover t]
4439 ["Skip One Statement" idlwave-shell-skip t]
4440 ["Continue" idlwave-shell-cont t]
4441 ["... to End of Block" idlwave-shell-up t]
4442 ["... to End of Subprog" idlwave-shell-return t]
4443 ["... to End of Subprog+1" idlwave-shell-out t]
4444 ["... to Here (Cursor Line)" idlwave-shell-to-here
52a244eb
S
4445 :keys "C-c C-d C-h" :active (eq major-mode 'idlwave-mode)])
4446 ("Examine Expressions"
15e42531
CD
4447 ["Print expression" idlwave-shell-print t]
4448 ["Help on expression" idlwave-shell-help-expression t]
52a244eb
S
4449 ("Examine nearby expression with"
4450 ,@(mapcar (lambda(x)
4451 `[ ,(car x) (idlwave-shell-print nil ',x) t ])
4452 idlwave-shell-examine-alist))
4453 ("Examine region with"
4454 ,@(mapcar (lambda(x)
4455 `[ ,(car x) (idlwave-shell-print '(4) ',x) t ])
4456 idlwave-shell-examine-alist)))
4457 ("Call Stack"
15e42531 4458 ["Stack Up" idlwave-shell-stack-up t]
52a244eb
S
4459 ["Stack Down" idlwave-shell-stack-down t]
4460 "--"
4461 ["Redisplay and Sync" idlwave-shell-redisplay t])
4462 ("Show Commands"
4463 ["Everything" (if (eq idlwave-shell-show-commands 'everything)
5cba7601 4464 (progn
52a244eb
S
4465 (setq idlwave-shell-show-commands
4466 (get 'idlwave-shell-show-commands 'last-val))
4467 (put 'idlwave-shell-show-commands 'last-val nil))
5cba7601 4468 (put 'idlwave-shell-show-commands 'last-val
52a244eb
S
4469 idlwave-shell-show-commands)
4470 (setq idlwave-shell-show-commands 'everything))
4471 :style toggle :selected (and (not (listp idlwave-shell-show-commands))
5cba7601 4472 (eq idlwave-shell-show-commands
52a244eb
S
4473 'everything))]
4474 "--"
4475 ["Compiling Commands" (idlwave-shell-add-or-remove-show 'run)
5cba7601
GM
4476 :style toggle
4477 :selected (not (idlwave-shell-hide-p
52a244eb
S
4478 'run
4479 (get 'idlwave-shell-show-commands 'last-val)))
4480 :active (not (eq idlwave-shell-show-commands 'everything))]
4481 ["Breakpoint Commands" (idlwave-shell-add-or-remove-show 'breakpoint)
5cba7601
GM
4482 :style toggle
4483 :selected (not (idlwave-shell-hide-p
52a244eb
S
4484 'breakpoint
4485 (get 'idlwave-shell-show-commands 'last-val)))
4486 :active (not (eq idlwave-shell-show-commands 'everything))]
4487 ["Debug Commands" (idlwave-shell-add-or-remove-show 'debug)
5cba7601
GM
4488 :style toggle
4489 :selected (not (idlwave-shell-hide-p
52a244eb
S
4490 'debug
4491 (get 'idlwave-shell-show-commands 'last-val)))
4492 :active (not (eq idlwave-shell-show-commands 'everything))]
4493 ["Miscellaneous Commands" (idlwave-shell-add-or-remove-show 'misc)
5cba7601
GM
4494 :style toggle
4495 :selected (not (idlwave-shell-hide-p
52a244eb
S
4496 'misc
4497 (get 'idlwave-shell-show-commands 'last-val)))
4498 :active (not (eq idlwave-shell-show-commands 'everything))])
15e42531
CD
4499 ("Input Mode"
4500 ["Send one char" idlwave-shell-send-char t]
4501 ["Temporary Character Mode" idlwave-shell-char-mode-loop t]
4502 "--"
4503 ["Use Input Mode Magic"
4504 (setq idlwave-shell-use-input-mode-magic
4505 (not idlwave-shell-use-input-mode-magic))
4506 :style toggle :selected idlwave-shell-use-input-mode-magic])
4507 "--"
4508 ["Update Working Dir" idlwave-shell-resync-dirs t]
5cba7601 4509 ["Save Path Info"
52a244eb
S
4510 (idlwave-shell-send-command idlwave-shell-path-query
4511 'idlwave-shell-get-path-info
4512 'hide)
4513 t]
15e42531
CD
4514 ["Reset IDL" idlwave-shell-reset t]
4515 "--"
4516 ["Toggle Toolbar" idlwave-shell-toggle-toolbar t]
4517 ["Exit IDL" idlwave-shell-quit t]))
8c7b4ec8
EZ
4518
4519(if (or (featurep 'easymenu) (load "easymenu" t))
4520 (progn
3d1ead4b 4521 (easy-menu-define
52a244eb 4522 idlwave-mode-debug-menu idlwave-mode-map "IDL debugging menus"
8c7b4ec8 4523 idlwave-shell-menu-def)
13ae1076 4524 (easy-menu-define
52a244eb 4525 idlwave-shell-mode-menu idlwave-shell-mode-map "IDL shell menus"
8c7b4ec8
EZ
4526 idlwave-shell-menu-def)
4527 (save-excursion
3d1ead4b
GM
4528 (mapc (lambda (buf)
4529 (set-buffer buf)
4530 (if (eq major-mode 'idlwave-mode)
4531 (progn
4532 (easy-menu-remove idlwave-mode-debug-menu)
4533 (easy-menu-add idlwave-mode-debug-menu))))
4534 (buffer-list)))))
8c7b4ec8
EZ
4535
4536;; The Breakpoint Glyph -------------------------------------------------------
4537
4538(defvar idlwave-shell-bp-glyph nil
52a244eb 4539 "The glyphs to mark breakpoint lines in the source code.")
8c7b4ec8 4540
3d1ead4b 4541(let ((image-alist
52a244eb 4542 '((bp . "/* XPM */
8c7b4ec8
EZ
4543static char * file[] = {
4544\"14 12 3 1\",
5e72c6b2 4545\" c None s backgroundColor\",
8c7b4ec8
EZ
4546\". c #4B4B4B4B4B4B\",
4547\"R c #FFFF00000000\",
4548\" \",
52a244eb
S
4549\" .... \",
4550\" .RRRR. \",
4551\" .RRRRRR. \",
4552\" .RRRRRRRR. \",
4553\" .RRRRRRRR. \",
4554\" .RRRRRRRR. \",
4555\" .RRRRRRRR. \",
4556\" .RRRRRR. \",
4557\" .RRRR. \",
4558\" .... \",
4559\" \"};")
4560 (bp-cond . "/* XPM */
4561static char * file[] = {
4562\"14 12 4 1\",
4563\" c None s backgroundColor\",
4564\". c #4B4B4B4B4B4B\",
4565\"R c #FFFF00000000\",
4566\"B c #000000000000\",
4567\" \",
4568\" .... \",
4569\" .RRRR. \",
4570\" .RRRRRR. \",
4571\" .RRRRRRRR. \",
4572\" .RRBBBBRR. \",
4573\" .RRRRRRRR. \",
4574\" .RRBBBBRR. \",
4575\" .RRRRRR. \",
4576\" .RRRR. \",
4577\" .... \",
4578\" \"};")
4579 (bp-1 . "/* XPM */
4580static char * file[] = {
4581\"14 12 4 1\",
4582\" c None s backgroundColor\",
4583\". c #4B4B4B4B4B4B\",
4584\"X c #FFFF00000000\",
4585\"o c #000000000000\",
4586\" \",
4587\" .... \",
4588\" .XXXX. \",
4589\" .XXooXX. \",
4590\" .XXoooXXX. \",
4591\" .XXXooXXX. \",
4592\" .XXXooXXX. \",
4593\" .XXooooXX. \",
4594\" .XooooX. \",
4595\" .XXXX. \",
4596\" .... \",
4597\" \"};")
4598 (bp-2 . "/* XPM */
4599static char * file[] = {
4600\"14 12 4 1\",
4601\" c None s backgroundColor\",
4602\". c #4B4B4B4B4B4B\",
4603\"X c #FFFF00000000\",
4604\"o c #000000000000\",
4605\" \",
4606\" .... \",
4607\" .XXXX. \",
4608\" .XoooXX. \",
4609\" .XXoXooXX. \",
4610\" .XXXXooXX. \",
4611\" .XXXooXXX. \",
4612\" .XXooXXXX. \",
4613\" .XooooX. \",
4614\" .XXXX. \",
4615\" .... \",
4616\" \"};")
4617 (bp-3 . "/* XPM */
4618static char * file[] = {
4619\"14 12 4 1\",
4620\" c None s backgroundColor\",
4621\". c #4B4B4B4B4B4B\",
4622\"X c #FFFF00000000\",
4623\"o c #000000000000\",
4624\" \",
4625\" .... \",
4626\" .XXXX. \",
4627\" .XoooXX. \",
4628\" .XXXXooXX. \",
4629\" .XXXooXXX. \",
4630\" .XXXXooXX. \",
4631\" .XXoXooXX. \",
4632\" .XoooXX. \",
4633\" .XXXX. \",
4634\" .... \",
4635\" \"};")
4636 (bp-4 . "/* XPM */
4637static char * file[] = {
4638\"14 12 4 1\",
4639\" c None s backgroundColor\",
4640\". c #4B4B4B4B4B4B\",
4641\"X c #FFFF00000000\",
4642\"o c #000000000000\",
8c7b4ec8 4643\" \",
52a244eb
S
4644\" .... \",
4645\" .XXXX. \",
4646\" .XoXXoX. \",
4647\" .XXoXXoXX. \",
4648\" .XXooooXX. \",
4649\" .XXXXooXX. \",
4650\" .XXXXooXX. \",
4651\" .XXXooX. \",
4652\" .XXXX. \",
4653\" .... \",
4654\" \"};")
4655 (bp-n . "/* XPM */
4656static char * file[] = {
4657\"14 12 4 1\",
4658\" c None s backgroundColor\",
4659\". c #4B4B4B4B4B4B\",
4660\"X c #FFFF00000000\",
4661\"o c #000000000000\",
8c7b4ec8 4662\" \",
52a244eb
S
4663\" .... \",
4664\" .XXXX. \",
4665\" .XXXXXX. \",
4666\" .XXoXoXXX. \",
4667\" .XXooXoXX. \",
4668\" .XXoXXoXX. \",
4669\" .XXoXXoXX. \",
4670\" .XoXXoX. \",
4671\" .XXXX. \",
4672\" .... \",
4673\" \"};"))) im-cons im)
5cba7601 4674
52a244eb
S
4675 (while (setq im-cons (pop image-alist))
4676 (setq im (cond ((and (featurep 'xemacs)
4677 (featurep 'xpm))
4678 (list
4679 (let ((data (cdr im-cons)))
4680 (string-match "#FFFF00000000" data)
4681 (setq data (replace-match "#8F8F8F8F8F8F" t t data))
4682 (make-glyph data))
4683 (make-glyph (cdr im-cons))))
4684 ((and (not (featurep 'xemacs))
4685 (fboundp 'image-type-available-p)
4686 (image-type-available-p 'xpm))
5cba7601 4687 (list 'image :type 'xpm :data (cdr im-cons)
52a244eb
S
4688 :ascent 'center))
4689 (t nil)))
4690 (if im (push (cons (car im-cons) im) idlwave-shell-bp-glyph))))
8c7b4ec8
EZ
4691
4692(provide 'idlw-shell)
a98f98c0 4693(provide 'idlwave-shell)
8c7b4ec8
EZ
4694
4695;;; Load the toolbar when wanted by the user.
4696
5cba7601 4697(autoload 'idlwave-toolbar-toggle "idlw-toolbar"
ca660d22
CD
4698 "Toggle the IDLWAVE toolbar")
4699(autoload 'idlwave-toolbar-add-everywhere "idlw-toolbar"
4700 "Add IDLWAVE toolbar")
8c7b4ec8
EZ
4701(defun idlwave-shell-toggle-toolbar ()
4702 "Toggle the display of the debugging toolbar."
4703 (interactive)
ca660d22 4704 (idlwave-toolbar-toggle))
8c7b4ec8 4705
ca660d22
CD
4706(if idlwave-shell-use-toolbar
4707 (add-hook 'idlwave-shell-mode-hook 'idlwave-toolbar-add-everywhere))
8df608c1
MB
4708
4709;; arch-tag: 20c2e8ce-0709-41d8-a5b6-bb039148440a
8c7b4ec8 4710;;; idlw-shell.el ends here