\input texinfo @c -*-texinfo-*-
@c %**start of header
@setfilename ../info/idlwave
@settitle IDLWAVE User Manual
@dircategory Emacs
@direntry
* IDLWAVE: (idlwave). Major mode and shell for IDL and WAVE/CL files.
@end direntry
@synindex ky cp
@syncodeindex vr cp
@syncodeindex fn cp
@set VERSION 4.7
@set EDITION 4.7
@set IDLVERSION 5.4
@set NSYSROUTINES 1287
@set NSYSKEYWORDS 5724
@set DATE December 2000
@set AUTHOR Carsten Dominik
@set AUTHOR-EMAIL dominik@@astro.uva.nl
@set MAINTAINER John-David Smith
@set MAINTAINER-EMAIL jdsmith@@astro.cornell.edu
@set IDLWAVE-HOMEPAGE http://www.strw.leidenuniv.nl/~dominik/Tools/idlwave
@c %**end of header
@finalout
@ifinfo
This file documents IDLWAVE, a major mode for editing IDL and
WAVE/CL files with Emacs. It also implements a shell for running IDL as
a subprocess.
This is edition @value{EDITION} of the IDLWAVE User Manual for
IDLWAVE @value{VERSION}
Copyright (c) 1999, 2000, 2001 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.1 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.
@end ifinfo
@titlepage
@title IDLWAVE User Manual
@subtitle Major Emacs mode and shell for IDL and WAVE/CL files
@subtitle Edition @value{EDITION}, @value{DATE}
@author by Carsten Dominik
@page
This is edition @value{EDITION} of the @cite{IDLWAVE User Manual} for
IDLWAVE version @value{VERSION}, @value{DATE}.
@sp 2
Copyright @copyright{} 1999, 2000, 2001 Free Software Foundation, Inc.
@sp 2
@cindex 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.1 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.
@end titlepage
@contents
@page
@ifnottex
@node Top, Introduction, (dir), (dir)
IDLWAVE is a package to support editing command files for the
Interactive Data Language (IDL), and for running IDL as an inferior
shell.
@end ifnottex
@menu
* Introduction:: What IDLWAVE is and what not
* IDLWAVE in a Nutshell:: One page quick-start guide
* Getting Started:: Tutorial
* The IDLWAVE Major Mode:: The mode to edit IDL programs
* The IDLWAVE Shell:: The mode to run IDL as inferior program
* Installation:: How to Install or Upgrade
* Acknowledgement:: Who helped
* Sources of Routine Info:: How does IDLWAVE know about routine XYZ
* Configuration Examples:: The user is king...
* Index:: Fast access
@detailmenu --- The Detailed Node Listing ---
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:: How to visit the source file of routine XYZ
* Resolving Routines:: Force the Shell to compile a routine
* Code Templates:: Abbreviations for frequent constructs
* 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
* Comment Indentation:: Special indentation for comment lines
* Continuation Lines:: Splitting statements over lines
* Syntax Highlighting:: Font-lock support
Actions
* Block Boundary Check:: Is the END 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
* Debugging IDL Programs:: Compilation/Debugging
Debugging IDL Programs
* Compiling Programs:: Compiling buffers under the shell
* Breakpoints and Stepping:: Deciding where to stop and look
* Examining Variables:: What is the value now?
Installation
* Installing IDLWAVE:: How to install the distribution
* Installing Online Help:: Where to get the additional files needed
* Upgrading from idl.el:: Necessary configuration changes
Sources of Routine Info
* Routine Definitions:: Where IDL Routines are defined.
* Routine Information Sources:: So how does IDLWAVE know about...
* Library Catalog:: Scanning the Libraries for Routine Info
* Load-Path Shadows:: Routines defined in several places
* Documentation Scan:: Scanning the IDL Manuals
@end detailmenu
@end menu
@node Introduction, IDLWAVE in a Nutshell, Top, Top
@chapter Introduction
@cindex Introduction
@cindex CORBA (Common Object Request Broker Architecture)
@cindex Interface Definition Language
@cindex Interactive Data Language
@cindex cc-mode.el
@cindex @file{idl.el}
@cindex @file{idl-shell.el}
@cindex Feature overview
IDLWAVE is a package to support editing command files for the
Interactive Data Language (IDL), and for running IDL as an inferior
shell. It also can be used for WAVE/CL command files, but the support
for these is limited. Note that this package has nothing to do with the
Interface Definition Language as part of the Common Object Request
Broker Architecture (CORBA).
IDLWAVE is the successor to the @file{idl.el} and @file{idl-shell.el}
files written by Chris Chase. The modes and files had to be renamed
because of a name space conflict with CORBAs @code{idl-mode}, defined in
Emacs in the file @file{cc-mode.el}. If you have been using the old
files, check @ref{Upgrading from idl.el} for information on how to
switch.
IDLWAVE consists of two parts: A major mode for editing command files
(@code{idlwave-mode}) and a mode to allow running the IDL program as an
inferior shell (@code{idlwave-shell-mode}). Both modes work closely
together and form a complete development environment.
Here is a brief summary of what IDLWAVE does.
@itemize @bullet
@item
Code indentation and formatting.
@item
Font-lock support on three levels.
@item
Display of calling sequence and keywords of more than 1000 IDL
routines and any routines in your local IDL library.
@item
Name space conflict search.
@item
Fast context-sensitive online help.
@item
Context sensitive completion of routine names and keywords.
@item
Insertion of code templates.
@item
Actions to enforce coding standards during typing.
@item
Block structure check.
@item
Support for @file{imenu} (Emacs) and @file{func-menu} (XEmacs).
@item
Documentation support.
@item
Running IDL as inferior process.
@item
Shell with history search, command line editing and completion.
@item
Compilation, execution and debugging of programs directly from the source
buffer.
@item
Examining expressions with a mouse click.
@end itemize
@ifnottex
@cindex Screenshots
Here are a number of screenshots showing IDLWAVE in action.
@itemize @bullet
@item
@uref{http://www.strw.leidenuniv.nl/~dominik/Tools/idlwave/font-lock.gif,
XEmacs 21.1 with formatted and fontified code}
@item
@uref{http://www.strw.leidenuniv.nl/~dominik/Tools/idlwave/rinfo.gif,
XEmacs 21.1 displaying routine info}
@item
@uref{http://www.strw.leidenuniv.nl/~dominik/Tools/idlwave/complete.gif,
XEmacs 21.1 completing a keyword}
@item
@uref{http://www.strw.leidenuniv.nl/~dominik/Tools/idlwave/shell.gif,
XEmacs 21.1 with debugging toolbar; execution stopped at a breakpoint}
@end itemize
@end ifnottex
In this manual, each section contains a list of user options related to
the subject. Don't be confused by the shear 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
things. For a full description of what a particular variable does and
how to configure it, see the documentation string of that variable.
Some configuration examples are also given in the appendix.
@node IDLWAVE in a Nutshell, Getting Started, Introduction, Top
@chapter IDLWAVE in a Nutshell
@cindex Summary of important commands
@cindex IDLWAVE in a Nutshell
@cindex Nutshell, IDLWAVE in a
@subheading Editing IDL Programs
@multitable @columnfractions .15 .85
@item @key{TAB}
@tab Indent the current line relative to context.
@item @kbd{M-C-\}
@tab Re-indent all lines in the current region.
@item @kbd{M-@key{RET}}
@tab Start a continuation line. Or split the current line at point.
@item @kbd{M-q}
@tab Fill the current comment paragraph.
@item @kbd{C-c ?}
@tab Display calling sequence, keywords of the procedure/function call
at point.
@item @kbd{M-?}
@tab Context sensitive online help.
@item @kbd{M-@key{TAB}}
@tab Complete a procedure name, function name or keyword in the buffer.
@item @kbd{C-c C-i}
@tab Update IDLWAVE's knowledge about functions and procedures.
@item @kbd{C-c C-v}
@tab Find the source code of a procedure/function.
@item @kbd{C-c C-h}
@tab Insert a standard documentation header.
@item @kbd{C-c C-m}
@tab Insert a new timestamp and history item in the documentation header.
@end multitable
@subheading Running the IDLWAVE Shell, Debugging Programs
@multitable @columnfractions .15 .85
@item @kbd{C-c C-s}
@tab Start IDL as a subprocess and/or switch to the interaction buffer.
@item @kbd{M-p}
@tab Cycle back through IDL command history matching command line input.
@item @kbd{M-n}
@tab Cycle forward.
@item @kbd{M-@key{TAB}}
@tab Complete a procedure name, function name or keyword in the shell buffer.
@item @kbd{C-c C-d C-c}
@tab Save and compile the source file in the current buffer.
@item @kbd{C-c C-d C-x}
@tab Goto next syntax error.
@item @kbd{C-c C-d C-b}
@tab Set a breakpoint at the current source line.
@item @kbd{C-c C-d C-d}
@tab Clear the current breakpoint.
@item @kbd{C-c C-d C-p}
@tab Ask IDL to print the value of the expression near point.
@end multitable
@subheading Commonly used Settings in @file{.emacs}
@lisp
;; Change the indentation preferences
(setq idlwave-main-block-indent 2 ; default 0
idlwave-block-indent 2 ; default 4
idlwave-end-offset -2) ; default -4
;; Pad some 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))
;; Where are the online help files?
(setq idlwave-help-directory "~/.idlwave")
@end lisp
@node Getting Started, The IDLWAVE Major Mode, IDLWAVE in a Nutshell, Top
@chapter Getting Started (Tutorial)
@cindex Quick-Start
@cindex Tutorial
@cindex Getting Started
@section Lession I: Development Cycle
The purpose of this tutorial is to guide you through a very basic
development cycle with IDLWAVE. We will type a simple program into a
buffer and use the shell to compile, debug and run this program. On the
way we will use the most important commands in IDLWAVE. Note
however that there is much more funtionality available in IDLWAVE than
we cover here, and it will pay off greatly if eventually you go further
and read the whole manual.
I assume that you have access to Emacs or XEmacs with the full IDLWAVE
package including online help (@pxref{Installation}). I 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 @key{META} (often the @key{ALT} key carries this
functionality)).
Open a new source file by typing
@example
@kbd{C-x C-f tutorial.pro @key{RET}}
@end example
A buffer for this file will pop up, and it should be in IDLWAVE mode.
You can see this by looking at the mode line, just below the editing
window. Also, the menu bar should contain entries @samp{IDLWAVE} and
@samp{Debug}.
Now cut-and-paste the following program, also available as
@file{tutorial.pro} in the IDLWAVE distribution.
@example
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
@end 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} followed by @kbd{M-C-\}). 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
@key{SPC}. IDLWAVE blinks back to the beginning of the block and
changes the generic @code{end} to the specific @code{endfor}
automatically. Now place the cursor in any line you would like to split
into two and press @kbd{M-@key{RET}}. 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 weekday of a given
date for the first 10 years of the 21st century. I have put in a few
bugs which we are going to fix now.
First, let's launch the IDLWAVE shell. You do this with the command
@kbd{C-c C-s}. The Emacs window will split and display IDL running in a
shell interaction buffer. Type a few commands like @code{print,!PI} to
convince yourself that you can work there like in an xterminal, 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
@samp{.run 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 Delete!). Compile again, using the
same keystrokes as before. Notice that the file is 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 weekdays for 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), the window
will split to show all procedures it knows starting with that string,
and @w{@code{plot_wday}} should be one of them. Saving the buffer was
enough to tell 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 @samp{plot_} to make it
unambiguous, hit @key{TAB}, and the full routine name will be completed.
Now provide the two arguments:
@example
plot_wday,1,1
@end example
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 pops up the routine info window for
the plot routine, which contains a list of keywords, and 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 @kbd{C-c 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
@kbd{M-@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 @kbd{M-?} for
online help (alternatively, you could have right clicked on the colored
keyword itself in the completion list). The online help window will pop
up showing the 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 the command
to recall it by now: @kbd{C-c C-s}) and execute again. Now things look
pretty good.
Lets try a different day - how about April fool's day?
@example
plot_wday,1,4
@end 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. Lets 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 line is
highlighted in some way. 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: @samp{d}, @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
@samp{delta} to see that it's 0. Below, we see the offending line:
@samp{y1=y*delta...} the multiplication should have been a minus sign!
So fix the line to
@example
y1 = y - delta
@end 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.
@section Lession II: Customization
Emacs is probably the most customizable piece of software available, and
it would be a shame if you did not make use of this and adapt IDLWAVE to
your own preferences. Customizing Emacs or IDLWAVE means that you have
to set Lisp variables in the @file{.emacs} file in your home directory.
This looks scary to many people because of all the parenthesis.
However, you can just cut and paste the examples given here and work
from there.
Lets 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
@file{.emacs} file, exit and restart Emacs.
@lisp
(setq idlwave-reserved-word-upcase t)
@end 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
@samp{IF}, @samp{begin} to @samp{BEGIN}. If you don't like this
behavior, remove the option again from your @file{.emacs} file.
Now I bet you have your own indentation preferences for IDL code. For
example, I like to indent the main block of an IDL program a bit,
different from the conventions used by RSI. Also, I'd like to use only
3 spaces as indentation between @code{BEGIN} and @code{END}. Try the
following lines in @file{.emacs}
@lisp
(setq idlwave-main-block-indent 2)
(setq idlwave-block-indent 3)
(setq idlwave-end-offset -3)
@end lisp
Restart Emacs, take the program we developed in the first part of this
tutorial and re-indent it with @kbd{C-c h} and @kbd{M-C-\}. You
probably 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:} in the manual.
If you cannot wrap your head around this Lisp stuff, 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 @file{.pro} buffers,
option @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. Idlwave Code Formatting->Idlwave Main Block
Indent), 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.
Many people I talk to find the key bindings used for the debugging
commands too long and complicated. Do I always have to type @kbd{C-c
C-d C-c} to get a single simple command? Due to Emacs rules and
conventions I cannot make better bindings by default, but you can.
First, there is a way to assign all debugging commands in a single sweep
to other combinations. The only problem is that we have to use
something which Emacs does not need for other important commands. A
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. You can
have this with
@lisp
(setq idlwave-shell-debug-modifiers '(shift control))
@end lisp
If you have a special keyboard with for example a @key{HYPER} key, you
could use
@lisp
(setq idlwave-shell-debug-modifiers '(hyper))
@end lisp
instead to get compilation on @kbd{H-c}.
You can also assign specific commands to function keys. This you must
do in the @emph{mode-hook}, a special function which is run when a new
buffer gets set up. Keybindings can only be done when the buffer
exists. The possibilities for key customization are endless. Here we
set function keys f5-f8 to common debugging commands.
@lisp
;; First for the source buffer
(add-hook 'idlwave-mode-hook
(lambda ()
(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 [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)))
@end lisp
@section Lession III: Library Catalog
We have already used the routine info display in the first part of this
tutorial. This was the key @kbd{C-c ?} which displays information about
the IDL routine near the cursor position. Wouldn't it be nice
to have the same available for your own library routines and for the
huge amount of code in major extension libraries like JHUPL or the
IDL-Astro library? To do this, you must give IDLWAVE a chance to study
these routines first. We call this @emph{Building the library catalog}.
From the IDLWAVE entry in the menu bar, select @code{Routine Info/Select
Catalog Directories}. 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) 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{.idlcat} in your home
directory and will from now one be automatically loaded whenever you use
IDLWAVE. Try to use routine info (@kbd{C-c ?}) or completion
(@kbd{M-<TAB>}) while 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:
@example
a=readf@key{M-<TAB>}
@end example
expands to `readfits('. Then try
@example
a=readfits(@key{C-c ?}
@end example
and you get:
@example
Usage: Result = READFITS(filename, header, heap)
...
@end 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 @code{comp.lang.idl-pvwave}.
@node The IDLWAVE Major Mode, The IDLWAVE Shell, Getting Started, Top
@chapter The IDLWAVE Major Mode
@cindex IDLWAVE major mode
@cindex Major mode, @code{idlwave-mode}
The IDLWAVE major mode supports editing IDL and WAVE/CL command files.
In this chapter we describe the main features of the mode and how to
customize them.
@menu
* 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:: How to visit the source file of routine XYZ
* Resolving Routines:: Force the Shell to compile a routine
* Code Templates:: Abbreviations for frequent constructs
* 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
@end menu
@node Code Formatting, Routine Info, The IDLWAVE Major Mode, The IDLWAVE Major Mode
@section Code Formatting
@cindex Code formatting
@cindex Formatting, of code
@menu
* Code Indentation:: Reflecting the logical structure
* Comment Indentation:: Special indentation for comment lines
* Continuation Lines:: Splitting statements over lines
* Syntax Highlighting:: Font-lock support
@end menu
@node Code Indentation, Comment Indentation, Code Formatting, Code Formatting
@subsection Code Indentation
@cindex Code indentation
@cindex Indentation
Like all Emacs programming modes, IDLWAVE performs code indentation.
The @key{TAB} key indents the current line relative to context.
@key{LFD} insert a newline and indents the new line. The indentation is
governed by a number of variables.
@cindex Foreign code, adapting
@cindex Indentation, of foreign code
@kindex M-C-\
To re-indent a larger portion of code (e.g. when working with foreign code
written with different conventions), use @kbd{M-C-\}
(@code{indent-region}) after marking the relevant code. Useful marking
commands are @kbd{C-x h} (the entire file) or @kbd{M-C-h} (the
current subprogram). @xref{Actions}, for information how to impose
additional formatting conventions on foreign code.
@defopt idlwave-main-block-indent (@code{0})
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.
@end defopt
@defopt idlwave-block-indent (@code{5})
Extra indentation applied to block lines. If you change this, you
probably also want to change @code{idlwave-end-offset}.
@end defopt
@defopt idlwave-end-offset (@code{-4})
Extra indentation applied to block END lines. A value equal to negative
@code{idlwave-block-indent} will make END lines line up with the block
BEGIN lines.
@end defopt
@defopt idlwave-continuation-indent (@code{2})
Extra indentation applied to continuation lines and inside unbalanced
parenthesis.
@end defopt
@node Comment Indentation, Continuation Lines, Code Indentation, Code Formatting
@subsection Comment Indentation
@cindex Comment indentation
@cindex Hanging paragraphs
@cindex Paragraphs, filling
@cindex Paragraphs, hanging
In IDL, lines starting with a @samp{;} are called @emph{comment lines}.
Comment lines are indented as follows:
@multitable @columnfractions .1 .90
@item @code{;;;}
@tab The indentation of lines starting with three semicolons remains
unchanged.
@item @code{;;}
@tab Lines starting with two semicolons are indented like the surrounding code.
@item @code{;}
@tab Lines starting with a single semicolon are indent to a minimum column.
@end multitable
@noindent
The indentation of comments starting in column 0 is never changed.
@defopt idlwave-no-change-comment
The indentation of a comment starting with this regexp will not be changed.
@end defopt
@defopt idlwave-begin-line-comment
A comment anchored at the beginning of line.
@end defopt
@defopt idlwave-code-comment
A comment that starts with this regexp is indented as if it is a part of
IDL code.
@end defopt
@node Continuation Lines, Syntax Highlighting, Comment Indentation, Code Formatting
@subsection Continuation Lines and Filling
@cindex Continuation lines
@cindex Line splitting
@cindex String splitting
@cindex Splitting, of lines
@kindex M-@key{RET}
In IDL, a newline character terminates a statement unless preceded by a
@samp{$}. If you would like to start a continuation line, use
@kbd{M-@key{RET}} which calls the command @code{idlwave-split-line}. It
inserts a @samp{$} to indicate that the following line is a continuation
of the current line, terminates the line with a newline and indents the
new line. The command @kbd{M-@key{RET}} can also be used in the middle
of a line to split the line at that point. When used inside a long
string constant, the string is split with the @samp{+} concatenation
operator.
@cindex Filling
@cindex @code{auto-fill-mode}
@cindex Hanging paragraphs
When filling comment paragraphs, IDLWAVE overloads the normal filling
functions and uses a function which creates hanging paragraphs as they
are customary in the 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 is matched by
@code{idlwave-hang-indent-regexp}, subsequent lines are indented to
after the position of this match, as in the following example.
@example
; INPUTS:
; x - an array containing
; lots of interesting numbers.
;
; y - another variable where
; a hanging paragraph is used
; to describe it.
@end example
@kindex M-q
You also refill a comment paragraph with @kbd{M-q}.
@defopt idlwave-fill-comment-line-only (@code{t})
Non-@code{nil} means auto fill will only operate on comment lines.
@end defopt
@defopt idlwave-auto-fill-split-string (@code{t})
Non-@code{nil} means auto fill will split strings with the IDL @samp{+}
operator.
@end defopt
@defopt idlwave-split-line-string (@code{t})
Non-@code{nil} means @code{idlwave-split-line} will split strings with
@samp{+}.
@end defopt
@defopt idlwave-hanging-indent (@code{t})
Non-@code{nil} means comment paragraphs are indented under the hanging
indent given by @code{idlwave-hang-indent-regexp} match in the first
line of the paragraph.
@end defopt
@defopt idlwave-hang-indent-regexp
Regular expression matching the position of the hanging indent
in the first line of a comment paragraph.
@end defopt
@defopt idlwave-use-last-hang-indent (@code{nil})
Non-@code{nil} means use last match on line for
@code{idlwave-indent-regexp}.
@end defopt
@node Syntax Highlighting, , Continuation Lines, Code Formatting
@subsection Syntax Highlighting
@cindex Syntax highlighting
@cindex Highlighting of syntax
@cindex Font lock
Highlighting of keywords, comments, strings etc. can be accomplished
with @code{font-lock}. If you are using @code{global-font-lock-mode}
(on Emacs), or have @code{font-lock} turned on in any other buffer in
XEmacs, it should also automatically work in IDLWAVE buffers. If not,
you can enforce it with the following line in your @file{.emacs}
@lisp
(add-hook 'idlwave-mode-hook 'turn-on-font-lock)
@end lisp
IDLWAVE supports 3 levels of syntax highlighting. The variable
@code{font-lock-maximum-decoration} determines which level is selected.
@defopt idlwave-default-font-lock-items
Items which should be fontified on the default fontification level
2.
@end defopt
@node Routine Info, Online Help, Code Formatting, The IDLWAVE Major Mode
@section Routine Info
@cindex Routine info
@cindex Updating routine info
@cindex Scanning buffers for routine info
@cindex Buffers, scanning for routine info
@cindex Shell, querying for routine info
@kindex C-c C-i
IDL defines more than one thousand procedures, functions and object
methods. This large command set makes it difficult to remember the
calling sequence and keywords of a command. IDLWAVE contains a list of
all builtin routines with calling sequences and keywords@footnote{This
list was created by scanning the IDL manual and might contain (very few)
errors. Please report any detected errors to the maintainer, so that
they can be fixed.}. It also scans Emacs buffers and library files for
routine definitions and queries the IDLWAVE-Shell for the properties of
modules currently compiled under the shell. This information is updated
automatically. If you think the information is not up-to-date, use
@kbd{C-c C-i} (@code{idlwave-update-routine-info}) to enforce a global
update.
@kindex 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 cursor positions in the following line
@example
plot,x,alog(x+5*sin(x) + 2),
1 2 3 4 5 6 7 8
@end example
@cindex 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 select 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.
@cindex Calling sequences
@cindex Keywords of a routine
@cindex 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:
@example
Usage: XMANAGER, NAME, ID
Keywords: BACKGROUND CATCH CLEANUP EVENT_HANDLER GROUP_LEADER
JUST_REG MODAL NO_BLOCK
Source: SystemLib [CSB] /soft1/idl53/lib/xmanager.pro
@end example
@cindex Categories, of routines
@cindex Load-path shadows
@cindex Shadows, load-path
@cindex IDL variable @code{!PATH}
@cindex @code{!PATH}, IDL variable
@cindex IDL variable @code{!DIR}
@cindex @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 library routine,
which may or may not be what you want (@pxref{Load-Path Shadows}). The
information about the calling sequence and the keywords is derived from
the first source listed. Library routines can only be supported if you
have scanned the local IDL library (@pxref{Library Catalog}). The source
entry consists of a @emph{source category}, a set of @emph{flags} and
the path to the @emph{source file}. The following categories
exist:
@multitable @columnfractions .15 .85
@item @i{System}
@tab A system routine, but we do not know if it is @i{Builtin} or
@i{SystemLib}. When the system library has bee scanned
(@pxref{Library Catalog}), this category will automatically split into the
next two.
@item @i{Builtin}
@tab A builtin routine with no source code available.
@item @i{SystemLib}
@tab A library routine in the official lib directory @file{!DIR/lib}.
@item @i{Obsolete}
@tab A library routine in the official lib directory @file{!DIR/lib/obsolete}.
@item @i{Library}
@tab A file on IDL's search path @code{!PATH}.
@item @i{Other}
@tab Any other file not known to be on the search path.
@item @i{Unresolved}
@tab The shell lists this routine as unresolved.
@end multitable
You can define additional categories based on the file name and path
with the variable @code{idlwave-special-lib-alist}.
@cindex Flags, in routine info
@cindex Duplicate routines
@cindex Multiply defined routines
@cindex Routine definitions, multiple
The flags @code{[CSB]} indicate if the file is known to IDLWAVE from the
library catalog (@w{@code{[C--]}}, @pxref{Library Catalog}), from the Shell
(@w{@code{[-S-]}}) or from an Emacs buffer (@w{@code{[--B]}}).
Combinations are possible. If a file contains multiple definitions of
the same routine, the file name will be prefixed with @samp{(Nx)} where
@samp{N} is the number of definitions.
@cindex Online Help from the routine info buffer
@cindex Active text, in routine info
@cindex Inserting keywords, from routine info
@cindex Source file, access from routine info
Some of the text in the @file{*Help*} buffer will be active (it
highlights when you move the mouse over it). Clicking on these items
will have the following effects:
@multitable @columnfractions 0.15 0.85
@item @i{Usage}
@tab 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}).
@item @i{Keyword}
@tab Online help about keywords is also available with the
@emph{right} mouse button. Clicking on a keyword with the @emph{middle}
mouse button will insert this keyword in the buffer from where
@code{idlwave-routine-info} was called. Holding down @key{SHIFT} while
clicking also adds the initial @samp{/}.
@item @i{Source}
@tab 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
@kbd{C-c ?} 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.
@item @i{Classes}
@tab 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
@emph{middle} mouse button to display routine info about the current
method in other classes on the inheritance chain.
@end multitable
@defopt idlwave-resize-routine-help-window (@code{t})
Non-@code{nil} means, resize the Routine-info @file{*Help*} window to
fit the content.
@end defopt
@defopt idlwave-special-lib-alist
Alist of regular expressions matching special library directories.
@end defopt
@defopt idlwave-rinfo-max-source-lines (@code{5})
Maximum number of source files displayed in the Routine Info window.
@end defopt
@page
@node Online Help, Completion, Routine Info, The IDLWAVE Major Mode
@section Online Help
@cindex Online Help
@cindex @file{idlw-help.txt}
@cindex @file{idlw-help.el}
@cindex IDL manual, ASCII version
@cindex Installing online help
@cindex Online Help, Installation
@cindex Speed, of online help
For IDL system routines, RSI provides extensive documentation. IDLWAVE
can access an ASCII version of this documentation very quickly and
accurately. This is @emph{much} faster than using the IDL online help
application, also because usually IDLWAVE gets you to the right place in
the docs directly, without additional browsing and scrolling. For this
online help to work, you need an ASCII version of the IDL documentation
which is not part of the standard IDLWAVE distribution. The required
files can be downloaded from @uref{@value{IDLWAVE-HOMEPAGE}, the
maintainers webpage}. As the text is extracted from PDF files, the
formatting of the help text is good for normal text, but graphics and
multiline equations will not be well represented. See also
@ref{Documentation Scan}.
@cindex Source code, as online help
@cindex DocLib header, as online help
For routines which are not documented in the IDL manual (for example
your own routines), the source code 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. Otherwise the routine definition
statement (@code{pro}/@code{function}) is shown.
@kindex M-?
In any IDL program, press @kbd{M-?} (@code{idlwave-context-help}) or
click with @kbd{S-Mouse-3} to access context sensitive online help. The
following locations are recognized as context:
@cindex Context, for online help
@multitable @columnfractions .25 .75
@item @i{Routine name}
@tab The name of a routine (function, procedure, method).
@item @i{Keyword Parameter}
@tab Keyword parameter of a routine.
@item @i{System Variable}
@tab System variable like @code{!DPI}.
@item @i{IDL Statement}
@tab Like @code{PRO}, @code{REPEAT}, or @code{COMPILE_OPT}.
@item @i{Class name}
@tab Class name in @code{OBJ_NEW} call.
@item @i{Executive Command}
@tab Executive command like @code{.RUN}. Mostly useful in the shell.
@item @i{Default}
@tab The routine that would be selected for routine info display.
@end multitable
@cindex @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
@samp{OBJ_NEW}, 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.
@noindent Apart from source buffers, there are two more places from
which online help can be accessed.
@itemize @bullet
@item
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}).
@item
When using completion and Emacs pops up a window with possible
completions, clicking with @kbd{Mouse-3} on a completion item invokes
help on that item (@pxref{Completion}).
@end itemize
@noindent
In both cases, a blue face indicates that the item is documented in the
IDL manual.
@page
@cindex Help application, key bindings
@cindex Key bindings, in help application
The help window is normally displayed in a separate frame. The
following commands can be used to navigate inside the help system.
@multitable @columnfractions .15 .85
@item @kbd{@key{SPACE}}
@tab Scroll forward one page.
@item @kbd{@key{RET}}
@tab Scroll forward one line.
@item @kbd{@key{DEL}}
@tab Scroll back one page.
@item @kbd{n, p}
@tab Browse to the next or previous topic (in physical sequence).
@item @kbd{b, f}
@tab Move back and forward through the help topic history.
@item @kbd{c}
@tab Clear the history.
@item @kbd{Mouse-2}
@tab Follow a link. Active links are displayed in a different font.
Items under @i{See Also} are active, and classes have links to their
methods and back.
@item @kbd{o}
@tab Open a topic. The topic can be selected with completion.
@item @kbd{*}
@tab Load the whole help file into Emacs, for global text searches.
@item @kbd{q}
@tab Kill the help window.
@end multitable
@sp 1
@noindent When the help text is a source file, the following commands
are also available.
@multitable @columnfractions .15 .85
@item @kbd{h}
@tab Jump to DocLib Header of the routine whose source is displayed
as help.
@item @kbd{H}
@tab Jump to the first DocLib Header in the file.
@item @kbd{.} @r{(Dot)}
@tab Jump back and forth between the routine definition (the
@code{pro}/@code{function} statement) and the description of the help
item in the DocLib header.
@item @kbd{F}
@tab Fontify the buffer like source code. See the variable @code{idlwave-help-fontify-source-code}.
@end multitable
@defopt idlwave-help-directory
The directory where idlw-help.txt and idlw-help.el are stored.
@end defopt
@defopt idlwave-help-use-dedicated-frame (@code{t})
Non-nil means, use a separate frame for Online Help if possible.
@end defopt
@defopt idlwave-help-frame-parameters
The frame parameters for the special Online Help frame.
@end defopt
@defopt idlwave-max-popup-menu-items (@code{20})
Maximum number of items per pane in pop-up menus.
@end defopt
@defopt idlwave-extra-help-function
Function to call for help if the normal help fails.
@end defopt
@defopt idlwave-help-fontify-source-code (@code{nil})
Non-nil means, fontify source code displayed as help.
@end defopt
@defopt idlwave-help-source-try-header (@code{t})
Non-nil means, try to find help in routine header when displaying source
file.
@end defopt
@defopt idlwave-help-link-face
The face for links to IDLWAVE online help.
@end defopt
@defopt idlwave-help-activate-links-agressively (@code{t})
Non-@code{nil} means, make all possible links in help window active.
@end defopt
@node Completion, Routine Source, Online Help, The IDLWAVE Major Mode
@section Completion
@cindex Completion
@cindex Keyword completion
@cindex Method completion
@cindex Object method completion
@cindex Class name completion
@cindex Function name completion
@cindex Procedure name completion
@kindex M-@key{TAB}
@kindex C-c C-i
IDLWAVE offers completion for class names, routine names and keywords.
As in many programming modes, completion is bound to @kbd{M-@key{TAB}}.
Completion uses the same internal information as routine info, so when
necessary 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 at point. Here are example lines and what @kbd{M-@key{TAB}}
would try to complete when the cursor is on the position marked with a
@samp{*}.
@example
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}
@end example
@cindex Scrolling the @file{*Completions*} window
@cindex Completion, scrolling
@cindex Completion, Online Help
@cindex Online Help in @file{*Completions*} buffer
If the list of completions is too long to fit in the
@file{*Completions*} window, the window can be scrolled by pressing
@kbd{M-@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 displayed in a different font. For other items, the
corresponding source code or DocLib header is available as help text.
@cindex Case of completed words
@cindex Mixed case completion
The case of the completed words is determined by what is already in the
buffer. 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.
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. These defaults can be changed with the
variable @code{idlwave-completion-case}.
@defopt idlwave-completion-case
Association list setting the case (UPPER/lower/Capitalized/...) of completed
words.
@end defopt
@defopt idlwave-completion-force-default-case (@code{nil})
Non-@code{nil} means, completion will always honor the settings in
@code{idlwave-completion-case}. When nil (the default), lower case
strings will be completed to lower case.
@end defopt
@defopt idlwave-complete-empty-string-as-lower-case (@code{nil})
Non-@code{nil} means, the empty string is considered lower case for
completion.
@end defopt
@defopt idlwave-keyword-completion-adds-equal (@code{t})
Non-@code{nil} means, completion automatically adds @samp{=} after
completed keywords.
@end defopt
@defopt idlwave-function-completion-adds-paren (@code{t})
Non-@code{nil} means, completion automatically adds @samp{(} after
completed function. A value of `2' means, also add the closing
parenthesis and position cursor between the two.
@end defopt
@defopt idlwave-completion-restore-window-configuration (@code{t})
Non-@code{nil} means, restore window configuration after successful
completion.
@end defopt
@defopt idlwave-highlight-help-links-in-completion (@code{t})
Non-nil means, highlight completions for which system help is available.
@end defopt
@subsubheading Object Method Completion and Class Ambiguity
@cindex Object methods
@cindex Class ambiguity
@cindex @code{self} object, default class
An object method is not uniquely determined without the object's class.
Since the class part is usually omitted in the source code, IDLWAVE
considers all available methods in all classes as possible completions
of an object method name. For keywords, the combined keywords of the
current method in all available classes will be considered. In the
@file{*Completions*} buffer, the classes allowed for each completion
will be shown next to the item (see option
@code{idlwave-completion-show-classes}). As a special case, the class
of an object called @samp{self} object is always the class of the
current routine. All classes it inherits from are considered as well
where appropriate.
@cindex Forcing class query.
@cindex Class query, forcing
You can also call @code{idlwave-complete} with a prefix arg: @kbd{C-u
M-@key{TAB}}. IDLWAVE will then prompt you for the class in order to
narrow down the number of possible completions. The variable
@code{idlwave-query-class} can be configured to make this behavior the
default (not recommended). 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. Remembering the class works by placing a text
property in the object operator @samp{->}. This is not enabled by
default - the variable @code{idlwave-store-inquired-class} can be used
to turn it on.
@defopt idlwave-support-inheritance (@code{t})
Non-@code{nil} means, treat inheritance with completion, online help etc.
@end defopt
@defopt idlwave-completion-show-classes (@code{1})
Non-@code{nil} means, show classes in @file{*Completions*} buffer when
completing object methods and keywords.
@end defopt
@defopt idlwave-completion-fontify-classes (@code{t})
Non-@code{nil} means, fontify the classes in completions buffer.
@end defopt
@defopt idlwave-query-class (@code{nil})
Association list governing query for object classes during completion.
@end defopt
@defopt idlwave-store-inquired-class (@code{nil})
Non-@code{nil} means, store class of a method call as text property on
@samp{->}.
@end defopt
@defopt idlwave-class-arrow-face
Face to highlight object operator arrows @samp{->} which carry a class
text property.
@end defopt
@node Routine Source, Resolving Routines, Completion, The IDLWAVE Major Mode
@section Routine Source
@cindex Routine source file
@cindex Module source file
@cindex Source file, of a routine
@kindex C-c C-v
Apart from clicking on a @i{Source:} line in the routine info window,
there is also another way to find 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 @code{idlwave-routine-info} would
have used. In the minibuffer, specify a complete routine name
(including the class part). IDLWAVE will display the source file in
another window.
@cindex Buffers, killing
@cindex 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 remove these
buffers.
@node Resolving Routines, Code Templates, Routine Source, The IDLWAVE Major Mode
@section Resolving Routines
@cindex @code{RESOLVE_ROUTINE}
@cindex Compiling library modules
@cindex 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.
@code{idlwave-resolve} is one way to get a library module within reach
of IDLWAVE's routine info collecting functions. A better way is to
scan (parts of) the library (@pxref{Library Catalog}). Routine info on
library modules will then be available without the need to compile the
modules first, and even without a running shell.
@xref{Sources of Routine Info}, for in-depth information where IDLWAVE
collects data about routines, and how to update this information.
@node Code Templates, Actions, Resolving Routines, The IDLWAVE Major Mode
@section Code Templates
@cindex Code templates
@cindex Abbreviations
@cindex Templates
IDLWAVE can insert IDL code templates into the buffer. For a few
templates, this is done with direct key bindings:
@multitable @columnfractions .15 .85
@item @kbd{C-c C-c}
@tab @code{CASE} statement template
@item @kbd{C-c C-f}
@tab @code{FOR} loop template
@item @kbd{C-c C-r}
@tab @code{REPEAT} loop template
@item @kbd{C-c C-w}
@tab @code{WHILE} loop template
@end multitable
Otherwise, special abbreviations are used. 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). Here are a few examples of
predefined abbreviations. For a full list, use @kbd{M-x
idlwave-list-abbrevs}.
@multitable @columnfractions .15 .85
@item @code{\pr}
@tab @code{PROCEDURE} template
@item @code{\fu}
@tab @code{FUNCTION} template
@item @code{\c}
@tab @code{CASE} statement template
@item @code{\f}
@tab @code{FOR} loop template
@item @code{\r}
@tab @code{REPEAT} loop template
@item @code{\w}
@tab @code{WHILE} loop template
@item @code{\i}
@tab @code{IF} statement template
@item @code{\elif}
@tab @code{IF-ELSE} statement template
@item @code{\b}
@tab @code{BEGIN}
@end multitable
The templates are expanded in upper or lower case, depending upon the
variables @code{idlwave-abbrev-change-case} and
@code{idlwave-reserved-word-upcase}.
@defopt idlwave-abbrev-start-char (@code{"\"})
A single character string used to start abbreviations in abbrev
mode.
@end defopt
@defopt idlwave-abbrev-move (@code{t})
Non-@code{nil} means the abbrev hook can move point, e.g. to end up
between the parenthesis of a function call.
@end defopt
@node Actions, Doc Header, Code Templates, The IDLWAVE Major Mode
@section Actions
@cindex Actions
@cindex Coding standards, enforcing
@emph{Actions} are special 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, they can be
helpful.
Action can be applied in three ways:
@itemize @bullet
@item
Some actions are applied directly while typing. For example, pressing
@samp{=} 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.
@item
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 non-@code{nil}.
@item
@cindex Foreign code, adapting
@cindex Actions, applied to foreign code
Action can also be applied to a larger piece of code, e.g. in order 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{M-C-h} (the
current subprogram). @xref{Code Indentation}, for information how to
adjust the indentation of the code.
@end itemize
@defopt idlwave-do-actions (@code{nil})
Non-@code{nil} means performs actions when indenting.
@end defopt
@menu
* Block Boundary Check:: Is the END correct
* Padding Operators:: Enforcing space around `=' etc
* Case Changes:: Enforcing upper case keywords
@end menu
@node Block Boundary Check, Padding Operators, Actions, Actions
@subsection Block Boundary Check
@cindex Block boundary check
@cindex @code{END} type checking
@cindex @code{END}, automatic insertion
@cindex @code{END}, expanding
@cindex Block, closing
@cindex 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
@code{ENDIF} or @code{ENDCASE}, you get a warning if that kind of END
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 a specific type.
You can also type @kbd{C-c ]} to close the current block by inserting
the appropriate @code{END} statement.
@defopt idlwave-show-block (@code{t})
Non-@code{nil} means point blinks to block beginning for
@code{idlwave-show-begin}.
@end defopt
@defopt idlwave-expand-generic-end (@code{t})
Non-@code{nil} means expand generic END to ENDIF/ENDELSE/ENDWHILE etc.
@end defopt
@defopt idlwave-reindent-end (@code{t})
Non-nil means re-indent line after END was typed.
@end defopt
@node Padding Operators, Case Changes, Block Boundary Check, Actions
@subsection Padding Operators
@cindex Padding operators with spaces
@cindex Operators, padding with spaces
@cindex Space, around operators
Some operators can be automatically surrounded by spaces. This can
happen when the operator is typed, or also later when the line is
indented. IDLWAVE contains this setting for the operators @samp{&},
@samp{<}, @samp{>}, @samp{,}, @samp{=}, and @samp{->}@footnote{Operators
longer than one character can only be padded during line indentation.},
but the feature is turned off by default. If you want to turn it on,
customize the variables @code{idlwave-surround-by-blank} and
@code{idlwave-do-actions}. 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, try this in @file{.emacs}
@lisp
(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))))
@end lisp
@defopt idlwave-surround-by-blank (@code{nil})
Non-@code{nil} means, enable @code{idlwave-surround}. If non-nil,
@samp{=}, @samp{<}, @samp{>}, @samp{&}, @samp{,}, @samp{->} are
surrounded with spaces by @code{idlwave-surround}.
@end defopt
@defopt idlwave-pad-keyword (@code{t})
Non-@code{nil} means pad @samp{=} for keywords like assignments.
@end defopt
@node Case Changes, , Padding Operators, Actions
@subsection Case Changes
@cindex Case changes
@cindex Upcase, enforcing for reserved words
@cindex Downcase, enforcing for reserved words
Actions can be used to change the case of reserved words or expanded
abbreviations by customizing the variables
@code{idlwave-abbrev-change-case} and
@code{idlwave-reserved-word-upcase}. If you want to change the case of
additional words automatically, put something like the following into
your @file{.emacs} file:
@lisp
(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)))
@end lisp
For more information, see the documentation string for the function
@code{idlwave-action-and-binding}.
@defopt idlwave-abbrev-change-case (@code{nil})
Non-@code{nil} means all abbrevs will be forced to either upper or lower
case. Legal values are @code{nil}, @code{t}, and @code{down}.
@end defopt
@defopt idlwave-reserved-word-upcase (@code{nil})
Non-@code{nil} means, reserved words will be made upper case via abbrev
expansion.
@end defopt
@node Doc Header, Motion Commands, Actions, The IDLWAVE Major Mode
@section Documentation Header
@cindex Documentation header
@cindex DocLib header
@cindex Modification timestamp
@cindex Header, for file documentation
@cindex Timestamp, in doc header.
@cindex Changelog, in doc header.
@kindex C-c C-h
@kindex 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. One of the keywords is
@samp{MODIFICATION 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.
@defopt idlwave-file-header
The doc-header template or a path to a file containing it.
@end defopt
@defopt idlwave-timestamp-hook
The hook function used to update the timestamp of a function.
@end defopt
@defopt idlwave-doc-modifications-keyword
The modifications keyword to use with the log documentation commands.
@end defopt
@defopt idlwave-doclib-start
Regexp matching the start of a document library header.
@end defopt
@defopt idlwave-doclib-end
Regexp matching the start of a document library header.
@end defopt
@node Motion Commands, Misc Options, Doc Header, The IDLWAVE Major Mode
@section Motion Commands
@cindex Motion commands
@cindex Program structure, moving through
@cindex Code structure, moving through
@cindex @file{Func-menu}, XEmacs package
@cindex @file{Imenu}, Emacs package
@cindex Function definitions, jumping to
@cindex 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.
Several commands allow to move quickly through the structure of an IDL
program. These are
@multitable @columnfractions .15 .85
@item @kbd{C-M-a}
@tab Beginning of subprogram
@item @kbd{C-M-e}
@tab End of subprogram
@item @kbd{C-c @{}
@tab Beginning of block (stay inside the block)
@item @kbd{C-c @}}
@tab End of block (stay inside the block)
@item @kbd{M-C-n}
@tab Forward block (on same level)
@item @kbd{M-C-p}
@tab Backward block (on same level)
@item @kbd{M-C-d}
@tab Down block (enters a block)
@item @kbd{M-C-u}
@tab Backward up block (leaves a block)
@item @kbd{C-c C-n}
@tab Next Statement
@end multitable
@node Misc Options, , Motion Commands, The IDLWAVE Major Mode
@section Miscellaneous Options
@cindex Hooks
@defopt idlwave-help-application
The external application providing reference help for programming.
@end defopt
@defopt idlwave-startup-message (@code{t})
Non-@code{nil} means display a startup message when @code{idlwave-mode}'
is first called.
@end defopt
@defopt idlwave-mode-hook
Normal hook. Executed when a buffer is put into @code{idlwave-mode}.
@end defopt
@defopt idlwave-load-hook
Normal hook. Executed when @file{idlwave.el} is loaded.
@end defopt
@node The IDLWAVE Shell, Installation, The IDLWAVE Major Mode, Top
@chapter The IDLWAVE Shell
@cindex IDLWAVE shell
@cindex Major mode, @code{idlwave-shell-mode}
@cindex IDL, as Emacs subprocess
@cindex Subprocess of Emacs, IDL
@cindex Comint, Emacs package
@cindex Windows
@cindex MacOS
The IDLWAVE shell is an Emacs major mode which allows to run the IDL
program as an inferior process of Emacs. 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 uses @file{comint}, an Emacs
packages which handles the communication with the IDL program.
Unfortunately IDL for Windows and MacOS does not allow the interaction
with Emacs@footnote{Please inform the maintainer if you come up with a way
to make the IDLWAVE shell work on these systems.}, so the IDLWAVE shell
only works under GNU and Unix.
@menu
* Starting the Shell:: How to launch IDL as a subprocess
* Using the Shell:: Interactively working with the Shell
* Debugging IDL Programs:: Compilation/Debugging
@end menu
@node Starting the Shell, Using the Shell, The IDLWAVE Shell, The IDLWAVE Shell
@section Starting the Shell
@cindex Starting the shell
@cindex Shell, starting
@cindex Dedicated frame, for shell buffer
@cindex Frame, for shell buffer
@cindex Subprocess of Emacs, IDL
@kindex 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
@kbd{C-c 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 simple 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.
In order to create a separate frame for the IDLWAVE shell buffer, call
@code{idlwave-shell} with a prefix argument: @kbd{C-u C-c C-s} or
@kbd{C-u C-c C-l}. If you always want a dedicated frame for the shell
window, configure the variable
@code{idlwave-shell-use-dedicated-frame}.
The shell can also be started automatically when another command tries
to send a command to it. To enable auto start, set the variable
@code{idlwave-shell-automatic-start} to @code{t}.
@defopt idlwave-shell-explicit-file-name
This is the command to run IDL.
@end defopt
@defopt idlwave-shell-command-line-options
A list of command line options for calling the IDL program.
@end defopt
@defopt idlwave-shell-prompt-pattern
Regexp to match IDL prompt at beginning of a line.
@end defopt
@defopt idlwave-shell-process-name
Name to be associated with the IDL process.
@end defopt
@defopt idlwave-shell-automatic-start
Non-@code{nil} means attempt to invoke idlwave-shell if not already
running.
@end defopt
@defopt idlwave-shell-initial-commands
Initial commands, separated by newlines, to send to IDL.
@end defopt
@defopt idlwave-shell-use-dedicated-frame (@code{nil})
Non-@code{nil} means, IDLWAVE should use a special frame to display
shell buffer.
@end defopt
@defopt idlwave-shell-frame-parameters
The frame parameters for a dedicated idlwave-shell frame.
@end defopt
@defopt idlwave-shell-temp-pro-prefix
The prefix for temporary IDL files used when compiling regions.
@end defopt
@cindex Hooks
@defopt idlwave-shell-mode-hook
Hook for customizing @code{idlwave-shell-mode}.
@end defopt
@node Using the Shell, Debugging IDL Programs, Starting the Shell, The IDLWAVE Shell
@section Using the Shell
@cindex Comint
@cindex 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 terminal@footnote{This is different from
normal Emacs/Comint behavior, but more like an xterm. If you prefer the
default comint functionality, check the variable
@code{idlwave-shell-arrows-do-history}.}. Here is a list of
commonly used commands.
@multitable @columnfractions .12 .88
@item @key{UP}
@tab Cycle backwards in input history
@item @key{DOWN}
@tab Cycle forwards in input history
@item @kbd{M-p}
@tab Cycle backwards in input history @emph{matching input}
@item @kbd{M-n}
@tab Cycle forwards in input history @emph{matching input}
@item @kbd{M-r}
@tab Previous input matching a regexp
@item @kbd{M-s}
@tab Next input that matches a regexp
@item @kbd{return}
@tab Send input or copy line to current prompt
@item @kbd{C-c C-a}
@tab Beginning of line; skip prompt
@item @kbd{C-c C-u}
@tab Kill input to beginning of line
@item @kbd{C-c C-w}
@tab Kill word before cursor
@item @kbd{C-c C-c}
@tab Send ^C
@item @kbd{C-c C-z}
@tab Send ^Z
@item @kbd{C-c C-\}
@tab Send ^\
@item @kbd{C-c C-o}
@tab Delete last batch of process output
@item @kbd{C-c C-r}
@tab Show last batch of process output
@item @kbd{C-c C-l}
@tab List input history
@end multitable
In addition to these standard @file{comint} commands,
@code{idlwave-shell-mode} provides many of the commands which simplify
writing IDL code, including abbreviations, online help, and completion.
See @ref{Routine Info} and @ref{Online Help} and @ref{Completion} for more
information on these commands.
@cindex Completion, in the shell
@cindex Routine info, in the shell
@cindex Online Help, in the shell
@multitable @columnfractions .12 .88
@item @kbd{@key{TAB}}
@tab Completion of file names, routine names and keywords
(@code{idlwave-shell-complete})
@item @kbd{M-@key{TAB}}
@tab Same as @key{TAB}
@item @kbd{C-c ?}
@tab Routine Info display (@code{idlwave-routine-info})
@item @kbd{M-?}
@tab IDL online help on routine (@code{idlwave-routine-info-from-idlhelp})
@item @kbd{C-c C-i}
@tab Update routine info from buffers and shell
(@code{idlwave-update-routine-info})
@item @kbd{C-c C-v}
@tab Find the source file of a routine (@code{idlwave-find-module})
@item @kbd{C-c =}
@tab Compile a library routine (@code{idlwave-resolve})
@end multitable
@defopt idlwave-shell-arrows-do-history (@code{t})
Non-@code{nil} means @key{UP} and @key{DOWN} arrows move through command
history like xterm.
@end defopt
@defopt idlwave-shell-file-name-chars
The characters allowed in file names, as a string. Used for file name
completion.
@end defopt
@defopt idlwave-shell-graphics-window-size
Size of IDL graphics windows popped up by special IDLWAVE command.
@end defopt
@cindex Input mode
@cindex Character input mode (Shell)
@cindex Line input mode (Shell)
@cindex Magic spells, for input mode
@cindex 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.
@defopt idlwave-shell-use-input-mode-magic (@code{nil})
Non-nil means, IDLWAVE should check for input mode spells in output.
@end defopt
@defopt idlwave-shell-input-mode-spells
The three regular expressions which match the magic spells for input
modes.
@end defopt
@node Debugging IDL Programs, , Using the Shell, The IDLWAVE Shell
@section Debugging IDL Programs
@cindex Debugging
@cindex Keybindings for debugging
@cindex Toolbar
@kindex C-c C-d
Programs can be compiled, run, and debugged directly from the source
buffer in Emacs. The IDLWAVE shell installs key bindings both in the
shell buffer and in all IDL code buffers of the current Emacs session.
On Emacs versions which support this, it also installs a debugging
toolbar. The display of the toolbar can be toggled with @kbd{C-c C-d
C-t} (@code{idlwave-shell-toggle-toolbar}).
The debugging key bindings are 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}, compiling a source file with @kbd{C-c C-d C-c}. If you find this
too much work you can choose a combination of modifier keys which is not
used by other commands. For example, if you write in @file{.emacs}
@lisp
(setq idlwave-shell-debug-modifiers '(control shift))
@end lisp
a breakpoint can be set by pressing @kbd{b} while holding down
@kbd{shift} 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 @kbd{C-c
C-d} bindings are active, but each of these bindings will have an
equivalent single-keypress shortcut with the modifiers given in the
@code{idlwave-shell-debug-modifiers} variable.
@defopt idlwave-shell-prefix-key (@kbd{C-c C-d})
The prefix key for the debugging map
@code{idlwave-shell-mode-prefix-map}.
@end defopt
@defopt idlwave-shell-activate-prefix-keybindings (@code{t})
Non-@code{nil} means, debug commands will be bound to the prefix
key, like @kbd{C-c C-d C-b}.
@end defopt
@defopt idlwave-shell-debug-modifiers (@code{nil})
List of modifier keys to use for binding debugging commands in the shell
and in source buffers.
@end defopt
@defopt idlwave-shell-use-toolbar (@code{t})
Non-@code{nil} means, use the debugging toolbar in all IDL related
buffers.
@end defopt
@menu
* Compiling Programs:: Compiling buffers under the shell
* Breakpoints and Stepping:: Deciding where to stop and look
* Examining Variables:: What is the value now?
@end menu
@node Compiling Programs, Breakpoints and Stepping, Debugging IDL Programs, Debugging IDL Programs
@subsection Compiling Programs
@cindex Compiling programs
@cindex Programs, compiling
@cindex Default command line, executing
@cindex Executing a default command line
@kindex C-c C-d C-c
In order to compile the current buffer under the IDLWAVE shell, press
@kbd{C-c C-d C-c} (@code{idlwave-save-and-run}). This first saves the
current buffer and then send 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
@kbd{C-c 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}.
@defopt idlwave-shell-mark-stop-line (@code{t})
Non-@code{nil} means, mark the source code line where IDL is currently
stopped. The value decides about the preferred method. Legal values
are @code{nil}, @code{t}, @code{arrow}, and @code{face}.
@end defopt
@defopt idlwave-shell-overlay-arrow (@code{">"})
The overlay arrow to display at source lines where execution
halts.
@end defopt
@defopt idlwave-shell-stop-line-face
The face which highlights the source line where IDL is
stopped.
@end defopt
@node Breakpoints and Stepping, Examining Variables, Compiling Programs, Debugging IDL Programs
@subsection Breakpoints and Stepping
@cindex Breakpoints
@cindex Stepping
@cindex Execution, controlled
@kindex C-c C-d C-b
@kindex C-c C-d C-b
You can set breakpoints and step through a program with IDLWAVE.
Setting a breakpoint in the current line of the source buffer is done
with @kbd{C-c C-d C-b} (@code{idlwave-shell-break-here}). With a prefix
arg of 1, the breakpoint gets a @code{/ONCE} keyword, meaning that it
will be deleted after first use. With a numeric prefix greater than
one, the breakpoint will only be active the @code{nth} time it is hit.
To clear the breakpoint in the current line, use @kbd{C-c C-d C-d}
(@code{idlwave-clear-current-bp}). To clear all breakpoints, use
@kbd{C-c C-d C-a} (@code{idlwave-clear-all-bp}). Breakpoint lines are
highlighted in the source code.
Once the program has stopped somewhere, you can step through it. Here
is a summary of the breakpoint and stepping commands:
@multitable @columnfractions .23 .77
@item @kbd{C-c C-d C-b}
@tab Set breakpoint (@code{idlwave-shell-break-here})
@item @kbd{C-c C-d C-i}
@tab Set breakpoint in function named here (@code{idlwave-shell-break-in})
@item @kbd{C-c C-d C-d}
@tab Clear current breakpoint (@code{idlwave-shell-clear-current-bp})
@item @kbd{C-c C-d C-a}
@tab Clear all breakpoints (@code{idlwave-shell-clear-all-bp})
@item @kbd{C-c C-d C-s}
@tab Step, into function calls (@code{idlwave-shell-step})
@item @kbd{C-c C-d C-n}
@tab Step, over function calls (@code{idlwave-shell-stepover})
@item @kbd{C-c C-d C-k}
@tab Skip one statement (@code{idlwave-shell-skip})
@item @kbd{C-c C-d C-u}
@tab Continue to end of block (@code{idlwave-shell-up})
@item @kbd{C-c C-d C-m}
@tab Continue to end of function (@code{idlwave-shell-return})
@item @kbd{C-c C-d C-o}
@tab Continue past end of function (@code{idlwave-shell-out})
@item @kbd{C-c C-d C-h}
@tab Continue to line at cursor position (@code{idlwave-shell-to-here})
@item @kbd{C-c C-d C-r}
@tab Continue execution to next breakpoint (@code{idlwave-shell-cont})
@item @kbd{C-c C-d C-up}
@tab Show higher level in calling stack (@code{idlwave-shell-stack-up})
@item @kbd{C-c C-d C-down}
@tab Show lower level in calling stack (@code{idlwave-shell-stack-down})
@end multitable
@defopt idlwave-shell-mark-breakpoints (@code{t})
Non-@code{nil} means, mark breakpoints in the source file buffers. The
value indicates the preferred method. Legal values are @code{nil},
@code{t}, @code{face}, and @code{glyph}.
@end defopt
@defopt idlwave-shell-breakpoint-face
The face for breakpoint lines in the source code if
@code{idlwave-shell-mark-breakpoints} has the value @code{face}.
@end defopt
@node Examining Variables, , Breakpoints and Stepping, Debugging IDL Programs
@subsection Examining Variables
@cindex @code{PRINT} expressions
@cindex @code{HELP}, on expressions
@cindex Expressions, printing
@cindex Expressions, help
@cindex Mouse binding to print expressions
@kindex C-c C-d C-p
When execution is stopped you can examine the values of variables. The
command @kbd{C-c C-d C-p} prints the expression at point, while @kbd{C-c
C-d ?} shows help on this expression. The expression at point is an
array expression or a function call, or the contents of a pair of
parenthesis. The selected expression becomes highlighted in the source
code for a short time. Calling the above commands with a prefix
argument will prompt for an expression instead of using the one at
point.
It is very convenient to click with the mouse on expressions to retrieve
their value. Expression printing is also bound to @kbd{S-Mouse-2} and
expression help to @kbd{C-S-Mouse-2}. I.e. you need to hold down
@key{SHIFT} and @key{CONTROL} while clicking with the mouse.
@cindex Calling stack, motion
@cindex Printing expressions, on calling stack
@cindex Restrictions for expression printing
Printing of expressions also works on higher levels of the calling
stack. This means that you can examine the values of variables and
expressions inside the routine which called the current routine etc.
Use the commands @kbd{C-c C-d C-@key{UP}}
(@code{idlwave-shell-stack-up}) and @kbd{C-c C-d C-@key{DOWN}}
(@code{idlwave-shell-stack-down}) or the corresponding toolbar buttons
to move through the calling stack. The mode line of the shell window
will indicate the routine and the calling stack level which define the
context for printing expressions. The following restrictions apply for
all levels except the current:
@itemize @bullet
@item
Array expressions must use the @samp{[ ]} index delimiters. Identifiers
with a @samp{( )} will be interpreted as function calls.
@item
@cindex ROUTINE_NAMES, IDL procedure
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.
@end itemize
@defopt 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.
@end defopt
@defopt idlwave-shell-print-expression-function (@code{nil})
A function to handle special display of evaluated expressions.
@end defopt
@node Installation, Acknowledgement, The IDLWAVE Shell, Top
@chapter Installation
@cindex Installation
@menu
* Installing IDLWAVE:: How to install the distribution
* Installing Online Help:: Where to get the additional files needed
* Upgrading from idl.el:: Necessary configuration changes
@end menu
@node Installing IDLWAVE, Installing Online Help, Installation, Installation
@section Installing IDLWAVE
@cindex FTP site
@cindex URL, homepage for IDLWAVE
@cindex Homepage for IDLWAVE
@cindex IDLWAVE, homepage
@cindex XEmacs package IDLWAVE
@cindex Emacs, distributed with IDLWAVE
@cindex Copyright, of IDL manual
IDLWAVE is part of Emacs 21.1 and later. It is also an XEmacs package
and can be installed from
@uref{ftp://ftp.xemacs.org/pub/xemacs/packages/,the XEmacs ftp site}
with the normal package management system on XEmacs 21. These
pre-installed versions should work out-of-the-box. However, the files
needed for online help are not distributed with XEmacs/Emacs and have to
be installed separately@footnote{Due to copyright reasons, the ASCII
version of the IDL manual cannot be distributed under the GPL.}
(@pxref{Installing Online Help}).
You can also download IDLWAVE and install it yourself from
@uref{@value{IDLWAVE-HOMEPAGE}, the maintainers webpage}. Follow the
instructions in the INSTALL file.
@node Installing Online Help, Upgrading from idl.el , Installing IDLWAVE, Installation
@section Installing Online Help
@cindex Installing online help
@cindex Online Help, Installation
If you want to use the online help display, two additional files (an
ASCII version of the IDL documentation and a topics/code file) must be
installed. These files can also be downloaded from
@uref{@value{IDLWAVE-HOMEPAGE}, the maintainers webpage}. You need to
place the files somewhere on your system and tell IDLWAVE where they are
with
@lisp
(setq idlwave-help-directory "/path/to/help/files/")
@end lisp
@node Upgrading from idl.el, , Installing Online Help, Installation
@section Upgrading from the old @b{@file{idl.el}} file
@cindex Upgrading from old @b{@file{idl.el}}
@cindex Renaming old variables
@cindex Old variables, renaming
@kindex M-@key{TAB}
If you have been using the old @file{idl.el} and @file{idl-shell.el}
files and would like to use IDLWAVE, you need to update your
customization in @file{.emacs}.
@enumerate
@item
Change all variable and function prefixes from @samp{idl-} to @samp{idlwave-}.
@item
Remove the now invalid @code{autoload} and @code{auto-mode-alist} forms
pointing to the @file{idl.el} and @file{idl-shell.el} files. Install
the new autoload forms.
@item
If you have been using the hook function recommended in earlier versions
to get a separate frame for the IDL shell, remove that command from your
@code{idlwave-shell-mode-hook}. Instead, set the variable
@code{idlwave-shell-use-dedicated-frame} with
@lisp
(setq idlwave-shell-use-dedicated-frame t)
@end lisp
@item
The key sequence @kbd{M-@key{TAB}} no longer inserts a TAB character.
Like in many other Emacs modes, @kbd{M-@key{TAB}} now does
completion. Inserting a TAB has therefore been moved to
@kbd{C-@key{TAB}}. On a character based terminal you can also use
@kbd{C-c @key{SPC}}.
@end enumerate
@node Acknowledgement, Sources of Routine Info, Installation, Top
@chapter Acknowledgement
@cindex Acknowledgement
@cindex Maintainer, of IDLWAVE
@cindex Authors, of IDLWAVE
@cindex Contributors, to IDLWAVE
@cindex Email address, of Maintainer
@cindex Thanks
@noindent
The main contributors to the IDLWAVE package have been:
@itemize @minus
@item
@uref{mailto: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.
@item
@uref{mailto:dominik@@astro.uva.nl, @b{Carsten Dominik}}, who have
been in charge of the package since version 3.0, and also wrote this
manual.
@item
@uref{mailto: jdsmith@@astro.cornell.edu, @b{John-David Smith}},
current maintainer, who is also responsible for this manual's
maintenance. John-David has also shaped Object method completion and
most new features in version 4.0 with his ideas, bug reports, and
patient explanations of IDL internals.
@end itemize
@noindent
The following people have also contributed to the development of IDLWAVE
with patches, ideas, bug reports and suggestions.
@itemize @minus
@item
Ulrik Dickow <dickow@@nbi.dk>
@item
Eric E. Dors <edors@@lanl.gov>
@item
Stein Vidar H. Haugan <s.v.h.haugan@@astro.uio.no>
@item
David Huenemoerder <dph@@space.mit.edu>
@item
Kevin Ivory <Kevin.Ivory@@linmpi.mpg.de>
@item
Xuyong Liu <liu@@stsci.edu>
@item
Simon Marshall <Simon.Marshall@@esrin.esa.it>
@item
Craig Markwardt <craigm@@cow.physics.wisc.edu>
@item
Laurent Mugnier <mugnier@@onera.fr>
@item
Lubos Pochman <lubos@@rsinc.com>
@item
Patrick M. Ryan <pat@@jaameri.gsfc.nasa.gov>
@item
Marty Ryba <ryba@@ll.mit.edu>
@item
Phil Williams <williams@@irc.chmcc.org>
@item
Phil Sterne <sterne@@dublin.llnl.gov>
@end itemize
@noindent
Thanks to everyone!
@node Sources of Routine Info, Configuration Examples, Acknowledgement, Top
@appendix Sources of Routine Info
@cindex Sources of routine information
In @ref{Routine Info} and @ref{Completion} it was shown how IDLWAVE
displays the calling sequence and keywords of routines, and how it
completes routine names and keywords. For these features to work,
IDLWAVE must know about the accessible routines.
@menu
* Routine Definitions:: Where IDL Routines are defined.
* Routine Information Sources:: So how does IDLWAVE know about...
* Library Catalog:: Scanning the Libraries for Routine Info
* Load-Path Shadows:: Routines defined in several places
* Documentation Scan:: Scanning the IDL Manuals
@end menu
@node Routine Definitions, Routine Information Sources, Sources of Routine Info, Sources of Routine Info
@section Routine Definitions
@cindex Routine definitions
@cindex IDL variable @code{!PATH}
@cindex @code{!PATH}, IDL variable
@cindex @code{CALL_EXTERNAL}, IDL routine
@cindex @code{LINKIMAGE}, IDL routine
@cindex External routines
Routines which can be used in an IDL program can be defined in several
places:
@enumerate
@item
@emph{Builtin routines} are defined inside IDL itself. The source
code of such routines is not accessible to the user.
@item
Routines @emph{part of the current program} are defined in a file which
is explicitly compiled by the user. This file may or may not be located
on the IDL search path.
@item
@emph{Library routines} are defined in special files which are located
somewhere 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.
@item
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 external
routines.
@end enumerate
@node Routine Information Sources, Library Catalog, Routine Definitions, Sources of Routine Info
@section Routine Information Sources
@cindex Routine info sources
@cindex Builtin list of routines
@cindex Updating routine info
@cindex Scanning buffers for routine info
@cindex Buffers, scanning for routine info
@cindex Shell, querying for routine info
In oder to know about as many routines as possible, IDLWAVE will do the
following to collect information:
@enumerate
@item
It has a @emph{builtin list} with the properties of the builtin IDL
routines. IDLWAVE @value{VERSION} is distributed with a list of
@value{NSYSROUTINES} routines and @value{NSYSKEYWORDS} keywords,
reflecting IDL version @value{IDLVERSION}. This list has been created
by scanning the IDL manuals and is stored in the file
@file{idlw-rinfo.el}. @xref{Documentation Scan}, for
information how to regenerate this file for new versions of IDL.
@item
It @emph{scans} all @emph{buffers} of 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 which is 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.
@item
If you have an IDLWAVE-Shell running as inferior process of the current
Emacs session, IDLWAVE will @emph{query the shell} for compiled routines
and their arguments. This happens automatically when routine
information or completion is first requested by the user, and each time
an Emacs buffer is compiled with @kbd{C-c C-d C-c}. The command
@kbd{C-c C-i} (@code{idlwave-update-routine-info}) can be used to ask
the shell again at any time.
@item
IDLWAVE can scan all or selected library files and store the result in a
file which will be automatically loaded just like
@file{idlw-rinfo.el}. @xref{Library Catalog}, for information how to
scan library files.
@end enumerate
@defopt idlwave-scan-all-buffers-for-routine-info (@code{t})
Non-@code{nil} means, scan all buffers for IDL programs when updating
info.
@end defopt
@defopt idlwave-query-shell-for-routine-info (@code{t})
Non-@code{nil} means query the shell for info about compiled routines.
@end defopt
@defopt idlwave-auto-routine-info-updates
Controls under what circumstances routine info is updated automatically.
@end defopt
@node Library Catalog, Load-Path Shadows, Routine Information Sources, Sources of Routine Info
@section Library Catalog
@cindex Library scan
@cindex Library catalog
@cindex IDL library routine info
@cindex Windows
@cindex MacOS
@cindex IDL variable @code{!DIR}
@cindex @code{!DIR}, IDL variable
IDLWAVE can extract routine information from library modules and store
that information in a file. To do this, the variable
@code{idlwave-libinfo-file} needs to contain the path to a file in an
existing directory (the default is @code{"~/.idlcat.el"}). Since the
file will contain lisp code, its name should end in @file{.el}. Under
Windows and MacOS, you also need to specify the search path for IDL
library files 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 @code{idlwave-system-directory}. Under Unix and GNU,
these values will be automatically inferred from an IDLWAVE
shell.
The command @kbd{M-x idlwave-create-libinfo-file} can then be used to
scan library files. It brings up a widget in which you can select some
or all directories on the search path. If you only want to have routine
and completion info of some libraries, it is sufficient to scan those
directories. However, if you want IDLWAVE to detect possible name
conflicts with routines defined in other libraries, the whole pass
should be scanned.
After selecting directories, click on the @w{@samp{[Scan & Save]}}
button in the widget to scan all files in the selected directories and
write the resulting routine information into the file
@code{idlwave-libinfo-file}. In order to update the library information
from the same directories, call the command
@code{idlwave-update-routine-info} with a double prefix argument:
@w{@kbd{C-u C-u C-c C-i}}. This will rescan files in the previously
selected directories, write an updated version of the libinfo file and
rebuild IDLWAVEs internal lists.
A note of caution: Depending on your local installation, the IDL
library can be very large. Parsing it for routine information will take
time and loading this information into Emacs can require a
significant amount of memory. However, having this information
available will be a great help.
@defopt idlwave-libinfo-file
File for routine information of the IDL library.
@end defopt
@defopt idlwave-library-path
IDL library path for Windows and MacOS. Not needed under GNU and Unix.
@end defopt
@defopt idlwave-system-directory
The IDL system directory for Windows and MacOS. Not needed under GNU and Unix.
@end defopt
@defopt idlwave-special-lib-alist
Alist of regular expressions matching special library directories.
@end defopt
@node Load-Path Shadows, Documentation Scan, Library Catalog, Sources of Routine Info
@section Load-Path Shadows
@cindex Load-path shadows
@cindex Shadows, load-path
@cindex Duplicate routines
@cindex Multiply defined routines
@cindex Routine definitions, multiple
@cindex Application, testing for shadowing
@cindex Buffer, testing for shadowing
IDLWAVE can compile a list of routines which are defined in several
different files. 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
@file{*Shadows*}. 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 listed in the sequence of
@emph{likelyhood 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:
@table @asis
@item @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}
@item @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.
@item @kbd{M-x idlwave-list-all-load-path-shadows}
This command checks all routines accessible to IDLWAVE for conflicts.
@end table
For these commands to work properly you should have scanned the entire
load path, not just selected directories. Also, IDLWAVE should be able to
distinguish between the system library files (normally installed in
@file{/usr/local/rsi/idl/lib}) and any site specific or user specific
files. Therefore, such local files should not be installed
inside the @file{lib} directory of the IDL directory. This is of course
also advisable for many other reasons.
@cindex Windows
@cindex MacOS
@cindex IDL variable @code{!DIR}
@cindex @code{!DIR}, IDL variable
Users of Windows and MacOS also must set the variable
@code{idlwave-system-directory} 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}).
@node Documentation Scan, , Load-Path Shadows, Sources of Routine Info
@section Documentation Scan
@cindex @file{get_rinfo}
@cindex @file{idlw-rinfo.el}
@cindex @file{idlw-help.txt}
@cindex @file{idlw-help.el}
@cindex Scanning the documentation
@cindex Perl program, to create @file{idlw-rinfo.el}
IDLWAVE derives it knowledge about system routines from the IDL
manuals. The file @file{idlw-rinfo.el} contains the routine information
for the IDL system routines. The Online Help feature of IDLWAVE
requires ASCII versions of some IDL manuals to be available in a
specific format (@file{idlw-help.txt}), along with an Emacs-Lisp file
@file{idlw-help.el} with supporting code and pointers to the ASCII file.
All 3 files can be derived from the IDL documentation. 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 @file{get_rinfo} which constructs these files
by scanning selected files from the IDL documentation. Instructions on
how to use @file{get_rinfo} are in the program itself.
@node Configuration Examples, Index, Sources of Routine Info, Top
@appendix Configuration Examples
@cindex Configuration examples
@cindex Example configuration
@cindex @file{.emacs}
@cindex Default settings, of options
@cindex Interview, with the maintainer
@noindent
@b{Question:} So now 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?
@noindent
@b{Answer:} Hardly any. As the maintainer, I set the default of most
options to what I think is best. However, the default settings do not
turn on features which
@itemize @minus
@item
are not self-evident (i.e. too magic) when used by an unsuspecting user
@item
are too intrusive
@item
will not work properly on all Emacs installations out there
@item
break with widely used standards.
@end itemize
@noindent To see what I mean, here is the @emph{entire} configuration I
have in my @file{.emacs}:
@lisp
(setq idlwave-shell-debug-modifiers '(control shift)
idlwave-store-inquired-class t
idlwave-shell-automatic-start t
idlwave-main-block-indent 2
idlwave-help-dir "~/lib/emacs/idlwave"
idlwave-special-lib-alist '(("/idl-astro/" . "AstroLib")
("/jhuapl/" . "JHUAPL-Lib")
("/dominik/lib/idl/" . "MyLib")))
@end lisp
However, if you are an Emacs power-user and want IDLWAVE to work
completely differently, the options allow you to change almost every
aspect of it. Here is an example of a much more extensive configuration
of IDLWAVE. To say it again - this is not what I recommend, but the
user is King!
@example
;;; 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
;; Some setting can only be done from a mode hook. Here is an example:
(add-hook 'idlwave-mode-hook
(lambda ()
(setq abbrev-mode 1) ; Turn on abbrevs (-1 for off)
(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
;;
;; 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)
;; 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.
))
;;; 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
@end example
@node Index, , Configuration Examples, Top
@unnumbered Index
@printindex cp
@bye