[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] Changes to idlwave.texi
|
From: |
Glenn Morris |
|
Subject: |
[Emacs-diffs] Changes to idlwave.texi |
|
Date: |
Thu, 06 Sep 2007 05:00:45 +0000 |
CVSROOT: /sources/emacs
Module name: emacs
Changes by: Glenn Morris <gm> 07/09/06 05:00:45
Index: idlwave.texi
===================================================================
RCS file: idlwave.texi
diff -N idlwave.texi
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ idlwave.texi 6 Sep 2007 05:00:45 -0000 1.1
@@ -0,0 +1,4327 @@
+\input texinfo @c -*-texinfo-*-
address@hidden %**start of header
address@hidden ../info/idlwave
address@hidden IDLWAVE User Manual
address@hidden Emacs
address@hidden
+* IDLWAVE: (idlwave). Major mode and shell for IDL files.
address@hidden direntry
address@hidden ky cp
address@hidden vr cp
address@hidden fn cp
address@hidden VERSION 6.1
address@hidden EDITION 6.1
address@hidden IDLVERSION 6.3
address@hidden NSYSROUTINES 4346
address@hidden DATE April, 2007
address@hidden AUTHOR J.D. Smith & Carsten Dominik
address@hidden MAINTAINER J.D. Smith
address@hidden %**end of header
address@hidden
+
address@hidden
+This file documents IDLWAVE, a major mode for editing IDL files with
+Emacs, and interacting with an IDL shell run as a subprocess.
+
+This is edition @value{EDITION} of the IDLWAVE User Manual for IDLWAVE
address@hidden
+
+Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005,
+ 2006, 2007 Free Software Foundation, Inc.
+
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover texts being ``A GNU
+Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
+license is included in the section entitled ``GNU Free Documentation
+License'' in the Emacs manual.
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software. Copies published by the Free
+Software Foundation raise funds for GNU development.''
+
+This document is part of a collection distributed under the GNU Free
+Documentation License. If you want to distribute this document
+separately from the collection, you can do so by adding a copy of the
+license to the document, as described in section 6 of the license.
address@hidden ifinfo
+
address@hidden
address@hidden IDLWAVE User Manual
address@hidden Emacs major mode and shell for IDL
address@hidden Edition @value{EDITION}, @value{DATE}
+
address@hidden by J.D. Smith & Carsten Dominik
address@hidden
+This is edition @value{EDITION} of the @cite{IDLWAVE User Manual} for
+IDLWAVE version @value{VERSION}, @value{DATE}.
address@hidden 2
+Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005,
+ 2006, 2007 Free Software Foundation, Inc.
address@hidden 2
address@hidden Copyright, of IDLWAVE
+Permission is granted to copy, distribute and/or modify this document
+under the terms of the GNU Free Documentation License, Version 1.2 or
+any later version published by the Free Software Foundation; with no
+Invariant Sections, with the Front-Cover texts being ``A GNU
+Manual'', and with the Back-Cover Texts as in (a) below. A copy of the
+license is included in the section entitled ``GNU Free Documentation
+License'' in the Emacs manual.
+
+(a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify
+this GNU Manual, like GNU software. Copies published by the Free
+Software Foundation raise funds for GNU development.''
+
+This document is part of a collection distributed under the GNU Free
+Documentation License. If you want to distribute this document
+separately from the collection, you can do so by adding a copy of the
+license to the document, as described in section 6 of the license.
address@hidden titlepage
address@hidden
+
address@hidden
+
address@hidden
+
address@hidden Top, Introduction, (dir), (dir)
+
+IDLWAVE is a package which supports editing source code written in the
+Interactive Data Language (IDL), and running IDL as an inferior shell.
+
address@hidden ifnottex
+
address@hidden
+* Introduction:: What IDLWAVE is, and what it is not
+* IDLWAVE in a Nutshell:: One page quick-start guide
+* Getting Started:: Tutorial
+* The IDLWAVE Major Mode:: The mode for editing IDL programs
+* The IDLWAVE Shell:: The mode for running IDL as an inferior program
+* Acknowledgements:: Who did what
+* Sources of Routine Info:: How does IDLWAVE know about routine XYZ
+* HTML Help Browser Tips::
+* Configuration Examples:: The user is king
+* Windows and MacOS:: What still works, and how
+* Troubleshooting:: When good computers turn bad
+* GNU Free Documentation License:: The license for this documentation.
+* Index:: Fast access
+
address@hidden
+ --- The Detailed Node Listing ---
+
+Getting Started (Tutorial)
+
+* Lesson I -- Development Cycle::
+* Lesson II -- Customization::
+* Lesson III -- User Catalog::
+
+The IDLWAVE Major Mode
+
+* Code Formatting:: Making code look nice
+* Routine Info:: Calling Sequence and Keyword List
+* Online Help:: One key press from source to help
+* Completion:: Completing routine names and Keywords
+* Routine Source:: Finding routines, the easy way
+* Resolving Routines:: Force the Shell to compile a routine
+* Code Templates:: Frequent code constructs
+* Abbreviations:: Abbreviations for common commands
+* Actions:: Changing case, Padding, End checking
+* Doc Header:: Inserting a standard header
+* Motion Commands:: Moving through the structure of a program
+* Misc Options:: Things that fit nowhere else
+
+Code Formatting
+
+* Code Indentation:: Reflecting the logical structure
+* Continued Statement Indentation::
+* Comment Indentation:: Special indentation for comment lines
+* Continuation Lines:: Splitting statements over lines
+* Syntax Highlighting:: Font-lock support
+* Octals and Highlighting:: Why "123 causes problems
+
+Online Help
+
+* Help with HTML Documentation::
+* Help with Source::
+
+Completion
+
+* Case of Completed Words:: CaseOFcomPletedWords
+* Object Method Completion and Class Ambiguity:: obj->Method, what?
+* Object Method Completion in the Shell::
+* Class and Keyword Inheritance:: obj->Method, _EXTRA=e
+* Structure Tag Completion:: Completing state.Tag
+
+Actions
+
+* Block Boundary Check:: Is the END statement correct?
+* Padding Operators:: Enforcing space around `=' etc
+* Case Changes:: Enforcing upper case keywords
+
+The IDLWAVE Shell
+
+* Starting the Shell:: How to launch IDL as a subprocess
+* Using the Shell:: Interactively working with the Shell
+* Commands Sent to the Shell::
+* Debugging IDL Programs::
+* Examining Variables::
+* Custom Expression Examination::
+
+Debugging IDL Programs
+
+* A Tale of Two Modes::
+* Debug Key Bindings::
+* Breakpoints and Stepping::
+* Compiling Programs::
+* Walking the Calling Stack::
+* Electric Debug Mode::
+
+Sources of Routine Info
+
+* Routine Definitions:: Where IDL Routines are defined.
+* Routine Information Sources:: So how does IDLWAVE know about...
+* Catalogs::
+* Load-Path Shadows:: Routines defined in several places
+* Documentation Scan:: Scanning the IDL Manuals
+
+Catalogs
+
+* Library Catalogs::
+* User Catalog::
+
address@hidden detailmenu
address@hidden menu
+
address@hidden Introduction, IDLWAVE in a Nutshell, Top, Top
address@hidden Introduction
address@hidden Introduction
address@hidden CORBA (Common Object Request Broker Architecture)
address@hidden Interface Definition Language
address@hidden Interactive Data Language
address@hidden cc-mode.el
address@hidden @file{idl.el}
address@hidden @file{idl-shell.el}
address@hidden Feature overview
+
+IDLWAVE is a package which supports editing source files written in
+the Interactive Data Language (IDL), and running IDL as an inferior
address@hidden can also be used
+for editing source files for the related WAVE/CL language, but with only
+limited support.}. It is a feature-rich replacement for the IDLDE
+development environment included with IDL, and uses the full power of
+Emacs to make editing and running IDL programs easier, quicker, and more
+structured.
+
+IDLWAVE consists of two main parts: a major mode for editing IDL
+source files (@code{idlwave-mode}) and a mode for running the IDL
+program as an inferior shell (@code{idlwave-shell-mode}). Although
+one mode can be used without the other, both work together closely to
+form a complete development environment. Here is a brief summary of
+what IDLWAVE does:
+
address@hidden @bullet
address@hidden
+Smart code indentation and automatic-formatting.
address@hidden
+Three level syntax highlighting support.
address@hidden
+Context-sensitive display of calling sequences and keywords for more
+than 1000 native IDL routines, extendible to any additional number of
+local routines, and already available with many pre-scanned libraries.
address@hidden
+Fast, context-sensitive online HTML help, or source-header help for
+undocumented routines.
address@hidden
+Context sensitive completion of routine names, keywords, system
+variables, class names and much more.
address@hidden
+Easy insertion of code templates and abbreviations of common constructs.
address@hidden
+Automatic corrections to enforce a variety of customizable coding
+standards.
address@hidden
+Integrity checks and auto-termination of logical blocks.
address@hidden
+Routine name space conflict search with likelihood-of-use ranking.
address@hidden
+Support for @file{imenu} (Emacs) and @file{func-menu} (XEmacs).
address@hidden
+Documentation support.
address@hidden
+Running IDL as an inferior Shell with history search, command line
+editing and all the completion and routine info capabilities present in
+IDL source buffers.
address@hidden
+Full handling of debugging with breakpoints, with interactive setting
+of break conditions, and easy stepping through code.
address@hidden
+Compilation, execution and interactive single-keystroke debugging of
+programs directly from the source buffer.
address@hidden
+Quick, source-guided navigation of the calling stack, with variable
+inspection, etc.
address@hidden
+Examining variables and expressions with a mouse click.
address@hidden
+And much, much more...
address@hidden itemize
+
address@hidden
address@hidden Screenshots
+Here are a number of screenshots showing IDLWAVE in action:
+
address@hidden @bullet
address@hidden
address@hidden://idlwave.org/screenshots/emacs_21_nav.gif,An IDLWAVE buffer}
address@hidden
address@hidden://idlwave.org/screenshots/emacs_21_keys.gif,A keyword being
completed}
address@hidden
address@hidden://idlwave.org/screenshots/emacs_21_help.gif,Online help text.}
address@hidden
address@hidden://idlwave.org/screenshots/emacs_21_ri.gif,Routine information
displayed}
address@hidden
address@hidden://idlwave.org/screenshots/emacs_21_bp.gif,Debugging code
+stopped at a breakpoint}
address@hidden itemize
address@hidden ifnottex
+
+IDLWAVE is the distant successor to the @file{idl.el} and
address@hidden files written by Chris Chase. The modes and files
+had to be renamed because of a name space conflict with CORBA's
address@hidden, defined in Emacs in the file @file{cc-mode.el}.
+
+In this manual, each section ends with a list of related user options.
+Don't be confused by the sheer number of options available --- in most
+cases the default settings are just fine. The variables are listed here
+to make sure you know where to look if you want to change anything. For
+a full description of what a particular variable does and how to
+configure it, see the documentation string of that variable (available
+with @kbd{C-h v}). Some configuration examples are also given in the
+appendix.
+
address@hidden IDLWAVE in a Nutshell, Getting Started, Introduction, Top
address@hidden IDLWAVE in a Nutshell
address@hidden Summary of important commands
address@hidden IDLWAVE in a Nutshell
address@hidden Nutshell, IDLWAVE in a
+
address@hidden Editing IDL Programs
+
address@hidden @columnfractions .15 .85
address@hidden @key{TAB}
address@hidden Indent the current line relative to context.
address@hidden @kbd{C-M-\}
address@hidden Re-indent all lines in the current region.
address@hidden @kbd{C-M-q}
address@hidden Re-indent all lines in the current routine.
address@hidden @kbd{C-u @key{TAB}}
address@hidden Re-indent all lines in the current statement.
address@hidden @address@hidden
address@hidden Start a continuation line, splitting the current line at point.
address@hidden @kbd{M-;}
address@hidden Start new comment at line beginning or after code, or (un)comment
+highlighted region.
address@hidden @kbd{M-q}
address@hidden Fill the current comment paragraph.
address@hidden @kbd{C-c ?}
address@hidden Display calling sequence and keywords for the procedure or
function call
+at point.
address@hidden @kbd{M-?}
address@hidden Load context sensitive online help for nearby routine, keyword,
etc.
address@hidden @address@hidden
address@hidden Complete a procedure name, function name or keyword in the
buffer.
address@hidden @kbd{C-c C-i}
address@hidden Update IDLWAVE's knowledge about functions and procedures.
address@hidden @kbd{C-c C-v}
address@hidden Visit the source code of a procedure/function.
address@hidden @kbd{C-u C-c C-v}
address@hidden Visit the source code of a procedure/function in this buffer.
address@hidden @kbd{C-c C-h}
address@hidden Insert a standard documentation header.
address@hidden @kbd{C-c @key{RET}}
address@hidden Insert a new timestamp and history item in the documentation
header.
address@hidden multitable
+
address@hidden Running the IDLWAVE Shell, Debugging Programs
+
address@hidden @columnfractions .15 .85
address@hidden @kbd{C-c C-s}
address@hidden Start IDL as a subprocess and/or switch to the shell buffer.
address@hidden @key{Up}, @kbd{M-p}
address@hidden Cycle back through IDL command history.
address@hidden @key{Down},@kbd{M-n}
address@hidden Cycle forward.
address@hidden @address@hidden
address@hidden Complete a procedure name, function name or keyword in the shell
buffer.
address@hidden @kbd{C-c C-d C-c}
address@hidden Save and compile the source file in the current buffer.
address@hidden @kbd{C-c C-d C-e}
address@hidden Compile and run the current region.
address@hidden @kbd{C-c C-d C-x}
address@hidden Go to next syntax error.
address@hidden @kbd{C-c C-d C-v}
address@hidden Switch to electric debug mode.
address@hidden @kbd{C-c C-d C-b}
address@hidden Set a breakpoint at the nearest viable source line.
address@hidden @kbd{C-c C-d C-d}
address@hidden Clear the nearest breakpoint.
address@hidden @kbd{C-c C-d [}
address@hidden Go to the previous breakpoint.
address@hidden @kbd{C-c C-d ]}
address@hidden Go to the next breakpoint.
address@hidden @kbd{C-c C-d C-p}
address@hidden Print the value of the expression near point in IDL.
address@hidden multitable
+
address@hidden Commonly used Settings in @file{.emacs}
address@hidden
+;; Change the indentation preferences
+;; Start autoloading routine info after 2 idle seconds
+(setq idlwave-init-rinfo-when-idle-after 2)
+;; Pad operators with spaces
+(setq idlwave-do-actions t
+ idlwave-surround-by-blank t)
+;; Syntax Highlighting
+(add-hook 'idlwave-mode-hook 'turn-on-font-lock)
+;; Automatically start the shell when needed
+(setq idlwave-shell-automatic-start t)
+;; Bind debugging commands with CONTROL and SHIFT modifiers
+(setq idlwave-shell-debug-modifiers '(control shift))
address@hidden lisp
+
address@hidden
+<A NAME="TUTORIAL"></A>
address@hidden html
+
address@hidden Getting Started, The IDLWAVE Major Mode, IDLWAVE in a Nutshell,
Top
address@hidden Getting Started (Tutorial)
address@hidden Quick-Start
address@hidden Tutorial
address@hidden Getting Started
+
address@hidden
+* Lesson I -- Development Cycle::
+* Lesson II -- Customization::
+* Lesson III -- User Catalog::
address@hidden menu
+
address@hidden Lesson I -- Development Cycle, Lesson II -- Customization,
Getting Started, Getting Started
address@hidden Lesson I: Development Cycle
+
+The purpose of this tutorial is to guide you through a very basic
+development cycle using IDLWAVE. We will paste a simple program into
+a buffer and use the shell to compile, debug and run it. On the way
+we will use many of the important IDLWAVE commands. Note, however,
+that IDLWAVE has many more capabilities than covered here, which can
+be discovered by reading the entire manual, or hovering over the
+shoulder of your nearest IDLWAVE guru for a few days.
+
+It is assumed that you have access to Emacs or XEmacs with the full
+IDLWAVE package including online help. We also assume that you are
+familiar with Emacs and can read the nomenclature of key presses in
+Emacs (in particular, @kbd{C} stands for @key{CONTROL} and @kbd{M} for
address@hidden (often the @key{ALT} key carries this functionality)).
+
+Open a new source file by typing:
+
address@hidden
address@hidden C-f tutorial.pro @key{RET}}
address@hidden example
+
+A buffer for this file will pop up, and it should be in IDLWAVE mode,
+indicated in the mode line just below the editing window. Also, the
+menu bar should contain @samp{IDLWAVE}.
+
+Now cut-and-paste the following code, also available as
address@hidden in the IDLWAVE distribution.
+
address@hidden
+function daynr,d,m,y
+ ;; compute a sequence number for a date
+ ;; works 1901-2099.
+ if y lt 100 then y = y+1900
+ if m le 2 then delta = 1 else delta = 0
+ m1 = m + delta*12 + 1
+ y1 = y * delta
+ return, d + floor(m1*30.6)+floor(y1*365.25)+5
+end
+
+function weekday,day,month,year
+ ;; compute weekday number for date
+ nr = daynr(day,month,year)
+ return, nr mod 7
+end
+
+pro plot_wday,day,month
+ ;; Plot the weekday of a date in the first 10 years of this century.
+ years = 2000,+indgen(10)
+ wdays = intarr(10)
+ for i=0,n_elements(wdays)-1 do begin
+ wdays[i] = weekday(day,month,years[i])
+ end
+ plot,years,wdays,YS=2,YT="Wday (0=Sunday)"
+end
address@hidden example
+
+The indentation probably looks funny, since it's different from the
+settings you use, so use the @key{TAB} key in each line to
+automatically line it up (or, more quickly, @emph{select} the entire
+buffer with @kbd{C-x h}, and indent the whole region with
address@hidden). Notice how different syntactical elements are
+highlighted in different colors, if you have set up support for
+font-lock.
+
+Let's check out two particular editing features of IDLWAVE. Place the
+cursor after the @code{end} statement of the @code{for} loop and press
address@hidden IDLWAVE blinks back to the beginning of the block and
+changes the generic @code{end} to the specific @code{endfor}
+automatically (as long as the variable @code{idlwave-expand-generic-end}
+is turned on --- @pxref{Lesson II -- Customization}). Now place the
+cursor in any line you would like to split and press @address@hidden
+The line is split at the cursor position, with the continuation @samp{$}
+and indentation all taken care of. Use @kbd{C-/} to undo the last
+change.
+
+The procedure @code{plot_wday} is supposed to plot the day of the week
+of a given date for the first 10 years of the 21st century. As in
+most code, there are a few bugs, which we are going to use IDLWAVE to
+help us fix.
+
+First, let's launch the IDLWAVE shell. You do this with the command
address@hidden C-s}. The Emacs window will split or another window will popup
+to display IDL running in a shell interaction buffer. Type a few
+commands like @code{print,!PI} to convince yourself that you can work
+there just as well as in a terminal, or the IDLDE. Use the arrow keys
+to cycle through your command history. Are we having fun now?
+
+Now go back to the source window and type @kbd{C-c C-d C-c} to compile
+the program. If you watch the shell buffer, you see that IDLWAVE types
address@hidden "tutorial.pro"} for you. But the compilation fails because
+there is a comma in the line @samp{years=...}. The line with the error
+is highlighted and the cursor positioned at the error, so remove the
+comma (you should only need to hit @kbd{Delete}!). Compile again, using
+the same keystrokes as before. Notice that the file is automatically
+saved for you. This time everything should work fine, and you should
+see the three routines compile.
+
+Now we want to use the command to plot the day of the week on January
+1st. We could type the full command ourselves, but why do that? Go
+back to the shell window, type @samp{plot_} and hit @key{TAB}. After
+a bit of a delay (while IDLWAVE initializes its routine info database,
+if necessary), the window will split to show all procedures it knows
+starting with that string, and @address@hidden should be one of
+them. Saving the buffer alerted IDLWAVE about this new routine.
+Click with the middle mouse button on @code{plot_wday} and it will be
+copied to the shell buffer, or if you prefer, add @samp{w} to
address@hidden to make it unambiguous (depending on what other routines
+starting with @samp{plot_} you have installed on your system), hit
address@hidden again, and the full routine name will be completed. Now
+provide the two arguments:
+
address@hidden
+plot_wday,1,1
address@hidden example
+
address@hidden and press @key{RET}. This fails with an error message telling
+you the @code{YT} keyword to plot is ambiguous. What are the allowed
+keywords again? Go back to the source window and put the cursor into
+the `plot' line and press @kbd{C-c ?}. This shows the routine info
+window for the plot routine, which contains a list of keywords, along
+with the argument list. Oh, we wanted @code{YTITLE}. Fix that up.
+Recompile with @kbd{C-c C-d C-c}. Jump back into the shell with
address@hidden C-s}, press the @key{UP} arrow to recall the previous command
+and execute again.
+
+This time we get a plot, but it is pretty ugly --- the points are all
+connected with a line. Hmm, isn't there a way for @code{plot} to use
+symbols instead? What was that keyword? Position the cursor on the
+plot line after a comma (where you'd normally type a keyword), and hit
address@hidden@key{Tab}}. A long list of plot's keywords appears. Aha,
+there it is, @code{PSYM}. Middle click to insert it. An @samp{=}
+sign is included for you too. Now what were the values of @code{PSYM}
+supposed to be? With the cursor on or after the keyword, press
address@hidden for online help (alternatively, you could have right clicked
+on the colored keyword itself in the completion list). A browser will
+pop up showing the HTML documentation for the @code{PYSM} keyword.
+OK, let's use diamonds=4. Fix this, recompile (you know the command
+by now: @kbd{C-c C-d C-c}), go back to the shell (if it's vanished,
+you know what to do: @kbd{C-c C-s}) and execute again. Now things
+look pretty good.
+
+Let's try a different day --- how about April fool's day?
+
address@hidden
+plot_wday,1,4
address@hidden example
+
+Oops, this looks very wrong. All April Fool's days cannot be Fridays!
+We've got a bug in the program, perhaps in the @code{daynr} function.
+Let's put a breakpoint on the last line there. Position the cursor on
+the @samp{return, d+...} line and press @kbd{C-c C-d C-b}. IDL sets a
+breakpoint (as you see in the shell window), and the break line is
+indicated. Back to the shell buffer, re-execute the previous command.
+IDL stops at the line with the breakpoint. Now hold down the SHIFT
+key and click with the middle mouse button on a few variables there:
address@hidden, @samp{y}, @samp{m}, @samp{y1}, etc. Maybe @code{d} isn't
+the correct type. CONTROL-SHIFT middle-click on it for help. Well,
+it's an integer, so that's not the problem. Aha, @samp{y1} is zero,
+but it should be the year, depending on delta. Shift click
address@hidden to see that it's 0. Below, we see the offending line:
address@hidden the multiplication should have been a minus sign!
+Hit @kbd{q} to exit the debugging mode, and fix the line to read:
+
address@hidden
+y1 = y - delta
address@hidden example
+
+Now remove all breakpoints: @kbd{C-c C-d C-a}. Recompile and rerun the
+command. Everything should now work fine. How about those leap years?
+Change the code to plot 100 years and see that every 28 years, the
+sequence of weekdays repeats.
+
address@hidden Lesson II -- Customization, Lesson III -- User Catalog, Lesson
I -- Development Cycle, Getting Started
address@hidden Lesson II: Customization
+
+Emacs is probably the most customizable piece of software ever written,
+and it would be a shame if you did not make use of this to adapt IDLWAVE
+to your own preferences. Customizing Emacs or IDLWAVE is accomplished
+by setting Lisp variables in the @file{.emacs} file in your home
+directory --- but do not be dismayed; for the most part, you can just
+copy and work from the examples given here.
+
+Let's first use a boolean variable. These are variables which you turn
+on or off, much like a checkbox. A value of @samp{t} means on, a value
+of @samp{nil} means off. Copy the following line into your
address@hidden file, exit and restart Emacs.
+
address@hidden
+(setq idlwave-reserved-word-upcase t)
address@hidden lisp
+
+When this option is turned on, each reserved word you type into an IDL
+source buffer will be converted to upper case when you press @key{SPC}
+or @key{RET} right after the word. Try it out! @samp{if} changes to
address@hidden, @samp{begin} to @samp{BEGIN}. If you don't like this
+behavior, remove the option again from your @file{.emacs} file and
+restart Emacs.
+
+You likely have your own indentation preferences for IDL code. For
+example, some may prefer to indent the main block of an IDL program
+slightly from the margin and use only 3 spaces as indentation between
address@hidden and @code{END}. Try the following lines in @file{.emacs}:
+
address@hidden
+(setq idlwave-main-block-indent 1)
+(setq idlwave-block-indent 3)
+(setq idlwave-end-offset -3)
address@hidden lisp
+
+Restart Emacs, and re-indent the program we developed in the first part
+of this tutorial with @kbd{C-c h} and @kbd{C-M-\}. You may want to keep
+these lines in @file{.emacs}, with values adjusted to your likings. If
+you want to get more information about any of these variables, type,
+e.g., @kbd{C-h v idlwave-main-block-indent @key{RET}}. To find which
+variables can be customized, look for items marked @samp{User Option:}
+throughout this manual.
+
+If you cannot seem to master this Lisp customization in @file{.emacs},
+there is another, more user-friendly way to customize all the IDLWAVE
+variables. You can access it through the IDLWAVE menu in one of the
address@hidden buffers, menu item @code{Customize->Browse IDLWAVE
+Group}. Here you'll be presented with all the various variables grouped
+into categories. You can navigate the hierarchy (e.g. @samp{IDLWAVE
+Code Formatting->Idlwave Abbrev And Indent Action->Idlwave Expand
+Generic End} to turn on @code{END} expansion), read about the variables,
+change them, and `Save for Future Sessions'. Few of these variables
+need customization, but you can exercise considerable control over
+IDLWAVE's functionality with them.
+
+You may also find the key bindings used for the debugging commands too
+long and complicated. Often we have heard complaints along the lines
+of, ``Do I really have to go through the finger gymnastics of @kbd{C-c
+C-d C-c} to run a simple command?'' Due to Emacs rules and
+conventions, shorter bindings cannot be set by default, but you can
+easily enable them. First, there is a way to assign all debugging
+commands in a single sweep to another simpler combination. The only
+problem is that we have to use something which Emacs does not need for
+other important commands. One good option is to execute debugging
+commands by holding down @key{CONTROL} and @key{SHIFT} while pressing
+a single character: @kbd{C-S-b} for setting a breakpoint, @kbd{C-S-c}
+for compiling the current source file, @kbd{C-S-a} for deleting all
+breakpoints (try it, it's easier). You can enable this with:
+
address@hidden
+(setq idlwave-shell-debug-modifiers '(shift control))
address@hidden lisp
+
address@hidden If you have a special keyboard with, for example, a
address@hidden key, you could even shorten that:
+
address@hidden
+(setq idlwave-shell-debug-modifiers '(super))
address@hidden lisp
+
address@hidden to get compilation on @kbd{S-c}. Often, a modifier key like
address@hidden or @key{HYPER} is bound or can be bound to an otherwise
+unused key on your keyboard --- consult your system documentation.
+
+You can also assign specific commands to keys. This you must do in the
address@hidden, a special function which is run when a new IDLWAVE
+buffer gets set up. The possibilities for key customization are
+endless. Here we set function keys f4-f8 to common debugging commands.
+
address@hidden
+;; First for the source buffer
+(add-hook 'idlwave-mode-hook
+ (lambda ()
+ (local-set-key [f4] 'idlwave-shell-retall)
+ (local-set-key [f5] 'idlwave-shell-break-here)
+ (local-set-key [f6] 'idlwave-shell-clear-current-bp)
+ (local-set-key [f7] 'idlwave-shell-cont)
+ (local-set-key [f8] 'idlwave-shell-clear-all-bp)))
+;; Then for the shell buffer
+(add-hook 'idlwave-shell-mode-hook
+ (lambda ()
+ (local-set-key [f4] 'idlwave-shell-retall)
+ (local-set-key [f5] 'idlwave-shell-break-here)
+ (local-set-key [f6] 'idlwave-shell-clear-current-bp)
+ (local-set-key [f7] 'idlwave-shell-cont)
+ (local-set-key [f8] 'idlwave-shell-clear-all-bp)))
address@hidden lisp
+
address@hidden Lesson III -- User Catalog, , Lesson II -- Customization,
Getting Started
address@hidden Lesson III: User and Library Catalogs
+
+We have already used the routine info display in the first part of this
+tutorial. This was the invoked using @kbd{C-c ?}, and displays
+information about the IDL routine near the cursor position. Wouldn't it
+be nice to have the same kind of information available for your own
+routines and for the huge amount of code in major libraries like JHUPL
+or the IDL-Astro library? In many cases, you may already have this
+information. Files named @file{.idlwave_catalog} in library directories
+contain scanned information on the routines in that directory; many
+popular libraries ship with these ``library catalogs'' pre-scanned.
+Users can scan their own routines in one of two ways: either using the
+supplied tool to scan directories and build their own
address@hidden files, or using the built-in method to create a
+single ``user catalog'', which we'll show here. @xref{Catalogs}, for
+more information on choosing which method to use.
+
+To build a user catalog, select @code{Routine Info/Select Catalog
+Directories} from the IDLWAVE entry in the menu bar. If necessary,
+start the shell first with @kbd{C-c C-s} (@pxref{Starting the Shell}).
+IDLWAVE will find out about the IDL @code{!PATH} variable and offer a
+list of directories on the path. Simply select them all (or whichever
+you want --- directories with existing library catalogs will not be
+selected by default) and click on the @samp{Scan&Save} button. Then
+go for a cup of coffee while IDLWAVE collects information for each and
+every IDL routine on your search path. All this information is
+written to the file @file{.idlwave/idlusercat.el} in your home
+directory and will from now on automatically load whenever you use
+IDLWAVE. You may find it necessary to rebuild the catalog on occasion
+as your local libraries change, or build a library catalog for those
+directories instead. Invoke routine info (@kbd{C-c ?}) or completion
+(@address@hidden) on any routine or partial routine name you know to
+be located in the library. E.g., if you have scanned the IDL-Astro
+library:
+
address@hidden
+ address@hidden@key{TAB}}
address@hidden example
+
+expands to `readfits('. Then try
+
address@hidden
+ a=readfits(@key{C-c ?}
address@hidden example
+
+and you get:
+
address@hidden
+Usage: Result = READFITS(filename, header, heap)
+...
address@hidden example
+
+I hope you made it until here. Now you are set to work with IDLWAVE.
+On the way you will want to change other things, and to learn more
+about the possibilities not discussed in this short tutorial. Read
+the manual, look at the documentation strings of interesting variables
+(with @kbd{C-h v idlwave<-variable-name> @key{RET}}) and ask the
+remaining questions on the newsgroup @code{comp.lang.idl-pvwave}.
+
address@hidden The IDLWAVE Major Mode, The IDLWAVE Shell, Getting Started, Top
address@hidden The IDLWAVE Major Mode
address@hidden IDLWAVE major mode
address@hidden Major mode, @code{idlwave-mode}
+
+The IDLWAVE major mode supports editing IDL source files. In this
+chapter we describe the main features of the mode and how to customize
+them.
+
address@hidden
+* Code Formatting:: Making code look nice
+* Routine Info:: Calling Sequence and Keyword List
+* Online Help:: One key press from source to help
+* Completion:: Completing routine names and Keywords
+* Routine Source:: Finding routines, the easy way
+* Resolving Routines:: Force the Shell to compile a routine
+* Code Templates:: Frequent code constructs
+* Abbreviations:: Abbreviations for common commands
+* Actions:: Changing case, Padding, End checking
+* Doc Header:: Inserting a standard header
+* Motion Commands:: Moving through the structure of a program
+* Misc Options:: Things that fit nowhere else
address@hidden menu
+
address@hidden Code Formatting, Routine Info, The IDLWAVE Major Mode, The
IDLWAVE Major Mode
address@hidden Code Formatting
address@hidden Code formatting
address@hidden Formatting, of code
+
address@hidden
+* Code Indentation:: Reflecting the logical structure
+* Continued Statement Indentation::
+* Comment Indentation:: Special indentation for comment lines
+* Continuation Lines:: Splitting statements over lines
+* Syntax Highlighting:: Font-lock support
+* Octals and Highlighting:: Why "123 causes problems
address@hidden menu
+
+The IDL language, with its early roots in FORTRAN, modern
+implementation in C, and liberal borrowing of features of many vector
+and other languages along its 25+ year history, has inherited an
+unusual mix of syntax elements. Left to his or her own devices, a
+novice IDL programmer will often conjure code which is very difficult
+to read and impossible to adapt. Much can be gleaned from studying
+available IDL code libraries for coding style pointers, but, due to
+the variety of IDL syntax elements, replicating this style can be
+challenging at best. Luckily, IDLWAVE understands the structure of
+IDL code very well, and takes care of almost all formatting issues for
+you. After configuring it to match your coding standards, you can
+rely on it to help keep your code neat and organized.
+
+
address@hidden Code Indentation, Continued Statement Indentation, Code
Formatting, Code Formatting
address@hidden Code Indentation
address@hidden Code indentation
address@hidden Indentation
+
+Like all Emacs programming modes, IDLWAVE performs code indentation.
+The @key{TAB} key indents the current line relative to context.
address@hidden insert a newline and indents the new line. The indentation is
+governed by a number of variables. IDLWAVE indents blocks (between
address@hidden/@code{FUNCTION}/@code{BEGIN} and @code{END}), and
+continuation lines.
+
address@hidden Foreign code, adapting
address@hidden Indentation, of foreign code
address@hidden C-M-\
+To re-indent a larger portion of code (e.g. when working with foreign
+code written with different conventions), use @kbd{C-M-\}
+(@code{indent-region}) after marking the relevant code. Useful marking
+commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current
+subprogram). The command @kbd{C-M-q} reindents the entire current
+routine. @xref{Actions}, for information how to impose additional
+formatting conventions on foreign code.
+
address@hidden idlwave-main-block-indent (@code{2})
+Extra indentation for the main block of code. That is the block between
+the FUNCTION/PRO statement and the END statement for that program
+unit.
address@hidden defopt
+
address@hidden idlwave-block-indent (@code{3})
+Extra indentation applied to block lines. If you change this, you
+probably also want to change @code{idlwave-end-offset}.
address@hidden defopt
+
address@hidden idlwave-end-offset (@code{-3})
+Extra indentation applied to block END lines. A value equal to negative
address@hidden will make END lines line up with the block
+BEGIN lines.
address@hidden defopt
+
address@hidden Continued Statement Indentation, Comment Indentation, Code
Indentation, Code Formatting
address@hidden Continued Statement Indentation
address@hidden Indentation, continued statement
address@hidden Continued statement indentation
+Continuation lines (following a line ending with @code{$}) can receive a
+fixed indentation offset from the main level, but in several situations
+IDLWAVE can use a special form of indentation which aligns continued
+statements more naturally. Special indentation is calculated for
+continued routine definition statements and calls, enclosing parentheses
+(like function calls, structure/class definitions, explicit structures
+or lists, etc.), and continued assignments. An attempt is made to line
+up with the first non-whitespace character after the relevant opening
+punctuation mark (@code{,},@code{(},@address@hidden,@code{[},@code{=}). For
+lines without any non-comment characters on the line with the opening
+punctuation, the continued line(s) are aligned just past the
+punctuation. An example:
+
address@hidden
+function foo, a, b, $
+ c, d
+ bar = sin( a + b + $
+ c + d)
+end
address@hidden example
address@hidden
+
+The only drawback to this special continued statement indentation is
+that it consumes more space, e.g., for long function names or left hand
+sides of an assignment:
+
address@hidden
+function thisfunctionnameisverylongsoitwillleavelittleroom, a, b, $
+ c, d
address@hidden example
+
+You can instruct IDLWAVE when to avoid using this special continuation
+indentation by setting the variable
address@hidden, which specifies the
+maximum additional indentation beyond the basic indent to be
+tolerated, otherwise defaulting to a fixed-offset from the enclosing
+indent (the size of which offset is set in
address@hidden). As a special case, continuations
+of routine calls without any arguments or keywords will @emph{not}
+align the continued line, under the assumption that you continued
+because you needed the space.
+
+Also, since the indentation level can be somewhat dynamic in continued
+statements with special continuation indentation, especially if
address@hidden is small, the key
address@hidden @key{TAB}} will re-indent all lines in the current statement.
+Note that @code{idlwave-indent-to-open-paren}, if address@hidden,
+overrides the @code{idlwave-max-extra-continuation-indent} limit, for
+parentheses only, forcing them always to line up.
+
+
address@hidden idlwave-continuation-indent (@code{2})
+Extra indentation applied to normal continuation lines.
address@hidden defopt
+
address@hidden idlwave-max-extra-continuation-indent (@code{20})
+The maximum additional indentation (over the basic continuation-indent)
+that will be permitted for special continues. To effectively disable
+special continuation indentation, set to @code{0}. To enable it
+constantly, set to a large number (like @code{100}). Note that the
+indentation in a long continued statement never decreases from line to
+line, outside of nested parentheses statements.
address@hidden defopt
+
address@hidden idlwave-indent-to-open-paren (@code{t})
address@hidden means indent continuation lines to innermost open
+parenthesis, regardless of whether the
address@hidden limit is satisfied.
address@hidden defopt
+
address@hidden Comment Indentation, Continuation Lines, Continued Statement
Indentation, Code Formatting
address@hidden Comment Indentation
address@hidden Comment indentation
address@hidden Hanging paragraphs
address@hidden Paragraphs, filling
address@hidden Paragraphs, hanging
+
+In IDL, lines starting with a @samp{;} are called @emph{comment lines}.
+Comment lines are indented as follows:
+
address@hidden @columnfractions .1 .90
address@hidden @code{;;;}
address@hidden The indentation of lines starting with three semicolons remains
+unchanged.
address@hidden @code{;;}
address@hidden Lines starting with two semicolons are indented like the
surrounding code.
address@hidden @code{;}
address@hidden Lines starting with a single semicolon are indented to a minimum
column.
address@hidden multitable
+
address@hidden
+The indentation of comments starting in column 0 is never changed.
+
address@hidden idlwave-no-change-comment
+The indentation of a comment starting with this regexp will not be
+changed.
address@hidden defopt
+
address@hidden idlwave-begin-line-comment
+A comment anchored at the beginning of line.
address@hidden defopt
+
address@hidden idlwave-code-comment
+A comment that starts with this regexp is indented as if it is a part of
+IDL code.
address@hidden defopt
+
address@hidden Continuation Lines, Syntax Highlighting, Comment Indentation,
Code Formatting
address@hidden Continuation Lines and Filling
address@hidden Continuation lines
address@hidden Line splitting
address@hidden String splitting
address@hidden Splitting, of lines
+
address@hidden address@hidden
+In IDL, a newline character terminates a statement unless preceded by a
address@hidden If you would like to start a continuation line, use
address@hidden@key{RET}}, which calls the command @code{idlwave-split-line}.
+It inserts the continuation character @samp{$}, terminates the line and
+indents the new line. The command @address@hidden can also be invoked
+inside a string to split it at that point, in which case the @samp{+}
+concatenation operator is used.
+
address@hidden Filling
address@hidden @code{auto-fill-mode}
address@hidden Hanging paragraphs
+When filling comment paragraphs, IDLWAVE overloads the normal filling
+functions and uses a function which creates the hanging paragraphs
+customary in IDL routine headers. When @code{auto-fill-mode} is turned
+on (toggle with @kbd{C-c C-a}), comments will be auto-filled. If the
+first line of a paragraph contains a match for
address@hidden (a dash-space by default), subsequent
+lines are positioned to line up after it, as in the following example.
+
address@hidden
address@hidden
+;=================================
+; x - an array containing
+; lots of interesting numbers.
+;
+; y - another variable where
+; a hanging paragraph is used
+; to describe it.
+;=================================
address@hidden group
address@hidden example
+
address@hidden M-q
+You can also refill a comment at any time paragraph with @kbd{M-q}.
+Comment delimiting lines as in the above example, consisting of one or
+more @samp{;} followed by one or more of the characters @samp{+=-_*},
+are kept in place, as is.
+
address@hidden idlwave-fill-comment-line-only (@code{t})
address@hidden means auto fill will only operate on comment lines.
address@hidden defopt
+
address@hidden idlwave-auto-fill-split-string (@code{t})
address@hidden means auto fill will split strings with the IDL @samp{+}
+operator.
address@hidden defopt
+
address@hidden idlwave-split-line-string (@code{t})
address@hidden means @code{idlwave-split-line} will split strings with
address@hidden
address@hidden defopt
+
address@hidden idlwave-hanging-indent (@code{t})
address@hidden means comment paragraphs are indented under the hanging
+indent given by @code{idlwave-hang-indent-regexp} match in the first
+line of the paragraph.
address@hidden defopt
+
address@hidden idlwave-hang-indent-regexp (@code{"- "})
+Regular expression matching the position of the hanging indent
+in the first line of a comment paragraph.
address@hidden defopt
+
address@hidden idlwave-use-last-hang-indent (@code{nil})
address@hidden means use last match on line for
address@hidden
address@hidden defopt
+
address@hidden Syntax Highlighting, Octals and Highlighting, Continuation
Lines, Code Formatting
address@hidden Syntax Highlighting
address@hidden Syntax highlighting
address@hidden Highlighting of syntax
address@hidden Font lock
+
+Highlighting of keywords, comments, strings etc. can be accomplished
+with @code{font-lock}. If you are using @code{global-font-lock-mode}
+(in Emacs), or have @code{font-lock} turned on in any other buffer in
+XEmacs, it should also automatically work in IDLWAVE buffers. If you'd
+prefer invoking font-lock individually by mode, you can enforce it in
address@hidden with the following line in your @file{.emacs}:
+
address@hidden
+(add-hook 'idlwave-mode-hook 'turn-on-font-lock)
address@hidden lisp
+
address@hidden IDLWAVE supports 3 increasing levels of syntax highlighting.
+The variable @code{font-lock-maximum-decoration} determines which level
+is selected. Individual categories of special tokens can be selected
+for highlighting using the variable
address@hidden
+
address@hidden idlwave-default-font-lock-items
+Items which should be fontified on the default fontification level
+2.
address@hidden defopt
+
address@hidden Octals and Highlighting, , Syntax Highlighting, Code Formatting
address@hidden Octals and Highlighting
address@hidden Syntax highlighting, Octals
address@hidden Highlighting of syntax, Octals
+
+A rare syntax highlighting problem results from an extremely unfortunate
+notation for octal numbers in IDL: @code{"123}. This unpaired quotation
+mark is very difficult to parse, given that it can be mixed on a single
+line with any number of strings. Emacs will incorrectly identify this
+as a string, and the highlighting of following lines of code can be
+distorted, since the string is never terminated.
+
+One solution to this involves terminating the mistakenly identified
+string yourself by providing a closing quotation mark in a comment:
+
address@hidden
+ string("305B) + $ ;" <--- for font-lock
+ ' is an Angstrom.'
address@hidden example
+
address@hidden A far better solution is to abandon this notation for octals
+altogether, and use the more sensible alternative IDL provides:
+
address@hidden
+ string('305'OB) + ' is an Angstrom.'
address@hidden example
+
address@hidden This simultaneously solves the font-lock problem and is more
+consistent with the notation for hexadecimal numbers, e.g. @code{'C5'XB}.
+
address@hidden Routine Info, Online Help, Code Formatting, The IDLWAVE Major
Mode
address@hidden Routine Info
address@hidden Routine info
address@hidden Updating routine info
address@hidden Scanning buffers for routine info
address@hidden Buffers, scanning for routine info
address@hidden Shell, querying for routine info
+
address@hidden C-c C-i
+IDL comes bundled with more than one thousand procedures, functions
+and object methods, and large libraries typically contain hundreds or
+even thousands more (each with a few to tens of keywords and
+arguments). This large command set can make it difficult to remember
+the calling sequence and keywords for the routines you use, but
+IDLWAVE can help. It builds up routine information from a wide
+variety of sources; IDLWAVE in fact knows far more about the
address@hidden routines on your system than IDL itself! It maintains a
+list of all built-in routines, with calling sequences and
address@hidden list is created by scanning the IDL manuals and
+might contain (very few) errors. Please report any errors to the
+maintainer, so that they can be fixed.}. It also scans Emacs buffers
+for routine definitions, queries the IDLWAVE-Shell for information
+about routines currently compiled there, and automatically locates
+library and user-created catalogs. This information is updated
+automatically, and so should usually be current. To force a global
+update and refresh the routine information, use @kbd{C-c C-i}
+(@code{idlwave-update-routine-info}).
+
address@hidden C-c ?
+To display the information about a routine, press @kbd{C-c ?}, which
+calls the command @code{idlwave-routine-info}. When the current cursor
+position is on the name or in the argument list of a procedure or
+function, information will be displayed about the routine. For example,
+consider the indicated cursor positions in the following line:
+
address@hidden
+plot,x,alog(x+5*sin(x) + 2),
+ | | | | | | | |
+ 1 2 3 4 5 6 7 8
address@hidden example
+
address@hidden Default routine, for info and help
+On positions 1,2 and 8, information about the @samp{plot} procedure will
+be shown. On positions 3,4, and 7, the @samp{alog} function will be
+described, while positions 5 and 6 will investigate the @samp{sin}
+function.
+
+When you ask for routine information about an object method, and the
+method exists in several classes, IDLWAVE queries for the class of the
+object, unless the class is already known through a text property on the
address@hidden>} operator (@pxref{Object Method Completion and Class
+Ambiguity}), or by having been explicitly included in the call
+(e.g. @code{a->myclass::Foo}).
+
address@hidden Calling sequences
address@hidden Keywords of a routine
address@hidden Routine source information
+The description displayed contains the calling sequence, the list of
+keywords and the source location of this routine. It looks like this:
+
address@hidden
+Usage: XMANAGER, NAME, ID
+Keywords: BACKGROUND CATCH CLEANUP EVENT_HANDLER GROUP_LEADER
+ JUST_REG MODAL NO_BLOCK
+Source: SystemLib [LCSB] /soft1/idl53/lib/xmanager.pro
address@hidden example
+
address@hidden Categories, of routines
address@hidden Load-path shadows
address@hidden Shadows, load-path
address@hidden IDL variable @code{!PATH}
address@hidden @code{!PATH}, IDL variable
address@hidden IDL variable @code{!DIR}
address@hidden @code{!DIR}, IDL variable
+
+If a definition of this routine exists in several files accessible to
+IDLWAVE, several @samp{Source} lines will point to the different
+files. This may indicate that your routine is shadowing a system
+library routine, which may or may not be what you want
+(@pxref{Load-Path Shadows}). The information about the calling
+sequence and keywords is derived from the first source listed.
+Library routines are available only if you have scanned your local IDL
+directories or are using pre-scanned libraries (@pxref{Catalogs}).
+The source entry consists of a @emph{source category}, a set of
address@hidden and the path to the @emph{source file}. The following
+default categories exist:
+
address@hidden @columnfractions .15 .85
address@hidden @i{System}
address@hidden A system routine of unknown origin. When the system library has
+been scanned as part of a catalog (@pxref{Catalogs}), this category
+will automatically split into the next two.
address@hidden @i{Builtin}
address@hidden A builtin system routine with no source code available.
address@hidden @i{SystemLib}
address@hidden A library system routine in the official lib directory
@file{!DIR/lib}.
address@hidden @i{Obsolete}
address@hidden A library routine in the official lib directory
@file{!DIR/lib/obsolete}.
address@hidden @i{Library}
address@hidden A routine in a file on IDL's search path @code{!PATH}.
address@hidden @i{Other}
address@hidden Any other routine with a file not known to be on the search path.
address@hidden @i{Unresolved}
address@hidden An otherwise unknown routine the shell lists as unresolved
+(referenced, but not compiled).
address@hidden multitable
+
+Any routines discovered in library catalogs (@pxref{Library
+Catalogs}), will display the category assigned during creation,
+e.g. @samp{NasaLib}. For routines not discovered in this way, you can
+create additional categories based on the routine's filename using the
+variable @code{idlwave-special-lib-alist}.
+
address@hidden Flags, in routine info
address@hidden Duplicate routines
address@hidden Multiply defined routines
address@hidden Routine definitions, multiple
+The flags @code{[LCSB]} indicate the source of the information IDLWAVE
+has regarding the file: from a library catalog (@address@hidden),
+from a user catalog (@address@hidden, from the IDL Shell
+(@address@hidden) or from an Emacs buffer (@address@hidden).
+Combinations are possible (a compiled library routine visited in a
+buffer might read @address@hidden). If a file contains multiple
+definitions of the same routine, the file name will be prefixed with
address@hidden(Nx)} where @samp{N} is the number of definitions.
+
address@hidden Online Help from the routine info buffer
address@hidden Active text, in routine info
address@hidden Inserting keywords, from routine info
address@hidden Source file, access from routine info
+Some of the text in the @file{*Help*} routine info buffer will be active
+(it is highlighted when the mouse moves over it). Typically, clicking
+with the right mouse button invokes online help lookup, and clicking
+with the middle mouse button inserts keywords or visits files:
+
address@hidden @columnfractions 0.15 0.85
address@hidden @i{Usage}
address@hidden If online help is installed, a click with the @emph{right} mouse
+button on the @i{Usage:} line will access the help for the
+routine (@pxref{Online Help}).
address@hidden @i{Keyword}
address@hidden Online help about keywords is also available with the
address@hidden mouse button. Clicking on a keyword with the @emph{middle}
+mouse button will insert this keyword in the buffer from where
address@hidden was called. Holding down @key{SHIFT} while
+clicking also adds the initial @samp{/}.
address@hidden @i{Source}
address@hidden Clicking with the @emph{middle} mouse button on a @samp{Source}
line
+finds the source file of the routine and visits it in another window.
+Another click on the same line switches back to the buffer from which
address@hidden ?} was called. If you use the @emph{right} mouse button, the
+source will not be visited by a buffer, but displayed in the online help
+window.
address@hidden @i{Classes}
address@hidden The @i{Classes} line is only included in the routine info window
if
+the current class inherits from other classes. You can click with the
address@hidden mouse button to display routine info about the current
+method in other classes on the inheritance chain, if such a method
+exists there.
address@hidden multitable
+
address@hidden idlwave-resize-routine-help-window (@code{t})
address@hidden means resize the Routine-info @file{*Help*} window to
+fit the content.
address@hidden defopt
+
address@hidden idlwave-special-lib-alist
+Alist of regular expressions matching special library directories.
address@hidden defopt
+
address@hidden idlwave-rinfo-max-source-lines (@code{5})
+Maximum number of source files displayed in the Routine Info window.
address@hidden defopt
+
+
address@hidden
+<A NAME="ONLINE_HELP"></A>
address@hidden html
address@hidden Online Help, Completion, Routine Info, The IDLWAVE Major Mode
address@hidden Online Help
+
address@hidden Online Help
address@hidden @file{idlw-help.txt}
address@hidden @file{idlw-help.el}
address@hidden Installing online help
address@hidden Online Help, Installation
address@hidden Speed, of online help
address@hidden XML Help Catalog
+
+For IDL system routines, extensive documentation is supplied with IDL.
+IDLWAVE can access the HTML version of this documentation very quickly
+and accurately, based on the local context. This can be @emph{much}
+faster than using the IDL online help application, because IDLWAVE
+usually gets you to the right place in the documentation directly ---
+e.g. a specific keyword of a routine --- without any additional browsing
+and scrolling.
+
+For this online help to work, an HTML version of the IDL documentation
+is required. Beginning with IDL 6.2, HTML documentation is distributed
+directly with IDL, along with an XML-based catalog of routine
+information. By default, IDLWAVE automatically attempts to convert this
+XML catalog into a format Emacs can more easily understand, and caches
+this information in your @code{idlwave_config_directory}
+(@file{~/.idlwave/}, by default). It also re-scans the XML catalog if
+it is newer than the current cached version. You can force rescan with
+the menu entry @code{IDLWAVE->Routine Info->Rescan XML Help Catalog}.
+
+Before IDL 6.2, the HTML help was not distributed with IDL, and was not
+part of the standalone IDLWAVE distribution, but had to be downloaded
+separately. This is no longer necessary: all help and routine
+information is supplied with IDL versions 6.2 and later.
+
+There are a variety of options for displaying the HTML help: see below.
+Help for routines without HTML documentation is also available, by using
+the routine documentation header and/or routine source.
+
address@hidden M-?
+In any IDL program (or, as with most IDLWAVE commands, in the IDL
+Shell), press @kbd{M-?} (@code{idlwave-context-help}), or click with
address@hidden to access context sensitive online help. The following
+locations are recognized context for help:
+
address@hidden Context, for online help
address@hidden @columnfractions .25 .75
address@hidden @i{Routine names}
address@hidden The name of a routine (function, procedure, method).
address@hidden @i{Keyword Parameters}
address@hidden A keyword parameter of a routine.
address@hidden @i{System Variables}
address@hidden System variables like @code{!DPI}.
address@hidden @i{System Variable Tags}
address@hidden System variables tags like @code{!D.X_SIZE}.
address@hidden @i{IDL Statements}
address@hidden Statements like @code{PRO}, @code{REPEAT}, @code{COMPILE_OPT},
etc.
address@hidden @i{IDL Controls}
address@hidden Control structures like @code{FOR}, @code{SWITCH}, etc.
address@hidden @i{Class names}
address@hidden A class name in an @code{OBJ_NEW} call.
address@hidden @i{Class Init Keywords}
address@hidden Beyond the class name in an @code{OBJ_NEW} call.
address@hidden @i{Executive Command}
address@hidden An executive command like @code{.RUN}. Mostly useful in the
shell.
address@hidden @i{Structure Tags}
address@hidden Structure tags like @code{state.xsize}
address@hidden @i{Class Tags}
address@hidden Class tags like @code{self.value}.
address@hidden @i{Default}
address@hidden The routine that would be selected for routine info display.
address@hidden multitable
+
address@hidden @code{OBJ_NEW}, special online help
+Note that the @code{OBJ_NEW} function is special in that the help
+displayed depends on the cursor position. If the cursor is on the
address@hidden, this function is described. If it is on the class
+name inside the quotes, the documentation for the class is pulled up.
+If the cursor is @emph{after} the class name, anywhere in the argument
+list, the documentation for the corresponding @code{Init} method and
+its keywords is targeted.
+
+Apart from an IDLWAVE buffer or shell, there are two more places from
+which online help can be accessed.
+
address@hidden @bullet
address@hidden
+Online help for routines and keywords can be accessed through the
+Routine Info display. Click with @kbd{Mouse-3} on an item to see the
+corresponding help (@pxref{Routine Info}).
address@hidden
+When using completion and Emacs pops up a @file{*Completions*} buffer
+with possible completions, clicking with @kbd{Mouse-3} on a completion
+item invokes help on that item (@pxref{Completion}). Items for which
+help is available in the online system documentation (vs. just the
+program source itself) will be emphasized (e.g. colored blue).
address@hidden itemize
address@hidden
+In both cases, a blue face indicates that the item is documented in
+the IDL manual, but an attempt will be made to visit non-blue items
+directly in the originating source file.
+
+
address@hidden
+* Help with HTML Documentation::
+* Help with Source::
address@hidden menu
+
address@hidden Help with HTML Documentation, Help with Source, Online Help,
Online Help
address@hidden Help with HTML Documentation
address@hidden HTML Help
address@hidden Help using HTML manuals
address@hidden IDL manual, HTML version
address@hidden IDL Assistant
+
+Help using the HTML documentation is invoked with the built-in Emacs
+command @code{browse-url}, which displays the relevant help topic in a
+browser of your choosing. Beginning with version 6.2, IDL comes with
+the help browser @emph{IDL Assistant}, which it uses by default for
+displaying online help on all supported platforms. This browser
+offers topical searches, an index, and is also now the default and
+recommended IDLWAVE help browser. The variable
address@hidden controls whether this browser is
+used. Note that, due to limitations in the Assistant, invoking help
+within IDLWAVE and @code{? topic} within IDL will result in two
+running copies of Assistant.
+
+Aside from the IDL Assistant, there are many possible browsers to choose
+among, with differing advantages and disadvantages. The variable
address@hidden controls which browser help is sent
+to (as long as @code{idlwave-help-use-assistant} is not set). This
+function is used to set the variable @code{browse-url-browser-function}
+locally for IDLWAVE help only. Customize the latter variable to see
+what choices of browsers your system offers. Certain browsers like
address@hidden (bundled with many versions of Emacs) and @code{w3m}
+(@uref{http://emacs-w3m.namazu.org/}) are run within Emacs, and use
+Emacs buffers to display the HTML help. This can be convenient,
+especially on small displays, and images can even be displayed in-line
+on newer Emacs versions. However, better formatting results are often
+achieved with external browsers, like Mozilla. IDLWAVE assumes any
+browser function containing "w3" is displayed in a local buffer. If you
+are using another Emacs-local browser for which this is not true, set
+the variable @code{idlwave-help-browser-is-local}.
+
+With IDL 6.2 or later, it is important to ensure that the variable
address@hidden is set (@pxref{Catalogs}). One easy way
+to ensure this is to run the IDL Shell (@kbd{C-c C-s}). It will be
+queried for this directory, and the results will be cached to file for
+subsequent use.
+
address@hidden Help Browser Tips}, for more information on selecting and
+configuring a browser for use with IDL's HTML help system.
+
address@hidden idlwave-html-system-help-location @file{help/online_help}
+Relative directory of the system-supplied HTML help directory,
+considered with respect to @code{idlwave-system-directory}. Relevant
+for IDL 6.2 and greater. Should not change.
address@hidden defopt
+
address@hidden idlwave-html-help-location @file{/usr/local/etc/}
+The directory where the @file{idl_html_help} HTML directory live.
+Obsolete and ignored for IDL 6.2 and greater
+(@code{idlwave-html-system-help-location} is used instead).
address@hidden defopt
+
address@hidden idlwave-help-use-assistant @code{t}
+If set, use the IDL Assistant if possible for online HTML help,
+otherwise use the browser function specified in
address@hidden
address@hidden defopt
+
address@hidden idlwave-help-browser-function
+The browser function to use to display IDLWAVE HTML help. Should be
+one of the functions available for setting
address@hidden, which see.
address@hidden defopt
+
address@hidden idlwave-help-browser-is-local
+Is the browser selected in @code{idlwave-help-browser-function} run in a
+local Emacs buffer or window? Defaults to @code{t} if the function
+contains "-w3".
address@hidden defopt
+
address@hidden idlwave-help-link-face
+The face for links to IDLWAVE online help.
address@hidden defopt
+
address@hidden Help with Source, , Help with HTML Documentation, Online Help
address@hidden Help with Source
address@hidden Help using routine source
+
address@hidden Source code, as online help
address@hidden DocLib header, as online help
+For routines which are not documented in an HTML manual (for example
+personal or library routines), the source code itself is used as help
+text. If the requested information can be found in a (more or less)
+standard DocLib file header, IDLWAVE shows the header (scrolling down to
+a keyword, if appropriate). Otherwise the routine definition statement
+(@code{pro}/@code{function}) is shown. The doclib header sections which
+are searched for include @samp{NAME} and @samp{KEYWORDS}. Localization
+support can be added by customizing the @code{idlwave-help-doclib-name}
+and @code{idlwave-help-doclib-keyword} variables.
+
address@hidden Structure tags, in online help
address@hidden Class tags, in online help
+Help is also available for class structure tags (@code{self.TAG}), and
+generic structure tags, if structure tag completion is enabled
+(@pxref{Structure Tag Completion}). This is implemented by visiting the
+tag within the class or structure definition source itself. Help is not
+available on built-in system class tags.
+
+The help window is normally displayed in the same frame, but can be
+popped-up in a separate frame. The following commands can be used to
+navigate inside the help system for source files:
+
address@hidden @columnfractions .15 .85
address@hidden @address@hidden
address@hidden Scroll forward one page.
address@hidden @address@hidden
address@hidden Scroll forward one line.
address@hidden @address@hidden
address@hidden Scroll back one page.
address@hidden @kbd{h}
address@hidden Jump to DocLib Header of the routine whose source is displayed
+as help.
address@hidden @kbd{H}
address@hidden Jump to the first DocLib Header in the file.
address@hidden @kbd{.} @r{(Dot)}
address@hidden Jump back and forth between the routine definition (the
address@hidden/@code{function} statement) and the description of the help
+item in the DocLib header.
address@hidden @kbd{F}
address@hidden Fontify the buffer like source code. See the variable
@code{idlwave-help-fontify-source-code}.
address@hidden @kbd{q}
address@hidden Kill the help window.
address@hidden multitable
+
+
address@hidden idlwave-help-use-dedicated-frame (@code{nil})
address@hidden means use a separate frame for Online Help if possible.
address@hidden defopt
+
address@hidden idlwave-help-frame-parameters
+The frame parameters for the special Online Help frame.
address@hidden defopt
+
address@hidden idlwave-max-popup-menu-items (@code{20})
+Maximum number of items per pane in pop-up menus.
address@hidden defopt
+
address@hidden idlwave-extra-help-function
+Function to call for help if the normal help fails.
address@hidden defopt
+
address@hidden idlwave-help-fontify-source-code (@code{nil})
address@hidden means fontify source code displayed as help.
address@hidden defopt
+
address@hidden idlwave-help-source-try-header (@code{t})
address@hidden means try to find help in routine header when
+displaying source file.
address@hidden defopt
+
address@hidden idlwave-help-doclib-name (@code{"name"})
+The case-insensitive heading word in doclib headers to locate the
address@hidden section. Can be a regexp, e.g. @code{"\\(name\\|nom\\)"}.
address@hidden defopt
+
address@hidden idlwave-help-doclib-keyword (@code{"KEYWORD"})
+The case-insensitive heading word in doclib headers to locate the
address@hidden section. Can be a regexp.
address@hidden defopt
+
+
address@hidden Completion, Routine Source, Online Help, The IDLWAVE Major Mode
address@hidden Completion
address@hidden Completion
address@hidden Keyword completion
address@hidden Method completion
address@hidden Object method completion
address@hidden Class name completion
address@hidden Function name completion
address@hidden Procedure name completion
+
address@hidden address@hidden
address@hidden C-c C-i
+IDLWAVE offers completion for class names, routine names, keywords,
+system variables, system variable tags, class structure tags, regular
+structure tags and file names. As in many programming modes, completion
+is bound to @address@hidden (or simply @address@hidden in the IDLWAVE
+Shell --- @pxref{Using the Shell}). Completion uses exactly the same
+internal information as routine info, so when necessary (rarely) it can
+be updated with @kbd{C-c C-i} (@code{idlwave-update-routine-info}).
+
+The completion function is context sensitive and figures out what to
+complete based on the location of the point. Here are example lines and
+what @address@hidden would try to complete when the cursor is on the
+position marked with a @samp{_}:
+
address@hidden
+plo_ @r{Procedure}
+x = a_ @r{Function}
+plot,xra_ @r{Keyword of @code{plot} procedure}
+plot,x,y,/x_ @r{Keyword of @code{plot} procedure}
+plot,min(_ @r{Keyword of @code{min} function}
+obj -> a_ @r{Object method (procedure)}
+a[2,3] = obj -> a_ @r{Object method (function)}
+x = obj_new('IDL_ @r{Class name}
+x = obj_new('MyCl',a_ @r{Keyword to @code{Init} method in class @code{MyCl}}
+pro A_ @r{Class name}
+pro _ @r{Fill in @code{Class::} of first method in this file}
+!v_ @r{System variable}
+!version.t_ @r{Structure tag of system variable}
+self.g_ @r{Class structure tag in methods}
+state.w_ @r{Structure tag, if tag completion enabled}
+name = 'a_ @r{File name (default inside quotes)}
address@hidden example
+
address@hidden Completion, ambiguity
address@hidden Completion, forcing function name
+The only place where completion is ambiguous is procedure/function
address@hidden versus @emph{functions}. After @samp{plot,x,_}, IDLWAVE
+will always assume a keyword to @samp{plot}. However, a function is
+also a possible completion here. You can force completion of a function
+name at such a location by using a prefix arg: @kbd{C-u address@hidden
+
+Giving two prefix arguments (@kbd{C-u C-u address@hidden) prompts for a
+regular expression to search among the commands to be completed. As
+an example, completing a blank line in this way will allow you to
+search for a procedure matching a regexp.
+
address@hidden Scrolling the @file{*Completions*} window
address@hidden Completion, scrolling
address@hidden Completion, Online Help
address@hidden Online Help in @file{*Completions*} buffer
+If the list of completions is too long to fit in the
address@hidden window, the window can be scrolled by pressing
address@hidden@key{TAB}} repeatedly. Online help (if installed) for each
+possible completion is available by clicking with @kbd{Mouse-3} on the
+item. Items for which system online help (from the IDL manual) is
+available will be emphasized (e.g. colored blue). For other items, the
+corresponding source code or DocLib header will be used as the help
+text.
+
address@hidden Completion, cancelling
address@hidden Cancelling completion
+Completion is not a blocking operation --- you are free to continue
+editing, enter commands, or simply ignore the @file{*Completions*}
+buffer during a completion operation. If, however, the most recent
+command was a completion, @kbd{C-g} will remove the buffer and restore
+the window configuration. You can also remove the buffer at any time
+with no negative consequences.
+
address@hidden idlwave-keyword-completion-adds-equal (@code{t})
address@hidden means completion automatically adds @samp{=} after
+completed keywords.
address@hidden defopt
+
address@hidden idlwave-function-completion-adds-paren (@code{t})
address@hidden means completion automatically adds @samp{(} after
+completed function. A value of `2' means also add the closing
+parenthesis and position the cursor between the two.
address@hidden defopt
+
address@hidden idlwave-completion-restore-window-configuration (@code{t})
address@hidden means restore window configuration after successful
+completion.
address@hidden defopt
+
address@hidden idlwave-highlight-help-links-in-completion (@code{t})
address@hidden means highlight completions for which system help is
+available.
address@hidden defopt
+
address@hidden
+* Case of Completed Words:: CaseOFcomPletedWords
+* Object Method Completion and Class Ambiguity:: obj->Method, what?
+* Object Method Completion in the Shell::
+* Class and Keyword Inheritance:: obj->Method, _EXTRA=e
+* Structure Tag Completion:: Completing state.Tag
address@hidden menu
+
address@hidden Case of Completed Words, Object Method Completion and Class
Ambiguity, Completion, Completion
address@hidden Case of Completed Words
address@hidden Case of completed words
address@hidden Mixed case completion
+IDL is a case-insensitive language, so casing is a matter of style
+only. IDLWAVE helps maintain a consistent casing style for completed
+items. The case of the completed words is determined by what is
+already in the buffer. As an exception, when the partial word being
+completed is all lower case, the completion will be lower case as
+well. If at least one character is upper case, the string will be
+completed in upper case or mixed case, depending on the value of the
+variable @code{idlwave-completion-case}. The default is to use upper
+case for procedures, functions and keywords, and mixed case for object
+class names and methods, similar to the conventions in the IDL
+manuals. For instance, to enable mixed-case completion for routines
+in addition to classes and methods, you need an entry such as
address@hidden(routine . preserve)} in that variable. To enable total control
+over the case of completed items, independent of buffer context, set
address@hidden to address@hidden
+
address@hidden idlwave-completion-case
+Association list setting the case (UPPER/lower/Capitalized/MixedCase...)
+of completed words.
address@hidden defopt
+
address@hidden idlwave-completion-force-default-case (@code{nil})
address@hidden means completion will always honor the settings in
address@hidden When nil (the default), entirely lower
+case strings will always be completed to lower case, no matter what the
+settings in @code{idlwave-completion-case}.
address@hidden defopt
+
address@hidden idlwave-complete-empty-string-as-lower-case (@code{nil})
address@hidden means the empty string is considered lower case for
+completion.
address@hidden defopt
+
address@hidden Object Method Completion and Class Ambiguity, Object Method
Completion in the Shell, Case of Completed Words, Completion
address@hidden Object Method Completion and Class Ambiguity
address@hidden Object methods
address@hidden Class ambiguity
address@hidden @code{self} object, default class
+An object method is not uniquely determined without the object's class.
+Since the class is almost always omitted in the calling source (as
+required to obtain the true benefits of object-based programming),
+IDLWAVE considers all available methods in all classes as possible
+method name completions. The combined list of keywords of the current
+method in @emph{all} known classes which contain that method will be
+considered for keyword completion. In the @file{*Completions*} buffer,
+the matching classes will be shown next to each item (see option
address@hidden). As a special case, the class
+of an object called @samp{self} is always taken to be the class of the
+current routine, when in an IDLWAVE buffer. All inherits classes are
+considered as well.
+
address@hidden Forcing class query.
address@hidden Class query, forcing
+You can also call @code{idlwave-complete} with a prefix arg: @kbd{C-u
address@hidden IDLWAVE will then prompt you for the class in order to
+narrow down the number of possible completions. The variable
address@hidden can be configured to make such prompting the
+default for all methods (not recommended), or selectively for very
+common methods for which the number of completing keywords would be too
+large (e.g. @code{Init,SetProperty,GetProperty}).
+
address@hidden Saving object class on @code{->}
address@hidden @code{->}
+After you have specified the class for a particular statement (e.g. when
+completing the method), IDLWAVE can remember it for the rest of the
+editing session. Subsequent completions in the same statement
+(e.g. keywords) can then reuse this class information. This works by
+placing a text property on the method invocation operator @samp{->},
+after which the operator will be shown in a different face (bold by
+default). The variable @code{idlwave-store-inquired-class} can be used
+to turn it off or on.
+
address@hidden idlwave-completion-show-classes (@code{1})
address@hidden means show up to that many classes in
address@hidden buffer when completing object methods and
+keywords.
address@hidden defopt
+
address@hidden idlwave-completion-fontify-classes (@code{t})
address@hidden means fontify the classes in completions buffer.
address@hidden defopt
+
address@hidden idlwave-query-class (@code{nil})
+Association list governing query for object classes during completion.
address@hidden defopt
+
address@hidden idlwave-store-inquired-class (@code{t})
address@hidden means store class of a method call as text property on
address@hidden>}.
address@hidden defopt
+
address@hidden idlwave-class-arrow-face
+Face to highlight object operator arrows @samp{->} which carry a saved
+class text property.
address@hidden defopt
+
address@hidden Object Method Completion in the Shell, Class and Keyword
Inheritance, Object Method Completion and Class Ambiguity, Completion
address@hidden Object Method Completion in the Shell
address@hidden Method Completion in Shell
+In the IDLWAVE Shell (@pxref{The IDLWAVE Shell}), objects on which
+methods are being invoked have a special property: they must exist as
+variables, and so their class can be determined (for instance, using the
address@hidden()} function). In the Shell, when attempting completion,
+routine info, or online help within a method routine, a query is sent to
+determine the class of the object. If this query is successful, the
+class found will be used to select appropriate completions, routine
+info, or help. If unsuccessful, information from all known classes will
+be used (as in the buffer).
+
address@hidden Class and Keyword Inheritance, Structure Tag Completion,
Object Method Completion in the Shell, Completion
address@hidden Class and Keyword Inheritance
address@hidden Inheritance, class
address@hidden Keyword inheritance
address@hidden Inheritance, keyword
+
+Class inheritance affects which methods are called in IDL. An object of
+a class which inherits methods from one or more superclasses can
+override that method by defining its own method of the same name, extend
+the method by calling the method(s) of its superclass(es) in its
+version, or inherit the method directly by making no modifications.
+IDLWAVE examines class definitions during completion and routine
+information display, and records all inheritance information it finds.
+This information is displayed if appropriate with the calling sequence
+for methods (@pxref{Routine Info}), as long as variable
address@hidden is address@hidden
+
+In many class methods, @emph{keyword} inheritance (@code{_EXTRA} and
address@hidden) is used hand-in-hand with class inheritance and
+method overriding. E.g., in a @code{SetProperty} method, this technique
+allows a single call @code{obj->SetProperty} to set properties up the
+entire class inheritance chain. This is often referred to as
address@hidden, and is characterized by chained method calls like
address@hidden@code{self->MySuperClass::SetProperty,_EXTRA=e}}.
+
+IDLWAVE can accommodate this special synergy between class and keyword
+inheritance: if @code{_EXTRA} or @code{_REF_EXTRA} is detected among a
+method's keyword parameters, all keywords of superclass versions of
+the method being considered can be included in completion. There is
+of course no guarantee that this type of keyword chaining actually
+occurs, but for some methods it's a very convenient assumption. The
+variable @code{idlwave-keyword-class-inheritance} can be used to
+configure which methods have keyword inheritance treated in this
+simple, class-driven way. By default, only @code{Init} and
address@hidden(Get|Set)Property} are. The completion buffer will label
+keywords based on their originating class.
+
address@hidden idlwave-support-inheritance (@code{t})
address@hidden means consider inheritance during completion, online help etc.
address@hidden defopt
+
address@hidden idlwave-keyword-class-inheritance
+A list of regular expressions to match methods for which simple
+class-driven keyword inheritance will be used for Completion.
address@hidden defopt
+
address@hidden Structure Tag Completion, , Class and Keyword Inheritance,
Completion
address@hidden Structure Tag Completion
address@hidden Completion, structure tag
address@hidden Structure tag completion
+
+In many programs, especially those involving widgets, large structures
+(e.g. the @samp{state} structure) are used to communicate among
+routines. It is very convenient to be able to complete structure tags,
+in the same way as for instance variables (tags) of the @samp{self}
+object (@pxref{Object Method Completion and Class Ambiguity}). Add-in
+code for structure tag completion is available in the form of a loadable
+completion module: @file{idlw-complete-structtag.el}. Tag completion in
+structures is highly ambiguous (much more so than @samp{self}
+completion), so @code{idlw-complete-structtag} makes an unusual and very
+specific assumption: the exact same variable name is used to refer to
+the structure in all parts of the program. This is entirely unenforced
+by the IDL language, but is a typical convention. If you consistently
+refer to the same structure with the same variable name
+(e.g. @samp{state}), structure tags which are read from its definition
+in the same file can be used for completion.
+
+Structure tag completion is not enabled by default. To enable it,
+simply add the following to your @file{.emacs}:
+
address@hidden
+ (add-hook 'idlwave-load-hook
+ (lambda () (require 'idlw-complete-structtag)))
address@hidden lisp
+
+Once enabled, you'll also be able to access online help on the structure
+tags, using the usual methods (@pxref{Online Help}). In addition,
+structure variables in the shell will be queried for tag names, similar
+to the way object variables in the shell are queried for method names.
+So, e.g.:
+
address@hidden
+IDL> st.[Tab]
address@hidden example
+
address@hidden will complete with all structure fields of the structure
address@hidden
+
address@hidden Routine Source, Resolving Routines, Completion, The IDLWAVE
Major Mode
address@hidden Routine Source
address@hidden Routine source file
address@hidden Module source file
address@hidden Source file, of a routine
address@hidden C-c C-v
+In addition to clicking on a @i{Source:} line in the routine info
+window, there is another way to quickly visit the source file of a
+routine. The command @kbd{C-c C-v} (@code{idlwave-find-module}) asks
+for a module name, offering the same default as
address@hidden would have used, taken from nearby buffer
+contents. In the minibuffer, specify a complete routine name (including
+any class part). IDLWAVE will display the source file in another
+window, positioned at the routine in question. You can also limit this
+to a routine in the current buffer only, with completion, and a
+context-sensitive default, by using a single prefix (@kbd{C-u C-c C-v})
+or the convenience binding @kbd{C-c C-t}.
+
address@hidden Buffers, killing
address@hidden Killing autoloaded buffers
+Since getting the source of a routine into a buffer is so easy with
+IDLWAVE, too many buffers visiting different IDL source files are
+sometimes created. The special command @kbd{C-c C-k}
+(@code{idlwave-kill-autoloaded-buffers}) can be used to easily remove
+these buffers.
+
address@hidden Resolving Routines, Code Templates, Routine Source, The IDLWAVE
Major Mode
address@hidden Resolving Routines
address@hidden @code{RESOLVE_ROUTINE}
address@hidden Compiling library modules
address@hidden Routines, resolving
+
+The key sequence @kbd{C-c =} calls the command @code{idlwave-resolve}
+and sends the line @samp{RESOLVE_ROUTINE, '@var{routine_name}'} to IDL
+in order to resolve (compile) it. The default routine to be resolved is
+taken from context, but you get a chance to edit it. Usually this is
+not necessary, since IDL automatically discovers routines on its path.
+
address@hidden is one way to get a library module within reach
+of IDLWAVE's routine info collecting functions. A better way is to
+keep routine information available in catalogs (@pxref{Catalogs}).
+Routine info on modules will then be available without the need to
+compile the modules first, and even without a running shell.
+
address@hidden of Routine Info}, for more information on the ways IDLWAVE
+collects data about routines, and how to update this information.
+
address@hidden Code Templates, Abbreviations, Resolving Routines, The IDLWAVE
Major Mode
address@hidden Code Templates
address@hidden Code templates
address@hidden Templates
+
+IDLWAVE can insert IDL code templates into the buffer. For a few
+templates, this is done with direct key bindings:
+
address@hidden @columnfractions .15 .85
address@hidden @kbd{C-c C-c}
address@hidden @code{CASE} statement template
address@hidden @kbd{C-c C-f}
address@hidden @code{FOR} loop template
address@hidden @kbd{C-c C-r}
address@hidden @code{REPEAT} loop template
address@hidden @kbd{C-c C-w}
address@hidden @code{WHILE} loop template
address@hidden multitable
+
+All code templates are also available as abbreviations
+(@pxref{Abbreviations}).
+
address@hidden Abbreviations, Actions, Code Templates, The IDLWAVE Major Mode
address@hidden Abbreviations
address@hidden Abbreviations
+
+Special abbreviations exist to enable rapid entry of commonly used
+commands. Emacs abbreviations are expanded by typing text into the
+buffer and pressing @key{SPC} or @key{RET}. The special abbreviations
+used to insert code templates all start with a @samp{\} (the backslash),
+or, optionally, any other character set in
address@hidden IDLWAVE ensures that abbreviations are
+only expanded where they should be (i.e., not in a string or comment),
+and permits the point to be moved after an abbreviation expansion ---
+very useful for positioning the mark inside of parentheses, etc.
+
+Special abbreviations are pre-defined for code templates and other
+useful items. To visit the full list of abbreviations, use @kbd{M-x
+idlwave-list-abbrevs}.
+
+Template abbreviations:
+
address@hidden @columnfractions .15 .85
address@hidden @code{\pr}
address@hidden @code{PROCEDURE} template
address@hidden @code{\fu}
address@hidden @code{FUNCTION} template
address@hidden @code{\c}
address@hidden @code{CASE} statement template
address@hidden @code{\f}
address@hidden @code{FOR} loop template
address@hidden @code{\r}
address@hidden @code{REPEAT} loop template
address@hidden @code{\w}
address@hidden @code{WHILE} loop template
address@hidden @code{\i}
address@hidden @code{IF} statement template
address@hidden @code{\elif}
address@hidden @code{IF-ELSE} statement template
address@hidden multitable
+
+String abbreviations:
+
address@hidden @columnfractions .15 .85
address@hidden @code{\ap}
address@hidden @code{arg_present()}
address@hidden @code{\b}
address@hidden @code{begin}
address@hidden @code{\cb}
address@hidden @code{byte()}
address@hidden @code{\cc}
address@hidden @code{complex()}
address@hidden @code{\cd}
address@hidden @code{double()}
address@hidden @code{\cf}
address@hidden @code{float()}
address@hidden @code{\cl}
address@hidden @code{long()}
address@hidden @code{\co}
address@hidden @code{common}
address@hidden @code{\cs}
address@hidden @code{string()}
address@hidden @code{\cx}
address@hidden @code{fix()}
address@hidden @code{\e}
address@hidden @code{else}
address@hidden @code{\ec}
address@hidden @code{endcase}
address@hidden @code{\ee}
address@hidden @code{endelse}
address@hidden @code{\ef}
address@hidden @code{endfor}
address@hidden @code{\ei}
address@hidden @code{endif else if}
address@hidden @code{\el}
address@hidden @code{endif else}
address@hidden @code{\en}
address@hidden @code{endif}
address@hidden @code{\er}
address@hidden @code{endrep}
address@hidden @code{\es}
address@hidden @code{endswitch}
address@hidden @code{\ew}
address@hidden @code{endwhile}
address@hidden @code{\g}
address@hidden @code{goto,}
address@hidden @code{\h}
address@hidden @code{help,}
address@hidden @code{\ik}
address@hidden @code{if keyword_set() then}
address@hidden @code{\iap}
address@hidden @code{if arg_present() then}
address@hidden @code{\ine}
address@hidden @code{if n_elements() eq 0 then}
address@hidden @code{\inn}
address@hidden @code{if n_elements() ne 0 then}
address@hidden @code{\k}
address@hidden @code{keyword_set()}
address@hidden @code{\n}
address@hidden @code{n_elements()}
address@hidden @code{\np}
address@hidden @code{n_params()}
address@hidden @code{\oi}
address@hidden @code{on_ioerror,}
address@hidden @code{\or}
address@hidden @code{openr,}
address@hidden @code{\ou}
address@hidden @code{openu,}
address@hidden @code{\ow}
address@hidden @code{openw,}
address@hidden @code{\p}
address@hidden @code{print,}
address@hidden @code{\pt}
address@hidden @code{plot,}
address@hidden @code{\pv}
address@hidden @code{ptr_valid()}
address@hidden @code{\re}
address@hidden @code{read,}
address@hidden @code{\rf}
address@hidden @code{readf,}
address@hidden @code{\rt}
address@hidden @code{return}
address@hidden @code{\ru}
address@hidden @code{readu,}
address@hidden @code{\s}
address@hidden @code{size()}
address@hidden @code{\sc}
address@hidden @code{strcompress()}
address@hidden @code{\sl}
address@hidden @code{strlowcase()}
address@hidden @code{\sm}
address@hidden @code{strmid()}
address@hidden @code{\sn}
address@hidden @code{strlen()}
address@hidden @code{\sp}
address@hidden @code{strpos()}
address@hidden @code{\sr}
address@hidden @code{strtrim()}
address@hidden @code{\st}
address@hidden @code{strput()}
address@hidden @code{\su}
address@hidden @code{strupcase()}
address@hidden @code{\t}
address@hidden @code{then}
address@hidden @code{\u}
address@hidden @code{until}
address@hidden @code{\wc}
address@hidden @code{widget_control,}
address@hidden @code{\wi}
address@hidden @code{widget_info()}
address@hidden @code{\wu}
address@hidden @code{writeu,}
address@hidden multitable
+
address@hidden You can easily add your own abbreviations or override existing
+abbrevs with @code{define-abbrev} in your mode hook, using the
+convenience function @code{idlwave-define-abbrev}:
+
address@hidden
+(add-hook 'idlwave-mode-hook
+ (lambda ()
+ (idlwave-define-abbrev "wb" "widget_base()"
+ (idlwave-keyword-abbrev 1))
+ (idlwave-define-abbrev "ine" "IF N_Elements() EQ 0 THEN"
+ (idlwave-keyword-abbrev 11))))
address@hidden lisp
+
+Notice how the abbreviation (here @emph{wb}) and its expansion
+(@emph{widget_base()}) are given as arguments, and the single argument to
address@hidden (here @emph{1}) specifies how far back to
+move the point upon expansion (in this example, to put it between the
+parentheses).
+
+The abbreviations are expanded in upper or lower case, depending upon
+the variables @code{idlwave-abbrev-change-case} and, for reserved word
+templates, @code{idlwave-reserved-word-upcase} (@pxref{Case Changes}).
+
address@hidden idlwave-abbrev-start-char (@code{"\"})
+A single character string used to start abbreviations in abbrev mode.
+Beware of common characters which might naturally occur in sequence with
+abbreviation strings.
address@hidden defopt
+
address@hidden idlwave-abbrev-move (@code{t})
address@hidden means the abbrev hook can move point, e.g. to end up
+between the parentheses of a function call.
address@hidden defopt
+
address@hidden Actions, Doc Header, Abbreviations, The IDLWAVE Major Mode
address@hidden Actions
address@hidden Actions
address@hidden Coding standards, enforcing
+
address@hidden are special formatting commands which are executed
+automatically while you write code in order to check the structure of
+the program or to enforce coding standards. Most actions which have
+been implemented in IDLWAVE are turned off by default, assuming that the
+average user wants her code the way she writes it. But if you are a
+lazy typist and want your code to adhere to certain standards, actions
+can be helpful.
+
+Actions can be applied in three ways:
+
address@hidden @bullet
address@hidden
+Some actions are applied directly while typing. For example, pressing
address@hidden can run a check to make sure that this operator is surrounded
+by spaces and insert these spaces if necessary. Pressing @key{SPC}
+after a reserved word can call a command to change the word to upper
+case.
address@hidden
+When a line is re-indented with @key{TAB}, actions can be applied to the
+entire line. To enable this, the variable @code{idlwave-do-actions}
+must be address@hidden
address@hidden
address@hidden Foreign code, adapting
address@hidden Actions, applied to foreign code
+Actions can also be applied to a larger piece of code, e.g. to convert
+foreign code to your own style. To do this, mark the relevant part of
+the code and execute @kbd{M-x expand-region-abbrevs}. Useful marking
+commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current
+subprogram). @xref{Code Indentation}, for information how to adjust the
+indentation of the code.
address@hidden itemize
+
address@hidden idlwave-do-actions (@code{nil})
address@hidden means performs actions when indenting. Individual action
+settings are described below and set separately.
address@hidden defopt
+
address@hidden
+* Block Boundary Check:: Is the END statement correct?
+* Padding Operators:: Enforcing space around `=' etc
+* Case Changes:: Enforcing upper case keywords
address@hidden menu
+
address@hidden Block Boundary Check, Padding Operators, Actions, Actions
address@hidden Block Boundary Check
address@hidden Block boundary check
address@hidden @code{END} type checking
address@hidden @code{END}, automatic insertion
address@hidden @code{END}, expanding
address@hidden Block, closing
address@hidden Closing a block
+
+Whenever you type an @code{END} statement, IDLWAVE finds the
+corresponding start of the block and the cursor blinks back to that
+location for a second. If you have typed a specific @code{END}, like
address@hidden or @code{ENDCASE}, you get a warning if that terminator
+does not match the type of block it terminates.
+
+Set the variable @code{idlwave-expand-generic-end} in order to have all
+generic @code{END} statements automatically expanded to the appropriate
+type. You can also type @kbd{C-c ]} to close the current block by
+inserting the appropriate @code{END} statement.
+
address@hidden idlwave-show-block (@code{t})
address@hidden means point blinks to block beginning for
address@hidden
address@hidden defopt
+
address@hidden idlwave-expand-generic-end (@code{t})
address@hidden means expand generic END to ENDIF/ENDELSE/ENDWHILE etc.
address@hidden defopt
+
address@hidden idlwave-reindent-end (@code{t})
address@hidden means re-indent line after END was typed.
address@hidden defopt
+
address@hidden Padding Operators, Case Changes, Block Boundary Check, Actions
address@hidden Padding Operators
address@hidden Padding operators with spaces
address@hidden Operators, padding with spaces
address@hidden Space, around operators
+
+Some operators can be automatically surrounded by spaces. This can
+happen when the operator is typed, or later when the line is indented.
+IDLWAVE can pad the operators @samp{<}, @samp{>}, @samp{,}, @samp{=},
+and @samp{->}, as well as the modified assignment operators
+(@samp{AND=}, @samp{OR=}, etc.). This feature is turned off by default.
+If you want to turn it on, customize the variables
address@hidden and @code{idlwave-do-actions} and turn
+both on. You can also define similar actions for other operators by
+using the function @code{idlwave-action-and-binding} in the mode hook.
+For example, to enforce space padding of the @samp{+} and @samp{*}
+operators (outside of strings and comments, of course), try this in
address@hidden
+
address@hidden
+(add-hook 'idlwave-mode-hook
+ (lambda ()
+ (setq idlwave-surround-by-blank t) ; Turn this type of actions on
+ (idlwave-action-and-binding "*" '(idlwave-surround 1 1))
+ (idlwave-action-and-binding "+" '(idlwave-surround 1 1))))
address@hidden lisp
+
+Note that the modified assignment operators which begin with a word
+(@samp{AND=}, @samp{OR=}, @samp{NOT=}, etc.) require a leading space to
+be recognized (e.g @code{vAND=4} would be interpreted as a variable
address@hidden). Also note that, since e.g., @code{>} and @code{>=} are
+both valid operators, it is impossible to surround both by blanks while
+they are being typed. Similarly with @code{&} and @code{&&}. For
+these, a compromise is made: the padding is placed on the left, and if
+the longer operator is keyed in, on the right as well (otherwise you
+must insert spaces to pad right yourself, or press simply press Tab to
+repad everything if @code{idlwave-do-actions} is on).
+
address@hidden idlwave-surround-by-blank (@code{nil})
address@hidden means enable @code{idlwave-surround}. If address@hidden,
address@hidden, @samp{<}, @samp{>}, @samp{&}, @samp{,}, @samp{->}, and the
+modified assignment operators (@samp{AND=}, @samp{OR=}, etc.) are
+surrounded with spaces by @code{idlwave-surround}.
address@hidden defopt
+
address@hidden idlwave-pad-keyword (@code{t})
address@hidden means space-pad the @samp{=} in keyword assignments.
address@hidden defopt
+
address@hidden Case Changes, , Padding Operators, Actions
address@hidden Case Changes
address@hidden Case changes
address@hidden Upcase, enforcing for reserved words
address@hidden Downcase, enforcing for reserved words
+
+Actions can be used to change the case of reserved words or expanded
+abbreviations by customizing the variables
address@hidden and
address@hidden If you want to change the case of
+additional words automatically, put something like the following into
+your @file{.emacs} file:
+
address@hidden
+(add-hook 'idlwave-mode-hook
+ (lambda ()
+ ;; Capitalize system vars
+ (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
+ ;; Capitalize procedure name
+ (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
+ '(capitalize-word 1) t)
+ ;; Capitalize common block name
+ (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
+ '(capitalize-word 1) t)))
address@hidden lisp
+
+For more information, see the documentation string for the function
address@hidden For information on controlling the
+case of routines, keywords, classes, and methods as they are completed, see
address@hidden
+
address@hidden idlwave-abbrev-change-case (@code{nil})
address@hidden means all abbrevs will be forced to either upper or lower
+case. Valid values are @code{nil}, @code{t}, and @code{down}.
address@hidden defopt
+
address@hidden idlwave-reserved-word-upcase (@code{nil})
address@hidden means reserved words will be made upper case via abbrev
+expansion.
address@hidden defopt
+
+
address@hidden Doc Header, Motion Commands, Actions, The IDLWAVE Major Mode
address@hidden Documentation Header
address@hidden Documentation header
address@hidden DocLib header
address@hidden Modification timestamp
address@hidden Header, for file documentation
address@hidden Timestamp, in doc header.
address@hidden Changelog, in doc header.
+
address@hidden C-c C-h
address@hidden C-c C-m
+The command @kbd{C-c C-h} inserts a standard routine header into the
+buffer, with the usual fields for documentation (a different header can
+be specified with @code{idlwave-file-header}). One of the keywords is
address@hidden HISTORY} under which the changes to a routine can be
+recorded. The command @kbd{C-c C-m} jumps to the @samp{MODIFICATION
+HISTORY} of the current routine or file and inserts the user name with a
+timestamp.
+
address@hidden idlwave-file-header
+The doc-header template or a path to a file containing it.
address@hidden defopt
+
address@hidden idlwave-header-to-beginning-of-file (@code{nil})
address@hidden means the documentation header will always be at start
+of file.
address@hidden defopt
+
address@hidden idlwave-timestamp-hook
+The hook function used to update the timestamp of a function.
address@hidden defopt
+
address@hidden idlwave-doc-modifications-keyword
+The modifications keyword to use with the log documentation commands.
address@hidden defopt
+
address@hidden idlwave-doclib-start
+Regexp matching the start of a document library header.
address@hidden defopt
+
address@hidden idlwave-doclib-end
+Regexp matching the start of a document library header.
address@hidden defopt
+
address@hidden Motion Commands, Misc Options, Doc Header, The IDLWAVE Major Mode
address@hidden Motion Commands
address@hidden Motion commands
address@hidden Program structure, moving through
address@hidden Code structure, moving through
address@hidden @file{Func-menu}, XEmacs package
address@hidden @file{Imenu}, Emacs package
address@hidden Function definitions, jumping to
address@hidden Procedure definitions, jumping to
+
+IDLWAVE supports both @file{Imenu} and @file{Func-menu}, two packages
+which make it easy to jump to the definitions of functions and
+procedures in the current file with a pop-up selection. To bind
address@hidden to a mouse-press, use in your @file{.emacs}:
+
address@hidden
+(define-key global-map [S-down-mouse-3] 'imenu)
address@hidden lisp
+
address@hidden @file{Speedbar}, Emacs package
+
+In addition, @file{Speedbar} support allows convenient navigation of a
+source tree of IDL routine files, quickly stepping to routine
+definitions. See @code{Tools->Display Speedbar}.
+
+Several commands allow you to move quickly through the structure of an
+IDL program:
+
address@hidden @columnfractions .15 .85
address@hidden @kbd{C-M-a}
address@hidden Beginning of subprogram
address@hidden @kbd{C-M-e}
address@hidden End of subprogram
address@hidden @kbd{C-c @{}
address@hidden Beginning of block (stay inside the block)
address@hidden @kbd{C-c @}}
address@hidden End of block (stay inside the block)
address@hidden @kbd{C-M-n}
address@hidden Forward block (on same level)
address@hidden @kbd{C-M-p}
address@hidden Backward block (on same level)
address@hidden @kbd{C-M-d}
address@hidden Down block (enters a block)
address@hidden @kbd{C-M-u}
address@hidden Backward up block (leaves a block)
address@hidden @kbd{C-c C-n}
address@hidden Next Statement
address@hidden multitable
+
+
address@hidden Misc Options, , Motion Commands, The IDLWAVE Major Mode
address@hidden Miscellaneous Options
address@hidden Hooks
+
address@hidden idlwave-help-application
+The external application providing reference help for programming.
address@hidden defopt
+
address@hidden idlwave-startup-message (@code{t})
address@hidden means display a startup message when @code{idlwave-mode}'
+is first called.
address@hidden defopt
+
address@hidden idlwave-mode-hook
+Normal hook. Executed when a buffer is put into @code{idlwave-mode}.
address@hidden defopt
+
address@hidden idlwave-load-hook
+Normal hook. Executed when @file{idlwave.el} is loaded.
address@hidden defopt
+
address@hidden The IDLWAVE Shell, Acknowledgements, The IDLWAVE Major Mode, Top
address@hidden The IDLWAVE Shell
address@hidden IDLWAVE shell
address@hidden Major mode, @code{idlwave-shell-mode}
address@hidden IDL, as Emacs subprocess
address@hidden Subprocess of Emacs, IDL
address@hidden Comint, Emacs package
address@hidden Windows
address@hidden MacOS
+
+The IDLWAVE shell is an Emacs major mode which permits running the IDL
+program as an inferior process of Emacs, and works closely with the
+IDLWAVE major mode in buffers. It can be used to work with IDL
+interactively, to compile and run IDL programs in Emacs buffers and to
+debug these programs. The IDLWAVE shell is built on @file{comint}, an
+Emacs packages which handles the communication with the IDL program.
+Unfortunately, IDL for Windows does not have command-prompt versions and
+thus do not allow the interaction with Emacs --- so the IDLWAVE shell
+currently only works under Unix and MacOSX.
+
address@hidden
+* Starting the Shell:: How to launch IDL as a subprocess
+* Using the Shell:: Interactively working with the Shell
+* Commands Sent to the Shell::
+* Debugging IDL Programs::
+* Examining Variables::
+* Custom Expression Examination::
address@hidden menu
+
address@hidden Starting the Shell, Using the Shell, The IDLWAVE Shell, The
IDLWAVE Shell
address@hidden Starting the Shell
address@hidden Starting the shell
address@hidden Shell, starting
address@hidden Dedicated frame, for shell buffer
address@hidden Frame, for shell buffer
address@hidden Subprocess of Emacs, IDL
+
address@hidden C-c C-s
+The IDLWAVE shell can be started with the command @kbd{M-x
+idlwave-shell}. In @code{idlwave-mode} the function is bound to
address@hidden C-s}. It creates a buffer @file{*idl*} which is used to
+interact with the shell. If the shell is already running, @kbd{C-c
+C-s} will simply switch to the shell buffer. The command @kbd{C-c
+C-l} (@code{idlwave-shell-recenter-shell-window}) displays the shell
+window without selecting it. The shell can also be started
+automatically when another command tries to send a command to it. To
+enable auto start, set the variable
address@hidden to @code{t}.
+
+In order to create a separate frame for the IDLWAVE shell buffer, call
address@hidden with a prefix argument: @kbd{C-u C-c C-s} or
address@hidden C-c C-l}. If you always want a dedicated frame for the shell
+window, configure the variable
address@hidden
+
+To launch a quick IDLWAVE shell directly from a shell prompt without
+an IDLWAVE buffer (e.g., as a replacement for running inside an
+xterm), define a system alias with the following content:
+
address@hidden
+emacs -geometry 80x32 -eval "(idlwave-shell 'quick)"
address@hidden example
+
+Replace the @samp{-geometry 80x32} option with @samp{-nw} if you prefer
+the Emacs process to run directly inside the terminal window.
+
address@hidden ENVI
address@hidden IDL> Prompt
+
+To use IDLWAVE with ENVI or other custom packages which change the
address@hidden> } prompt, you must change the
address@hidden, which defaults to @samp{"^ ?IDL>
+"}. Normally, you can just replace the @samp{IDL} in this expression
+with the prompt you see. A suitable pattern which matches the prompt
+for both ENVI and IDL simultaneously is @samp{"^ ?\\(ENVI\\|IDL\\)> "}.
+
address@hidden idlwave-shell-explicit-file-name (@file{idl})
+This is the command to run IDL.
address@hidden defopt
+
address@hidden idlwave-shell-command-line-options
+A list of command line options for calling the IDL program.
address@hidden defopt
+
address@hidden idlwave-shell-prompt-pattern
+Regexp to match IDL prompt at beginning of a line.
address@hidden defopt
+
address@hidden idlwave-shell-process-name
+Name to be associated with the IDL process.
address@hidden defopt
+
address@hidden idlwave-shell-automatic-start (@code{nil})
address@hidden means attempt to invoke idlwave-shell if not already
+running.
address@hidden defopt
+
address@hidden idlwave-shell-initial-commands
+Initial commands, separated by newlines, to send to IDL.
address@hidden defopt
+
address@hidden idlwave-shell-save-command-history (@code{t})
address@hidden means preserve command history between sessions.
address@hidden defopt
+
address@hidden idlwave-shell-command-history-file (@file{~/.idlwave/.idlwhist})
+The file in which the command history of the idlwave shell is saved.
+Unless it's an absolute path, it goes in
address@hidden
address@hidden defopt
+
address@hidden idlwave-shell-use-dedicated-frame (@code{nil})
address@hidden means IDLWAVE should use a special frame to display the
+shell buffer.
address@hidden defopt
+
address@hidden idlwave-shell-use-dedicated-window (@code{nil})
address@hidden means use a dedicated window for the shell, taking care
+not it replace it with other buffers.
address@hidden defopt
+
address@hidden idlwave-shell-frame-parameters
+The frame parameters for a dedicated idlwave-shell frame.
address@hidden defopt
+
address@hidden idlwave-shell-raise-frame (@code{t})
address@hidden means `idlwave-shell' raises the frame showing the shell
+window.
address@hidden defopt
+
address@hidden idlwave-shell-temp-pro-prefix
+The prefix for temporary IDL files used when compiling regions.
address@hidden defopt
+
address@hidden Hooks
address@hidden idlwave-shell-mode-hook
+Hook for customizing @code{idlwave-shell-mode}.
address@hidden defopt
+
address@hidden Using the Shell, Commands Sent to the Shell, Starting the Shell,
The IDLWAVE Shell
address@hidden Using the Shell
address@hidden Comint
address@hidden Shell, basic commands
+
+The IDLWAVE shell works in the same fashion as other shell modes in
+Emacs. It provides command history, command line editing and job
+control. The @key{UP} and @key{DOWN} arrows cycle through the input
+history just like in an X address@hidden is different from
+normal Emacs/Comint behavior, but more like an xterm. If you prefer the
+default comint functionality, check the variable
address@hidden The history is preserved
+between emacs and IDL sessions. Here is a list of commonly used
+commands:
+
address@hidden @columnfractions .12 .88
address@hidden @key{UP}, @key{M-p}
address@hidden Cycle backwards in input history
address@hidden @key{DOWN}, @key{M-n}
address@hidden Cycle forwards in input history
address@hidden @kbd{M-r}
address@hidden Previous input matching a regexp
address@hidden @kbd{M-s}
address@hidden Next input matching a regexp
address@hidden @kbd{return}
address@hidden Send input or copy line to current prompt
address@hidden @kbd{C-c C-a}
address@hidden Beginning of line; skip prompt
address@hidden @kbd{C-c C-u}
address@hidden Kill input to beginning of line
address@hidden @kbd{C-c C-w}
address@hidden Kill word before cursor
address@hidden @kbd{C-c C-c}
address@hidden Send ^C
address@hidden @kbd{C-c C-z}
address@hidden Send ^Z
address@hidden @kbd{C-c C-\}
address@hidden Send ^\
address@hidden @kbd{C-c C-o}
address@hidden Delete last batch of process output
address@hidden @kbd{C-c C-r}
address@hidden Show last batch of process output
address@hidden @kbd{C-c C-l}
address@hidden List input history
address@hidden multitable
+
+In addition to these standard @file{comint} commands,
address@hidden provides many of the same commands which
+simplify writing IDL code available in IDLWAVE buffers. This includes
+abbreviations, online help, and completion. See @ref{Routine Info} and
address@hidden Help} and @ref{Completion} for more information on these
+commands.
+
address@hidden Completion, in the shell
address@hidden Routine info, in the shell
address@hidden Online Help, in the shell
address@hidden @columnfractions .12 .88
address@hidden @address@hidden
address@hidden Completion of file names (between quotes and after executive
+commands @samp{.run} and @samp{.compile}), routine names, class names,
+keywords, system variables, system variable tags etc.
+(@code{idlwave-shell-complete}).
address@hidden @address@hidden
address@hidden Same as @key{TAB}
address@hidden @kbd{C-c ?}
address@hidden Routine Info display (@code{idlwave-routine-info})
address@hidden @kbd{M-?}
address@hidden IDL online help on routine
(@code{idlwave-routine-info-from-idlhelp})
address@hidden @kbd{C-c C-i}
address@hidden Update routine info from buffers and shell
+(@code{idlwave-update-routine-info})
address@hidden @kbd{C-c C-v}
address@hidden Find the source file of a routine (@code{idlwave-find-module})
address@hidden @kbd{C-c C-t}
address@hidden Find the source file of a routine in the currently visited file
+(@code{idlwave-find-module-this-file}).
address@hidden @kbd{C-c =}
address@hidden Compile a library routine (@code{idlwave-resolve})
address@hidden multitable
+
address@hidden idlwave-shell-arrows-do-history (@code{t})
address@hidden means @key{UP} and @key{DOWN} arrows move through command
+history like xterm.
address@hidden defopt
+
address@hidden idlwave-shell-comint-settings
+Alist of special settings for the comint variables in the IDLWAVE Shell.
address@hidden defopt
+
address@hidden idlwave-shell-file-name-chars
+The characters allowed in file names, as a string. Used for file name
+completion.
address@hidden defopt
+
address@hidden idlwave-shell-graphics-window-size
+Size of IDL graphics windows popped up by special IDLWAVE command.
address@hidden defopt
+
address@hidden Input mode
address@hidden Character input mode (Shell)
address@hidden Line input mode (Shell)
address@hidden Magic spells, for input mode
address@hidden Spells, magic
+IDLWAVE works in line input mode: You compose a full command line, using
+all the power Emacs gives you to do this. When you press @key{RET}, the
+whole line is sent to IDL. Sometimes it is necessary to send single
+characters (without a newline), for example when an IDL program is
+waiting for single character input with the @code{GET_KBRD} function.
+You can send a single character to IDL with the command @kbd{C-c C-x}
+(@code{idlwave-shell-send-char}). When you press @kbd{C-c C-y}
+(@code{idlwave-shell-char-mode-loop}), IDLWAVE runs a blocking loop
+which accepts characters and immediately sends them to IDL. The loop
+can be exited with @kbd{C-g}. It terminates also automatically when the
+current IDL command is finished. Check the documentation of the two
+variables described below for a way to make IDL programs trigger
+automatic switches of the input mode.
+
address@hidden idlwave-shell-use-input-mode-magic (@code{nil})
address@hidden means IDLWAVE should check for input mode spells in
+output.
address@hidden defopt
+
address@hidden idlwave-shell-input-mode-spells
+The three regular expressions which match the magic spells for input
+modes.
address@hidden defopt
+
address@hidden Commands Sent to the Shell, Debugging IDL Programs, Using the
Shell, The IDLWAVE Shell
address@hidden Commands Sent to the Shell
address@hidden Commands in shell, showing
address@hidden Showing commands in shell
+
+The IDLWAVE buffers and shell interact very closely. In addition to the
+normal commands you enter at the @code{IDL>} prompt, many other special
+commands are sent to the shell, sometimes as a direct result of invoking
+a key command, menu item, or toolbar button, but also automatically, as
+part of the normal flow of information updates between the buffer and
+shell.
+
+The commands sent include @code{breakpoint}, @code{.step} and other
+debug commands (@pxref{Debugging IDL Programs}), @code{.run} and other
+compilation statements (@pxref{Compiling Programs}), examination
+commands like @code{print} and @code{help} (@pxref{Examining
+Variables}), and other special purpose commands designed to keep
+information on the running shell current.
+
+By default, much of this background shell input and output is hidden
+from the user, but this is configurable. The custom variable
address@hidden allows you to configure which
+commands sent to the shell are shown there. For a related customization
+for separating the output of @emph{examine} commands, see @ref{Examining
+Variables}.
+
address@hidden idlwave-shell-show-commands (@code{'(run misc breakpoint)})
+A list of command types to echo in the shell when sent. Possible values
+are @code{run} for @code{.run}, @code{.compile} and other run commands,
address@hidden for lesser used commands like @code{window},
address@hidden,@code{close}, etc., @code{breakpoint} for breakpoint
+setting and clearing commands, and @code{debug} for other debug,
+stepping, and continue commands. In addition, if the variable is set to
+the single symbol @code{'everything}, all the copious shell input is
+displayed (which is probably only useful for debugging purposes).
+N.B. For hidden commands which produce output by side-effect, that
+output remains hidden (e.g., stepping through a @code{print} command).
+As a special case, any error message in the output will be displayed
+(e.g., stepping to an error).
address@hidden defopt
+
address@hidden Debugging IDL Programs, Examining Variables, Commands Sent to
the Shell, The IDLWAVE Shell
address@hidden Debugging IDL Programs
address@hidden Debugging
address@hidden Keybindings for debugging
address@hidden Toolbar
+
+Programs can be compiled, run, and debugged directly from the source
+buffer in Emacs, walking through arbitrarily deeply nested code,
+printing expressions and skipping up and down the calling stack along
+the way. IDLWAVE makes compiling and debugging IDL programs far less
+cumbersome by providing a full-featured, key/menu/toolbar-driven
+interface to commands like @code{breakpoint}, @code{.step},
address@hidden, etc. It can even perform complex debug operations not
+natively supported by IDL (like continuing to the line at the cursor).
+
+The IDLWAVE shell installs key bindings both in the shell buffer and
+in all IDL code buffers of the current Emacs session, so debug
+commands work in both places (in the shell, commands operate on the
+last file compiled). On Emacs versions which support it, a debugging
+toolbar is also installed. The toolbar display can be toggled with
address@hidden C-d C-t} (@code{idlwave-shell-toggle-toolbar}).
+
+
address@hidden idlwave-shell-use-toolbar (@code{t})
address@hidden means use the debugging toolbar in all IDL related
+buffers.
address@hidden defopt
+
address@hidden
+* A Tale of Two Modes::
+* Debug Key Bindings::
+* Breakpoints and Stepping::
+* Compiling Programs::
+* Walking the Calling Stack::
+* Electric Debug Mode::
address@hidden menu
+
+
address@hidden A Tale of Two Modes, Debug Key Bindings, Debugging IDL Programs,
Debugging IDL Programs
address@hidden A Tale of Two Modes
address@hidden Electric Debug Mode
address@hidden Debugging Interface
+
+The many debugging, compiling, and examination commands provided in
+IDLWAVE are available simultaneously through two different interfaces:
+the original, multi-key command interface, and the new Electric Debug
+Mode. The functionality they offer is similar, but the way you interact
+with them is quite different. The main difference is that, in Electric
+Debug Mode, the source buffers are made read-only, and single
+key-strokes are used to step through, examine expressions, set and
+remove breakpoints, etc. The same variables, prefix arguments, and
+settings apply to both versions, and both can be used interchangeably.
+By default, when breakpoints are hit, Electric Debug Mode is enabled.
+The traditional interface is described first. @xref{Electric Debug
+Mode}, for more on that mode. Note that electric debug mode can be
+prevented from activating automatically by customizing the variable
address@hidden
+
address@hidden Debug Key Bindings, Breakpoints and Stepping, A Tale of Two
Modes, Debugging IDL Programs
address@hidden Debug Key Bindings
address@hidden C-c C-d
address@hidden Key bindings
+
+The standard debugging key bindings are always available by default on
+the prefix key @kbd{C-c C-d}, so, for example, setting a breakpoint is
+done with @kbd{C-c C-d C-b}, and compiling a source file with @kbd{C-c
+C-d C-c}. You can also easily configure IDLWAVE to use one or more
+modifier keys not in use by other commands, in lieu of the prefix
address@hidden C-d} (though these bindings will typically also be available
+--- see @code{idlwave-shell-activate-prefix-keybindings}). For
+example, if you include in @file{.emacs}:
+
address@hidden
+(setq idlwave-shell-debug-modifiers '(control shift))
address@hidden lisp
+
address@hidden a breakpoint can then be set by pressing @kbd{b} while holding
down
address@hidden and @kbd{control} keys, i.e. @kbd{C-S-b}. Compiling a
+source file will be on @kbd{C-S-c}, deleting a breakpoint @kbd{C-S-d},
+etc. In the remainder of this chapter we will assume that the
address@hidden C-d} bindings are active, but each of these bindings will
+have an equivalent shortcut if modifiers are given in the
address@hidden variable (@pxref{Lesson II --
+Customization}). A much simpler and faster form of debugging for
+running code is also available by default --- see @ref{Electric Debug
+Mode}.
+
address@hidden idlwave-shell-prefix-key (@kbd{C-c C-d})
+The prefix key for the debugging map
address@hidden
address@hidden defopt
+
address@hidden idlwave-shell-activate-prefix-keybindings (@code{t})
address@hidden means debug commands will be bound to the prefix
+key, like @kbd{C-c C-d C-b}.
address@hidden defopt
+
address@hidden idlwave-shell-debug-modifiers (@code{nil})
+List of modifier keys to use for additional, alternative binding of
+debugging commands in the shell and source buffers. Can be one or
+more of @code{control}, @code{meta}, @code{super}, @code{hyper},
address@hidden, and @code{shift}.
address@hidden defopt
+
address@hidden Breakpoints and Stepping, Compiling Programs, Debug Key
Bindings, Debugging IDL Programs
address@hidden Breakpoints and Stepping
address@hidden Breakpoints
address@hidden Stepping
address@hidden Execution, controlled
+
address@hidden C-c C-d C-b
address@hidden C-c C-d C-b
+IDLWAVE helps you set breakpoints and step through code. Setting a
+breakpoint in the current line of the source buffer is accomplished
+with @kbd{C-c C-d C-b} (@code{idlwave-shell-break-here}). With a
+prefix arg of 1 (i.e. @kbd{C-1 C-c C-d C-b}), the breakpoint gets a
address@hidden/ONCE} keyword, meaning that it will be deleted after first use.
+With a numeric prefix greater than one (e.g. @kbd{C-4 C-c C-d C-b}),
+the breakpoint will only be active the @code{nth} time it is hit.
+With a single non-numeric prefix (i.e. @kbd{C-u C-c C-d C-b}), prompt
+for a condition --- an IDL expression to be evaluated and trigger the
+breakpoint only if true. To clear the breakpoint in the current line,
+use @kbd{C-c C-d C-d} (@code{idlwave-clear-current-bp}). When
+executed from the shell window, the breakpoint where IDL is currently
+stopped will be deleted. To clear all breakpoints, use @kbd{C-c C-d
+C-a} (@code{idlwave-clear-all-bp}). Breakpoints can also be disabled
+and re-enabled: @kbd{C-c C-d C-\}
+(@code{idlwave-shell-toggle-enable-current-bp}).
+
+Breakpoint lines are highlighted or indicated with an icon in the source
+code (different icons for conditional, after, and other break types).
+Disabled breakpoints are @emph{grayed out} by default. Note that IDL
+places breakpoints as close as possible on or after the line you
+specify. IDLWAVE queries the shell for the actual breakpoint location
+which was set, so the exact line you specify may not be marked. You can
+re-sync the breakpoint list and update the display at any time (e.g., if
+you add or remove some on the command line) using @kbd{C-c C-d C-l}.
+
+In recent IDLWAVE versions, the breakpoint line is highlighted when the
+mouse is moved over it, and a tooltip pops up describing the break
+details. @kbd{Mouse-3} on the breakpoint line pops up a menu of
+breakpoint actions, including clearing, disabling, and adding or
+changing break conditions or ``after'' break count.
+
+Once the program has stopped somewhere, you can step through it. The
+most important stepping commands are @kbd{C-c C-d C-s} to execute one
+line of IDL code ("step into"); @kbd{C-c C-d C-n} to step a single line,
+treating procedure and function calls as a single step ("step over");
address@hidden C-d C-h} to continue execution to the line at the cursor and
address@hidden C-d C-r} to continue execution. @xref{Commands Sent to the
+Shell}, for information on displaying or hiding the breakpoint and
+stepping commands the shell receives. Here is a summary of the
+breakpoint and stepping commands:
+
address@hidden @columnfractions .23 .77
address@hidden @kbd{C-c C-d C-b}
address@hidden Set breakpoint (@code{idlwave-shell-break-here})
address@hidden @kbd{C-c C-d C-i}
address@hidden Set breakpoint in module named here
(@code{idlwave-shell-break-in})
address@hidden @kbd{C-c C-d C-d}
address@hidden Clear current breakpoint (@code{idlwave-shell-clear-current-bp})
address@hidden @kbd{C-c C-d C-a}
address@hidden Clear all breakpoints (@code{idlwave-shell-clear-all-bp})
address@hidden @kbd{C-c C-d [}
address@hidden Go to the previous breakpoint
(@code{idlwave-shell-goto-previous-bp})
address@hidden @kbd{C-c C-d ]}
address@hidden Go to the next breakpoint (@code{idlwave-shell-goto-next-bp})
address@hidden @kbd{C-c C-d C-\}
address@hidden Disable/Enable current breakpoint
(@code{idlwave-shell-toggle-enable-current-bp})
address@hidden @kbd{C-c C-d C-j}
address@hidden Set a breakpoint at the beginning of the enclosing routine.
address@hidden @kbd{C-c C-d C-s}
address@hidden Step, into function calls (@code{idlwave-shell-step})
address@hidden @kbd{C-c C-d C-n}
address@hidden Step, over function calls (@code{idlwave-shell-stepover})
address@hidden @kbd{C-c C-d C-k}
address@hidden Skip one statement (@code{idlwave-shell-skip})
address@hidden @kbd{C-c C-d C-u}
address@hidden Continue to end of block (@code{idlwave-shell-up})
address@hidden @kbd{C-c C-d C-m}
address@hidden Continue to end of function (@code{idlwave-shell-return})
address@hidden @kbd{C-c C-d C-o}
address@hidden Continue past end of function (@code{idlwave-shell-out})
address@hidden @kbd{C-c C-d C-h}
address@hidden Continue to line at cursor position
(@code{idlwave-shell-to-here})
address@hidden @kbd{C-c C-d C-r}
address@hidden Continue execution to next breakpoint, if any
(@code{idlwave-shell-cont})
address@hidden @kbd{C-c C-d C-up}
address@hidden Show higher level in calling stack
(@code{idlwave-shell-stack-up})
address@hidden @kbd{C-c C-d C-down}
address@hidden Show lower level in calling stack
(@code{idlwave-shell-stack-down})
address@hidden multitable
+
+All of these commands have equivalents in Electric Debug Mode, which
+provides faster single-key access (@pxref{Electric Debug Mode}).
+
+The line where IDL is currently stopped, at breakpoints, halts, and
+errors, etc., is marked with a color overlay or arrow, depending on the
+setting in @code{idlwave-shell-mark-stop-line}. If an overlay face is
+used to mark the stop line (as it is by default), when stepping through
+code, the face color is temporarily changed to gray, until IDL completes
+the next command and moves to the new line.
+
address@hidden idlwave-shell-mark-breakpoints (@code{t})
address@hidden means mark breakpoints in the source file buffers. The
+value indicates the preferred method. Valid values are @code{nil},
address@hidden, @code{face}, and @code{glyph}.
address@hidden defopt
+
address@hidden idlwave-shell-breakpoint-face
+The face for breakpoint lines in the source code if
address@hidden has the value @code{face}.
address@hidden defopt
+
address@hidden idlwave-shell-breakpoint-popup-menu (@code{t})
+Whether to pop-up a menu and present a tooltip description on
+breakpoint lines.
address@hidden defopt
+
address@hidden idlwave-shell-mark-stop-line (@code{t})
address@hidden means mark the source code line where IDL is currently
+stopped. The value specifies the preferred method. Valid values are
address@hidden, @code{t}, @code{arrow}, and @code{face}.
address@hidden defopt
+
address@hidden idlwave-shell-overlay-arrow (@code{">"})
+The overlay arrow to display at source lines where execution halts, if
+configured in @code{idlwave-shell-mark-stop-line}.
address@hidden defopt
+
address@hidden idlwave-shell-stop-line-face
+The face which highlights the source line where IDL is stopped, if
+configured in @code{idlwave-shell-mark-stop-line}.
address@hidden defopt
+
+
address@hidden Compiling Programs, Walking the Calling Stack, Breakpoints and
Stepping, Debugging IDL Programs
address@hidden Compiling Programs
address@hidden Compiling programs
address@hidden Programs, compiling
address@hidden Default command line, executing
address@hidden Executing a default command line
+
address@hidden C-c C-d C-c
+In order to compile the current buffer under the IDLWAVE shell, press
address@hidden C-d C-c} (@code{idlwave-save-and-run}). This first saves the
+current buffer and then sends the command @samp{.run path/to/file} to the
+shell. You can also execute @kbd{C-c C-d C-c} from the shell buffer, in
+which case the most recently compiled buffer will be saved and
+re-compiled.
+
+When developing or debugging a program, it is often necessary to execute
+the same command line many times. A convenient way to do this is
address@hidden C-d C-y} (@code{idlwave-shell-execute-default-command-line}).
+This command first resets IDL from a state of interrupted execution by
+closing all files and returning to the main interpreter level. Then a
+default command line is send to the shell. To edit the default command
+line, call @code{idlwave-shell-execute-default-command-line} with a
+prefix argument: @kbd{C-u C-c C-d C-y}. If no default command line has
+been set (or you give two prefix arguments), the last command on the
address@hidden input history is sent.
+
address@hidden C-c C-d C-e
address@hidden Compiling regions
+For quickly compiling and running the currently marked region as a main
+level program @kbd{C-c C-d C-e} (@code{idlwave-shell-run-region}) is
+very useful. A temporary file is created holding the contents of the
+current region (with @code{END} appended), and run from the shell.
+
address@hidden Walking the Calling Stack, Electric Debug Mode, Compiling
Programs, Debugging IDL Programs
address@hidden Walking the Calling Stack
address@hidden Calling stack, walking
+
+While debugging a program, it can be very useful to check the context in
+which the current routine was called, for instance to help understand
+the value of the arguments passed. To do so conveniently you need to
+examine the calling stack. If execution is stopped somewhere deep in a
+program, you can use the commands @kbd{C-c C-d address@hidden
+(@code{idlwave-shell-stack-up}) and @kbd{C-c C-d address@hidden
+(@code{idlwave-shell-stack-down}), or the corresponding toolbar buttons,
+to move up or down through the calling stack. The mode line of the
+shell window will indicate the position within the stack with a label
+like @samp{[-3:MYPRO]}. The line of IDL code at that stack position
+will be highlighted. If you continue execution, IDLWAVE will
+automatically return to the current level. @xref{Examining Variables},
+for information how to examine the value of variables and expressions on
+higher calling stack levels.
+
address@hidden
+<A NAME="EDEBUG"></A>
address@hidden html
address@hidden Electric Debug Mode, , Walking the Calling Stack, Debugging IDL
Programs
address@hidden Electric Debug Mode
address@hidden Electric Debug Mode
address@hidden @samp{*Debugging*}
+
+Even with a convenient debug key prefix enabled, repetitive stepping,
+variable examination (@pxref{Examining Variables}), and other debugging
+activities can be awkward and slow using commands which require multiple
+keystrokes. Luckily, there's a better way, inspired by the lisp e-debug
+mode, and available through the @emph{Electric Debug Mode}. By default,
+as soon as a breakpoint is hit, this minor mode is enabled. The buffer
+showing the line where execution has halted is switched to Electric
+Debug Mode. This mode is visible as @samp{*Debugging*} in the mode
+line, and a different face (violet by default, if color is available)
+for the line stopped at point. The buffer is made read-only and
+single-character bindings for the most commonly used debugging commands
+are enabled. These character commands (a list of which is available
+with @kbd{C-?}) are:
+
address@hidden @columnfractions .2 .8
address@hidden @kbd{a}
address@hidden Clear all breakpoints (@code{idlwave-shell-clear-all-bp})
address@hidden @kbd{b}
address@hidden Set breakpoint, @kbd{C-u b} for a conditional break, @kbd{C-n b}
for nth hit (@code{idlwave-shell-break-here})
address@hidden @kbd{d}
address@hidden Clear current breakpoint (@code{idlwave-shell-clear-current-bp})
address@hidden @kbd{e}
address@hidden Prompt for expression to print
(@code{idlwave-shell-clear-current-bp}).
address@hidden @kbd{h}
address@hidden Continue to the line at cursor position
(@code{idlwave-shell-to-here})
address@hidden @kbd{i}
address@hidden Set breakpoint in module named here
(@code{idlwave-shell-break-in})
address@hidden @kbd{[}
address@hidden Go to the previous breakpoint in the file
(@code{idlwave-shell-goto-previous-bp})
address@hidden @kbd{]}
address@hidden Go to the next breakpoint in the file
+(@code{idlwave-shell-goto-next-bp})
address@hidden @kbd{\}
address@hidden Disable/Enable current breakpoint
(@code{idlwave-shell-toggle-enable-current-bp})
address@hidden @kbd{j}
address@hidden Set breakpoint at beginning of enclosing routine
(@code{idlwave-shell-break-this-module})
address@hidden @kbd{k}
address@hidden Skip one statement (@code{idlwave-shell-skip})
address@hidden @kbd{m}
address@hidden Continue to end of function (@code{idlwave-shell-return})
address@hidden @kbd{n}
address@hidden Step, over function calls (@code{idlwave-shell-stepover})
address@hidden @kbd{o}
address@hidden Continue past end of function (@code{idlwave-shell-out})
address@hidden @kbd{p}
address@hidden Print expression near point or in region with @kbd{C-u p}
(@code{idlwave-shell-print})
address@hidden @kbd{q}
address@hidden End the debugging session and return to the Shell's main level
+(@code{idlwave-shell-retall})
address@hidden @kbd{r}
address@hidden Continue execution to next breakpoint, if any
(@code{idlwave-shell-cont})
address@hidden @kbd{s} or @address@hidden
address@hidden Step, into function calls (@code{idlwave-shell-step})
address@hidden @kbd{t}
address@hidden Print a calling-level traceback in the shell
address@hidden @kbd{u}
address@hidden Continue to end of block (@code{idlwave-shell-up})
address@hidden @kbd{v}
address@hidden Turn Electric Debug Mode off
+(@code{idlwave-shell-electric-debug-mode})
address@hidden @kbd{x}
address@hidden Examine expression near point (or in region with @kbd{C-u x})
+with shortcut of examine type.
address@hidden @kbd{z}
address@hidden Reset IDL (@code{idlwave-shell-reset})
address@hidden @kbd{+} or @kbd{=}
address@hidden Show higher level in calling stack
(@code{idlwave-shell-stack-up})
address@hidden @kbd{-} or @kbd{_}
address@hidden Show lower level in calling stack
(@code{idlwave-shell-stack-down})
address@hidden @kbd{?}
address@hidden Help on expression near point or in region with @kbd{C-u ?}
+(@code{idlwave-shell-help-expression})
address@hidden @kbd{C-?}
address@hidden Show help on the commands available.
address@hidden multitable
+
+Most single-character electric debug bindings use the final keystroke
+of the equivalent multiple key commands (which are of course also
+still available), but some differ (e.g. @kbd{e},@kbd{t},@kbd{q},@kbd{x}).
+Some have additional convenience bindings (like @address@hidden for
+stepping). All prefix and other argument options described in this
+section for the commands invoked by electric debug bindings are still
+valid. For example, @kbd{C-u b} sets a conditional breakpoint, just
+as it did with @kbd{C-u C-c C-d C-b}.
+
+You can toggle the electric debug mode at any time in a buffer using
address@hidden C-d C-v} (@kbd{v} to turn it off while in the mode), or from
+the Debug menu. Normally the mode will be enabled and disabled at the
+appropriate times, but occasionally you might want to edit a file
+while still debugging it, or switch to the mode for conveniently
+setting lots of breakpoints.
+
+To quickly abandon a debugging session and return to normal editing at
+the Shell's main level, use @kbd{q} (@code{idlwave-shell-retall}).
+This disables electric debug mode in all IDLWAVE address@hidden
+that this binding is not symmetric: @kbd{C-c C-d C-q} is bound to
address@hidden, which quits your IDL session.}. Help is
+available for the command shortcuts with @kbd{C-?}. If you find this
+mode gets in your way, you can keep it from automatically activating
+by setting the variable @code{idlwave-shell-automatic-electric-debug}
+to @code{nil}, or @code{'breakpoint}. If you'd like the convenient
+electric debug shortcuts available also when run-time errors are
+encountered, set to @code{t}.
+
address@hidden idlwave-shell-automatic-electric-debug (@code{'breakpoint})
+Whether to enter electric debug mode automatically when a breakpoint
+or run-time error is encountered, and then disable it in all buffers
+when the $MAIN$ level is reached (either through normal program
+execution, or retall). In addition to @code{nil} for never, and
address@hidden for both breakpoints and errors, this can be
address@hidden'breakpoint} (the default) to enable it only at breakpoint
+halts.
address@hidden defopt
+
address@hidden idlwave-shell-electric-stop-color (Violet)
+Default color of the stopped line overlay when in electric debug mode.
address@hidden defopt
+
address@hidden idlwave-shell-electric-stop-line-face
+The face to use for the stopped line. Defaults to a face similar to the
+modeline, with color @code{idlwave-shell-electric-stop-color}.
address@hidden defopt
+
address@hidden idlwave-shell-electric-zap-to-file (@code{t})
+If set, when entering electric debug mode, select the window displaying
+the file where point is stopped. This takes point away from the shell
+window, but is useful for immediate stepping, etc.
address@hidden defopt
+
address@hidden
+<A NAME="EXAMINE"></A>
address@hidden html
address@hidden Examining Variables, Custom Expression Examination, Debugging
IDL Programs, The IDLWAVE Shell
address@hidden Examining Variables
address@hidden @code{PRINT} expressions
address@hidden @code{HELP}, on expressions
address@hidden Expressions, printing & help
address@hidden Examining expressions
address@hidden Printing expressions
address@hidden Mouse binding to print expressions
+
address@hidden C-c C-d C-p
+Do you find yourself repeatedly typing, e.g. @code{print,n_elements(x)},
+and similar statements to remind yourself of the
+type/size/structure/value/etc. of variables and expressions in your code
+or at the command line? IDLWAVE has a suite of special commands to
+automate these types of variable or expression examinations. They work
+by sending statements to the shell formatted to include the indicated
+expression, and can be accessed in several ways.
+
+These @emph{examine} commands can be used in the shell or buffer at any
+time (as long as the shell is running), and are very useful when
+execution is stopped in a buffer due to a triggered breakpoint or error,
+or while composing a long command in the IDLWAVE shell. In the latter
+case, the command is sent to the shell and its output is visible, but
+point remains unmoved in the command being composed --- you can inspect
+the constituents of a command you're building without interrupting the
+process of building it! You can even print arbitrary expressions from
+older input or output further up in the shell window --- any expression,
+variable, number, or function you see can be examined.
+
+If the variable @code{idlwave-shell-separate-examine-output} is
address@hidden (the default), all examine output will be sent to a
+special @file{*Examine*} buffer, rather than the shell. The output of
+prior examine commands is saved in this buffer. In this buffer @key{c}
+clears the contents, and @key{q} hides the buffer.
+
+The two most basic examine commands are bound to @kbd{C-c C-d C-p}, to
+print the expression at point, and @kbd{C-c C-d ?}, to invoke help on
+this address@hidden as @kbd{p} and @kbd{?} in Electric
+Debug Mode (@pxref{Electric Debug Mode})}. The expression at point is
+either an array expression or a function call, or the contents of a pair
+of parentheses. The chosen expression is highlighted, and
+simultaneously the resulting output is highlighted in the shell or
+separate output buffer. Calling the above commands with a prefix
+argument will use the current region as expression instead of using the
+one at point. which can be useful for examining complicated, multi-line
+expressions. Two prefix arguments (@kbd{C-u C-u C-c C-d C-p}) will
+prompt for an expression to print directly. By default, when invoking
+print, only an initial portion of long arrays will be printed, up to
address@hidden
+
+For added speed and convenience, there are mouse bindings which allow
+you to click on expressions and examine their values. Use
address@hidden to print an expression and @kbd{C-M-Mouse-2} to invoke
+help (i.e. you need to hold down @key{META} and @key{CONTROL} while
+clicking with the middle mouse button). If you simply click, the
+nearest expression will be selected in the same manner as described
+above. You can also @emph{drag} the mouse in order to highlight
+exactly the specific expression or sub-expression you want to examine.
+For custom expression examination, and the powerful customizable
+pop-up examine selection, @xref{Custom Expression Examination}.
+
address@hidden Printing expressions, on calling stack
address@hidden Restrictions for expression printing
+The same variable inspection commands work both in the IDL Shell and
+IDLWAVE buffers, and even for variables at higher levels of the calling
+stack. For instance, if you're stopped at a breakpoint in a routine,
+you can examine the values of variables and expressions inside its
+calling routine, and so on, all the way up through the calling stack.
+Simply step up the stack, and print variables as you see them
+(@pxref{Walking the Calling Stack}, for information on stepping back
+through the calling stack). The following restrictions apply for all
+levels except the current:
+
address@hidden @bullet
address@hidden
+Array expressions must use the @samp{[ ]} index delimiters. Identifiers
+with a @samp{( )} will be interpreted as function calls.
address@hidden
address@hidden ROUTINE_NAMES, IDL procedure
+N.B.: printing values of expressions on higher levels of the calling
+stack uses the @emph{unsupported} IDL routine @code{ROUTINE_NAMES},
+which may or may not be available in future versions of IDL. Caveat
+Examinor.
address@hidden itemize
+
address@hidden idlwave-shell-expression-face
+The face for @code{idlwave-shell-expression-overlay}.
+Allows you to choose the font, color and other properties for
+the expression printed by IDL.
address@hidden defopt
+
address@hidden idlwave-shell-output-face
+The face for @code{idlwave-shell-output-overlay}.
+Allows to choose the font, color and other properties for the most
+recent output of IDL when examining an expression."
address@hidden defopt
+
address@hidden idlwave-shell-separate-examine-output (@code{t})
+If address@hidden, re-direct the output of examine commands to a special
address@hidden buffer, instead of in the shell itself.
address@hidden defopt
+
address@hidden idlwave-shell-max-print-length (200)
+The maximum number of leading array entries to print, when examining
+array expressions.
address@hidden defopt
+
address@hidden Custom Expression Examination, , Examining Variables, The
IDLWAVE Shell
address@hidden Custom Expression Examination
address@hidden Expressions, custom examination
address@hidden Custom expression examination
+
+The variety of possible variable and expression examination commands is
+endless (just look, for instance, at the keyword list to
address@hidden()}). Rather than attempt to include them all, IDLWAVE
+provides two easy methods to customize your own commands, with a special
+mouse examine command, and two macros for generating your own examine
+key and mouse bindings.
+
+The most powerful and flexible mouse examine command of all is
+available on @kbd{C-S-Mouse-2}. Just as for all the other mouse
+examine commands, it permits click or drag expression selection, but
+instead of sending hard-coded commands to the shell, it pops-up a
+customizable selection list of examine functions to choose among,
+configured with the @code{idlwave-shell-examine-alist}
address@hidden Electric Debug Mode (@pxref{Electric Debug
+Mode}), the key @kbd{x} provides a single-character shortcut interface
+to the same examine functions for the expression at point or marked by
+the region.}. This variable is a list of key-value pairs (an
address@hidden in Emacs parlance), where the key gives a name to be
+shown for the examine command, and the value is the command strings
+itself, in which the text @code{___} (three underscores) will be
+replaced by the selected expression before being sent to the shell.
+An example might be key @code{Structure Help} with value
address@hidden,___,/STRUCTURE}. In that case, you'd be prompted with
address@hidden Help}, which might send something like
address@hidden,var,/STRUCTURE} to the shell for output.
address@hidden comes configured by default with a
+large list of examine commands, but you can easily customize it to add
+your own.
+
+In addition to configuring the functions available to the pop-up mouse
+command, you can easily create your own customized bindings to inspect
+expressions using the two convenience macros
address@hidden and @code{idlwave-shell-mouse-examine}.
+These create keyboard or mouse-based custom inspections of variables,
+sharing all the same properties of the built-in examine commands.
+Both functions take a single string argument sharing the syntax of the
address@hidden values, e.g.:
+
address@hidden
+(add-hook 'idlwave-shell-mode-hook
+ (lambda ()
+ (idlwave-shell-define-key-both [s-down-mouse-2]
+ (idlwave-shell-mouse-examine
+ "print, size(___,/DIMENSIONS)"))
+ (idlwave-shell-define-key-both [f9] (idlwave-shell-examine
+ "print, size(___,/DIMENSIONS)"))
+ (idlwave-shell-define-key-both [f10] (idlwave-shell-examine
+ "print,size(___,/TNAME)"))
+ (idlwave-shell-define-key-both [f11] (idlwave-shell-examine
+ "help,___,/STRUCTURE"))))
address@hidden lisp
+
address@hidden Now pressing @key{f9}, or middle-mouse dragging with the
address@hidden key depressed, will print the dimensions of the nearby or
+highlighted expression. Pressing @key{f10} will give the type string,
+and @key{f11} will show the contents of a nearby structure. As you can
+see, the possibilities are only marginally finite.
+
address@hidden idlwave-shell-examine-alist
+An alist of examine commands in which the keys name the command and
+are displayed in the selection pop-up, and the values are custom IDL
+examine command strings to send, after all instances of @code{___}
+(three underscores) are replaced by the indicated expression.
address@hidden defopt
+
address@hidden Acknowledgements, Sources of Routine Info, The IDLWAVE Shell, Top
address@hidden Acknowledgements
address@hidden Acknowledgements
address@hidden Maintainer, of IDLWAVE
address@hidden Authors, of IDLWAVE
address@hidden Contributors, to IDLWAVE
address@hidden Email address, of Maintainer
address@hidden Thanks
+
address@hidden
+The main contributors to the IDLWAVE package have been:
+
address@hidden @minus
address@hidden
address@hidden:chase@@att.com, @b{Chris Chase}}, the original author.
+Chris wrote @file{idl.el} and @file{idl-shell.el} and maintained them
+for several years.
+
address@hidden
address@hidden:dominik@@astro.uva.nl, @b{Carsten Dominik}} was in charge
+of the package from version 3.0, during which time he overhauled almost
+everything, modernized IDLWAVE with many new features, and developed the
+manual.
+
address@hidden
address@hidden:jdsmith@@as.arizona.edu, @b{J.D. Smith}}, the current
+maintainer, as of version 4.10, helped shape object method completion
+and most new features introduced in versions 4.x, and introduced many
+new features for IDLWAVE versions 5.x and 6.x.
address@hidden itemize
+
address@hidden
+The following people have also contributed to the development of IDLWAVE
+with patches, ideas, bug reports and suggestions.
+
address@hidden @minus
address@hidden
+Ulrik Dickow <dickow__at__nbi.dk>
address@hidden
+Eric E. Dors <edors__at__lanl.gov>
address@hidden
+Stein Vidar H. Haugan <s.v.h.haugan__at__astro.uio.no>
address@hidden
+David Huenemoerder <dph__at__space.mit.edu>
address@hidden
+Kevin Ivory <Kevin.Ivory__at__linmpi.mpg.de>
address@hidden
+Dick Jackson <dick__at__d-jackson.com>
address@hidden
+Xuyong Liu <liu__at__stsci.edu>
address@hidden
+Simon Marshall <Simon.Marshall__at__esrin.esa.it>
address@hidden
+Craig Markwardt <craigm__at__cow.physics.wisc.edu>
address@hidden
+Laurent Mugnier <mugnier__at__onera.fr>
address@hidden
+Lubos Pochman <lubos__at__rsinc.com>
address@hidden
+Bob Portmann <portmann__at__al.noaa.gov>
address@hidden
+Patrick M. Ryan <pat__at__jaameri.gsfc.nasa.gov>
address@hidden
+Marty Ryba <ryba__at__ll.mit.edu>
address@hidden
+Phil Williams <williams__at__irc.chmcc.org>
address@hidden
+Phil Sterne <sterne__at__dublin.llnl.gov>
address@hidden
+Paul Sorenson <aardvark62__at__msn.com>
address@hidden itemize
+
+Doug Dirks was instrumental in providing the crucial IDL XML catalog to
+support HTML help with IDL v6.2 and later, and Ali Bahrami provided
+scripts and documentation to interface with the IDL Assistant.
+
address@hidden
+Thanks to everyone!
+
address@hidden Sources of Routine Info, HTML Help Browser Tips,
Acknowledgements, Top
address@hidden Sources of Routine Info
+
address@hidden Sources of routine information
+In @ref{Routine Info} and @ref{Completion} we showed how IDLWAVE
+displays the calling sequence and keywords of routines, and completes
+routine names and keywords. For these features to work, IDLWAVE must
+know about the accessible routines.
+
address@hidden
+* Routine Definitions:: Where IDL Routines are defined.
+* Routine Information Sources:: So how does IDLWAVE know about...
+* Catalogs::
+* Load-Path Shadows:: Routines defined in several places
+* Documentation Scan:: Scanning the IDL Manuals
address@hidden menu
+
address@hidden Routine Definitions, Routine Information Sources, Sources of
Routine Info, Sources of Routine Info
address@hidden Routine Definitions
address@hidden Routine definitions
address@hidden IDL variable @code{!PATH}
address@hidden @code{!PATH}, IDL variable
address@hidden @code{CALL_EXTERNAL}, IDL routine
address@hidden @code{LINKIMAGE}, IDL routine
address@hidden External routines
+
address@hidden Routines which can be used in an IDL program can be defined in
+several places:
+
address@hidden
address@hidden
address@hidden routines} are defined inside IDL itself. The source code
+of such routines is not available, but instead are learned about through
+the IDL documentation.
address@hidden
+Routines which are @emph{part of the current program}, are defined in a
+file explicitly compiled by the user. This file may or may not be
+located on the IDL search path.
address@hidden
address@hidden routines} are defined in files located on IDL's search
+path. When a library routine is called for the first time, IDL will
+find the source file and compile it dynamically. A special sub-category
+of library routines are the @emph{system routines} distributed with IDL,
+and usually available in the @file{lib} subdirectory of the IDL
+distribution.
address@hidden
+External routines written in other languages (like Fortran or C) can be
+called with @code{CALL_EXTERNAL}, linked into IDL via @code{LINKIMAGE},
+or included as dynamically loaded modules (DLMs). Currently IDLWAVE
+cannot provide routine info and completion for such external routines,
+except by querying the Shell for calling information (DLMs only).
address@hidden enumerate
+
address@hidden Routine Information Sources, Catalogs, Routine Definitions,
Sources of Routine Info
address@hidden Routine Information Sources
address@hidden Routine info sources
address@hidden Builtin list of routines
address@hidden Updating routine info
address@hidden Scanning buffers for routine info
address@hidden Buffers, scanning for routine info
address@hidden Shell, querying for routine info
+
address@hidden To maintain the most comprehensive information about all IDL
+routines on a system, IDLWAVE collects data from many sources:
+
address@hidden
+
address@hidden
+It has a @emph{builtin list} with information about the routines IDL
+ships with. IDLWAVE @value{VERSION} is distributed with a list of
address@hidden routines and object methods, reflecting IDL version
address@hidden As of IDL v6.2, the routine info is distributed
+directly with IDL in the form of an XML catalog which IDLWAVE scans.
+Formerly, this list was created by scanning the IDL manuals to produce
+the file @file{idlw-rinfo.el}.
+
address@hidden
+IDLWAVE @emph{scans} all its @emph{buffers} in the current Emacs session
+for routine definitions. This is done automatically when routine
+information or completion is first requested by the user. Each new
+buffer and each buffer saved after making changes is also scanned. The
+command @kbd{C-c C-i} (@code{idlwave-update-routine-info}) can be used
+at any time to rescan all buffers.
+
address@hidden
+If you have an IDLWAVE-Shell running in the Emacs session, IDLWAVE will
address@hidden the shell} for compiled routines and their arguments. This
+happens automatically when routine information or completion is first
+requested by the user. Each time an Emacs buffer is compiled with
address@hidden C-d C-c}, the routine info for that file is queried. Though
+rarely necessary, the command @kbd{C-c C-i}
+(@code{idlwave-update-routine-info}) can be used to explicitly update
+the shell routine data.
+
address@hidden
+Many popular libraries are distributed with routine information already
+scanned into @emph{library catalogs} (@pxref{Library Catalogs}). These
+per-directory catalog files can also be built by the user with the
+supplied @file{idlwave_catalog} tool. They are automatically discovered
+by IDLWAVE.
+
address@hidden
+IDLWAVE can scan selected directories of source files and store the
+result in a single @emph{user catalog} file which will be
+automatically loaded just like @file{idlw-rinfo.el}. @xref{User
+Catalog}, for information on how to scan files in this way.
address@hidden enumerate
+
+Loading all the routine and catalog information can be a time consuming
+process, especially over slow networks. Depending on the system and
+network configuration it could take up to 30 seconds (though locally on
+fast systems is usually only a few seconds). In order to minimize the
+wait time upon your first completion or routine info command in a
+session, IDLWAVE uses Emacs idle time to do the initialization in six
+steps, yielding to user input in between. If this gets into your way,
+set the variable @code{idlwave-init-rinfo-when-idle-after} to 0 (zero).
+The more routines documented in library and user catalogs, the slower
+the loading will be, so reducing this number can help alleviate any long
+load times.
+
address@hidden idlwave-init-rinfo-when-idle-after (@code{10})
+Seconds of idle time before routine info is automatically initialized.
address@hidden defopt
+
address@hidden idlwave-scan-all-buffers-for-routine-info (@code{t})
address@hidden means scan all buffers for IDL programs when updating
+info.
address@hidden defopt
+
address@hidden idlwave-query-shell-for-routine-info (@code{t})
address@hidden means query the shell for info about compiled routines.
address@hidden defopt
+
address@hidden idlwave-auto-routine-info-updates
+Controls under what circumstances routine info is updated automatically.
address@hidden defopt
+
address@hidden
+<A NAME="CATALOGS"></A>
address@hidden html
address@hidden Catalogs, Load-Path Shadows, Routine Information Sources,
Sources of Routine Info
address@hidden Catalogs
address@hidden Catalogs
+
address@hidden are files containing scanned information on individual
+routines, including arguments and keywords, calling sequence, file path,
+class and procedure vs. function type, etc. They represent a way of
+extending the internal built-in information available for IDL system
+routines (@pxref{Routine Info}) to other source collections.
+
+Starting with version 5.0, there are two types of catalogs available
+with IDLWAVE. The traditional @emph{user catalog} and the newer
address@hidden catalogs}. Although they can be used interchangeably, the
+library catalogs are more flexible, and preferred. There are few
+occasions when a user catalog might be preferred --- read below. Both
+types of catalogs can coexist without causing problems.
+
+To facilitate the catalog systems, IDLWAVE stores information it gathers
+from the shell about the IDL search paths, and can write this
+information out automatically, or on-demand (menu @code{Debug->Save Path
+Info}). On systems with no shell from which to discover the path
+information (e.g. Windows), a library path must be specified in
address@hidden to allow library catalogs to be located, and
+to setup directories for user catalog scan (@pxref{User Catalog} for
+more on this variable). Note that, before the shell is running, IDLWAVE
+can only know about the IDL search path by consulting the file pointed
+to by @code{idlwave-path-file} (@file{~/.idlwave/idlpath.el}, by
+default). If @code{idlwave-auto-write-path} is enabled (which is the
+default), the paths are written out whenever the IDLWAVE shell is
+started.
+
address@hidden idlwave-auto-write-path (@code{t})
+Write out information on the !PATH and !DIR paths from IDL automatically
+when they change and when the Shell is closed. These paths are needed
+to locate library catalogs.
address@hidden defopt
+
address@hidden idlwave-library-path
+IDL library path for Windows and MacOS. Under Unix/MacOSX, will be
+obtained from the Shell when run.
address@hidden defopt
+
address@hidden idlwave-system-directory
+The IDL system directory for Windows and MacOS. Also needed for
+locating HTML help and the IDL Assistant for IDL v6.2 and later. Under
+Unix/MacOSX, will be obtained from the Shell and recorded, if run.
address@hidden defopt
+
address@hidden idlwave-config-directory (@file{~/.idlwave})
+Default path where IDLWAVE saves configuration information, a user
+catalog (if any), and a cached scan of the XML catalog (IDL v6.2 and
+later).
address@hidden defopt
+
address@hidden
+* Library Catalogs::
+* User Catalog::
address@hidden menu
+
address@hidden
+<A NAME="LIBRARY_CATALOGS"></A>
address@hidden html
address@hidden Library Catalogs, User Catalog, Catalogs, Catalogs
address@hidden Library Catalogs
address@hidden @file{.idlwave_catalog}
address@hidden Library catalogs
address@hidden @code{idlwave_catalog}
+
+Library catalogs consist of files named @file{.idlwave_catalog} stored
+in directories containing @code{.pro} routine files. They are
+discovered on the IDL search path and loaded automatically when routine
+information is read. Each catalog file documents the routines found in
+that directory --- one catalog per directory. Every catalog has a
+library name associated with it (e.g. @emph{AstroLib}). This name will
+be shown briefly when the catalog is found, and in the routine info of
+routines it documents.
+
+Many popular libraries of routines are shipped with IDLWAVE catalog
+files by default, and so will be automatically discovered. Library
+catalogs are scanned externally to Emacs using a tool provided with
+IDLWAVE. Each catalog can be re-scanned independently of any other.
+Catalogs can easily be made available system-wide with a common source
+repository, providing uniform routine information, and lifting the
+burden of scanning from the user (who may not even know they're using a
+scanned catalog). Since all catalogs are independent, they can be
+re-scanned automatically to gather updates, e.g. in a @file{cron} job.
+Scanning is much faster than with the built-in user catalog method. One
+minor disadvantage: the entire IDL search path is scanned for catalog
+files every time IDLWAVE starts up, which might be slow if accessing IDL
+routines over a slow network.
+
+A Perl tool to create library catalogs is distributed with IDLWAVE:
address@hidden It can be called quite simply:
address@hidden
+idlwave_catalog MyLib
address@hidden example
+
address@hidden This will scan all directories recursively beneath the current
and
+populate them with @file{.idlwave_catalog} files, tagging the routines
+found there with the name library ``MyLib''. The full usage
+information:
+
address@hidden
+Usage: idlwave_catalog [-l] [-v] [-d] [-s] [-f] [-h] libname
+ libname - Unique name of the catalog (4 or more alphanumeric
+ characters).
+ -l - Scan local directory only, otherwise recursively
+ catalog all directories at or beneath this one.
+ -v - Print verbose information.
+ -d - Instead of scanning, delete all .idlwave_catalog files
+ here or below.
+ -s - Be silent.
+ -f - Force overwriting any catalogs found with a different
+ library name.
+ -h - Print this usage.
address@hidden example
+
+To re-load the library catalogs on the IDL path, force a system routine
+info update using a single prefix to @code{idlwave-update-routine-info}:
address@hidden C-c C-i}.
+
address@hidden idlwave-use-library-catalogs (@code{t})
+Whether to search for and load library catalogs. Disable if load
+performance is a problem and/or the catalogs are not needed.
address@hidden defopt
+
address@hidden User Catalog, , Library Catalogs, Catalogs
address@hidden User Catalog
address@hidden User catalog
address@hidden IDL library routine info
address@hidden Windows
address@hidden MacOS
address@hidden IDL variable @code{!DIR}
address@hidden @code{!DIR}, IDL variable
+
+The user catalog is the old routine catalog system. It is produced
+within Emacs, and stored in a single file in the user's home directory
+(@file{.idlwave/idlusercat.el} by default). Although library catalogs
+are more flexible, there may be reasons to prefer a user catalog
+instead, including:
+
address@hidden @bullet
address@hidden The scan is internal to Emacs, so you don't need a working Perl
+installation, as you do for library catalogs.
address@hidden Can be used to scan directories for which the user has no write
+privileges.
address@hidden Easy widget-based path selection.
address@hidden itemize
+
+However, no routine info is available in the user catalog by default;
+the user must actively complete a scan. In addition, this type of
+catalog is all or nothing: if a single routine changes, the entire
+catalog must be rescanned to update it. Creating the user catalog is
+also much slower than scanning library catalogs.
+
+You can scan any of the directories on the currently known path. Under
+Windows and MacOS (not OSX), you need to specify the IDL search path in
+the variable @code{idlwave-library-path}, and the location of the IDL
+directory (the value of the @code{!DIR} system variable) in the variable
address@hidden, like address@hidden initial @samp{+}
+leads to recursive expansion of the path, just like in IDL}:
+
address@hidden
+(setq idlwave-library-path
+ '("+c:/RSI/IDL56/lib/" "+c:/user/me/idllibs"))
+(setq idlwave-system-directory "c:/RSI/IDL56/")
address@hidden lisp
+
address@hidden Under GNU/Linux and UNIX, these values will be automatically
+gathered from the IDLWAVE shell, if run.
+
+The command @kbd{M-x idlwave-create-user-catalog-file} (or the menu item
address@hidden>Routine Info->Select Catalog Directories}) can then be
+used to create a user catalog. It brings up a widget in which you can
+select some or all directories on the search path. Directories which
+already contain a library catalog are marked with @samp{[LIB]}, and need
+not be scanned (although there is no harm if you do so, other than the
+additional memory used for the duplication).
+
+After selecting directories, click on the @address@hidden & Save]}}
+button in the widget to scan all files in the selected directories and
+write out the resulting routine information. In order to update the
+library information using the directory selection, call the command
address@hidden with a double prefix argument:
address@hidden@kbd{C-u C-u C-c C-i}}. This will rescan files in the previously
+selected directories, write an updated version of the user catalog file
+and rebuild IDLWAVE's internal lists. If you give three prefix
+arguments @address@hidden C-u C-u C-c C-i}}, updating will be done with a
+background address@hidden systems only, I think.}. You can continue
+to work, and the library catalog will be re-read when it is ready. If
+you find you need to update the user catalog often, you should consider
+building a library catalog for your routines instead (@pxref{Library
+Catalogs}).
+
address@hidden idlwave-special-lib-alist
+Alist of regular expressions matching special library directories for
+labeling in routine-info display.
address@hidden defopt
+
address@hidden Load-Path Shadows, Documentation Scan, Catalogs, Sources of
Routine Info
address@hidden Load-Path Shadows
address@hidden Load-path shadows
address@hidden Shadows, load-path
address@hidden Duplicate routines
address@hidden Multiply defined routines
address@hidden Routine definitions, multiple
address@hidden Application, testing for shadowing
address@hidden Buffer, testing for shadowing
+
+IDLWAVE can compile a list of routines which are (re-)defined in more
+than one file. Since one definition will hide (shadow) the others
+depending on which file is compiled first, such multiple definitions are
+called "load-path shadows". IDLWAVE has several routines to scan for
+load path shadows. The output is placed into the special buffer
address@hidden The format of the output is identical to the source
+section of the routine info buffer (@pxref{Routine Info}). The
+different definitions of a routine are ordered by @emph{likelihood of
+use}. So the first entry will be most likely the one you'll get if an
+unsuspecting command uses that routine. Before listing shadows, you
+should make sure that routine info is up-to-date by pressing @kbd{C-c
+C-i}. Here are the different routines (also available in the Menu
address@hidden>Routine Info}):
+
address@hidden @asis
address@hidden @kbd{M-x idlwave-list-buffer-load-path-shadows}
+This commands checks the names of all routines defined in the current
+buffer for shadowing conflicts with other routines accessible to
+IDLWAVE. The command also has a key binding: @kbd{C-c C-b}
address@hidden @kbd{M-x idlwave-list-shell-load-path-shadows}.
+Checks all routines compiled under the shell for shadowing. This is
+very useful when you have written a complete application. Just compile
+the application, use @code{RESOLVE_ALL} to compile any routines used by
+your code, update the routine info inside IDLWAVE with @kbd{C-c C-i} and
+then check for shadowing.
address@hidden @kbd{M-x idlwave-list-all-load-path-shadows}
+This command checks all routines accessible to IDLWAVE for conflicts.
address@hidden table
+
+For these commands to work fully you need to scan the entire load path
+in either a user or library catalog. Also, IDLWAVE should be able to
+distinguish between the system library files (normally installed in
address@hidden/usr/local/rsi/idl/lib}) and any site specific or user specific
+files. Therefore, such local files should not be installed inside the
address@hidden directory of the IDL directory. This is also advisable for
+many other reasons.
+
address@hidden Windows
address@hidden MacOS
address@hidden IDL variable @code{!DIR}
address@hidden @code{!DIR}, IDL variable
+Users of Windows and MacOS (not X) also must set the variable
address@hidden to the value of the @code{!DIR} system
+variable in IDL. IDLWAVE appends @file{lib} to the value of this
+variable and assumes that all files found on that path are system
+routines.
+
+Another way to find out if a specific routine has multiple definitions
+on the load path is routine info display (@pxref{Routine Info}).
+
address@hidden Documentation Scan, , Load-Path Shadows, Sources of Routine Info
address@hidden Documentation Scan
address@hidden @file{get_html_rinfo}
address@hidden @file{idlw-rinfo.el}
address@hidden Scanning the documentation
address@hidden Perl program, to create @file{idlw-rinfo.el}
+
address@hidden with version 6.2, IDL is distributed directly with HTML
+online help, and an XML-based catalog of routine information}. This
+makes scanning the manuals with the tool @file{get_html_rinfo}, and the
address@hidden file it produced, as described here, entirely
+unnecessary. The information is left here for users wishing to produce
+a catalog of older IDL versions' help.
+
+
+IDLWAVE derives its knowledge about system routines from the IDL
+manuals. The file @file{idlw-rinfo.el} contains the routine information
+for the IDL system routines, and links to relevant sections of the HTML
+documentation. The Online Help feature of IDLWAVE requires HTML
+versions of the IDL manuals to be available; the HTML documentation is
+not distributed with IDLWAVE by default, but must be downloaded
+separately.
+
+The HTML files and related images can be produced from the
address@hidden HTMLHelp file distributed with IDL using the free
+Microsoft HTML Help Workshop. If you are lucky, the maintainer of
+IDLWAVE will always have access to the newest version of IDL and provide
+updates. The IDLWAVE distribution also contains the Perl program
address@hidden which constructs the @file{idlw-rinfo.el} file by
+scanning the HTML documents produced from the IDL documentation.
+Instructions on how to use @file{get_html_rinfo} are in the program
+itself.
+
address@hidden HTML Help Browser Tips, Configuration Examples, Sources of
Routine Info, Top
address@hidden HTML Help Browser Tips
address@hidden Browser Tips
+
+There are a wide variety of possible browsers to use for displaying
+the online HTML help available with IDLWAVE (starting with version
+5.0). Since IDL v6.2, a single cross-platform HTML help browser, the
address@hidden Assistant} is distributed with IDL. If this help browser is
+available, it is the preferred choice, and the default. The variable
address@hidden, enabled by default, controls
+whether this help browser is used. If you use the IDL Assistant, the
+tips here are not relevant.
+
+Since IDLWAVE runs on a many different system types, a single browser
+configuration is not possible, but choices abound. On many systems,
+the default browser configured in @code{browse-url-browser-function},
+and hence inherited by default by
address@hidden, is Netscape. Unfortunately, the
+HTML manuals decompiled from the original source contain formatting
+structures which Netscape 4.x does not handle well, though they are
+still readable. A much better choice is Mozilla, or one of the
+Mozilla-derived browsers such as
address@hidden://galeon.sourceforge.net/,Galeon} (GNU/Linux),
address@hidden://www.mozilla.org/projects/camino/,Camino} (MacOSX), or
address@hidden://www.mozilla.org/projects/firebird/,Firebird} (all
+platforms). Newer versions of Emacs provide a browser-function choice
address@hidden which uses the Gnome-configured browser.
+
+Note that the HTML files decompiled from the help sources contain
+specific references to the @samp{Symbol} font, which by default is not
+permitted in normal encodings (it's invalid, technically). Though it
+only impacts a few symbols, you can trick Mozilla-based browsers into
+recognizing @samp{Symbol} by following the directions
address@hidden://hutchinson.belmont.ma.us/tth/Xfonts.html, here}. With
+this fix in place, HTML help pages look almost identical to their PDF
+equivalents (yet can be bookmarked, browsed as history, searched,
+etc.).
+
address@hidden Individual platform recommendations:
+
address@hidden @bullet
address@hidden Unix/MacOSX: The @uref{http://www.w3m.org,@code{w3m}} browser
+and its associated
address@hidden://emacs-w3m.namazu.org/,@code{emacs-w3m}} emacs mode
+provide in-buffer browsing with image display, and excellent speed and
+formatting. Both the Emacs mode and the browser itself must be
+downloaded separately. To use this browser, include
+
address@hidden
+(setq idlwave-help-browser-function 'w3m-browse-url)
address@hidden lisp
+
+in your @file{.emacs}. Setting a few other nice @code{w3m} options
+cuts down on screen clutter:
+
address@hidden
+(setq w3m-use-tab nil
+ w3m-use-header-line nil
+ w3m-use-toolbar nil)
address@hidden lisp
+
+If you use a dedicated frame for help, you might want to add the
+following, to get consistent behavior with the @kbd{q} key:
+
address@hidden
+;; Close my help window when w3m closes.
+(defadvice w3m-close-window (after idlwave-close activate)
+ (if (boundp 'idlwave-help-frame)
+ (idlwave-help-quit)))
address@hidden lisp
+
+Note that you can open the file in an external browser from within
address@hidden using @kbd{M}.
address@hidden itemize
+
address@hidden Configuration Examples, Windows and MacOS, HTML Help Browser
Tips, Top
address@hidden Configuration Examples
address@hidden Configuration examples
address@hidden Example configuration
address@hidden @file{.emacs}
address@hidden Default settings, of options
address@hidden Interview, with the maintainer
+
address@hidden
address@hidden:} You have all these complicated configuration options in
+your package, but which ones do @emph{you} as the maintainer actually
+set in your own configuration?
+
address@hidden
address@hidden:} Not many, beyond custom key bindings. I set most defaults
+the way that seems best. However, the default settings do not turn on
+features which:
+
address@hidden @minus
address@hidden
+are not self-evident (i.e. too magic) when used by an unsuspecting user.
address@hidden
+are too intrusive.
address@hidden
+will not work properly on all Emacs installations.
address@hidden
+break with widely used standards.
address@hidden
+use function or other non-standard keys.
address@hidden
+are purely personal customizations, like additional key bindings, and
+library names.
address@hidden itemize
+
address@hidden To see what I mean, here is the @emph{entire} configuration
+the old maintainer had in his @file{.emacs}:
+
address@hidden
+(setq idlwave-shell-debug-modifiers '(control shift)
+ idlwave-store-inquired-class t
+ idlwave-shell-automatic-start t
+ idlwave-main-block-indent 2
+ idlwave-init-rinfo-when-idle-after 2
+ idlwave-help-dir "~/lib/emacs/idlwave"
+ idlwave-special-lib-alist '(("/idl-astro/" . "AstroLib")
+ ("/jhuapl/" . "JHUAPL-Lib")
+ ("/dominik/lib/idl/" . "MyLib")))
address@hidden lisp
+
+However, if you are an Emacs power-user and want IDLWAVE to work
+completely differently, you can change almost every aspect of it. Here
+is an example of a much more extensive configuration of IDLWAVE. The
+user is King!
+
address@hidden
+;;; Settings for IDLWAVE mode
+
+(setq idlwave-block-indent 3) ; Indentation settings
+(setq idlwave-main-block-indent 3)
+(setq idlwave-end-offset -3)
+(setq idlwave-continuation-indent 1)
+(setq idlwave-begin-line-comment "^;[^;]") ; Leave ";" but not ";;"
+ ; anchored at start of line.
+(setq idlwave-surround-by-blank t) ; Turn on padding ops =,<,>
+(setq idlwave-pad-keyword nil) ; Remove spaces for keyword '='
+(setq idlwave-expand-generic-end t) ; convert END to ENDIF etc...
+(setq idlwave-reserved-word-upcase t) ; Make reserved words upper case
+ ; (with abbrevs only)
+(setq idlwave-abbrev-change-case nil) ; Don't force case of expansions
+(setq idlwave-hang-indent-regexp ": ") ; Change from "- " for auto-fill
+(setq idlwave-show-block nil) ; Turn off blinking to begin
+(setq idlwave-abbrev-move t) ; Allow abbrevs to move point
+(setq idlwave-query-class '((method-default . nil) ; No query for method
+ (keyword-default . nil); or keyword completion
+ ("INIT" . t) ; except for these
+ ("CLEANUP" . t)
+ ("SETPROPERTY" .t)
+ ("GETPROPERTY" .t)))
+
+;; Using w3m for help (must install w3m and emacs-w3m)
+(autoload 'w3m-browse-url "w3m" "Interface for w3m on Emacs." t)
+(setq idlwave-help-browser-function 'w3m-browse-url
+ w3m-use-tab nil ; no tabs, location line, or toolbar
+ w3m-use-header-line nil
+ w3m-use-toolbar nil)
+
+;; Close my help window or frame when w3m closes with `q'
+(defadvice w3m-close-window (after idlwave-close activate)
+ (if (boundp 'idlwave-help-frame)
+ (idlwave-help-quit)))
+
+;; Some setting can only be done from a mode hook. Here is an example:
+(add-hook 'idlwave-mode-hook
+ (lambda ()
+ (setq case-fold-search nil) ; Make searches case sensitive
+ ;; Run other functions here
+ (font-lock-mode 1) ; Turn on font-lock mode
+ (idlwave-auto-fill-mode 0) ; Turn off auto filling
+ (setq idlwave-help-browser-function 'browse-url-w3)
+
+ ;; Pad with 1 space (if -n is used then make the
+ ;; padding a minimum of n spaces.) The defaults use -1
+ ;; instead of 1.
+ (idlwave-action-and-binding "=" '(idlwave-expand-equal 1 1))
+ (idlwave-action-and-binding "<" '(idlwave-surround 1 1))
+ (idlwave-action-and-binding ">" '(idlwave-surround 1 1 '(?-)))
+ (idlwave-action-and-binding "&" '(idlwave-surround 1 1))
+
+ ;; Only pad after comma and with exactly 1 space
+ (idlwave-action-and-binding "," '(idlwave-surround nil 1))
+ (idlwave-action-and-binding "&" '(idlwave-surround 1 1))
+
+ ;; Pad only after `->', remove any space before the arrow
+ (idlwave-action-and-binding "->" '(idlwave-surround 0 -1 nil 2))
+
+ ;; Set some personal bindings
+ ;; (In this case, makes `,' have the normal self-insert behavior.)
+ (local-set-key "," 'self-insert-command)
+ (local-set-key [f5] 'idlwave-shell-break-here)
+ (local-set-key [f6] 'idlwave-shell-clear-current-bp)
+
+ ;; Create a newline, indenting the original and new line.
+ ;; A similar function that does _not_ reindent the original
+ ;; line is on "\C-j" (The default for emacs programming modes).
+ (local-set-key "\n" 'idlwave-newline)
+ ;; (local-set-key "\C-j" 'idlwave-newline) ; My preference.
+
+ ;; Some personal abbreviations
+ (define-abbrev idlwave-mode-abbrev-table
+ (concat idlwave-abbrev-start-char "wb") "widget_base()"
+ (idlwave-keyword-abbrev 1))
+ (define-abbrev idlwave-mode-abbrev-table
+ (concat idlwave-abbrev-start-char "on") "obj_new()"
+ (idlwave-keyword-abbrev 1))
+ ))
+
+;;; Settings for IDLWAVE SHELL mode
+
+(setq idlwave-shell-overlay-arrow "=>") ; default is ">"
+(setq idlwave-shell-use-dedicated-frame t) ; Make a dedicated frame
+(setq idlwave-shell-prompt-pattern "^WAVE> ") ; default is "^IDL> "
+(setq idlwave-shell-explicit-file-name "wave")
+(setq idlwave-shell-process-name "wave")
+(setq idlwave-shell-use-toolbar nil) ; No toolbar
+
+;; Most shell interaction settings can be done from the shell-mode-hook.
+(add-hook 'idlwave-shell-mode-hook
+ (lambda ()
+ ;; Set up some custom key and mouse examine commands
+ (idlwave-shell-define-key-both [s-down-mouse-2]
+ (idlwave-shell-mouse-examine
+ "print, size(___,/DIMENSIONS)"))
+ (idlwave-shell-define-key-both [f9] (idlwave-shell-examine
+ "print, size(___,/DIMENSIONS)"))
+ (idlwave-shell-define-key-both [f10] (idlwave-shell-examine
+ "print,size(___,/TNAME)"))
+ (idlwave-shell-define-key-both [f11] (idlwave-shell-examine
+ "help,___,/STRUCTURE"))))
address@hidden example
+
address@hidden
+<A NAME="WIN_MAC"></A>
address@hidden html
address@hidden Windows and MacOS, Troubleshooting, Configuration Examples, Top
address@hidden Windows and MacOS
address@hidden Windows
address@hidden MacOS
address@hidden MacOSX
+
+IDLWAVE was developed on a UNIX system. However, thanks to the
+portability of Emacs, much of IDLWAVE does also work under different
+operating systems like Windows (with NTEmacs or NTXEmacs) or MacOS.
+
+The only real problem is that there is no command-line version of IDL
+for Windows or MacOS(<=9) with which IDLWAVE can interact. As a
+result, the IDLWAVE Shell does not work and you have to rely on IDLDE
+to run and debug your programs. However, editing IDL source files
+with Emacs/IDLWAVE works with all bells and whistles, including
+routine info, completion and fast online help. Only a small amount of
+additional information must be specified in your @file{.emacs} file:
+the path names which, on a UNIX system, are automatically gathered by
+talking to the IDL program.
+
+Here is an example of the additional configuration needed for a Windows
+system. I am assuming that IDLWAVE has been installed in
address@hidden@samp{C:\Program Files\IDLWAVE}} and that IDL is installed in
address@hidden@samp{C:\RSI\IDL63}}.
+
address@hidden
+;; location of the lisp files (only needed if IDLWAVE is not part of
+;; your default X/Emacs installation)
+(setq load-path (cons "c:/program files/IDLWAVE" load-path))
+
+;; The location of the IDL library directories, both standard, and your own.
+;; note that the initial "+" expands the path recursively
+(setq idlwave-library-path
+ '("+c:/RSI/IDL63/lib/" "+c:/path/to/my/idllibs" ))
+
+;; location of the IDL system directory (try "print,!DIR")
+(setq idlwave-system-directory "c:/RSI/IDL63/")
+
address@hidden lisp
+
address@hidden Furthermore, Windows sometimes tries to outsmart you --- make
+sure you check the following things:
+
address@hidden @bullet
address@hidden When you download the IDLWAVE distribution, make sure you save
the
+file under the names @file{idlwave.tar.gz}.
address@hidden M-TAB switches among running programs --- use Esc-TAB
+instead.
address@hidden Other issues as yet unnamed...
address@hidden itemize
+
+Windows users who'd like to make use of IDLWAVE's context-aware HTML
+help can skip the browser and use the HTMLHelp functionality directly.
address@hidden with HTML Documentation}.
+
address@hidden
+<A NAME="TROUBLE"></A>
address@hidden html
address@hidden Troubleshooting, GNU Free Documentation License, Windows and
MacOS, Top
address@hidden Troubleshooting
address@hidden Troubleshooting
+
+Although IDLWAVE usually installs and works without difficulty, a few
+common problems and their solutions are documented below.
+
address@hidden
+
address@hidden @strong{Whenever an IDL error occurs or a breakpoint is hit, I
get
+errors or strange behavior when I try to type anything into some of my
+IDLWAVE buffers.}
+
+This is a @emph{feature}, not an error. You're in @emph{Electric
+Debug Mode} (@pxref{Electric Debug Mode}). You should see
address@hidden in the mode-line. The buffer is read-only and all
+debugging and examination commands are available as single keystrokes;
address@hidden lists these shortcuts. Use @kbd{q} to quit the mode, and
+customize the variable @code{idlwave-shell-automatic-electric-debug}
+if you prefer not to enter electric debug on address@hidden but
+you really should try it before you disable it! You can also
+customize this variable to enter debug mode when errors are
+encountered.
+
address@hidden @strong{I get errors like @samp{Searching for program: no such
+file or directory, idl} when attempting to start the IDL shell.}
+
+IDLWAVE needs to know where IDL is in order to run it as a process.
+By default, it attempts to invoke it simply as @samp{idl}, which
+presumes such an executable is on your search path. You need to
+ensure @samp{idl} is on your @samp{$PATH}, or specify the full
+pathname to the idl program with the variable
address@hidden Note that you may need to
+set your shell search path in two places when running Emacs as an Aqua
+application with MacOSX; see the next topic.
+
address@hidden @strong{IDLWAVE is disregarding my @samp{IDL_PATH} which I set
+under MacOSX}
+
+If you run Emacs directly as an Aqua application, rather than from the
+console shell, the environment is set not from your usual shell
+configuration files (e.g. @file{.cshrc}), but from the file
address@hidden/.MacOSX/environment.plist}. Either include your path settings
+there, or start Emacs and IDLWAVE from the shell.
+
address@hidden @strong{I get errors like @samp{Symbol's function is void:
+overlayp}}
+
+You don't have the @samp{fsf-compat} package installed, which IDLWAVE
+needs to run under XEmacs. Install it, or find an XEmacs distribution
+which includes it by default.
+
address@hidden @strong{I'm getting errors like @samp{Symbol's value as variable
is void:
+cl-builtin-gethash} on completion or routine info.}
+
+This error arises if you upgraded Emacs from 20.x to 21.x without
+re-installing IDLWAVE. Old Emacs and new Emacs are not byte-compatible
+in compiled lisp files. Presumably, you kept the original .elc files in
+place, and this is the source of the error. If you recompile (or just
+"make; make install") from source, it should resolve this problem.
+Another option is to recompile the @file{idlw*.el} files by hand using
address@hidden byte-compile-file}.
+
address@hidden @address@hidden@key{TAB}} doesn't complete words, it switches
+windows on my desktop.}
+
+Your system is trapping @address@hidden and using it for its own
+nefarious purposes: Emacs never sees the keystrokes. On many Unix
+systems, you can reconfigure your window manager to use another key
+sequence for switching among windows. Another option is to use the
+equivalent sequence @address@hidden@key{TAB}}.
+
address@hidden @strong{When stopping at breakpoints or errors, IDLWAVE does not
+seem to highlight the relevant line in the source.}
+
+IDLWAVE scans for error and halt messages and highlights the stop
+location in the correct file. However, if you've changed the system
+variable @samp{!ERROR_STATE.MSG_PREFIX}, it is unable to parse these
+message correctly. Don't do that.
+
address@hidden @strong{IDLWAVE doesn't work correctly when using ENVI.}
+
+Though IDLWAVE was not written with ENVI in mind, it works just fine
+with it, as long as you update the prompt it's looking for (@samp{IDL>
+} by default). You can do this with the variable
address@hidden (@pxref{Starting the Shell}), e.g.,
+in your @file{.emacs}:
+
address@hidden
+(setq idlwave-shell-prompt-pattern "^\r? ?\\(ENVI\\|IDL\\)> ")
address@hidden lisp
+
address@hidden @strong{Attempts to set breakpoints fail: no breakpoint is
+indicated in the IDLWAVE buffer.}
+
+IDL changed its breakpoint reporting format starting with IDLv5.5. The
+first version of IDLWAVE to support the new format is IDLWAVE v4.10. If
+you have an older version and are using IDL >v5.5, you need to upgrade,
+and/or make sure your recent version of IDLWAVE is being found on the
+Emacs load-path (see the next entry). You can list the version being
+used with @kbd{C-h v idlwave-mode-version @key{RET}}.
+
address@hidden @strong{I installed a new version of IDLWAVE, but the old
+version is still being used} or @strong{IDLWAVE works, but when I
+tried to install the optional modules @file{idlw-roprompt.el} or
address@hidden, I get errors like @samp{Cannot open
+load file}}.
+
+The problem is that your Emacs is not finding the version of IDLWAVE you
+installed. Many Emacsen come with an older bundled copy of IDLWAVE
+(e.g. v4.7 for Emacs 21.x), which is likely what's being used instead.
+You need to make sure your Emacs @emph{load-path} contains the directory
+where IDLWAVE is installed (@file{/usr/local/share/emacs/site-lisp}, by
+default), @emph{before} Emacs' default search directories. You can
+accomplish this by putting the following in your @file{.emacs}:
+
address@hidden
+(setq load-path (cons "/usr/local/share/emacs/site-lisp" load-path))
address@hidden lisp
+
address@hidden You can check on your load-path value using @kbd{C-h v
+load-path @key{RET}}, and @kbd{C-h m} in an IDLWAVE buffer should show
+you the version Emacs is using.
+
address@hidden @strong{IDLWAVE is screwing up the formatting of my @file{.idl}
files.}
+
+Actually, this isn't IDLWAVE at all, but @samp{idl-mode}, an unrelated
+programming mode for CORBA's Interface Definition Language (you should
+see @samp{(IDL)}, not @samp{(IDLWAVE)} in the mode-line). One
+solution: don't name your file @file{.idl}, but rather @file{.pro}.
+Another solution: make sure @file{.idl} files load IDLWAVE instead of
address@hidden by adding the following to your @file{.emacs}:
+
address@hidden
+(setcdr (rassoc 'idl-mode auto-mode-alist) 'idlwave-mode)
address@hidden lisp
+
address@hidden @strong{The routine info for my local routines is out of date!}
+
+IDLWAVE collects routine info from various locations (@pxref{Routine
+Information Sources}). Routines in files visited in a buffer or
+compiled in the shell should be up to date. For other routines, the
+information is only as current as the most recent scan. If you have a
+rapidly changing set of routines, and you'd like the latest routine
+information to be available for it, one powerful technique is to make
+use of the library catalog tool, @samp{idlwave_catalog}. Simply add a
+line to your @samp{cron} file (@samp{crontab -e} will let you edit this
+on some systems), like this
+
address@hidden
+45 3 * * 1-5 (cd /path/to/myidllib; /path/to/idlwave_catalog MyLib)
address@hidden example
+
address@hidden where @samp{MyLib} is the name of your library. This will
+rescan all @file{.pro} files at or below @file{/path/to/myidllib} every
+week night at 3:45am. You can even scan site-wide libraries with this
+method, and the most recent information will be available to all users.
+Since the scanning is very fast, there is very little impact.
+
address@hidden @strong{All the Greek-font characters in the HTML help are
+displayed as Latin characters!}
+
+Unfortunately, the HTMLHelp files RSI provides attempt to switch to
address@hidden font to display Greek characters, which is not really an
+permitted method for doing this in HTML. There is a "workaround" for
+some browsers: @xref{HTML Help Browser Tips}.
+
address@hidden @strong{In the shell, my long commands are truncated at 256
characters!}
+
+This actually happens when running IDL in an XTerm as well. There are
+a couple of workarounds: @code{define_key,/control,'^d'} (e.g. in
+your @file{$IDL_STARTUP} file) will disable the @samp{EOF} character
+and give you a 512 character limit. You won't be able to use
address@hidden to quit the shell, however. Another possibility is
address@hidden, which gives you an @emph{infinite} limit (OK, a
+memory-bounded limit), but disables the processing of background
+widget events (those with @code{/NO_BLOCK} passed to @code{XManager}).
+
address@hidden @strong{When I invoke IDL HTML help on a routine, the page which
+is loaded is one page off, e.g. for @code{CONVERT_COORD}, I get
address@hidden
+
+You have a mismatch between your help index and the HTML help package
+you downloaded. You need to ensure you download a ``downgrade kit'' if
+you are using anything older than the latest HTML help package. A new
+help package appears with each IDL release (assuming the documentation
+is updated).
+Starting with IDL 6.2, the HTML help and its catalog are
+distributed with IDL, and so should never be inconsistent.
+
address@hidden @strong{I get errors such as @samp{void-variable
+browse-url-browser-function} or similar when attempting to load IDLWAVE
+under XEmacs.}
+
+You don't have the @samp{browse-url} (or other required) XEmacs package.
+Unlike GNU Emacs, XEmacs distributes many packages separately from the
+main program. IDLWAVE is actually among these, but is not always the
+most up to date. When installing IDLWAVE as an XEmacs package, it
+should prompt you for required additional packages. When installing it
+from source, it won't and you'll get this error. The easiest solution
+is to install all the packages when you install XEmacs (the so-called
address@hidden bundle). The minimum set of XEmacs packages required by
+IDLWAVE is @samp{fsf-compat, xemacs-base, mail-lib}.
+
address@hidden enumerate
+
address@hidden GNU Free Documentation License, Index, Troubleshooting, Top
address@hidden GNU Free Documentation License
address@hidden doclicense.texi
+
address@hidden Index, , GNU Free Documentation License, Top
address@hidden Index
address@hidden cp
+
address@hidden
+
address@hidden
+ arch-tag: f1d73958-1423-4127-b8aa-f7b953d64492
address@hidden ignore
- [Emacs-diffs] Changes to idlwave.texi,
Glenn Morris <=