File: `idlw-shell.el.html`

NOTE: IDLWAVE has been moved to GNU ELPA. The version bundled with
      Emacs is out-of-date, marked as obsolete, and will be removed
      in a future release. Please use M-x list-packages to install
      IDLWAVE from GNU ELPA instead of using this version.

This mode is for IDL version 5 or later.

Runs IDL as an inferior process of Emacs, much like the Emacs shell or telnet commands. Provides command history and searching. Provides debugging commands available in buffers visiting IDL procedure files, e.g., breakpoint setting, stepping, execution until a certain line, printing expressions under point, visual line pointer for current execution line, etc.

Documentation should be available online with M-x idlwave-info.

New versions of IDLWAVE, documentation, and more information available from:
https://github.com/jdtsmith/idlwave

INSTALLATION:
=============

Follow the instructions in the INSTALL file of the distribution. In short, put this file on your load path and add the following lines to your init file:

(autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)

SOURCE
======

The newest version of this file can be found on the maintainers
web site.

https://github.com/jdtsmith/idlwave

DOCUMENTATION
=============

IDLWAVE is documented online in info format. A printable version of the documentation is available from the maintainers webpage (see under SOURCE)

CUSTOMIZATION VARIABLES
=======================

IDLWAVE has customize support - so if you want to learn about the variables which control the behavior of the mode, use M-x idlwave-customize.

--------------------------------------------------------------------------

Defined variables (93)

`idlwave-mode-debug-menu`	IDL debugging menus.
`idlwave-shell-accumulation`	Accumulate last line of output.
`idlwave-shell-activate-prefix-keybindings`	Non-nil means, the debug commands will be bound to the prefix key.
`idlwave-shell-arrows-do-history`	Non-nil means UP and DOWN arrows move through command history.
`idlwave-shell-automatic-electric-debug`	Enter the electric-debug minor mode automatically.
`idlwave-shell-bp-alist`	Alist of breakpoints.
`idlwave-shell-bp-buffer`	Scratch buffer for parsing IDL breakpoint lists and other stuff.
`idlwave-shell-bp-glyph`	The glyphs to mark breakpoint lines in the source code.
`idlwave-shell-bp-overlays`	Alist of overlays marking breakpoints.
`idlwave-shell-bp-query`	Command to obtain list of breakpoints.
`idlwave-shell-break-message`	Regular expression matching an IDL breakpoint message line.
`idlwave-shell-breakpoint-face`	The face for breakpoint lines in the source code.
`idlwave-shell-breakpoint-popup-menu`	If non-nil, provide a menu on mouse-3 on breakpoint lines, and
`idlwave-shell-cant-continue-error`	A regular expression to match errors stepping errors.
`idlwave-shell-cleanup-hook`	List of functions to do cleanup when the shell exits.
`idlwave-shell-comint-settings`	Alist of special settings for the comint variables in the IDLWAVE Shell.
`idlwave-shell-command-history-file`	The file in which the command history of the idlwave shell is saved.
`idlwave-shell-command-output`	String for accumulating current command output.
`idlwave-shell-default-directory`	The default directory in the ‘idlwave-shell’ buffer, of outside use.
`idlwave-shell-dirstack-query`	Command used by ‘idlwave-shell-resync-dirs’ to query IDL for
`idlwave-shell-disabled-breakpoint-face`	The face for disabled breakpoint lines in the source code.
`idlwave-shell-display-wframe`	Frame for displaying the IDL source files.
`idlwave-shell-electric-debug-mode`	Non-nil if Idlwave-Shell-Electric-Debug mode is enabled.
`idlwave-shell-electric-debug-mode-hook`	Hook run after entering or leaving ‘idlwave-shell-electric-debug-mode’.
`idlwave-shell-electric-stop-color`	The color for the default face or overlay arrow when stopped.
`idlwave-shell-electric-stop-line-face`	The face for ‘idlwave-shell-stop-line-overlay’ when in electric debug mode.
`idlwave-shell-electric-zap-to-file`	When entering electric debug mode, select the window displaying the
`idlwave-shell-error-buffer`	Buffer containing syntax errors from IDL compilations.
`idlwave-shell-error-last`	Position of last syntax error in ‘idlwave-shell-error-buffer’.
`idlwave-shell-examine-alist`	Alist of special examine commands for popup selection.
`idlwave-shell-examine-label`	Label to include with examine text if in a separate buffer.
`idlwave-shell-examine-window-alist`	Variable to hold the win/height pairs for all Examine windows.
`idlwave-shell-expression-face`	The face for ‘idlwave-shell-expression-overlay’.
`idlwave-shell-expression-overlay`	The overlay for the examined expression.
`idlwave-shell-file-line-message`	A regular expression to parse out the file name and line number.
`idlwave-shell-file-name-chars`	The characters allowed in file names, as a string.
`idlwave-shell-frame-parameters`	The frame parameters for a dedicated ‘idlwave-shell’ frame.
`idlwave-shell-graphics-window-size`	Size of IDL graphics windows popped up by special IDLWAVE command.
`idlwave-shell-halt-frame`	The frame associated with halt/breakpoint messages.
`idlwave-shell-halt-messages`	A list of regular expressions matching IDL messages.
`idlwave-shell-halt-messages-re`	The regular expression computed from ‘idlwave-shell-halt-messages’.
`idlwave-shell-halting-error`	A regular expression to match errors which halt execution.
`idlwave-shell-hidden-output-buffer`	Buffer containing hidden output from IDL commands.
`idlwave-shell-hide-output`	If non-nil the process output is not inserted into the output buffer.
`idlwave-shell-idl-wframe`	Frame for displaying the IDL shell window.
`idlwave-shell-initial-commands`	Initial commands, separated by newlines, to send to IDL.
`idlwave-shell-input-mode-spells`	The three regular expressions which match the magic spells for input modes.
`idlwave-shell-last-save-and-action-file`	The last file which was compiled with ‘idlwave-shell-save-and-...’.
`idlwave-shell-mark-breakpoints`	Non-nil means, mark breakpoints in the source files.
`idlwave-shell-mark-stop-line`	Non-nil means, mark the source code line where IDL is currently stopped.
`idlwave-shell-max-print-length`	Maximum number of array elements to print when examining.
`idlwave-shell-mode-hook`	Hook for customizing ‘idlwave-shell-mode’.
`idlwave-shell-mode-line-info`	Additional info displayed in the mode line.
`idlwave-shell-mode-map`	Keymap for ‘idlwave-mode’.
`idlwave-shell-mode-menu`	IDL shell menus.
`idlwave-shell-mode-syntax-table`	Syntax table for ‘idlwave-shell-mode’.
`idlwave-shell-old-bp`	List of breakpoints previous to setting a new breakpoint.
`idlwave-shell-other-error`	A regular expression to match any IDL error.
`idlwave-shell-output-face`	The face for ‘idlwave-shell-output-overlay’.
`idlwave-shell-output-overlay`	The overlay for the last IDL output.
`idlwave-shell-overlay-arrow`	The overlay arrow to display at source lines where execution halts.
`idlwave-shell-path-query`	The command which gets !PATH and !DIR info from the shell.
`idlwave-shell-pending-commands`	List of commands to be sent to IDL.
`idlwave-shell-post-command-hook`	Lisp list expression or function to run when an IDL command is finished.
`idlwave-shell-prefix-key`	The prefix key for the debugging map ‘idlwave-shell-mode-prefix-map’.
`idlwave-shell-process-name`	Name to be associated with the IDL process.
`idlwave-shell-prompt-pattern`	Regexp to match IDL prompt at beginning of a line.
`idlwave-shell-query-for-class`	Non-nil means query the shell for object class on object completions.
`idlwave-shell-raise-frame`	Non-nil means, ‘idlwave-shell’ raises the frame showing the shell window.
`idlwave-shell-ready`	If non-nil can send next command to IDL process.
`idlwave-shell-reset-no-prompt`	If non-nil, skip the yes/no prompt when resetting the IDL session.
`idlwave-shell-save-command-history`	Non-nil means preserve command history between sessions.
`idlwave-shell-sentinel-hook`	Hook run when the IDL process exits.
`idlwave-shell-separate-examine-output`	Non-nil means, put output of examine commands in their own buffer.
`idlwave-shell-show-commands`	A list of command types to show output from in the shell.
`idlwave-shell-show-if-error`	If non-nil the process output is inserted into the output buffer if
`idlwave-shell-sources-alist`	Alist of IDL procedure names and compiled source files.
`idlwave-shell-sources-query`	IDL command to obtain source files for compiled procedures.
`idlwave-shell-step-frame`	The frame associated with step messages.
`idlwave-shell-step-messages`	A list of regular expressions matching stepped execution messages.
`idlwave-shell-stop-line-face`	The face for ‘idlwave-shell-stop-line-overlay’.
`idlwave-shell-stop-line-overlay`	The overlay for where IDL is currently stopped.
`idlwave-shell-syntax-error`	A regular expression to match an IDL syntax error.
`idlwave-shell-temp-pro-file`	Absolute pathname for temporary IDL file for compiling regions.
`idlwave-shell-temp-pro-prefix`	The prefix for temporary IDL files used when compiling regions.
`idlwave-shell-temp-rinfo-save-file`	Absolute pathname for temporary IDL file save file for routine_info.
`idlwave-shell-trace-frame`	The frame associated with trace messages.
`idlwave-shell-trace-message-re`	A regular expression matching IDL trace messages.
`idlwave-shell-use-dedicated-frame`	Non-nil means, IDLWAVE should use a special frame to display shell buffer.
`idlwave-shell-use-dedicated-window`	Non-nil means, never replace the shell frame with another buffer.
`idlwave-shell-use-input-mode-magic`	Non-nil means, IDLWAVE should check for input mode spells in output.
`idlwave-shell-use-toolbar`	Non-nil means, use the debugging toolbar in all IDL related buffers.
`idlwave-shell-use-truename`	Non-nil means, use ‘file-truename’ when looking for buffers.

Defined functions (135)

`idl-shell`	(&optional ARG)
`idlwave-default-mouse-track-event-is-with-button`	(&rest ARGUMENTS)
`idlwave-display-buffer`	(BUF NOT-THIS-WINDOW-P &optional FRAME)
`idlwave-mode-debug-menu`	(ARG1)
`idlwave-retrieve-expression-from-level`	(EXPR LEVEL)
`idlwave-shell`	(&optional ARG)
`idlwave-shell--mouse-examine`	(EVENT HELP &optional EV)
`idlwave-shell-add-or-remove-show`	(TYPE)
`idlwave-shell-batch-command`	()
`idlwave-shell-bp`	(FRAME &optional DATA MODULE)
`idlwave-shell-bp-get`	(BP &optional ITEM)
`idlwave-shell-bp-query`	(&optional NO-SHOW)
`idlwave-shell-break-here`	(&optional COUNT CMD CONDITION DISABLED NO-SHOW)
`idlwave-shell-break-in`	()
`idlwave-shell-break-this-module`	(&optional ARG)
`idlwave-shell-buffer`	()
`idlwave-shell-char-mode-loop`	(&optional NO-ERROR)
`idlwave-shell-check-compiled-and-display`	()
`idlwave-shell-cleanup`	()
`idlwave-shell-clear-all-bp`	()
`idlwave-shell-clear-bp`	(BP &optional NO-QUERY)
`idlwave-shell-clear-current-bp`	()
`idlwave-shell-closeall`	()
`idlwave-shell-comint-filter`	(PROCESS STRING)
`idlwave-shell-command-failure`	()
`idlwave-shell-complete`	(&optional ARG)
`idlwave-shell-complete-execcomm-help`	(MODE WORD)
`idlwave-shell-complete-filename`	()
`idlwave-shell-cont`	(&optional NO-SHOW)
`idlwave-shell-current-frame`	()
`idlwave-shell-current-module`	()
`idlwave-shell-define-key-both`	(KEY HOOK)
`idlwave-shell-delete-temp-files`	()
`idlwave-shell-display-level-in-calling-stack`	(&optional HIDE)
`idlwave-shell-display-line`	(FRAME &optional COL DEBUG)
`idlwave-shell-down-or-history`	(&optional ARG)
`idlwave-shell-edit-default-command-line`	()
`idlwave-shell-electric-debug-mode`	(&optional ARG)
`idlwave-shell-enable-all-bp`	(&optional ENABLE NO-UPDATE BPL)
`idlwave-shell-evaluate-region`	(BEG END &optional N)
`idlwave-shell-examine`	(HELP)
`idlwave-shell-examine-display`	()
`idlwave-shell-examine-highlight`	()
`idlwave-shell-examine-select`	(EVENT)
`idlwave-shell-execute-default-command-line`	(ARG)
`idlwave-shell-executive-command`	()
`idlwave-shell-file-name`	(NAME)
`idlwave-shell-filename-string`	()
`idlwave-shell-filter`	(PROC STRING)
`idlwave-shell-filter-bp`	(&optional NO-SHOW)
`idlwave-shell-filter-directory`	()
`idlwave-shell-filter-hidden-output`	(OUTPUT)
`idlwave-shell-find-bp`	(FRAME)
`idlwave-shell-find-current-bp`	()
`idlwave-shell-get-object-class`	(APOS)
`idlwave-shell-get-path-info`	(&optional NO-WRITE)
`idlwave-shell-go`	()
`idlwave-shell-goto-frame`	(&optional FRAME)
`idlwave-shell-goto-next-bp`	()
`idlwave-shell-goto-next-error`	()
`idlwave-shell-goto-previous-bp`	()
`idlwave-shell-help-expression`	(ARG)
`idlwave-shell-help-statement`	(HELP EXPR)
`idlwave-shell-hide-p`	(TYPE &optional LIST)
`idlwave-shell-input-mode-magic`	(STRING)
`idlwave-shell-is-running`	()
`idlwave-shell-kill-buffer`	(BUF)
`idlwave-shell-list-all-bp`	()
`idlwave-shell-make-new-bp-overlay`	(&optional TYPE DISABLED)
`idlwave-shell-make-temp-file`	(PREFIX &optional DIR-FLAG SUFFIX TEXT)
`idlwave-shell-maybe-update-routine-info`	(&optional WAIT FILE)
`idlwave-shell-mode`	()
`idlwave-shell-mode-menu`	(ARG1)
`idlwave-shell-module-source-filter`	(MODULE)
`idlwave-shell-module-source-query`	(MODULE &optional TYPE)
`idlwave-shell-mouse-active-bp`	(EV)
`idlwave-shell-mouse-help`	(EVENT)
`idlwave-shell-mouse-print`	(EVENT)
`idlwave-shell-move-or-history`	(UP &optional ARG)
`idlwave-shell-move-to-bp`	(DIR)
`idlwave-shell-new-bp`	(BP)
`idlwave-shell-out`	()
`idlwave-shell-parse-line`	(STRING &optional SKIP-MAIN)
`idlwave-shell-parse-object-class`	()
`idlwave-shell-pc-frame`	()
`idlwave-shell-print`	(ARG &optional HELP EV COMPLETE-HELP-TYPE)
`idlwave-shell-quit`	(&optional ARG)
`idlwave-shell-recenter-shell-window`	(&optional ARG)
`idlwave-shell-redisplay`	(&optional HIDE)
`idlwave-shell-repair-file-name`	(FILE)
`idlwave-shell-repair-string`	(STRING)
`idlwave-shell-reset`	(&optional HIDDEN)
`idlwave-shell-resync-dirs`	()
`idlwave-shell-retall`	()
`idlwave-shell-return`	()
`idlwave-shell-routine-info-filter`	()
`idlwave-shell-run-region`	(BEG END &optional N)
`idlwave-shell-save-and-action`	(ACTION)
`idlwave-shell-save-and-batch`	()
`idlwave-shell-save-and-compile`	()
`idlwave-shell-save-and-run`	()
`idlwave-shell-scan-for-state`	()
`idlwave-shell-send-char`	(C &optional ERROR)
`idlwave-shell-send-command`	(&optional CMD PCMD HIDE PREEMPT SHOW-IF-ERROR)
`idlwave-shell-sentinel`	(PROCESS EVENT)
`idlwave-shell-set-bp`	(BP &optional NO-SHOW)
`idlwave-shell-set-bp-adjust`	(BP &optional NO-SHOW)
`idlwave-shell-set-bp-check`	(BP)
`idlwave-shell-set-bp-data`	(BP DATA)
`idlwave-shell-set-bp-in-module`	(NAME TYPE CLASS)
`idlwave-shell-shell-command`	()
`idlwave-shell-shell-frame`	()
`idlwave-shell-skip`	()
`idlwave-shell-source-frame`	()
`idlwave-shell-sources-bp`	(BP)
`idlwave-shell-sources-filter`	()
`idlwave-shell-sources-query`	()
`idlwave-shell-stack-down`	()
`idlwave-shell-stack-up`	()
`idlwave-shell-step`	(ARG)
`idlwave-shell-stepover`	(ARG)
`idlwave-shell-temp-file`	(TYPE)
`idlwave-shell-to-here`	()
`idlwave-shell-toggle-electric-debug-mode`	()
`idlwave-shell-toggle-enable-current-bp`	(&optional BP FORCE NO-UPDATE)
`idlwave-shell-toggle-toolbar`	()
`idlwave-shell-up`	()
`idlwave-shell-up-or-history`	(&optional ARG)
`idlwave-shell-update-bp`	(BP &optional COMMAND-ONLY)
`idlwave-shell-update-bp-command-only`	(BP)
`idlwave-shell-update-bp-overlays`	()
`idlwave-shell-valid-frame`	(FRAME)
`idlwave-shell-window`	(N)
`idlwave-sintern-execcomm`	(NAME &optional SET)
`idlwave-xemacs-hack-mouse-track`	(&rest ARGUMENTS)

File: idlw-shell.el.html

Defined variables (93)

Defined functions (135)

Defined faces (0)

File: `idlw-shell.el.html`