annotate doc/misc/idlwave.texi @ 105934:26b37c3219d1

(Hints to MUA Authors): MUA should do any decoding. http://lists.gnu.org/archive/html/emacs-devel/2009-11/msg00027.html
author Glenn Morris <rgm@gnu.org>
date Tue, 10 Nov 2009 08:12:52 +0000
parents 9bcea07061a8
children 1d1d5d9bd884
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1 \input texinfo @c -*-texinfo-*-
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2 @c %**start of header
84329
3d431f1997d8 (setfilename): Go up one more level to ../../info.
Glenn Morris <rgm@gnu.org>
parents: 84302
diff changeset
3 @setfilename ../../info/idlwave
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4 @settitle IDLWAVE User Manual
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
5 @synindex ky cp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
6 @syncodeindex vr cp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
7 @syncodeindex fn cp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
8 @set VERSION 6.1
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
9 @set EDITION 6.1
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
10 @set IDLVERSION 6.3
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
11 @set NSYSROUTINES 4346
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
12 @set DATE April, 2007
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
13 @set AUTHOR J.D. Smith & Carsten Dominik
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
14 @set MAINTAINER J.D. Smith
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
15 @c %**end of header
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
16 @finalout
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
17
95932
e17b253d63ca Use @copying.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
18 @copying
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
19 This file documents IDLWAVE, a major mode for editing IDL files with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
20 Emacs, and interacting with an IDL shell run as a subprocess.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
21
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
22 This is edition @value{EDITION} of the IDLWAVE User Manual for IDLWAVE
95932
e17b253d63ca Use @copying.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
23 @value{VERSION}.
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
24
95874
eafbd7a5c9be Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
25 Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
100974
cb5d2387102c Add 2009 to copyright years.
Glenn Morris <rgm@gnu.org>
parents: 99709
diff changeset
26 2007, 2008, 2009 Free Software Foundation, Inc.
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
27
95932
e17b253d63ca Use @copying.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
28 @quotation
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
29 Permission is granted to copy, distribute and/or modify this document
99709
6de181810d0f Relicense all texi files under FDL 1.3 or later.
Glenn Morris <rgm@gnu.org>
parents: 95932
diff changeset
30 under the terms of the GNU Free Documentation License, Version 1.3 or
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
31 any later version published by the Free Software Foundation; with no
95932
e17b253d63ca Use @copying.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
32 Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
e17b253d63ca Use @copying.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
33 and with the Back-Cover Texts as in (a) below. A copy of the license
e17b253d63ca Use @copying.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
34 is included in the section entitled ``GNU Free Documentation License''.
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
35
95874
eafbd7a5c9be Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
36 (a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
eafbd7a5c9be Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
37 modify this GNU manual. Buying copies from the FSF supports it in
eafbd7a5c9be Update Back-Cover Text as per maintain.info.
Glenn Morris <rgm@gnu.org>
parents: 87903
diff changeset
38 developing GNU and promoting software freedom.''
95932
e17b253d63ca Use @copying.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
39 @end quotation
e17b253d63ca Use @copying.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
40 @end copying
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
41
102059
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
42 @dircategory Emacs
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
43 @direntry
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
44 * IDLWAVE: (idlwave). Major mode and shell for IDL files.
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
45 @end direntry
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
46
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
47 @titlepage
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
48 @title IDLWAVE User Manual
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
49 @subtitle Emacs major mode and shell for IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
50 @subtitle Edition @value{EDITION}, @value{DATE}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
51 @author by J.D. Smith & Carsten Dominik
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
52 @page
95932
e17b253d63ca Use @copying.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
53 @vskip 0pt plus 1filll
e17b253d63ca Use @copying.
Glenn Morris <rgm@gnu.org>
parents: 95874
diff changeset
54 @insertcopying
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
55 @end titlepage
102059
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
56
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
57 @contents
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
58
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
59 @ifnottex
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
60 @node Top, Introduction, (dir), (dir)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
61
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
62 IDLWAVE is a package which supports editing source code written in the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
63 Interactive Data Language (IDL), and running IDL as an inferior shell.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
64
102059
9bcea07061a8 consistently use @insertcopying, @direntry, @contents
Karl Berry <karl@gnu.org>
parents: 100974
diff changeset
65 @insertcopying
84302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
66 @end ifnottex
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
67
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
68 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
69 * Introduction:: What IDLWAVE is, and what it is not
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
70 * IDLWAVE in a Nutshell:: One page quick-start guide
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
71 * Getting Started:: Tutorial
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
72 * The IDLWAVE Major Mode:: The mode for editing IDL programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
73 * The IDLWAVE Shell:: The mode for running IDL as an inferior program
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
74 * Acknowledgements:: Who did what
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
75 * Sources of Routine Info:: How does IDLWAVE know about routine XYZ
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
76 * HTML Help Browser Tips::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
77 * Configuration Examples:: The user is king
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
78 * Windows and MacOS:: What still works, and how
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
79 * Troubleshooting:: When good computers turn bad
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
80 * GNU Free Documentation License:: The license for this documentation.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
81 * Index:: Fast access
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
82
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
83 @detailmenu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
84 --- The Detailed Node Listing ---
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
85
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
86 Getting Started (Tutorial)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
87
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
88 * Lesson I -- Development Cycle::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
89 * Lesson II -- Customization::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
90 * Lesson III -- User Catalog::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
91
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
92 The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
93
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
94 * Code Formatting:: Making code look nice
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
95 * Routine Info:: Calling Sequence and Keyword List
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
96 * Online Help:: One key press from source to help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
97 * Completion:: Completing routine names and Keywords
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
98 * Routine Source:: Finding routines, the easy way
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
99 * Resolving Routines:: Force the Shell to compile a routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
100 * Code Templates:: Frequent code constructs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
101 * Abbreviations:: Abbreviations for common commands
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
102 * Actions:: Changing case, Padding, End checking
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
103 * Doc Header:: Inserting a standard header
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
104 * Motion Commands:: Moving through the structure of a program
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
105 * Misc Options:: Things that fit nowhere else
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
106
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
107 Code Formatting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
108
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
109 * Code Indentation:: Reflecting the logical structure
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
110 * Continued Statement Indentation::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
111 * Comment Indentation:: Special indentation for comment lines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
112 * Continuation Lines:: Splitting statements over lines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
113 * Syntax Highlighting:: Font-lock support
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
114 * Octals and Highlighting:: Why "123 causes problems
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
115
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
116 Online Help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
117
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
118 * Help with HTML Documentation::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
119 * Help with Source::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
120
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
121 Completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
122
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
123 * Case of Completed Words:: CaseOFcomPletedWords
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
124 * Object Method Completion and Class Ambiguity:: obj->Method, what?
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
125 * Object Method Completion in the Shell::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
126 * Class and Keyword Inheritance:: obj->Method, _EXTRA=e
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
127 * Structure Tag Completion:: Completing state.Tag
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
128
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
129 Actions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
130
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
131 * Block Boundary Check:: Is the END statement correct?
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
132 * Padding Operators:: Enforcing space around `=' etc
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
133 * Case Changes:: Enforcing upper case keywords
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
134
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
135 The IDLWAVE Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
136
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
137 * Starting the Shell:: How to launch IDL as a subprocess
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
138 * Using the Shell:: Interactively working with the Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
139 * Commands Sent to the Shell::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
140 * Debugging IDL Programs::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
141 * Examining Variables::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
142 * Custom Expression Examination::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
143
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
144 Debugging IDL Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
145
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
146 * A Tale of Two Modes::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
147 * Debug Key Bindings::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
148 * Breakpoints and Stepping::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
149 * Compiling Programs::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
150 * Walking the Calling Stack::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
151 * Electric Debug Mode::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
152
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
153 Sources of Routine Info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
154
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
155 * Routine Definitions:: Where IDL Routines are defined.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
156 * Routine Information Sources:: So how does IDLWAVE know about...
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
157 * Catalogs::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
158 * Load-Path Shadows:: Routines defined in several places
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
159 * Documentation Scan:: Scanning the IDL Manuals
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
160
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
161 Catalogs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
162
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
163 * Library Catalogs::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
164 * User Catalog::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
165
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
166 @end detailmenu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
167 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
168
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
169 @node Introduction, IDLWAVE in a Nutshell, Top, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
170 @chapter Introduction
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
171 @cindex Introduction
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
172 @cindex CORBA (Common Object Request Broker Architecture)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
173 @cindex Interface Definition Language
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
174 @cindex Interactive Data Language
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
175 @cindex cc-mode.el
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
176 @cindex @file{idl.el}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
177 @cindex @file{idl-shell.el}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
178 @cindex Feature overview
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
179
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
180 IDLWAVE is a package which supports editing source files written in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
181 the Interactive Data Language (IDL), and running IDL as an inferior shell@footnote{IDLWAVE can also be used
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
182 for editing source files for the related WAVE/CL language, but with only
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
183 limited support.}. It is a feature-rich replacement for the IDLDE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
184 development environment included with IDL, and uses the full power of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
185 Emacs to make editing and running IDL programs easier, quicker, and more
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
186 structured.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
187
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
188 IDLWAVE consists of two main parts: a major mode for editing IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
189 source files (@code{idlwave-mode}) and a mode for running the IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
190 program as an inferior shell (@code{idlwave-shell-mode}). Although
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
191 one mode can be used without the other, both work together closely to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
192 form a complete development environment. Here is a brief summary of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
193 what IDLWAVE does:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
194
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
195 @itemize @bullet
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
196 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
197 Smart code indentation and automatic-formatting.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
198 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
199 Three level syntax highlighting support.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
200 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
201 Context-sensitive display of calling sequences and keywords for more
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
202 than 1000 native IDL routines, extendible to any additional number of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
203 local routines, and already available with many pre-scanned libraries.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
204 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
205 Fast, context-sensitive online HTML help, or source-header help for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
206 undocumented routines.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
207 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
208 Context sensitive completion of routine names, keywords, system
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
209 variables, class names and much more.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
210 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
211 Easy insertion of code templates and abbreviations of common constructs.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
212 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
213 Automatic corrections to enforce a variety of customizable coding
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
214 standards.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
215 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
216 Integrity checks and auto-termination of logical blocks.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
217 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
218 Routine name space conflict search with likelihood-of-use ranking.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
219 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
220 Support for @file{imenu} (Emacs) and @file{func-menu} (XEmacs).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
221 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
222 Documentation support.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
223 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
224 Running IDL as an inferior Shell with history search, command line
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
225 editing and all the completion and routine info capabilities present in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
226 IDL source buffers.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
227 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
228 Full handling of debugging with breakpoints, with interactive setting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
229 of break conditions, and easy stepping through code.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
230 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
231 Compilation, execution and interactive single-keystroke debugging of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
232 programs directly from the source buffer.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
233 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
234 Quick, source-guided navigation of the calling stack, with variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
235 inspection, etc.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
236 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
237 Examining variables and expressions with a mouse click.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
238 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
239 And much, much more...
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
240 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
241
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
242 @ifnottex
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
243 @cindex Screenshots
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
244 Here are a number of screenshots showing IDLWAVE in action:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
245
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
246 @itemize @bullet
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
247 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
248 @uref{http://idlwave.org/screenshots/emacs_21_nav.gif,An IDLWAVE buffer}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
249 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
250 @uref{http://idlwave.org/screenshots/emacs_21_keys.gif,A keyword being completed}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
251 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
252 @uref{http://idlwave.org/screenshots/emacs_21_help.gif,Online help text.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
253 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
254 @uref{http://idlwave.org/screenshots/emacs_21_ri.gif,Routine information displayed}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
255 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
256 @uref{http://idlwave.org/screenshots/emacs_21_bp.gif,Debugging code
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
257 stopped at a breakpoint}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
258 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
259 @end ifnottex
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
260
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
261 IDLWAVE is the distant successor to the @file{idl.el} and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
262 @file{idl-shell.el} files written by Chris Chase. The modes and files
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
263 had to be renamed because of a name space conflict with CORBA's
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
264 @code{idl-mode}, defined in Emacs in the file @file{cc-mode.el}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
265
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
266 In this manual, each section ends with a list of related user options.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
267 Don't be confused by the sheer number of options available --- in most
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
268 cases the default settings are just fine. The variables are listed here
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
269 to make sure you know where to look if you want to change anything. For
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
270 a full description of what a particular variable does and how to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
271 configure it, see the documentation string of that variable (available
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
272 with @kbd{C-h v}). Some configuration examples are also given in the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
273 appendix.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
274
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
275 @node IDLWAVE in a Nutshell, Getting Started, Introduction, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
276 @chapter IDLWAVE in a Nutshell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
277 @cindex Summary of important commands
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
278 @cindex IDLWAVE in a Nutshell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
279 @cindex Nutshell, IDLWAVE in a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
280
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
281 @subheading Editing IDL Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
282
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
283 @multitable @columnfractions .15 .85
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
284 @item @key{TAB}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
285 @tab Indent the current line relative to context.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
286 @item @kbd{C-M-\}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
287 @tab Re-indent all lines in the current region.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
288 @item @kbd{C-M-q}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
289 @tab Re-indent all lines in the current routine.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
290 @item @kbd{C-u @key{TAB}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
291 @tab Re-indent all lines in the current statement.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
292 @item @kbd{M-@key{RET}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
293 @tab Start a continuation line, splitting the current line at point.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
294 @item @kbd{M-;}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
295 @tab Start new comment at line beginning or after code, or (un)comment
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
296 highlighted region.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
297 @item @kbd{M-q}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
298 @tab Fill the current comment paragraph.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
299 @item @kbd{C-c ?}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
300 @tab Display calling sequence and keywords for the procedure or function call
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
301 at point.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
302 @item @kbd{M-?}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
303 @tab Load context sensitive online help for nearby routine, keyword, etc.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
304 @item @kbd{M-@key{TAB}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
305 @tab Complete a procedure name, function name or keyword in the buffer.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
306 @item @kbd{C-c C-i}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
307 @tab Update IDLWAVE's knowledge about functions and procedures.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
308 @item @kbd{C-c C-v}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
309 @tab Visit the source code of a procedure/function.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
310 @item @kbd{C-u C-c C-v}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
311 @tab Visit the source code of a procedure/function in this buffer.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
312 @item @kbd{C-c C-h}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
313 @tab Insert a standard documentation header.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
314 @item @kbd{C-c @key{RET}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
315 @tab Insert a new timestamp and history item in the documentation header.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
316 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
317
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
318 @subheading Running the IDLWAVE Shell, Debugging Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
319
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
320 @multitable @columnfractions .15 .85
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
321 @item @kbd{C-c C-s}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
322 @tab Start IDL as a subprocess and/or switch to the shell buffer.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
323 @item @key{Up}, @kbd{M-p}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
324 @tab Cycle back through IDL command history.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
325 @item @key{Down},@kbd{M-n}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
326 @tab Cycle forward.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
327 @item @kbd{@key{TAB}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
328 @tab Complete a procedure name, function name or keyword in the shell buffer.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
329 @item @kbd{C-c C-d C-c}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
330 @tab Save and compile the source file in the current buffer.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
331 @item @kbd{C-c C-d C-e}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
332 @tab Compile and run the current region.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
333 @item @kbd{C-c C-d C-x}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
334 @tab Go to next syntax error.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
335 @item @kbd{C-c C-d C-v}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
336 @tab Switch to electric debug mode.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
337 @item @kbd{C-c C-d C-b}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
338 @tab Set a breakpoint at the nearest viable source line.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
339 @item @kbd{C-c C-d C-d}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
340 @tab Clear the nearest breakpoint.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
341 @item @kbd{C-c C-d [}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
342 @tab Go to the previous breakpoint.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
343 @item @kbd{C-c C-d ]}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
344 @tab Go to the next breakpoint.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
345 @item @kbd{C-c C-d C-p}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
346 @tab Print the value of the expression near point in IDL.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
347 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
348
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
349 @subheading Commonly used Settings in @file{.emacs}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
350 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
351 ;; Change the indentation preferences
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
352 ;; Start autoloading routine info after 2 idle seconds
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
353 (setq idlwave-init-rinfo-when-idle-after 2)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
354 ;; Pad operators with spaces
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
355 (setq idlwave-do-actions t
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
356 idlwave-surround-by-blank t)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
357 ;; Syntax Highlighting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
358 (add-hook 'idlwave-mode-hook 'turn-on-font-lock)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
359 ;; Automatically start the shell when needed
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
360 (setq idlwave-shell-automatic-start t)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
361 ;; Bind debugging commands with CONTROL and SHIFT modifiers
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
362 (setq idlwave-shell-debug-modifiers '(control shift))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
363 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
364
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
365 @html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
366 <A NAME="TUTORIAL"></A>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
367 @end html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
368
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
369 @node Getting Started, The IDLWAVE Major Mode, IDLWAVE in a Nutshell, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
370 @chapter Getting Started (Tutorial)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
371 @cindex Quick-Start
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
372 @cindex Tutorial
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
373 @cindex Getting Started
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
374
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
375 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
376 * Lesson I -- Development Cycle::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
377 * Lesson II -- Customization::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
378 * Lesson III -- User Catalog::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
379 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
380
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
381 @node Lesson I -- Development Cycle, Lesson II -- Customization, Getting Started, Getting Started
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
382 @section Lesson I: Development Cycle
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
383
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
384 The purpose of this tutorial is to guide you through a very basic
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
385 development cycle using IDLWAVE. We will paste a simple program into
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
386 a buffer and use the shell to compile, debug and run it. On the way
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
387 we will use many of the important IDLWAVE commands. Note, however,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
388 that IDLWAVE has many more capabilities than covered here, which can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
389 be discovered by reading the entire manual, or hovering over the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
390 shoulder of your nearest IDLWAVE guru for a few days.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
391
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
392 It is assumed that you have access to Emacs or XEmacs with the full
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
393 IDLWAVE package including online help. We also assume that you are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
394 familiar with Emacs and can read the nomenclature of key presses in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
395 Emacs (in particular, @kbd{C} stands for @key{CONTROL} and @kbd{M} for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
396 @key{META} (often the @key{ALT} key carries this functionality)).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
397
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
398 Open a new source file by typing:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
399
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
400 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
401 @kbd{C-x C-f tutorial.pro @key{RET}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
402 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
403
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
404 A buffer for this file will pop up, and it should be in IDLWAVE mode,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
405 indicated in the mode line just below the editing window. Also, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
406 menu bar should contain @samp{IDLWAVE}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
407
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
408 Now cut-and-paste the following code, also available as
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
409 @file{tutorial.pro} in the IDLWAVE distribution.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
410
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
411 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
412 function daynr,d,m,y
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
413 ;; compute a sequence number for a date
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
414 ;; works 1901-2099.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
415 if y lt 100 then y = y+1900
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
416 if m le 2 then delta = 1 else delta = 0
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
417 m1 = m + delta*12 + 1
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
418 y1 = y * delta
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
419 return, d + floor(m1*30.6)+floor(y1*365.25)+5
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
420 end
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
421
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
422 function weekday,day,month,year
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
423 ;; compute weekday number for date
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
424 nr = daynr(day,month,year)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
425 return, nr mod 7
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
426 end
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
427
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
428 pro plot_wday,day,month
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
429 ;; Plot the weekday of a date in the first 10 years of this century.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
430 years = 2000,+indgen(10)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
431 wdays = intarr(10)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
432 for i=0,n_elements(wdays)-1 do begin
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
433 wdays[i] = weekday(day,month,years[i])
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
434 end
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
435 plot,years,wdays,YS=2,YT="Wday (0=Sunday)"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
436 end
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
437 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
438
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
439 The indentation probably looks funny, since it's different from the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
440 settings you use, so use the @key{TAB} key in each line to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
441 automatically line it up (or, more quickly, @emph{select} the entire
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
442 buffer with @kbd{C-x h}, and indent the whole region with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
443 @kbd{C-M-\}). Notice how different syntactical elements are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
444 highlighted in different colors, if you have set up support for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
445 font-lock.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
446
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
447 Let's check out two particular editing features of IDLWAVE. Place the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
448 cursor after the @code{end} statement of the @code{for} loop and press
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
449 @key{SPC}. IDLWAVE blinks back to the beginning of the block and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
450 changes the generic @code{end} to the specific @code{endfor}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
451 automatically (as long as the variable @code{idlwave-expand-generic-end}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
452 is turned on --- @pxref{Lesson II -- Customization}). Now place the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
453 cursor in any line you would like to split and press @kbd{M-@key{RET}}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
454 The line is split at the cursor position, with the continuation @samp{$}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
455 and indentation all taken care of. Use @kbd{C-/} to undo the last
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
456 change.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
457
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
458 The procedure @code{plot_wday} is supposed to plot the day of the week
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
459 of a given date for the first 10 years of the 21st century. As in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
460 most code, there are a few bugs, which we are going to use IDLWAVE to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
461 help us fix.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
462
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
463 First, let's launch the IDLWAVE shell. You do this with the command
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
464 @kbd{C-c C-s}. The Emacs window will split or another window will popup
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
465 to display IDL running in a shell interaction buffer. Type a few
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
466 commands like @code{print,!PI} to convince yourself that you can work
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
467 there just as well as in a terminal, or the IDLDE. Use the arrow keys
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
468 to cycle through your command history. Are we having fun now?
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
469
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
470 Now go back to the source window and type @kbd{C-c C-d C-c} to compile
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
471 the program. If you watch the shell buffer, you see that IDLWAVE types
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
472 @samp{.run "tutorial.pro"} for you. But the compilation fails because
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
473 there is a comma in the line @samp{years=...}. The line with the error
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
474 is highlighted and the cursor positioned at the error, so remove the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
475 comma (you should only need to hit @kbd{Delete}!). Compile again, using
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
476 the same keystrokes as before. Notice that the file is automatically
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
477 saved for you. This time everything should work fine, and you should
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
478 see the three routines compile.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
479
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
480 Now we want to use the command to plot the day of the week on January
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
481 1st. We could type the full command ourselves, but why do that? Go
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
482 back to the shell window, type @samp{plot_} and hit @key{TAB}. After
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
483 a bit of a delay (while IDLWAVE initializes its routine info database,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
484 if necessary), the window will split to show all procedures it knows
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
485 starting with that string, and @w{@code{plot_wday}} should be one of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
486 them. Saving the buffer alerted IDLWAVE about this new routine.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
487 Click with the middle mouse button on @code{plot_wday} and it will be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
488 copied to the shell buffer, or if you prefer, add @samp{w} to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
489 @samp{plot_} to make it unambiguous (depending on what other routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
490 starting with @samp{plot_} you have installed on your system), hit
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
491 @key{TAB} again, and the full routine name will be completed. Now
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
492 provide the two arguments:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
493
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
494 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
495 plot_wday,1,1
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
496 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
497
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
498 @noindent and press @key{RET}. This fails with an error message telling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
499 you the @code{YT} keyword to plot is ambiguous. What are the allowed
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
500 keywords again? Go back to the source window and put the cursor into
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
501 the `plot' line and press @kbd{C-c ?}. This shows the routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
502 window for the plot routine, which contains a list of keywords, along
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
503 with the argument list. Oh, we wanted @code{YTITLE}. Fix that up.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
504 Recompile with @kbd{C-c C-d C-c}. Jump back into the shell with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
505 @kbd{C-c C-s}, press the @key{UP} arrow to recall the previous command
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
506 and execute again.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
507
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
508 This time we get a plot, but it is pretty ugly --- the points are all
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
509 connected with a line. Hmm, isn't there a way for @code{plot} to use
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
510 symbols instead? What was that keyword? Position the cursor on the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
511 plot line after a comma (where you'd normally type a keyword), and hit
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
512 @kbd{M-@key{Tab}}. A long list of plot's keywords appears. Aha,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
513 there it is, @code{PSYM}. Middle click to insert it. An @samp{=}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
514 sign is included for you too. Now what were the values of @code{PSYM}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
515 supposed to be? With the cursor on or after the keyword, press
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
516 @kbd{M-?} for online help (alternatively, you could have right clicked
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
517 on the colored keyword itself in the completion list). A browser will
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
518 pop up showing the HTML documentation for the @code{PYSM} keyword.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
519 OK, let's use diamonds=4. Fix this, recompile (you know the command
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
520 by now: @kbd{C-c C-d C-c}), go back to the shell (if it's vanished,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
521 you know what to do: @kbd{C-c C-s}) and execute again. Now things
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
522 look pretty good.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
523
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
524 Let's try a different day --- how about April fool's day?
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
525
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
526 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
527 plot_wday,1,4
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
528 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
529
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
530 Oops, this looks very wrong. All April Fool's days cannot be Fridays!
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
531 We've got a bug in the program, perhaps in the @code{daynr} function.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
532 Let's put a breakpoint on the last line there. Position the cursor on
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
533 the @samp{return, d+...} line and press @kbd{C-c C-d C-b}. IDL sets a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
534 breakpoint (as you see in the shell window), and the break line is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
535 indicated. Back to the shell buffer, re-execute the previous command.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
536 IDL stops at the line with the breakpoint. Now hold down the SHIFT
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
537 key and click with the middle mouse button on a few variables there:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
538 @samp{d}, @samp{y}, @samp{m}, @samp{y1}, etc. Maybe @code{d} isn't
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
539 the correct type. CONTROL-SHIFT middle-click on it for help. Well,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
540 it's an integer, so that's not the problem. Aha, @samp{y1} is zero,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
541 but it should be the year, depending on delta. Shift click
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
542 @samp{delta} to see that it's 0. Below, we see the offending line:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
543 @samp{y1=y*delta...} the multiplication should have been a minus sign!
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
544 Hit @kbd{q} to exit the debugging mode, and fix the line to read:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
545
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
546 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
547 y1 = y - delta
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
548 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
549
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
550 Now remove all breakpoints: @kbd{C-c C-d C-a}. Recompile and rerun the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
551 command. Everything should now work fine. How about those leap years?
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
552 Change the code to plot 100 years and see that every 28 years, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
553 sequence of weekdays repeats.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
554
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
555 @node Lesson II -- Customization, Lesson III -- User Catalog, Lesson I -- Development Cycle, Getting Started
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
556 @section Lesson II: Customization
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
557
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
558 Emacs is probably the most customizable piece of software ever written,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
559 and it would be a shame if you did not make use of this to adapt IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
560 to your own preferences. Customizing Emacs or IDLWAVE is accomplished
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
561 by setting Lisp variables in the @file{.emacs} file in your home
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
562 directory --- but do not be dismayed; for the most part, you can just
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
563 copy and work from the examples given here.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
564
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
565 Let's first use a boolean variable. These are variables which you turn
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
566 on or off, much like a checkbox. A value of @samp{t} means on, a value
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
567 of @samp{nil} means off. Copy the following line into your
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
568 @file{.emacs} file, exit and restart Emacs.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
569
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
570 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
571 (setq idlwave-reserved-word-upcase t)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
572 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
573
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
574 When this option is turned on, each reserved word you type into an IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
575 source buffer will be converted to upper case when you press @key{SPC}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
576 or @key{RET} right after the word. Try it out! @samp{if} changes to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
577 @samp{IF}, @samp{begin} to @samp{BEGIN}. If you don't like this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
578 behavior, remove the option again from your @file{.emacs} file and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
579 restart Emacs.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
580
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
581 You likely have your own indentation preferences for IDL code. For
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
582 example, some may prefer to indent the main block of an IDL program
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
583 slightly from the margin and use only 3 spaces as indentation between
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
584 @code{BEGIN} and @code{END}. Try the following lines in @file{.emacs}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
585
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
586 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
587 (setq idlwave-main-block-indent 1)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
588 (setq idlwave-block-indent 3)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
589 (setq idlwave-end-offset -3)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
590 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
591
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
592 Restart Emacs, and re-indent the program we developed in the first part
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
593 of this tutorial with @kbd{C-c h} and @kbd{C-M-\}. You may want to keep
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
594 these lines in @file{.emacs}, with values adjusted to your likings. If
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
595 you want to get more information about any of these variables, type,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
596 e.g., @kbd{C-h v idlwave-main-block-indent @key{RET}}. To find which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
597 variables can be customized, look for items marked @samp{User Option:}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
598 throughout this manual.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
599
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
600 If you cannot seem to master this Lisp customization in @file{.emacs},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
601 there is another, more user-friendly way to customize all the IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
602 variables. You can access it through the IDLWAVE menu in one of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
603 @file{.pro} buffers, menu item @code{Customize->Browse IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
604 Group}. Here you'll be presented with all the various variables grouped
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
605 into categories. You can navigate the hierarchy (e.g. @samp{IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
606 Code Formatting->Idlwave Abbrev And Indent Action->Idlwave Expand
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
607 Generic End} to turn on @code{END} expansion), read about the variables,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
608 change them, and `Save for Future Sessions'. Few of these variables
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
609 need customization, but you can exercise considerable control over
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
610 IDLWAVE's functionality with them.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
611
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
612 You may also find the key bindings used for the debugging commands too
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
613 long and complicated. Often we have heard complaints along the lines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
614 of, ``Do I really have to go through the finger gymnastics of @kbd{C-c
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
615 C-d C-c} to run a simple command?'' Due to Emacs rules and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
616 conventions, shorter bindings cannot be set by default, but you can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
617 easily enable them. First, there is a way to assign all debugging
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
618 commands in a single sweep to another simpler combination. The only
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
619 problem is that we have to use something which Emacs does not need for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
620 other important commands. One good option is to execute debugging
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
621 commands by holding down @key{CONTROL} and @key{SHIFT} while pressing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
622 a single character: @kbd{C-S-b} for setting a breakpoint, @kbd{C-S-c}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
623 for compiling the current source file, @kbd{C-S-a} for deleting all
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
624 breakpoints (try it, it's easier). You can enable this with:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
625
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
626 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
627 (setq idlwave-shell-debug-modifiers '(shift control))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
628 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
629
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
630 @noindent If you have a special keyboard with, for example, a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
631 @key{SUPER} key, you could even shorten that:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
632
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
633 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
634 (setq idlwave-shell-debug-modifiers '(super))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
635 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
636
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
637 @noindent to get compilation on @kbd{S-c}. Often, a modifier key like
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
638 @key{SUPER} or @key{HYPER} is bound or can be bound to an otherwise
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
639 unused key on your keyboard --- consult your system documentation.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
640
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
641 You can also assign specific commands to keys. This you must do in the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
642 @emph{mode-hook}, a special function which is run when a new IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
643 buffer gets set up. The possibilities for key customization are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
644 endless. Here we set function keys f4-f8 to common debugging commands.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
645
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
646 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
647 ;; First for the source buffer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
648 (add-hook 'idlwave-mode-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
649 (lambda ()
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
650 (local-set-key [f4] 'idlwave-shell-retall)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
651 (local-set-key [f5] 'idlwave-shell-break-here)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
652 (local-set-key [f6] 'idlwave-shell-clear-current-bp)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
653 (local-set-key [f7] 'idlwave-shell-cont)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
654 (local-set-key [f8] 'idlwave-shell-clear-all-bp)))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
655 ;; Then for the shell buffer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
656 (add-hook 'idlwave-shell-mode-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
657 (lambda ()
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
658 (local-set-key [f4] 'idlwave-shell-retall)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
659 (local-set-key [f5] 'idlwave-shell-break-here)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
660 (local-set-key [f6] 'idlwave-shell-clear-current-bp)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
661 (local-set-key [f7] 'idlwave-shell-cont)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
662 (local-set-key [f8] 'idlwave-shell-clear-all-bp)))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
663 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
664
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
665 @node Lesson III -- User Catalog, , Lesson II -- Customization, Getting Started
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
666 @section Lesson III: User and Library Catalogs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
667
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
668 We have already used the routine info display in the first part of this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
669 tutorial. This was the invoked using @kbd{C-c ?}, and displays
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
670 information about the IDL routine near the cursor position. Wouldn't it
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
671 be nice to have the same kind of information available for your own
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
672 routines and for the huge amount of code in major libraries like JHUPL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
673 or the IDL-Astro library? In many cases, you may already have this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
674 information. Files named @file{.idlwave_catalog} in library directories
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
675 contain scanned information on the routines in that directory; many
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
676 popular libraries ship with these ``library catalogs'' pre-scanned.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
677 Users can scan their own routines in one of two ways: either using the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
678 supplied tool to scan directories and build their own
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
679 @file{.idlwave_catalog} files, or using the built-in method to create a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
680 single ``user catalog'', which we'll show here. @xref{Catalogs}, for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
681 more information on choosing which method to use.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
682
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
683 To build a user catalog, select @code{Routine Info/Select Catalog
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
684 Directories} from the IDLWAVE entry in the menu bar. If necessary,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
685 start the shell first with @kbd{C-c C-s} (@pxref{Starting the Shell}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
686 IDLWAVE will find out about the IDL @code{!PATH} variable and offer a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
687 list of directories on the path. Simply select them all (or whichever
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
688 you want --- directories with existing library catalogs will not be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
689 selected by default) and click on the @samp{Scan&Save} button. Then
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
690 go for a cup of coffee while IDLWAVE collects information for each and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
691 every IDL routine on your search path. All this information is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
692 written to the file @file{.idlwave/idlusercat.el} in your home
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
693 directory and will from now on automatically load whenever you use
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
694 IDLWAVE. You may find it necessary to rebuild the catalog on occasion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
695 as your local libraries change, or build a library catalog for those
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
696 directories instead. Invoke routine info (@kbd{C-c ?}) or completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
697 (@kbd{M-@key{TAB}}) on any routine or partial routine name you know to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
698 be located in the library. E.g., if you have scanned the IDL-Astro
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
699 library:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
700
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
701 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
702 a=readf@key{M-@key{TAB}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
703 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
704
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
705 expands to `readfits('. Then try
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
706
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
707 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
708 a=readfits(@key{C-c ?}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
709 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
710
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
711 and you get:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
712
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
713 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
714 Usage: Result = READFITS(filename, header, heap)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
715 ...
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
716 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
717
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
718 I hope you made it until here. Now you are set to work with IDLWAVE.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
719 On the way you will want to change other things, and to learn more
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
720 about the possibilities not discussed in this short tutorial. Read
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
721 the manual, look at the documentation strings of interesting variables
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
722 (with @kbd{C-h v idlwave<-variable-name> @key{RET}}) and ask the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
723 remaining questions on the newsgroup @code{comp.lang.idl-pvwave}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
724
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
725 @node The IDLWAVE Major Mode, The IDLWAVE Shell, Getting Started, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
726 @chapter The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
727 @cindex IDLWAVE major mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
728 @cindex Major mode, @code{idlwave-mode}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
729
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
730 The IDLWAVE major mode supports editing IDL source files. In this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
731 chapter we describe the main features of the mode and how to customize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
732 them.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
733
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
734 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
735 * Code Formatting:: Making code look nice
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
736 * Routine Info:: Calling Sequence and Keyword List
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
737 * Online Help:: One key press from source to help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
738 * Completion:: Completing routine names and Keywords
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
739 * Routine Source:: Finding routines, the easy way
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
740 * Resolving Routines:: Force the Shell to compile a routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
741 * Code Templates:: Frequent code constructs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
742 * Abbreviations:: Abbreviations for common commands
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
743 * Actions:: Changing case, Padding, End checking
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
744 * Doc Header:: Inserting a standard header
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
745 * Motion Commands:: Moving through the structure of a program
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
746 * Misc Options:: Things that fit nowhere else
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
747 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
748
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
749 @node Code Formatting, Routine Info, The IDLWAVE Major Mode, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
750 @section Code Formatting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
751 @cindex Code formatting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
752 @cindex Formatting, of code
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
753
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
754 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
755 * Code Indentation:: Reflecting the logical structure
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
756 * Continued Statement Indentation::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
757 * Comment Indentation:: Special indentation for comment lines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
758 * Continuation Lines:: Splitting statements over lines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
759 * Syntax Highlighting:: Font-lock support
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
760 * Octals and Highlighting:: Why "123 causes problems
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
761 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
762
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
763 The IDL language, with its early roots in FORTRAN, modern
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
764 implementation in C, and liberal borrowing of features of many vector
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
765 and other languages along its 25+ year history, has inherited an
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
766 unusual mix of syntax elements. Left to his or her own devices, a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
767 novice IDL programmer will often conjure code which is very difficult
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
768 to read and impossible to adapt. Much can be gleaned from studying
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
769 available IDL code libraries for coding style pointers, but, due to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
770 the variety of IDL syntax elements, replicating this style can be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
771 challenging at best. Luckily, IDLWAVE understands the structure of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
772 IDL code very well, and takes care of almost all formatting issues for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
773 you. After configuring it to match your coding standards, you can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
774 rely on it to help keep your code neat and organized.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
775
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
776
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
777 @node Code Indentation, Continued Statement Indentation, Code Formatting, Code Formatting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
778 @subsection Code Indentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
779 @cindex Code indentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
780 @cindex Indentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
781
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
782 Like all Emacs programming modes, IDLWAVE performs code indentation.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
783 The @key{TAB} key indents the current line relative to context.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
784 @key{LFD} insert a newline and indents the new line. The indentation is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
785 governed by a number of variables. IDLWAVE indents blocks (between
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
786 @code{PRO}/@code{FUNCTION}/@code{BEGIN} and @code{END}), and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
787 continuation lines.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
788
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
789 @cindex Foreign code, adapting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
790 @cindex Indentation, of foreign code
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
791 @kindex C-M-\
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
792 To re-indent a larger portion of code (e.g. when working with foreign
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
793 code written with different conventions), use @kbd{C-M-\}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
794 (@code{indent-region}) after marking the relevant code. Useful marking
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
795 commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
796 subprogram). The command @kbd{C-M-q} reindents the entire current
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
797 routine. @xref{Actions}, for information how to impose additional
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
798 formatting conventions on foreign code.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
799
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
800 @defopt idlwave-main-block-indent (@code{2})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
801 Extra indentation for the main block of code. That is the block between
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
802 the FUNCTION/PRO statement and the END statement for that program
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
803 unit.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
804 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
805
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
806 @defopt idlwave-block-indent (@code{3})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
807 Extra indentation applied to block lines. If you change this, you
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
808 probably also want to change @code{idlwave-end-offset}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
809 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
810
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
811 @defopt idlwave-end-offset (@code{-3})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
812 Extra indentation applied to block END lines. A value equal to negative
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
813 @code{idlwave-block-indent} will make END lines line up with the block
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
814 BEGIN lines.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
815 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
816
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
817 @node Continued Statement Indentation, Comment Indentation, Code Indentation, Code Formatting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
818 @subsection Continued Statement Indentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
819 @cindex Indentation, continued statement
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
820 @cindex Continued statement indentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
821 Continuation lines (following a line ending with @code{$}) can receive a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
822 fixed indentation offset from the main level, but in several situations
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
823 IDLWAVE can use a special form of indentation which aligns continued
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
824 statements more naturally. Special indentation is calculated for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
825 continued routine definition statements and calls, enclosing parentheses
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
826 (like function calls, structure/class definitions, explicit structures
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
827 or lists, etc.), and continued assignments. An attempt is made to line
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
828 up with the first non-whitespace character after the relevant opening
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
829 punctuation mark (@code{,},@code{(},@code{@{},@code{[},@code{=}). For
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
830 lines without any non-comment characters on the line with the opening
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
831 punctuation, the continued line(s) are aligned just past the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
832 punctuation. An example:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
833
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
834 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
835 function foo, a, b, $
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
836 c, d
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
837 bar = sin( a + b + $
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
838 c + d)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
839 end
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
840 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
841 @noindent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
842
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
843 The only drawback to this special continued statement indentation is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
844 that it consumes more space, e.g., for long function names or left hand
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
845 sides of an assignment:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
846
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
847 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
848 function thisfunctionnameisverylongsoitwillleavelittleroom, a, b, $
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
849 c, d
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
850 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
851
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
852 You can instruct IDLWAVE when to avoid using this special continuation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
853 indentation by setting the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
854 @code{idlwave-max-extra-continuation-indent}, which specifies the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
855 maximum additional indentation beyond the basic indent to be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
856 tolerated, otherwise defaulting to a fixed-offset from the enclosing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
857 indent (the size of which offset is set in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
858 @code{idlwave-continuation-indent}). As a special case, continuations
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
859 of routine calls without any arguments or keywords will @emph{not}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
860 align the continued line, under the assumption that you continued
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
861 because you needed the space.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
862
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
863 Also, since the indentation level can be somewhat dynamic in continued
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
864 statements with special continuation indentation, especially if
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
865 @code{idlwave-max-extra-continuation-indent} is small, the key
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
866 @kbd{C-u @key{TAB}} will re-indent all lines in the current statement.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
867 Note that @code{idlwave-indent-to-open-paren}, if non-@code{nil},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
868 overrides the @code{idlwave-max-extra-continuation-indent} limit, for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
869 parentheses only, forcing them always to line up.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
870
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
871
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
872 @defopt idlwave-continuation-indent (@code{2})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
873 Extra indentation applied to normal continuation lines.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
874 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
875
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
876 @defopt idlwave-max-extra-continuation-indent (@code{20})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
877 The maximum additional indentation (over the basic continuation-indent)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
878 that will be permitted for special continues. To effectively disable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
879 special continuation indentation, set to @code{0}. To enable it
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
880 constantly, set to a large number (like @code{100}). Note that the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
881 indentation in a long continued statement never decreases from line to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
882 line, outside of nested parentheses statements.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
883 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
884
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
885 @defopt idlwave-indent-to-open-paren (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
886 Non-@code{nil} means indent continuation lines to innermost open
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
887 parenthesis, regardless of whether the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
888 @code{idlwave-max-extra-continuation-indent} limit is satisfied.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
889 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
890
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
891 @node Comment Indentation, Continuation Lines, Continued Statement Indentation, Code Formatting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
892 @subsection Comment Indentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
893 @cindex Comment indentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
894 @cindex Hanging paragraphs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
895 @cindex Paragraphs, filling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
896 @cindex Paragraphs, hanging
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
897
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
898 In IDL, lines starting with a @samp{;} are called @emph{comment lines}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
899 Comment lines are indented as follows:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
900
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
901 @multitable @columnfractions .1 .90
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
902 @item @code{;;;}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
903 @tab The indentation of lines starting with three semicolons remains
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
904 unchanged.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
905 @item @code{;;}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
906 @tab Lines starting with two semicolons are indented like the surrounding code.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
907 @item @code{;}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
908 @tab Lines starting with a single semicolon are indented to a minimum column.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
909 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
910
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
911 @noindent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
912 The indentation of comments starting in column 0 is never changed.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
913
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
914 @defopt idlwave-no-change-comment
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
915 The indentation of a comment starting with this regexp will not be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
916 changed.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
917 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
918
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
919 @defopt idlwave-begin-line-comment
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
920 A comment anchored at the beginning of line.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
921 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
922
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
923 @defopt idlwave-code-comment
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
924 A comment that starts with this regexp is indented as if it is a part of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
925 IDL code.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
926 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
927
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
928 @node Continuation Lines, Syntax Highlighting, Comment Indentation, Code Formatting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
929 @subsection Continuation Lines and Filling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
930 @cindex Continuation lines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
931 @cindex Line splitting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
932 @cindex String splitting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
933 @cindex Splitting, of lines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
934
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
935 @kindex M-@key{RET}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
936 In IDL, a newline character terminates a statement unless preceded by a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
937 @samp{$}. If you would like to start a continuation line, use
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
938 @kbd{M-@key{RET}}, which calls the command @code{idlwave-split-line}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
939 It inserts the continuation character @samp{$}, terminates the line and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
940 indents the new line. The command @kbd{M-@key{RET}} can also be invoked
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
941 inside a string to split it at that point, in which case the @samp{+}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
942 concatenation operator is used.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
943
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
944 @cindex Filling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
945 @cindex @code{auto-fill-mode}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
946 @cindex Hanging paragraphs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
947 When filling comment paragraphs, IDLWAVE overloads the normal filling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
948 functions and uses a function which creates the hanging paragraphs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
949 customary in IDL routine headers. When @code{auto-fill-mode} is turned
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
950 on (toggle with @kbd{C-c C-a}), comments will be auto-filled. If the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
951 first line of a paragraph contains a match for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
952 @code{idlwave-hang-indent-regexp} (a dash-space by default), subsequent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
953 lines are positioned to line up after it, as in the following example.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
954
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
955 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
956 @group
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
957 ;=================================
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
958 ; x - an array containing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
959 ; lots of interesting numbers.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
960 ;
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
961 ; y - another variable where
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
962 ; a hanging paragraph is used
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
963 ; to describe it.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
964 ;=================================
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
965 @end group
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
966 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
967
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
968 @kindex M-q
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
969 You can also refill a comment at any time paragraph with @kbd{M-q}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
970 Comment delimiting lines as in the above example, consisting of one or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
971 more @samp{;} followed by one or more of the characters @samp{+=-_*},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
972 are kept in place, as is.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
973
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
974 @defopt idlwave-fill-comment-line-only (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
975 Non-@code{nil} means auto fill will only operate on comment lines.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
976 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
977
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
978 @defopt idlwave-auto-fill-split-string (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
979 Non-@code{nil} means auto fill will split strings with the IDL @samp{+}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
980 operator.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
981 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
982
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
983 @defopt idlwave-split-line-string (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
984 Non-@code{nil} means @code{idlwave-split-line} will split strings with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
985 @samp{+}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
986 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
987
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
988 @defopt idlwave-hanging-indent (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
989 Non-@code{nil} means comment paragraphs are indented under the hanging
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
990 indent given by @code{idlwave-hang-indent-regexp} match in the first
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
991 line of the paragraph.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
992 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
993
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
994 @defopt idlwave-hang-indent-regexp (@code{"- "})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
995 Regular expression matching the position of the hanging indent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
996 in the first line of a comment paragraph.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
997 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
998
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
999 @defopt idlwave-use-last-hang-indent (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1000 Non-@code{nil} means use last match on line for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1001 @code{idlwave-indent-regexp}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1002 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1003
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1004 @node Syntax Highlighting, Octals and Highlighting, Continuation Lines, Code Formatting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1005 @subsection Syntax Highlighting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1006 @cindex Syntax highlighting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1007 @cindex Highlighting of syntax
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1008 @cindex Font lock
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1009
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1010 Highlighting of keywords, comments, strings etc. can be accomplished
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1011 with @code{font-lock}. If you are using @code{global-font-lock-mode}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1012 (in Emacs), or have @code{font-lock} turned on in any other buffer in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1013 XEmacs, it should also automatically work in IDLWAVE buffers. If you'd
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1014 prefer invoking font-lock individually by mode, you can enforce it in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1015 @code{idlwave-mode} with the following line in your @file{.emacs}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1016
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1017 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1018 (add-hook 'idlwave-mode-hook 'turn-on-font-lock)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1019 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1020
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1021 @noindent IDLWAVE supports 3 increasing levels of syntax highlighting.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1022 The variable @code{font-lock-maximum-decoration} determines which level
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1023 is selected. Individual categories of special tokens can be selected
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1024 for highlighting using the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1025 @code{idlwave-default-font-lock-items}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1026
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1027 @defopt idlwave-default-font-lock-items
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1028 Items which should be fontified on the default fontification level
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1029 2.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1030 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1031
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1032 @node Octals and Highlighting, , Syntax Highlighting, Code Formatting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1033 @subsection Octals and Highlighting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1034 @cindex Syntax highlighting, Octals
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1035 @cindex Highlighting of syntax, Octals
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1036
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1037 A rare syntax highlighting problem results from an extremely unfortunate
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1038 notation for octal numbers in IDL: @code{"123}. This unpaired quotation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1039 mark is very difficult to parse, given that it can be mixed on a single
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1040 line with any number of strings. Emacs will incorrectly identify this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1041 as a string, and the highlighting of following lines of code can be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1042 distorted, since the string is never terminated.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1043
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1044 One solution to this involves terminating the mistakenly identified
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1045 string yourself by providing a closing quotation mark in a comment:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1046
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1047 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1048 string("305B) + $ ;" <--- for font-lock
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1049 ' is an Angstrom.'
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1050 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1051
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1052 @noindent A far better solution is to abandon this notation for octals
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1053 altogether, and use the more sensible alternative IDL provides:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1054
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1055 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1056 string('305'OB) + ' is an Angstrom.'
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1057 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1058
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1059 @noindent This simultaneously solves the font-lock problem and is more
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1060 consistent with the notation for hexadecimal numbers, e.g. @code{'C5'XB}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1061
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1062 @node Routine Info, Online Help, Code Formatting, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1063 @section Routine Info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1064 @cindex Routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1065 @cindex Updating routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1066 @cindex Scanning buffers for routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1067 @cindex Buffers, scanning for routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1068 @cindex Shell, querying for routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1069
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1070 @kindex C-c C-i
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1071 IDL comes bundled with more than one thousand procedures, functions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1072 and object methods, and large libraries typically contain hundreds or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1073 even thousands more (each with a few to tens of keywords and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1074 arguments). This large command set can make it difficult to remember
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1075 the calling sequence and keywords for the routines you use, but
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1076 IDLWAVE can help. It builds up routine information from a wide
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1077 variety of sources; IDLWAVE in fact knows far more about the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1078 @samp{.pro} routines on your system than IDL itself! It maintains a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1079 list of all built-in routines, with calling sequences and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1080 keywords@footnote{This list is created by scanning the IDL manuals and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1081 might contain (very few) errors. Please report any errors to the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1082 maintainer, so that they can be fixed.}. It also scans Emacs buffers
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1083 for routine definitions, queries the IDLWAVE-Shell for information
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1084 about routines currently compiled there, and automatically locates
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1085 library and user-created catalogs. This information is updated
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1086 automatically, and so should usually be current. To force a global
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1087 update and refresh the routine information, use @kbd{C-c C-i}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1088 (@code{idlwave-update-routine-info}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1089
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1090 @kindex C-c ?
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1091 To display the information about a routine, press @kbd{C-c ?}, which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1092 calls the command @code{idlwave-routine-info}. When the current cursor
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1093 position is on the name or in the argument list of a procedure or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1094 function, information will be displayed about the routine. For example,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1095 consider the indicated cursor positions in the following line:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1096
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1097 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1098 plot,x,alog(x+5*sin(x) + 2),
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1099 | | | | | | | |
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1100 1 2 3 4 5 6 7 8
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1101 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1102
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1103 @cindex Default routine, for info and help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1104 On positions 1,2 and 8, information about the @samp{plot} procedure will
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1105 be shown. On positions 3,4, and 7, the @samp{alog} function will be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1106 described, while positions 5 and 6 will investigate the @samp{sin}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1107 function.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1108
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1109 When you ask for routine information about an object method, and the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1110 method exists in several classes, IDLWAVE queries for the class of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1111 object, unless the class is already known through a text property on the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1112 @samp{->} operator (@pxref{Object Method Completion and Class
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1113 Ambiguity}), or by having been explicitly included in the call
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1114 (e.g. @code{a->myclass::Foo}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1115
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1116 @cindex Calling sequences
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1117 @cindex Keywords of a routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1118 @cindex Routine source information
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1119 The description displayed contains the calling sequence, the list of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1120 keywords and the source location of this routine. It looks like this:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1121
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1122 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1123 Usage: XMANAGER, NAME, ID
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1124 Keywords: BACKGROUND CATCH CLEANUP EVENT_HANDLER GROUP_LEADER
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1125 JUST_REG MODAL NO_BLOCK
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1126 Source: SystemLib [LCSB] /soft1/idl53/lib/xmanager.pro
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1127 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1128
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1129 @cindex Categories, of routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1130 @cindex Load-path shadows
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1131 @cindex Shadows, load-path
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1132 @cindex IDL variable @code{!PATH}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1133 @cindex @code{!PATH}, IDL variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1134 @cindex IDL variable @code{!DIR}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1135 @cindex @code{!DIR}, IDL variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1136
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1137 If a definition of this routine exists in several files accessible to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1138 IDLWAVE, several @samp{Source} lines will point to the different
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1139 files. This may indicate that your routine is shadowing a system
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1140 library routine, which may or may not be what you want
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1141 (@pxref{Load-Path Shadows}). The information about the calling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1142 sequence and keywords is derived from the first source listed.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1143 Library routines are available only if you have scanned your local IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1144 directories or are using pre-scanned libraries (@pxref{Catalogs}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1145 The source entry consists of a @emph{source category}, a set of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1146 @emph{flags} and the path to the @emph{source file}. The following
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1147 default categories exist:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1148
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1149 @multitable @columnfractions .15 .85
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1150 @item @i{System}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1151 @tab A system routine of unknown origin. When the system library has
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1152 been scanned as part of a catalog (@pxref{Catalogs}), this category
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1153 will automatically split into the next two.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1154 @item @i{Builtin}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1155 @tab A builtin system routine with no source code available.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1156 @item @i{SystemLib}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1157 @tab A library system routine in the official lib directory @file{!DIR/lib}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1158 @item @i{Obsolete}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1159 @tab A library routine in the official lib directory @file{!DIR/lib/obsolete}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1160 @item @i{Library}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1161 @tab A routine in a file on IDL's search path @code{!PATH}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1162 @item @i{Other}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1163 @tab Any other routine with a file not known to be on the search path.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1164 @item @i{Unresolved}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1165 @tab An otherwise unknown routine the shell lists as unresolved
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1166 (referenced, but not compiled).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1167 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1168
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1169 Any routines discovered in library catalogs (@pxref{Library
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1170 Catalogs}), will display the category assigned during creation,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1171 e.g. @samp{NasaLib}. For routines not discovered in this way, you can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1172 create additional categories based on the routine's filename using the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1173 variable @code{idlwave-special-lib-alist}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1174
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1175 @cindex Flags, in routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1176 @cindex Duplicate routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1177 @cindex Multiply defined routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1178 @cindex Routine definitions, multiple
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1179 The flags @code{[LCSB]} indicate the source of the information IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1180 has regarding the file: from a library catalog (@w{@code{[L---]}}),
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1181 from a user catalog (@w{@code{[-C--]}}, from the IDL Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1182 (@w{@code{[--S-]}}) or from an Emacs buffer (@w{@code{[---B]}}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1183 Combinations are possible (a compiled library routine visited in a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1184 buffer might read @w{@code{[L-SB]}}). If a file contains multiple
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1185 definitions of the same routine, the file name will be prefixed with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1186 @samp{(Nx)} where @samp{N} is the number of definitions.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1187
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1188 @cindex Online Help from the routine info buffer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1189 @cindex Active text, in routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1190 @cindex Inserting keywords, from routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1191 @cindex Source file, access from routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1192 Some of the text in the @file{*Help*} routine info buffer will be active
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1193 (it is highlighted when the mouse moves over it). Typically, clicking
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1194 with the right mouse button invokes online help lookup, and clicking
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1195 with the middle mouse button inserts keywords or visits files:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1196
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1197 @multitable @columnfractions 0.15 0.85
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1198 @item @i{Usage}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1199 @tab If online help is installed, a click with the @emph{right} mouse
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1200 button on the @i{Usage:} line will access the help for the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1201 routine (@pxref{Online Help}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1202 @item @i{Keyword}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1203 @tab Online help about keywords is also available with the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1204 @emph{right} mouse button. Clicking on a keyword with the @emph{middle}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1205 mouse button will insert this keyword in the buffer from where
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1206 @code{idlwave-routine-info} was called. Holding down @key{SHIFT} while
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1207 clicking also adds the initial @samp{/}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1208 @item @i{Source}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1209 @tab Clicking with the @emph{middle} mouse button on a @samp{Source} line
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1210 finds the source file of the routine and visits it in another window.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1211 Another click on the same line switches back to the buffer from which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1212 @kbd{C-c ?} was called. If you use the @emph{right} mouse button, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1213 source will not be visited by a buffer, but displayed in the online help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1214 window.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1215 @item @i{Classes}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1216 @tab The @i{Classes} line is only included in the routine info window if
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1217 the current class inherits from other classes. You can click with the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1218 @emph{middle} mouse button to display routine info about the current
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1219 method in other classes on the inheritance chain, if such a method
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1220 exists there.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1221 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1222
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1223 @defopt idlwave-resize-routine-help-window (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1224 Non-@code{nil} means resize the Routine-info @file{*Help*} window to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1225 fit the content.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1226 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1227
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1228 @defopt idlwave-special-lib-alist
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1229 Alist of regular expressions matching special library directories.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1230 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1231
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1232 @defopt idlwave-rinfo-max-source-lines (@code{5})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1233 Maximum number of source files displayed in the Routine Info window.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1234 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1235
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1236
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1237 @html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1238 <A NAME="ONLINE_HELP"></A>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1239 @end html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1240 @node Online Help, Completion, Routine Info, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1241 @section Online Help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1242
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1243 @cindex Online Help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1244 @cindex @file{idlw-help.txt}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1245 @cindex @file{idlw-help.el}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1246 @cindex Installing online help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1247 @cindex Online Help, Installation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1248 @cindex Speed, of online help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1249 @cindex XML Help Catalog
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1250
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1251 For IDL system routines, extensive documentation is supplied with IDL.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1252 IDLWAVE can access the HTML version of this documentation very quickly
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1253 and accurately, based on the local context. This can be @emph{much}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1254 faster than using the IDL online help application, because IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1255 usually gets you to the right place in the documentation directly ---
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1256 e.g. a specific keyword of a routine --- without any additional browsing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1257 and scrolling.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1258
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1259 For this online help to work, an HTML version of the IDL documentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1260 is required. Beginning with IDL 6.2, HTML documentation is distributed
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1261 directly with IDL, along with an XML-based catalog of routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1262 information. By default, IDLWAVE automatically attempts to convert this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1263 XML catalog into a format Emacs can more easily understand, and caches
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1264 this information in your @code{idlwave_config_directory}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1265 (@file{~/.idlwave/}, by default). It also re-scans the XML catalog if
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1266 it is newer than the current cached version. You can force rescan with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1267 the menu entry @code{IDLWAVE->Routine Info->Rescan XML Help Catalog}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1268
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1269 Before IDL 6.2, the HTML help was not distributed with IDL, and was not
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1270 part of the standalone IDLWAVE distribution, but had to be downloaded
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1271 separately. This is no longer necessary: all help and routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1272 information is supplied with IDL versions 6.2 and later.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1273
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1274 There are a variety of options for displaying the HTML help: see below.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1275 Help for routines without HTML documentation is also available, by using
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1276 the routine documentation header and/or routine source.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1277
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1278 @kindex M-?
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1279 In any IDL program (or, as with most IDLWAVE commands, in the IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1280 Shell), press @kbd{M-?} (@code{idlwave-context-help}), or click with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1281 @kbd{S-Mouse-3} to access context sensitive online help. The following
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1282 locations are recognized context for help:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1283
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1284 @cindex Context, for online help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1285 @multitable @columnfractions .25 .75
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1286 @item @i{Routine names}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1287 @tab The name of a routine (function, procedure, method).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1288 @item @i{Keyword Parameters}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1289 @tab A keyword parameter of a routine.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1290 @item @i{System Variables}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1291 @tab System variables like @code{!DPI}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1292 @item @i{System Variable Tags}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1293 @tab System variables tags like @code{!D.X_SIZE}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1294 @item @i{IDL Statements}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1295 @tab Statements like @code{PRO}, @code{REPEAT}, @code{COMPILE_OPT}, etc.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1296 @item @i{IDL Controls}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1297 @tab Control structures like @code{FOR}, @code{SWITCH}, etc.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1298 @item @i{Class names}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1299 @tab A class name in an @code{OBJ_NEW} call.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1300 @item @i{Class Init Keywords}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1301 @tab Beyond the class name in an @code{OBJ_NEW} call.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1302 @item @i{Executive Command}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1303 @tab An executive command like @code{.RUN}. Mostly useful in the shell.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1304 @item @i{Structure Tags}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1305 @tab Structure tags like @code{state.xsize}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1306 @item @i{Class Tags}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1307 @tab Class tags like @code{self.value}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1308 @item @i{Default}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1309 @tab The routine that would be selected for routine info display.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1310 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1311
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1312 @cindex @code{OBJ_NEW}, special online help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1313 Note that the @code{OBJ_NEW} function is special in that the help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1314 displayed depends on the cursor position. If the cursor is on the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1315 @samp{OBJ_NEW}, this function is described. If it is on the class
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1316 name inside the quotes, the documentation for the class is pulled up.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1317 If the cursor is @emph{after} the class name, anywhere in the argument
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1318 list, the documentation for the corresponding @code{Init} method and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1319 its keywords is targeted.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1320
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1321 Apart from an IDLWAVE buffer or shell, there are two more places from
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1322 which online help can be accessed.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1323
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1324 @itemize @bullet
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1325 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1326 Online help for routines and keywords can be accessed through the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1327 Routine Info display. Click with @kbd{Mouse-3} on an item to see the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1328 corresponding help (@pxref{Routine Info}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1329 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1330 When using completion and Emacs pops up a @file{*Completions*} buffer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1331 with possible completions, clicking with @kbd{Mouse-3} on a completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1332 item invokes help on that item (@pxref{Completion}). Items for which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1333 help is available in the online system documentation (vs. just the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1334 program source itself) will be emphasized (e.g. colored blue).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1335 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1336 @noindent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1337 In both cases, a blue face indicates that the item is documented in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1338 the IDL manual, but an attempt will be made to visit non-blue items
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1339 directly in the originating source file.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1340
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1341
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1342 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1343 * Help with HTML Documentation::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1344 * Help with Source::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1345 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1346
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1347 @node Help with HTML Documentation, Help with Source, Online Help, Online Help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1348 @subsection Help with HTML Documentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1349 @cindex HTML Help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1350 @cindex Help using HTML manuals
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1351 @cindex IDL manual, HTML version
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1352 @cindex IDL Assistant
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1353
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1354 Help using the HTML documentation is invoked with the built-in Emacs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1355 command @code{browse-url}, which displays the relevant help topic in a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1356 browser of your choosing. Beginning with version 6.2, IDL comes with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1357 the help browser @emph{IDL Assistant}, which it uses by default for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1358 displaying online help on all supported platforms. This browser
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1359 offers topical searches, an index, and is also now the default and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1360 recommended IDLWAVE help browser. The variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1361 @code{idlwave-help-use-assistant} controls whether this browser is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1362 used. Note that, due to limitations in the Assistant, invoking help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1363 within IDLWAVE and @code{? topic} within IDL will result in two
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1364 running copies of Assistant.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1365
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1366 Aside from the IDL Assistant, there are many possible browsers to choose
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1367 among, with differing advantages and disadvantages. The variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1368 @code{idlwave-help-browser-function} controls which browser help is sent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1369 to (as long as @code{idlwave-help-use-assistant} is not set). This
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1370 function is used to set the variable @code{browse-url-browser-function}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1371 locally for IDLWAVE help only. Customize the latter variable to see
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1372 what choices of browsers your system offers. Certain browsers like
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1373 @code{w3} (bundled with many versions of Emacs) and @code{w3m}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1374 (@uref{http://emacs-w3m.namazu.org/}) are run within Emacs, and use
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1375 Emacs buffers to display the HTML help. This can be convenient,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1376 especially on small displays, and images can even be displayed in-line
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1377 on newer Emacs versions. However, better formatting results are often
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1378 achieved with external browsers, like Mozilla. IDLWAVE assumes any
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1379 browser function containing "w3" is displayed in a local buffer. If you
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1380 are using another Emacs-local browser for which this is not true, set
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1381 the variable @code{idlwave-help-browser-is-local}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1382
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1383 With IDL 6.2 or later, it is important to ensure that the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1384 @code{idlwave-system-directory} is set (@pxref{Catalogs}). One easy way
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1385 to ensure this is to run the IDL Shell (@kbd{C-c C-s}). It will be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1386 queried for this directory, and the results will be cached to file for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1387 subsequent use.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1388
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1389 @xref{HTML Help Browser Tips}, for more information on selecting and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1390 configuring a browser for use with IDL's HTML help system.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1391
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1392 @defopt idlwave-html-system-help-location @file{help/online_help}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1393 Relative directory of the system-supplied HTML help directory,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1394 considered with respect to @code{idlwave-system-directory}. Relevant
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1395 for IDL 6.2 and greater. Should not change.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1396 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1397
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1398 @defopt idlwave-html-help-location @file{/usr/local/etc/}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1399 The directory where the @file{idl_html_help} HTML directory live.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1400 Obsolete and ignored for IDL 6.2 and greater
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1401 (@code{idlwave-html-system-help-location} is used instead).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1402 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1403
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1404 @defopt idlwave-help-use-assistant @code{t}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1405 If set, use the IDL Assistant if possible for online HTML help,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1406 otherwise use the browser function specified in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1407 @code{idlwave-help-browser-function}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1408 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1409
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1410 @defopt idlwave-help-browser-function
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1411 The browser function to use to display IDLWAVE HTML help. Should be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1412 one of the functions available for setting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1413 @code{browse-url-browser-function}, which see.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1414 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1415
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1416 @defopt idlwave-help-browser-is-local
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1417 Is the browser selected in @code{idlwave-help-browser-function} run in a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1418 local Emacs buffer or window? Defaults to @code{t} if the function
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1419 contains "-w3".
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1420 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1421
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1422 @defopt idlwave-help-link-face
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1423 The face for links to IDLWAVE online help.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1424 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1425
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1426 @node Help with Source, , Help with HTML Documentation, Online Help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1427 @subsection Help with Source
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1428 @cindex Help using routine source
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1429
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1430 @cindex Source code, as online help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1431 @cindex DocLib header, as online help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1432 For routines which are not documented in an HTML manual (for example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1433 personal or library routines), the source code itself is used as help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1434 text. If the requested information can be found in a (more or less)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1435 standard DocLib file header, IDLWAVE shows the header (scrolling down to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1436 a keyword, if appropriate). Otherwise the routine definition statement
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1437 (@code{pro}/@code{function}) is shown. The doclib header sections which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1438 are searched for include @samp{NAME} and @samp{KEYWORDS}. Localization
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1439 support can be added by customizing the @code{idlwave-help-doclib-name}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1440 and @code{idlwave-help-doclib-keyword} variables.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1441
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1442 @cindex Structure tags, in online help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1443 @cindex Class tags, in online help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1444 Help is also available for class structure tags (@code{self.TAG}), and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1445 generic structure tags, if structure tag completion is enabled
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1446 (@pxref{Structure Tag Completion}). This is implemented by visiting the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1447 tag within the class or structure definition source itself. Help is not
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1448 available on built-in system class tags.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1449
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1450 The help window is normally displayed in the same frame, but can be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1451 popped-up in a separate frame. The following commands can be used to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1452 navigate inside the help system for source files:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1453
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1454 @multitable @columnfractions .15 .85
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1455 @item @kbd{@key{SPACE}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1456 @tab Scroll forward one page.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1457 @item @kbd{@key{RET}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1458 @tab Scroll forward one line.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1459 @item @kbd{@key{DEL}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1460 @tab Scroll back one page.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1461 @item @kbd{h}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1462 @tab Jump to DocLib Header of the routine whose source is displayed
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1463 as help.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1464 @item @kbd{H}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1465 @tab Jump to the first DocLib Header in the file.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1466 @item @kbd{.} @r{(Dot)}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1467 @tab Jump back and forth between the routine definition (the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1468 @code{pro}/@code{function} statement) and the description of the help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1469 item in the DocLib header.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1470 @item @kbd{F}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1471 @tab Fontify the buffer like source code. See the variable @code{idlwave-help-fontify-source-code}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1472 @item @kbd{q}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1473 @tab Kill the help window.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1474 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1475
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1476
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1477 @defopt idlwave-help-use-dedicated-frame (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1478 Non-@code{nil} means use a separate frame for Online Help if possible.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1479 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1480
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1481 @defopt idlwave-help-frame-parameters
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1482 The frame parameters for the special Online Help frame.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1483 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1484
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1485 @defopt idlwave-max-popup-menu-items (@code{20})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1486 Maximum number of items per pane in pop-up menus.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1487 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1488
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1489 @defopt idlwave-extra-help-function
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1490 Function to call for help if the normal help fails.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1491 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1492
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1493 @defopt idlwave-help-fontify-source-code (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1494 Non-@code{nil} means fontify source code displayed as help.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1495 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1496
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1497 @defopt idlwave-help-source-try-header (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1498 Non-@code{nil} means try to find help in routine header when
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1499 displaying source file.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1500 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1501
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1502 @defopt idlwave-help-doclib-name (@code{"name"})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1503 The case-insensitive heading word in doclib headers to locate the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1504 @emph{name} section. Can be a regexp, e.g. @code{"\\(name\\|nom\\)"}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1505 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1506
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1507 @defopt idlwave-help-doclib-keyword (@code{"KEYWORD"})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1508 The case-insensitive heading word in doclib headers to locate the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1509 @emph{keywords} section. Can be a regexp.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1510 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1511
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1512
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1513 @node Completion, Routine Source, Online Help, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1514 @section Completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1515 @cindex Completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1516 @cindex Keyword completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1517 @cindex Method completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1518 @cindex Object method completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1519 @cindex Class name completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1520 @cindex Function name completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1521 @cindex Procedure name completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1522
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1523 @kindex M-@key{TAB}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1524 @kindex C-c C-i
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1525 IDLWAVE offers completion for class names, routine names, keywords,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1526 system variables, system variable tags, class structure tags, regular
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1527 structure tags and file names. As in many programming modes, completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1528 is bound to @kbd{M-@key{TAB}} (or simply @kbd{@key{TAB}} in the IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1529 Shell --- @pxref{Using the Shell}). Completion uses exactly the same
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1530 internal information as routine info, so when necessary (rarely) it can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1531 be updated with @kbd{C-c C-i} (@code{idlwave-update-routine-info}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1532
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1533 The completion function is context sensitive and figures out what to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1534 complete based on the location of the point. Here are example lines and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1535 what @kbd{M-@key{TAB}} would try to complete when the cursor is on the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1536 position marked with a @samp{_}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1537
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1538 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1539 plo_ @r{Procedure}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1540 x = a_ @r{Function}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1541 plot,xra_ @r{Keyword of @code{plot} procedure}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1542 plot,x,y,/x_ @r{Keyword of @code{plot} procedure}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1543 plot,min(_ @r{Keyword of @code{min} function}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1544 obj -> a_ @r{Object method (procedure)}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1545 a[2,3] = obj -> a_ @r{Object method (function)}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1546 x = obj_new('IDL_ @r{Class name}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1547 x = obj_new('MyCl',a_ @r{Keyword to @code{Init} method in class @code{MyCl}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1548 pro A_ @r{Class name}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1549 pro _ @r{Fill in @code{Class::} of first method in this file}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1550 !v_ @r{System variable}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1551 !version.t_ @r{Structure tag of system variable}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1552 self.g_ @r{Class structure tag in methods}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1553 state.w_ @r{Structure tag, if tag completion enabled}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1554 name = 'a_ @r{File name (default inside quotes)}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1555 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1556
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1557 @cindex Completion, ambiguity
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1558 @cindex Completion, forcing function name
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1559 The only place where completion is ambiguous is procedure/function
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1560 @emph{keywords} versus @emph{functions}. After @samp{plot,x,_}, IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1561 will always assume a keyword to @samp{plot}. However, a function is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1562 also a possible completion here. You can force completion of a function
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1563 name at such a location by using a prefix arg: @kbd{C-u M-@key{TAB}}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1564
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1565 Giving two prefix arguments (@kbd{C-u C-u M-@key{TAB}}) prompts for a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1566 regular expression to search among the commands to be completed. As
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1567 an example, completing a blank line in this way will allow you to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1568 search for a procedure matching a regexp.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1569
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1570 @cindex Scrolling the @file{*Completions*} window
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1571 @cindex Completion, scrolling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1572 @cindex Completion, Online Help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1573 @cindex Online Help in @file{*Completions*} buffer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1574 If the list of completions is too long to fit in the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1575 @file{*Completions*} window, the window can be scrolled by pressing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1576 @kbd{M-@key{TAB}} repeatedly. Online help (if installed) for each
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1577 possible completion is available by clicking with @kbd{Mouse-3} on the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1578 item. Items for which system online help (from the IDL manual) is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1579 available will be emphasized (e.g. colored blue). For other items, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1580 corresponding source code or DocLib header will be used as the help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1581 text.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1582
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1583 @cindex Completion, cancelling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1584 @cindex Cancelling completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1585 Completion is not a blocking operation --- you are free to continue
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1586 editing, enter commands, or simply ignore the @file{*Completions*}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1587 buffer during a completion operation. If, however, the most recent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1588 command was a completion, @kbd{C-g} will remove the buffer and restore
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1589 the window configuration. You can also remove the buffer at any time
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1590 with no negative consequences.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1591
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1592 @defopt idlwave-keyword-completion-adds-equal (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1593 Non-@code{nil} means completion automatically adds @samp{=} after
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1594 completed keywords.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1595 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1596
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1597 @defopt idlwave-function-completion-adds-paren (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1598 Non-@code{nil} means completion automatically adds @samp{(} after
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1599 completed function. A value of `2' means also add the closing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1600 parenthesis and position the cursor between the two.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1601 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1602
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1603 @defopt idlwave-completion-restore-window-configuration (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1604 Non-@code{nil} means restore window configuration after successful
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1605 completion.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1606 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1607
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1608 @defopt idlwave-highlight-help-links-in-completion (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1609 Non-@code{nil} means highlight completions for which system help is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1610 available.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1611 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1612
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1613 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1614 * Case of Completed Words:: CaseOFcomPletedWords
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1615 * Object Method Completion and Class Ambiguity:: obj->Method, what?
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1616 * Object Method Completion in the Shell::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1617 * Class and Keyword Inheritance:: obj->Method, _EXTRA=e
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1618 * Structure Tag Completion:: Completing state.Tag
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1619 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1620
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1621 @node Case of Completed Words, Object Method Completion and Class Ambiguity, Completion, Completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1622 @subsection Case of Completed Words
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1623 @cindex Case of completed words
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1624 @cindex Mixed case completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1625 IDL is a case-insensitive language, so casing is a matter of style
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1626 only. IDLWAVE helps maintain a consistent casing style for completed
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1627 items. The case of the completed words is determined by what is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1628 already in the buffer. As an exception, when the partial word being
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1629 completed is all lower case, the completion will be lower case as
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1630 well. If at least one character is upper case, the string will be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1631 completed in upper case or mixed case, depending on the value of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1632 variable @code{idlwave-completion-case}. The default is to use upper
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1633 case for procedures, functions and keywords, and mixed case for object
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1634 class names and methods, similar to the conventions in the IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1635 manuals. For instance, to enable mixed-case completion for routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1636 in addition to classes and methods, you need an entry such as
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1637 @code{(routine . preserve)} in that variable. To enable total control
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1638 over the case of completed items, independent of buffer context, set
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1639 @code{idlwave-completion-force-default-case} to non-@code{nil}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1640
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1641 @defopt idlwave-completion-case
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1642 Association list setting the case (UPPER/lower/Capitalized/MixedCase...)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1643 of completed words.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1644 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1645
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1646 @defopt idlwave-completion-force-default-case (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1647 Non-@code{nil} means completion will always honor the settings in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1648 @code{idlwave-completion-case}. When nil (the default), entirely lower
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1649 case strings will always be completed to lower case, no matter what the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1650 settings in @code{idlwave-completion-case}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1651 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1652
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1653 @defopt idlwave-complete-empty-string-as-lower-case (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1654 Non-@code{nil} means the empty string is considered lower case for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1655 completion.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1656 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1657
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1658 @node Object Method Completion and Class Ambiguity, Object Method Completion in the Shell, Case of Completed Words, Completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1659 @subsection Object Method Completion and Class Ambiguity
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1660 @cindex Object methods
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1661 @cindex Class ambiguity
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1662 @cindex @code{self} object, default class
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1663 An object method is not uniquely determined without the object's class.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1664 Since the class is almost always omitted in the calling source (as
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1665 required to obtain the true benefits of object-based programming),
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1666 IDLWAVE considers all available methods in all classes as possible
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1667 method name completions. The combined list of keywords of the current
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1668 method in @emph{all} known classes which contain that method will be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1669 considered for keyword completion. In the @file{*Completions*} buffer,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1670 the matching classes will be shown next to each item (see option
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1671 @code{idlwave-completion-show-classes}). As a special case, the class
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1672 of an object called @samp{self} is always taken to be the class of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1673 current routine, when in an IDLWAVE buffer. All inherits classes are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1674 considered as well.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1675
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1676 @cindex Forcing class query.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1677 @cindex Class query, forcing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1678 You can also call @code{idlwave-complete} with a prefix arg: @kbd{C-u
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1679 M-@key{TAB}}. IDLWAVE will then prompt you for the class in order to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1680 narrow down the number of possible completions. The variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1681 @code{idlwave-query-class} can be configured to make such prompting the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1682 default for all methods (not recommended), or selectively for very
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1683 common methods for which the number of completing keywords would be too
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1684 large (e.g. @code{Init,SetProperty,GetProperty}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1685
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1686 @cindex Saving object class on @code{->}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1687 @cindex @code{->}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1688 After you have specified the class for a particular statement (e.g. when
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1689 completing the method), IDLWAVE can remember it for the rest of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1690 editing session. Subsequent completions in the same statement
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1691 (e.g. keywords) can then reuse this class information. This works by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1692 placing a text property on the method invocation operator @samp{->},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1693 after which the operator will be shown in a different face (bold by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1694 default). The variable @code{idlwave-store-inquired-class} can be used
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1695 to turn it off or on.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1696
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1697 @defopt idlwave-completion-show-classes (@code{1})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1698 Non-@code{nil} means show up to that many classes in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1699 @file{*Completions*} buffer when completing object methods and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1700 keywords.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1701 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1702
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1703 @defopt idlwave-completion-fontify-classes (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1704 Non-@code{nil} means fontify the classes in completions buffer.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1705 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1706
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1707 @defopt idlwave-query-class (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1708 Association list governing query for object classes during completion.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1709 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1710
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1711 @defopt idlwave-store-inquired-class (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1712 Non-@code{nil} means store class of a method call as text property on
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1713 @samp{->}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1714 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1715
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1716 @defopt idlwave-class-arrow-face
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1717 Face to highlight object operator arrows @samp{->} which carry a saved
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1718 class text property.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1719 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1720
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1721 @node Object Method Completion in the Shell, Class and Keyword Inheritance, Object Method Completion and Class Ambiguity, Completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1722 @subsection Object Method Completion in the Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1723 @cindex Method Completion in Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1724 In the IDLWAVE Shell (@pxref{The IDLWAVE Shell}), objects on which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1725 methods are being invoked have a special property: they must exist as
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1726 variables, and so their class can be determined (for instance, using the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1727 @code{obj_class()} function). In the Shell, when attempting completion,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1728 routine info, or online help within a method routine, a query is sent to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1729 determine the class of the object. If this query is successful, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1730 class found will be used to select appropriate completions, routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1731 info, or help. If unsuccessful, information from all known classes will
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1732 be used (as in the buffer).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1733
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1734 @node Class and Keyword Inheritance, Structure Tag Completion, Object Method Completion in the Shell, Completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1735 @subsection Class and Keyword Inheritance
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1736 @cindex Inheritance, class
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1737 @cindex Keyword inheritance
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1738 @cindex Inheritance, keyword
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1739
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1740 Class inheritance affects which methods are called in IDL. An object of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1741 a class which inherits methods from one or more superclasses can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1742 override that method by defining its own method of the same name, extend
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1743 the method by calling the method(s) of its superclass(es) in its
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1744 version, or inherit the method directly by making no modifications.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1745 IDLWAVE examines class definitions during completion and routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1746 information display, and records all inheritance information it finds.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1747 This information is displayed if appropriate with the calling sequence
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1748 for methods (@pxref{Routine Info}), as long as variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1749 @code{idlwave-support-inheritance} is non-@code{nil}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1750
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1751 In many class methods, @emph{keyword} inheritance (@code{_EXTRA} and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1752 @code{_REF_EXTRA}) is used hand-in-hand with class inheritance and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1753 method overriding. E.g., in a @code{SetProperty} method, this technique
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1754 allows a single call @code{obj->SetProperty} to set properties up the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1755 entire class inheritance chain. This is often referred to as
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1756 @emph{chaining}, and is characterized by chained method calls like
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1757 @w{@code{self->MySuperClass::SetProperty,_EXTRA=e}}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1758
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1759 IDLWAVE can accommodate this special synergy between class and keyword
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1760 inheritance: if @code{_EXTRA} or @code{_REF_EXTRA} is detected among a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1761 method's keyword parameters, all keywords of superclass versions of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1762 the method being considered can be included in completion. There is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1763 of course no guarantee that this type of keyword chaining actually
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1764 occurs, but for some methods it's a very convenient assumption. The
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1765 variable @code{idlwave-keyword-class-inheritance} can be used to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1766 configure which methods have keyword inheritance treated in this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1767 simple, class-driven way. By default, only @code{Init} and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1768 @code{(Get|Set)Property} are. The completion buffer will label
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1769 keywords based on their originating class.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1770
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1771 @defopt idlwave-support-inheritance (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1772 Non-@code{nil} means consider inheritance during completion, online help etc.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1773 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1774
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1775 @defopt idlwave-keyword-class-inheritance
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1776 A list of regular expressions to match methods for which simple
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1777 class-driven keyword inheritance will be used for Completion.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1778 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1779
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1780 @node Structure Tag Completion, , Class and Keyword Inheritance, Completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1781 @subsection Structure Tag Completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1782 @cindex Completion, structure tag
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1783 @cindex Structure tag completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1784
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1785 In many programs, especially those involving widgets, large structures
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1786 (e.g. the @samp{state} structure) are used to communicate among
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1787 routines. It is very convenient to be able to complete structure tags,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1788 in the same way as for instance variables (tags) of the @samp{self}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1789 object (@pxref{Object Method Completion and Class Ambiguity}). Add-in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1790 code for structure tag completion is available in the form of a loadable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1791 completion module: @file{idlw-complete-structtag.el}. Tag completion in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1792 structures is highly ambiguous (much more so than @samp{self}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1793 completion), so @code{idlw-complete-structtag} makes an unusual and very
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1794 specific assumption: the exact same variable name is used to refer to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1795 the structure in all parts of the program. This is entirely unenforced
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1796 by the IDL language, but is a typical convention. If you consistently
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1797 refer to the same structure with the same variable name
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1798 (e.g. @samp{state}), structure tags which are read from its definition
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1799 in the same file can be used for completion.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1800
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1801 Structure tag completion is not enabled by default. To enable it,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1802 simply add the following to your @file{.emacs}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1803
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1804 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1805 (add-hook 'idlwave-load-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1806 (lambda () (require 'idlw-complete-structtag)))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1807 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1808
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1809 Once enabled, you'll also be able to access online help on the structure
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1810 tags, using the usual methods (@pxref{Online Help}). In addition,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1811 structure variables in the shell will be queried for tag names, similar
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1812 to the way object variables in the shell are queried for method names.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1813 So, e.g.:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1814
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1815 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1816 IDL> st.[Tab]
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1817 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1818
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1819 @noindent will complete with all structure fields of the structure
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1820 @code{st}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1821
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1822 @node Routine Source, Resolving Routines, Completion, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1823 @section Routine Source
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1824 @cindex Routine source file
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1825 @cindex Module source file
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1826 @cindex Source file, of a routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1827 @kindex C-c C-v
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1828 In addition to clicking on a @i{Source:} line in the routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1829 window, there is another way to quickly visit the source file of a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1830 routine. The command @kbd{C-c C-v} (@code{idlwave-find-module}) asks
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1831 for a module name, offering the same default as
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1832 @code{idlwave-routine-info} would have used, taken from nearby buffer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1833 contents. In the minibuffer, specify a complete routine name (including
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1834 any class part). IDLWAVE will display the source file in another
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1835 window, positioned at the routine in question. You can also limit this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1836 to a routine in the current buffer only, with completion, and a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1837 context-sensitive default, by using a single prefix (@kbd{C-u C-c C-v})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1838 or the convenience binding @kbd{C-c C-t}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1839
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1840 @cindex Buffers, killing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1841 @cindex Killing autoloaded buffers
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1842 Since getting the source of a routine into a buffer is so easy with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1843 IDLWAVE, too many buffers visiting different IDL source files are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1844 sometimes created. The special command @kbd{C-c C-k}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1845 (@code{idlwave-kill-autoloaded-buffers}) can be used to easily remove
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1846 these buffers.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1847
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1848 @node Resolving Routines, Code Templates, Routine Source, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1849 @section Resolving Routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1850 @cindex @code{RESOLVE_ROUTINE}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1851 @cindex Compiling library modules
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1852 @cindex Routines, resolving
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1853
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1854 The key sequence @kbd{C-c =} calls the command @code{idlwave-resolve}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1855 and sends the line @samp{RESOLVE_ROUTINE, '@var{routine_name}'} to IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1856 in order to resolve (compile) it. The default routine to be resolved is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1857 taken from context, but you get a chance to edit it. Usually this is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1858 not necessary, since IDL automatically discovers routines on its path.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1859
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1860 @code{idlwave-resolve} is one way to get a library module within reach
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1861 of IDLWAVE's routine info collecting functions. A better way is to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1862 keep routine information available in catalogs (@pxref{Catalogs}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1863 Routine info on modules will then be available without the need to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1864 compile the modules first, and even without a running shell.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1865
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1866 @xref{Sources of Routine Info}, for more information on the ways IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1867 collects data about routines, and how to update this information.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1868
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1869 @node Code Templates, Abbreviations, Resolving Routines, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1870 @section Code Templates
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1871 @cindex Code templates
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1872 @cindex Templates
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1873
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1874 IDLWAVE can insert IDL code templates into the buffer. For a few
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1875 templates, this is done with direct key bindings:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1876
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1877 @multitable @columnfractions .15 .85
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1878 @item @kbd{C-c C-c}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1879 @tab @code{CASE} statement template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1880 @item @kbd{C-c C-f}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1881 @tab @code{FOR} loop template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1882 @item @kbd{C-c C-r}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1883 @tab @code{REPEAT} loop template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1884 @item @kbd{C-c C-w}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1885 @tab @code{WHILE} loop template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1886 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1887
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1888 All code templates are also available as abbreviations
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1889 (@pxref{Abbreviations}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1890
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1891 @node Abbreviations, Actions, Code Templates, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1892 @section Abbreviations
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1893 @cindex Abbreviations
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1894
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1895 Special abbreviations exist to enable rapid entry of commonly used
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1896 commands. Emacs abbreviations are expanded by typing text into the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1897 buffer and pressing @key{SPC} or @key{RET}. The special abbreviations
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1898 used to insert code templates all start with a @samp{\} (the backslash),
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1899 or, optionally, any other character set in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1900 @code{idlwave-abbrev-start-char}. IDLWAVE ensures that abbreviations are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1901 only expanded where they should be (i.e., not in a string or comment),
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1902 and permits the point to be moved after an abbreviation expansion ---
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1903 very useful for positioning the mark inside of parentheses, etc.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1904
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1905 Special abbreviations are pre-defined for code templates and other
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1906 useful items. To visit the full list of abbreviations, use @kbd{M-x
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1907 idlwave-list-abbrevs}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1908
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1909 Template abbreviations:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1910
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1911 @multitable @columnfractions .15 .85
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1912 @item @code{\pr}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1913 @tab @code{PROCEDURE} template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1914 @item @code{\fu}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1915 @tab @code{FUNCTION} template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1916 @item @code{\c}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1917 @tab @code{CASE} statement template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1918 @item @code{\f}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1919 @tab @code{FOR} loop template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1920 @item @code{\r}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1921 @tab @code{REPEAT} loop template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1922 @item @code{\w}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1923 @tab @code{WHILE} loop template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1924 @item @code{\i}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1925 @tab @code{IF} statement template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1926 @item @code{\elif}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1927 @tab @code{IF-ELSE} statement template
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1928 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1929
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1930 String abbreviations:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1931
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1932 @multitable @columnfractions .15 .85
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1933 @item @code{\ap}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1934 @tab @code{arg_present()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1935 @item @code{\b}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1936 @tab @code{begin}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1937 @item @code{\cb}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1938 @tab @code{byte()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1939 @item @code{\cc}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1940 @tab @code{complex()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1941 @item @code{\cd}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1942 @tab @code{double()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1943 @item @code{\cf}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1944 @tab @code{float()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1945 @item @code{\cl}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1946 @tab @code{long()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1947 @item @code{\co}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1948 @tab @code{common}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1949 @item @code{\cs}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1950 @tab @code{string()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1951 @item @code{\cx}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1952 @tab @code{fix()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1953 @item @code{\e}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1954 @tab @code{else}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1955 @item @code{\ec}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1956 @tab @code{endcase}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1957 @item @code{\ee}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1958 @tab @code{endelse}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1959 @item @code{\ef}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1960 @tab @code{endfor}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1961 @item @code{\ei}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1962 @tab @code{endif else if}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1963 @item @code{\el}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1964 @tab @code{endif else}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1965 @item @code{\en}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1966 @tab @code{endif}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1967 @item @code{\er}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1968 @tab @code{endrep}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1969 @item @code{\es}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1970 @tab @code{endswitch}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1971 @item @code{\ew}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1972 @tab @code{endwhile}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1973 @item @code{\g}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1974 @tab @code{goto,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1975 @item @code{\h}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1976 @tab @code{help,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1977 @item @code{\ik}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1978 @tab @code{if keyword_set() then}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1979 @item @code{\iap}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1980 @tab @code{if arg_present() then}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1981 @item @code{\ine}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1982 @tab @code{if n_elements() eq 0 then}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1983 @item @code{\inn}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1984 @tab @code{if n_elements() ne 0 then}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1985 @item @code{\k}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1986 @tab @code{keyword_set()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1987 @item @code{\n}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1988 @tab @code{n_elements()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1989 @item @code{\np}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1990 @tab @code{n_params()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1991 @item @code{\oi}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1992 @tab @code{on_ioerror,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1993 @item @code{\or}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1994 @tab @code{openr,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1995 @item @code{\ou}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1996 @tab @code{openu,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1997 @item @code{\ow}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1998 @tab @code{openw,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
1999 @item @code{\p}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2000 @tab @code{print,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2001 @item @code{\pt}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2002 @tab @code{plot,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2003 @item @code{\pv}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2004 @tab @code{ptr_valid()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2005 @item @code{\re}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2006 @tab @code{read,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2007 @item @code{\rf}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2008 @tab @code{readf,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2009 @item @code{\rt}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2010 @tab @code{return}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2011 @item @code{\ru}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2012 @tab @code{readu,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2013 @item @code{\s}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2014 @tab @code{size()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2015 @item @code{\sc}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2016 @tab @code{strcompress()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2017 @item @code{\sl}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2018 @tab @code{strlowcase()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2019 @item @code{\sm}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2020 @tab @code{strmid()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2021 @item @code{\sn}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2022 @tab @code{strlen()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2023 @item @code{\sp}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2024 @tab @code{strpos()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2025 @item @code{\sr}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2026 @tab @code{strtrim()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2027 @item @code{\st}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2028 @tab @code{strput()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2029 @item @code{\su}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2030 @tab @code{strupcase()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2031 @item @code{\t}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2032 @tab @code{then}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2033 @item @code{\u}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2034 @tab @code{until}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2035 @item @code{\wc}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2036 @tab @code{widget_control,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2037 @item @code{\wi}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2038 @tab @code{widget_info()}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2039 @item @code{\wu}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2040 @tab @code{writeu,}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2041 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2042
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2043 @noindent You can easily add your own abbreviations or override existing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2044 abbrevs with @code{define-abbrev} in your mode hook, using the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2045 convenience function @code{idlwave-define-abbrev}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2046
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2047 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2048 (add-hook 'idlwave-mode-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2049 (lambda ()
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2050 (idlwave-define-abbrev "wb" "widget_base()"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2051 (idlwave-keyword-abbrev 1))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2052 (idlwave-define-abbrev "ine" "IF N_Elements() EQ 0 THEN"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2053 (idlwave-keyword-abbrev 11))))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2054 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2055
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2056 Notice how the abbreviation (here @emph{wb}) and its expansion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2057 (@emph{widget_base()}) are given as arguments, and the single argument to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2058 @code{idlwave-keyword-abbrev} (here @emph{1}) specifies how far back to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2059 move the point upon expansion (in this example, to put it between the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2060 parentheses).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2061
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2062 The abbreviations are expanded in upper or lower case, depending upon
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2063 the variables @code{idlwave-abbrev-change-case} and, for reserved word
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2064 templates, @code{idlwave-reserved-word-upcase} (@pxref{Case Changes}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2065
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2066 @defopt idlwave-abbrev-start-char (@code{"\"})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2067 A single character string used to start abbreviations in abbrev mode.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2068 Beware of common characters which might naturally occur in sequence with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2069 abbreviation strings.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2070 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2071
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2072 @defopt idlwave-abbrev-move (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2073 Non-@code{nil} means the abbrev hook can move point, e.g. to end up
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2074 between the parentheses of a function call.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2075 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2076
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2077 @node Actions, Doc Header, Abbreviations, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2078 @section Actions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2079 @cindex Actions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2080 @cindex Coding standards, enforcing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2081
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2082 @emph{Actions} are special formatting commands which are executed
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2083 automatically while you write code in order to check the structure of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2084 the program or to enforce coding standards. Most actions which have
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2085 been implemented in IDLWAVE are turned off by default, assuming that the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2086 average user wants her code the way she writes it. But if you are a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2087 lazy typist and want your code to adhere to certain standards, actions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2088 can be helpful.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2089
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2090 Actions can be applied in three ways:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2091
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2092 @itemize @bullet
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2093 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2094 Some actions are applied directly while typing. For example, pressing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2095 @samp{=} can run a check to make sure that this operator is surrounded
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2096 by spaces and insert these spaces if necessary. Pressing @key{SPC}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2097 after a reserved word can call a command to change the word to upper
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2098 case.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2099 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2100 When a line is re-indented with @key{TAB}, actions can be applied to the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2101 entire line. To enable this, the variable @code{idlwave-do-actions}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2102 must be non-@code{nil}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2103 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2104 @cindex Foreign code, adapting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2105 @cindex Actions, applied to foreign code
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2106 Actions can also be applied to a larger piece of code, e.g. to convert
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2107 foreign code to your own style. To do this, mark the relevant part of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2108 the code and execute @kbd{M-x expand-region-abbrevs}. Useful marking
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2109 commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2110 subprogram). @xref{Code Indentation}, for information how to adjust the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2111 indentation of the code.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2112 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2113
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2114 @defopt idlwave-do-actions (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2115 Non-@code{nil} means performs actions when indenting. Individual action
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2116 settings are described below and set separately.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2117 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2118
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2119 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2120 * Block Boundary Check:: Is the END statement correct?
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2121 * Padding Operators:: Enforcing space around `=' etc
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2122 * Case Changes:: Enforcing upper case keywords
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2123 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2124
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2125 @node Block Boundary Check, Padding Operators, Actions, Actions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2126 @subsection Block Boundary Check
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2127 @cindex Block boundary check
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2128 @cindex @code{END} type checking
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2129 @cindex @code{END}, automatic insertion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2130 @cindex @code{END}, expanding
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2131 @cindex Block, closing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2132 @cindex Closing a block
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2133
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2134 Whenever you type an @code{END} statement, IDLWAVE finds the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2135 corresponding start of the block and the cursor blinks back to that
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2136 location for a second. If you have typed a specific @code{END}, like
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2137 @code{ENDIF} or @code{ENDCASE}, you get a warning if that terminator
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2138 does not match the type of block it terminates.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2139
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2140 Set the variable @code{idlwave-expand-generic-end} in order to have all
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2141 generic @code{END} statements automatically expanded to the appropriate
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2142 type. You can also type @kbd{C-c ]} to close the current block by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2143 inserting the appropriate @code{END} statement.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2144
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2145 @defopt idlwave-show-block (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2146 Non-@code{nil} means point blinks to block beginning for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2147 @code{idlwave-show-begin}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2148 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2149
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2150 @defopt idlwave-expand-generic-end (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2151 Non-@code{nil} means expand generic END to ENDIF/ENDELSE/ENDWHILE etc.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2152 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2153
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2154 @defopt idlwave-reindent-end (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2155 Non-@code{nil} means re-indent line after END was typed.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2156 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2157
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2158 @node Padding Operators, Case Changes, Block Boundary Check, Actions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2159 @subsection Padding Operators
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2160 @cindex Padding operators with spaces
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2161 @cindex Operators, padding with spaces
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2162 @cindex Space, around operators
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2163
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2164 Some operators can be automatically surrounded by spaces. This can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2165 happen when the operator is typed, or later when the line is indented.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2166 IDLWAVE can pad the operators @samp{<}, @samp{>}, @samp{,}, @samp{=},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2167 and @samp{->}, as well as the modified assignment operators
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2168 (@samp{AND=}, @samp{OR=}, etc.). This feature is turned off by default.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2169 If you want to turn it on, customize the variables
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2170 @code{idlwave-surround-by-blank} and @code{idlwave-do-actions} and turn
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2171 both on. You can also define similar actions for other operators by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2172 using the function @code{idlwave-action-and-binding} in the mode hook.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2173 For example, to enforce space padding of the @samp{+} and @samp{*}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2174 operators (outside of strings and comments, of course), try this in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2175 @file{.emacs}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2176
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2177 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2178 (add-hook 'idlwave-mode-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2179 (lambda ()
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2180 (setq idlwave-surround-by-blank t) ; Turn this type of actions on
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2181 (idlwave-action-and-binding "*" '(idlwave-surround 1 1))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2182 (idlwave-action-and-binding "+" '(idlwave-surround 1 1))))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2183 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2184
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2185 Note that the modified assignment operators which begin with a word
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2186 (@samp{AND=}, @samp{OR=}, @samp{NOT=}, etc.) require a leading space to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2187 be recognized (e.g @code{vAND=4} would be interpreted as a variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2188 @code{vAND}). Also note that, since e.g., @code{>} and @code{>=} are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2189 both valid operators, it is impossible to surround both by blanks while
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2190 they are being typed. Similarly with @code{&} and @code{&&}. For
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2191 these, a compromise is made: the padding is placed on the left, and if
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2192 the longer operator is keyed in, on the right as well (otherwise you
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2193 must insert spaces to pad right yourself, or press simply press Tab to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2194 repad everything if @code{idlwave-do-actions} is on).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2195
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2196 @defopt idlwave-surround-by-blank (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2197 Non-@code{nil} means enable @code{idlwave-surround}. If non-@code{nil},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2198 @samp{=}, @samp{<}, @samp{>}, @samp{&}, @samp{,}, @samp{->}, and the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2199 modified assignment operators (@samp{AND=}, @samp{OR=}, etc.) are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2200 surrounded with spaces by @code{idlwave-surround}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2201 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2202
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2203 @defopt idlwave-pad-keyword (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2204 Non-@code{nil} means space-pad the @samp{=} in keyword assignments.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2205 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2206
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2207 @node Case Changes, , Padding Operators, Actions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2208 @subsection Case Changes
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2209 @cindex Case changes
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2210 @cindex Upcase, enforcing for reserved words
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2211 @cindex Downcase, enforcing for reserved words
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2212
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2213 Actions can be used to change the case of reserved words or expanded
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2214 abbreviations by customizing the variables
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2215 @code{idlwave-abbrev-change-case} and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2216 @code{idlwave-reserved-word-upcase}. If you want to change the case of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2217 additional words automatically, put something like the following into
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2218 your @file{.emacs} file:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2219
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2220 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2221 (add-hook 'idlwave-mode-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2222 (lambda ()
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2223 ;; Capitalize system vars
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2224 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2225 ;; Capitalize procedure name
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2226 (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2227 '(capitalize-word 1) t)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2228 ;; Capitalize common block name
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2229 (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2230 '(capitalize-word 1) t)))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2231 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2232
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2233 For more information, see the documentation string for the function
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2234 @code{idlwave-action-and-binding}. For information on controlling the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2235 case of routines, keywords, classes, and methods as they are completed, see
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2236 @ref{Completion}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2237
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2238 @defopt idlwave-abbrev-change-case (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2239 Non-@code{nil} means all abbrevs will be forced to either upper or lower
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2240 case. Valid values are @code{nil}, @code{t}, and @code{down}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2241 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2242
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2243 @defopt idlwave-reserved-word-upcase (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2244 Non-@code{nil} means reserved words will be made upper case via abbrev
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2245 expansion.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2246 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2247
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2248
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2249 @node Doc Header, Motion Commands, Actions, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2250 @section Documentation Header
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2251 @cindex Documentation header
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2252 @cindex DocLib header
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2253 @cindex Modification timestamp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2254 @cindex Header, for file documentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2255 @cindex Timestamp, in doc header.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2256 @cindex Changelog, in doc header.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2257
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2258 @kindex C-c C-h
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2259 @kindex C-c C-m
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2260 The command @kbd{C-c C-h} inserts a standard routine header into the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2261 buffer, with the usual fields for documentation (a different header can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2262 be specified with @code{idlwave-file-header}). One of the keywords is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2263 @samp{MODIFICATION HISTORY} under which the changes to a routine can be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2264 recorded. The command @kbd{C-c C-m} jumps to the @samp{MODIFICATION
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2265 HISTORY} of the current routine or file and inserts the user name with a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2266 timestamp.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2267
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2268 @defopt idlwave-file-header
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2269 The doc-header template or a path to a file containing it.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2270 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2271
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2272 @defopt idlwave-header-to-beginning-of-file (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2273 Non-@code{nil} means the documentation header will always be at start
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2274 of file.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2275 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2276
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2277 @defopt idlwave-timestamp-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2278 The hook function used to update the timestamp of a function.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2279 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2280
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2281 @defopt idlwave-doc-modifications-keyword
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2282 The modifications keyword to use with the log documentation commands.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2283 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2284
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2285 @defopt idlwave-doclib-start
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2286 Regexp matching the start of a document library header.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2287 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2288
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2289 @defopt idlwave-doclib-end
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2290 Regexp matching the start of a document library header.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2291 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2292
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2293 @node Motion Commands, Misc Options, Doc Header, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2294 @section Motion Commands
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2295 @cindex Motion commands
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2296 @cindex Program structure, moving through
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2297 @cindex Code structure, moving through
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2298 @cindex @file{Func-menu}, XEmacs package
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2299 @cindex @file{Imenu}, Emacs package
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2300 @cindex Function definitions, jumping to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2301 @cindex Procedure definitions, jumping to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2302
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2303 IDLWAVE supports both @file{Imenu} and @file{Func-menu}, two packages
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2304 which make it easy to jump to the definitions of functions and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2305 procedures in the current file with a pop-up selection. To bind
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2306 @file{Imenu} to a mouse-press, use in your @file{.emacs}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2307
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2308 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2309 (define-key global-map [S-down-mouse-3] 'imenu)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2310 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2311
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2312 @cindex @file{Speedbar}, Emacs package
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2313
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2314 In addition, @file{Speedbar} support allows convenient navigation of a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2315 source tree of IDL routine files, quickly stepping to routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2316 definitions. See @code{Tools->Display Speedbar}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2317
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2318 Several commands allow you to move quickly through the structure of an
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2319 IDL program:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2320
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2321 @multitable @columnfractions .15 .85
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2322 @item @kbd{C-M-a}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2323 @tab Beginning of subprogram
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2324 @item @kbd{C-M-e}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2325 @tab End of subprogram
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2326 @item @kbd{C-c @{}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2327 @tab Beginning of block (stay inside the block)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2328 @item @kbd{C-c @}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2329 @tab End of block (stay inside the block)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2330 @item @kbd{C-M-n}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2331 @tab Forward block (on same level)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2332 @item @kbd{C-M-p}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2333 @tab Backward block (on same level)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2334 @item @kbd{C-M-d}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2335 @tab Down block (enters a block)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2336 @item @kbd{C-M-u}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2337 @tab Backward up block (leaves a block)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2338 @item @kbd{C-c C-n}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2339 @tab Next Statement
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2340 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2341
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2342
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2343 @node Misc Options, , Motion Commands, The IDLWAVE Major Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2344 @section Miscellaneous Options
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2345 @cindex Hooks
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2346
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2347 @defopt idlwave-help-application
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2348 The external application providing reference help for programming.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2349 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2350
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2351 @defopt idlwave-startup-message (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2352 Non-@code{nil} means display a startup message when @code{idlwave-mode}'
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2353 is first called.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2354 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2355
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2356 @defopt idlwave-mode-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2357 Normal hook. Executed when a buffer is put into @code{idlwave-mode}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2358 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2359
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2360 @defopt idlwave-load-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2361 Normal hook. Executed when @file{idlwave.el} is loaded.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2362 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2363
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2364 @node The IDLWAVE Shell, Acknowledgements, The IDLWAVE Major Mode, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2365 @chapter The IDLWAVE Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2366 @cindex IDLWAVE shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2367 @cindex Major mode, @code{idlwave-shell-mode}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2368 @cindex IDL, as Emacs subprocess
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2369 @cindex Subprocess of Emacs, IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2370 @cindex Comint, Emacs package
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2371 @cindex Windows
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2372 @cindex MacOS
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2373
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2374 The IDLWAVE shell is an Emacs major mode which permits running the IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2375 program as an inferior process of Emacs, and works closely with the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2376 IDLWAVE major mode in buffers. It can be used to work with IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2377 interactively, to compile and run IDL programs in Emacs buffers and to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2378 debug these programs. The IDLWAVE shell is built on @file{comint}, an
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2379 Emacs packages which handles the communication with the IDL program.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2380 Unfortunately, IDL for Windows does not have command-prompt versions and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2381 thus do not allow the interaction with Emacs --- so the IDLWAVE shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2382 currently only works under Unix and MacOSX.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2383
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2384 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2385 * Starting the Shell:: How to launch IDL as a subprocess
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2386 * Using the Shell:: Interactively working with the Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2387 * Commands Sent to the Shell::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2388 * Debugging IDL Programs::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2389 * Examining Variables::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2390 * Custom Expression Examination::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2391 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2392
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2393 @node Starting the Shell, Using the Shell, The IDLWAVE Shell, The IDLWAVE Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2394 @section Starting the Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2395 @cindex Starting the shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2396 @cindex Shell, starting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2397 @cindex Dedicated frame, for shell buffer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2398 @cindex Frame, for shell buffer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2399 @cindex Subprocess of Emacs, IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2400
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2401 @kindex C-c C-s
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2402 The IDLWAVE shell can be started with the command @kbd{M-x
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2403 idlwave-shell}. In @code{idlwave-mode} the function is bound to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2404 @kbd{C-c C-s}. It creates a buffer @file{*idl*} which is used to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2405 interact with the shell. If the shell is already running, @kbd{C-c
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2406 C-s} will simply switch to the shell buffer. The command @kbd{C-c
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2407 C-l} (@code{idlwave-shell-recenter-shell-window}) displays the shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2408 window without selecting it. The shell can also be started
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2409 automatically when another command tries to send a command to it. To
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2410 enable auto start, set the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2411 @code{idlwave-shell-automatic-start} to @code{t}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2412
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2413 In order to create a separate frame for the IDLWAVE shell buffer, call
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2414 @code{idlwave-shell} with a prefix argument: @kbd{C-u C-c C-s} or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2415 @kbd{C-u C-c C-l}. If you always want a dedicated frame for the shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2416 window, configure the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2417 @code{idlwave-shell-use-dedicated-frame}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2418
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2419 To launch a quick IDLWAVE shell directly from a shell prompt without
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2420 an IDLWAVE buffer (e.g., as a replacement for running inside an
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2421 xterm), define a system alias with the following content:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2422
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2423 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2424 emacs -geometry 80x32 -eval "(idlwave-shell 'quick)"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2425 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2426
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2427 Replace the @samp{-geometry 80x32} option with @samp{-nw} if you prefer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2428 the Emacs process to run directly inside the terminal window.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2429
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2430 @cindex ENVI
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2431 @cindex IDL> Prompt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2432
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2433 To use IDLWAVE with ENVI or other custom packages which change the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2434 @samp{IDL> } prompt, you must change the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2435 @code{idlwave-shell-prompt-pattern}, which defaults to @samp{"^ ?IDL>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2436 "}. Normally, you can just replace the @samp{IDL} in this expression
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2437 with the prompt you see. A suitable pattern which matches the prompt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2438 for both ENVI and IDL simultaneously is @samp{"^ ?\\(ENVI\\|IDL\\)> "}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2439
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2440 @defopt idlwave-shell-explicit-file-name (@file{idl})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2441 This is the command to run IDL.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2442 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2443
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2444 @defopt idlwave-shell-command-line-options
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2445 A list of command line options for calling the IDL program.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2446 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2447
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2448 @defopt idlwave-shell-prompt-pattern
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2449 Regexp to match IDL prompt at beginning of a line.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2450 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2451
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2452 @defopt idlwave-shell-process-name
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2453 Name to be associated with the IDL process.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2454 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2455
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2456 @defopt idlwave-shell-automatic-start (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2457 Non-@code{nil} means attempt to invoke idlwave-shell if not already
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2458 running.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2459 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2460
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2461 @defopt idlwave-shell-initial-commands
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2462 Initial commands, separated by newlines, to send to IDL.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2463 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2464
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2465 @defopt idlwave-shell-save-command-history (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2466 Non-@code{nil} means preserve command history between sessions.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2467 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2468
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2469 @defopt idlwave-shell-command-history-file (@file{~/.idlwave/.idlwhist})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2470 The file in which the command history of the idlwave shell is saved.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2471 Unless it's an absolute path, it goes in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2472 @code{idlwave-config-directory}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2473 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2474
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2475 @defopt idlwave-shell-use-dedicated-frame (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2476 Non-@code{nil} means IDLWAVE should use a special frame to display the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2477 shell buffer.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2478 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2479
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2480 @defopt idlwave-shell-use-dedicated-window (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2481 Non-@code{nil} means use a dedicated window for the shell, taking care
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2482 not it replace it with other buffers.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2483 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2484
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2485 @defopt idlwave-shell-frame-parameters
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2486 The frame parameters for a dedicated idlwave-shell frame.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2487 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2488
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2489 @defopt idlwave-shell-raise-frame (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2490 Non-@code{nil} means `idlwave-shell' raises the frame showing the shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2491 window.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2492 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2493
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2494 @defopt idlwave-shell-temp-pro-prefix
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2495 The prefix for temporary IDL files used when compiling regions.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2496 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2497
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2498 @cindex Hooks
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2499 @defopt idlwave-shell-mode-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2500 Hook for customizing @code{idlwave-shell-mode}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2501 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2502
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2503 @node Using the Shell, Commands Sent to the Shell, Starting the Shell, The IDLWAVE Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2504 @section Using the Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2505 @cindex Comint
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2506 @cindex Shell, basic commands
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2507
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2508 The IDLWAVE shell works in the same fashion as other shell modes in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2509 Emacs. It provides command history, command line editing and job
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2510 control. The @key{UP} and @key{DOWN} arrows cycle through the input
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2511 history just like in an X terminal@footnote{This is different from
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2512 normal Emacs/Comint behavior, but more like an xterm. If you prefer the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2513 default comint functionality, check the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2514 @code{idlwave-shell-arrows-do-history}.}. The history is preserved
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2515 between emacs and IDL sessions. Here is a list of commonly used
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2516 commands:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2517
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2518 @multitable @columnfractions .12 .88
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2519 @item @key{UP}, @key{M-p}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2520 @tab Cycle backwards in input history
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2521 @item @key{DOWN}, @key{M-n}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2522 @tab Cycle forwards in input history
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2523 @item @kbd{M-r}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2524 @tab Previous input matching a regexp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2525 @item @kbd{M-s}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2526 @tab Next input matching a regexp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2527 @item @kbd{return}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2528 @tab Send input or copy line to current prompt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2529 @item @kbd{C-c C-a}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2530 @tab Beginning of line; skip prompt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2531 @item @kbd{C-c C-u}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2532 @tab Kill input to beginning of line
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2533 @item @kbd{C-c C-w}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2534 @tab Kill word before cursor
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2535 @item @kbd{C-c C-c}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2536 @tab Send ^C
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2537 @item @kbd{C-c C-z}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2538 @tab Send ^Z
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2539 @item @kbd{C-c C-\}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2540 @tab Send ^\
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2541 @item @kbd{C-c C-o}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2542 @tab Delete last batch of process output
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2543 @item @kbd{C-c C-r}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2544 @tab Show last batch of process output
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2545 @item @kbd{C-c C-l}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2546 @tab List input history
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2547 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2548
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2549 In addition to these standard @file{comint} commands,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2550 @code{idlwave-shell-mode} provides many of the same commands which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2551 simplify writing IDL code available in IDLWAVE buffers. This includes
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2552 abbreviations, online help, and completion. See @ref{Routine Info} and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2553 @ref{Online Help} and @ref{Completion} for more information on these
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2554 commands.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2555
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2556 @cindex Completion, in the shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2557 @cindex Routine info, in the shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2558 @cindex Online Help, in the shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2559 @multitable @columnfractions .12 .88
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2560 @item @kbd{@key{TAB}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2561 @tab Completion of file names (between quotes and after executive
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2562 commands @samp{.run} and @samp{.compile}), routine names, class names,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2563 keywords, system variables, system variable tags etc.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2564 (@code{idlwave-shell-complete}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2565 @item @kbd{M-@key{TAB}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2566 @tab Same as @key{TAB}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2567 @item @kbd{C-c ?}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2568 @tab Routine Info display (@code{idlwave-routine-info})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2569 @item @kbd{M-?}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2570 @tab IDL online help on routine (@code{idlwave-routine-info-from-idlhelp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2571 @item @kbd{C-c C-i}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2572 @tab Update routine info from buffers and shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2573 (@code{idlwave-update-routine-info})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2574 @item @kbd{C-c C-v}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2575 @tab Find the source file of a routine (@code{idlwave-find-module})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2576 @item @kbd{C-c C-t}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2577 @tab Find the source file of a routine in the currently visited file
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2578 (@code{idlwave-find-module-this-file}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2579 @item @kbd{C-c =}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2580 @tab Compile a library routine (@code{idlwave-resolve})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2581 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2582
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2583 @defopt idlwave-shell-arrows-do-history (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2584 Non-@code{nil} means @key{UP} and @key{DOWN} arrows move through command
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2585 history like xterm.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2586 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2587
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2588 @defopt idlwave-shell-comint-settings
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2589 Alist of special settings for the comint variables in the IDLWAVE Shell.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2590 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2591
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2592 @defopt idlwave-shell-file-name-chars
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2593 The characters allowed in file names, as a string. Used for file name
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2594 completion.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2595 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2596
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2597 @defopt idlwave-shell-graphics-window-size
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2598 Size of IDL graphics windows popped up by special IDLWAVE command.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2599 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2600
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2601 @cindex Input mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2602 @cindex Character input mode (Shell)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2603 @cindex Line input mode (Shell)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2604 @cindex Magic spells, for input mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2605 @cindex Spells, magic
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2606 IDLWAVE works in line input mode: You compose a full command line, using
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2607 all the power Emacs gives you to do this. When you press @key{RET}, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2608 whole line is sent to IDL. Sometimes it is necessary to send single
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2609 characters (without a newline), for example when an IDL program is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2610 waiting for single character input with the @code{GET_KBRD} function.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2611 You can send a single character to IDL with the command @kbd{C-c C-x}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2612 (@code{idlwave-shell-send-char}). When you press @kbd{C-c C-y}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2613 (@code{idlwave-shell-char-mode-loop}), IDLWAVE runs a blocking loop
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2614 which accepts characters and immediately sends them to IDL. The loop
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2615 can be exited with @kbd{C-g}. It terminates also automatically when the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2616 current IDL command is finished. Check the documentation of the two
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2617 variables described below for a way to make IDL programs trigger
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2618 automatic switches of the input mode.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2619
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2620 @defopt idlwave-shell-use-input-mode-magic (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2621 Non-@code{nil} means IDLWAVE should check for input mode spells in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2622 output.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2623 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2624
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2625 @defopt idlwave-shell-input-mode-spells
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2626 The three regular expressions which match the magic spells for input
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2627 modes.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2628 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2629
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2630 @node Commands Sent to the Shell, Debugging IDL Programs, Using the Shell, The IDLWAVE Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2631 @section Commands Sent to the Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2632 @cindex Commands in shell, showing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2633 @cindex Showing commands in shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2634
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2635 The IDLWAVE buffers and shell interact very closely. In addition to the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2636 normal commands you enter at the @code{IDL>} prompt, many other special
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2637 commands are sent to the shell, sometimes as a direct result of invoking
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2638 a key command, menu item, or toolbar button, but also automatically, as
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2639 part of the normal flow of information updates between the buffer and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2640 shell.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2641
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2642 The commands sent include @code{breakpoint}, @code{.step} and other
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2643 debug commands (@pxref{Debugging IDL Programs}), @code{.run} and other
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2644 compilation statements (@pxref{Compiling Programs}), examination
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2645 commands like @code{print} and @code{help} (@pxref{Examining
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2646 Variables}), and other special purpose commands designed to keep
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2647 information on the running shell current.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2648
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2649 By default, much of this background shell input and output is hidden
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2650 from the user, but this is configurable. The custom variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2651 @code{idlwave-abbrev-show-commands} allows you to configure which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2652 commands sent to the shell are shown there. For a related customization
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2653 for separating the output of @emph{examine} commands, see @ref{Examining
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2654 Variables}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2655
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2656 @defopt idlwave-shell-show-commands (@code{'(run misc breakpoint)})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2657 A list of command types to echo in the shell when sent. Possible values
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2658 are @code{run} for @code{.run}, @code{.compile} and other run commands,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2659 @code{misc} for lesser used commands like @code{window},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2660 @code{retall},@code{close}, etc., @code{breakpoint} for breakpoint
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2661 setting and clearing commands, and @code{debug} for other debug,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2662 stepping, and continue commands. In addition, if the variable is set to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2663 the single symbol @code{'everything}, all the copious shell input is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2664 displayed (which is probably only useful for debugging purposes).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2665 N.B. For hidden commands which produce output by side-effect, that
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2666 output remains hidden (e.g., stepping through a @code{print} command).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2667 As a special case, any error message in the output will be displayed
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2668 (e.g., stepping to an error).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2669 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2670
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2671 @node Debugging IDL Programs, Examining Variables, Commands Sent to the Shell, The IDLWAVE Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2672 @section Debugging IDL Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2673 @cindex Debugging
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2674 @cindex Keybindings for debugging
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2675 @cindex Toolbar
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2676
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2677 Programs can be compiled, run, and debugged directly from the source
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2678 buffer in Emacs, walking through arbitrarily deeply nested code,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2679 printing expressions and skipping up and down the calling stack along
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2680 the way. IDLWAVE makes compiling and debugging IDL programs far less
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2681 cumbersome by providing a full-featured, key/menu/toolbar-driven
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2682 interface to commands like @code{breakpoint}, @code{.step},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2683 @code{.run}, etc. It can even perform complex debug operations not
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2684 natively supported by IDL (like continuing to the line at the cursor).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2685
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2686 The IDLWAVE shell installs key bindings both in the shell buffer and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2687 in all IDL code buffers of the current Emacs session, so debug
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2688 commands work in both places (in the shell, commands operate on the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2689 last file compiled). On Emacs versions which support it, a debugging
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2690 toolbar is also installed. The toolbar display can be toggled with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2691 @kbd{C-c C-d C-t} (@code{idlwave-shell-toggle-toolbar}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2692
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2693
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2694 @defopt idlwave-shell-use-toolbar (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2695 Non-@code{nil} means use the debugging toolbar in all IDL related
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2696 buffers.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2697 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2698
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2699 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2700 * A Tale of Two Modes::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2701 * Debug Key Bindings::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2702 * Breakpoints and Stepping::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2703 * Compiling Programs::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2704 * Walking the Calling Stack::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2705 * Electric Debug Mode::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2706 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2707
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2708
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2709 @node A Tale of Two Modes, Debug Key Bindings, Debugging IDL Programs, Debugging IDL Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2710 @subsection A Tale of Two Modes
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2711 @cindex Electric Debug Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2712 @cindex Debugging Interface
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2713
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2714 The many debugging, compiling, and examination commands provided in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2715 IDLWAVE are available simultaneously through two different interfaces:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2716 the original, multi-key command interface, and the new Electric Debug
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2717 Mode. The functionality they offer is similar, but the way you interact
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2718 with them is quite different. The main difference is that, in Electric
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2719 Debug Mode, the source buffers are made read-only, and single
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2720 key-strokes are used to step through, examine expressions, set and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2721 remove breakpoints, etc. The same variables, prefix arguments, and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2722 settings apply to both versions, and both can be used interchangeably.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2723 By default, when breakpoints are hit, Electric Debug Mode is enabled.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2724 The traditional interface is described first. @xref{Electric Debug
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2725 Mode}, for more on that mode. Note that electric debug mode can be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2726 prevented from activating automatically by customizing the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2727 @code{idlwave-shell-automatic-electric-debug}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2728
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2729 @node Debug Key Bindings, Breakpoints and Stepping, A Tale of Two Modes, Debugging IDL Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2730 @subsection Debug Key Bindings
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2731 @kindex C-c C-d
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2732 @cindex Key bindings
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2733
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2734 The standard debugging key bindings are always available by default on
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2735 the prefix key @kbd{C-c C-d}, so, for example, setting a breakpoint is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2736 done with @kbd{C-c C-d C-b}, and compiling a source file with @kbd{C-c
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2737 C-d C-c}. You can also easily configure IDLWAVE to use one or more
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2738 modifier keys not in use by other commands, in lieu of the prefix
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2739 @kbd{C-c C-d} (though these bindings will typically also be available
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2740 --- see @code{idlwave-shell-activate-prefix-keybindings}). For
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2741 example, if you include in @file{.emacs}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2742
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2743 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2744 (setq idlwave-shell-debug-modifiers '(control shift))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2745 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2746
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2747 @noindent a breakpoint can then be set by pressing @kbd{b} while holding down
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2748 @kbd{shift} and @kbd{control} keys, i.e. @kbd{C-S-b}. Compiling a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2749 source file will be on @kbd{C-S-c}, deleting a breakpoint @kbd{C-S-d},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2750 etc. In the remainder of this chapter we will assume that the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2751 @kbd{C-c C-d} bindings are active, but each of these bindings will
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2752 have an equivalent shortcut if modifiers are given in the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2753 @code{idlwave-shell-debug-modifiers} variable (@pxref{Lesson II --
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2754 Customization}). A much simpler and faster form of debugging for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2755 running code is also available by default --- see @ref{Electric Debug
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2756 Mode}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2757
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2758 @defopt idlwave-shell-prefix-key (@kbd{C-c C-d})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2759 The prefix key for the debugging map
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2760 @code{idlwave-shell-mode-prefix-map}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2761 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2762
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2763 @defopt idlwave-shell-activate-prefix-keybindings (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2764 Non-@code{nil} means debug commands will be bound to the prefix
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2765 key, like @kbd{C-c C-d C-b}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2766 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2767
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2768 @defopt idlwave-shell-debug-modifiers (@code{nil})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2769 List of modifier keys to use for additional, alternative binding of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2770 debugging commands in the shell and source buffers. Can be one or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2771 more of @code{control}, @code{meta}, @code{super}, @code{hyper},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2772 @code{alt}, and @code{shift}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2773 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2774
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2775 @node Breakpoints and Stepping, Compiling Programs, Debug Key Bindings, Debugging IDL Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2776 @subsection Breakpoints and Stepping
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2777 @cindex Breakpoints
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2778 @cindex Stepping
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2779 @cindex Execution, controlled
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2780
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2781 @kindex C-c C-d C-b
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2782 @kindex C-c C-d C-b
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2783 IDLWAVE helps you set breakpoints and step through code. Setting a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2784 breakpoint in the current line of the source buffer is accomplished
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2785 with @kbd{C-c C-d C-b} (@code{idlwave-shell-break-here}). With a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2786 prefix arg of 1 (i.e. @kbd{C-1 C-c C-d C-b}), the breakpoint gets a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2787 @code{/ONCE} keyword, meaning that it will be deleted after first use.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2788 With a numeric prefix greater than one (e.g. @kbd{C-4 C-c C-d C-b}),
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2789 the breakpoint will only be active the @code{nth} time it is hit.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2790 With a single non-numeric prefix (i.e. @kbd{C-u C-c C-d C-b}), prompt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2791 for a condition --- an IDL expression to be evaluated and trigger the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2792 breakpoint only if true. To clear the breakpoint in the current line,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2793 use @kbd{C-c C-d C-d} (@code{idlwave-clear-current-bp}). When
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2794 executed from the shell window, the breakpoint where IDL is currently
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2795 stopped will be deleted. To clear all breakpoints, use @kbd{C-c C-d
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2796 C-a} (@code{idlwave-clear-all-bp}). Breakpoints can also be disabled
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2797 and re-enabled: @kbd{C-c C-d C-\}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2798 (@code{idlwave-shell-toggle-enable-current-bp}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2799
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2800 Breakpoint lines are highlighted or indicated with an icon in the source
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2801 code (different icons for conditional, after, and other break types).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2802 Disabled breakpoints are @emph{grayed out} by default. Note that IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2803 places breakpoints as close as possible on or after the line you
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2804 specify. IDLWAVE queries the shell for the actual breakpoint location
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2805 which was set, so the exact line you specify may not be marked. You can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2806 re-sync the breakpoint list and update the display at any time (e.g., if
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2807 you add or remove some on the command line) using @kbd{C-c C-d C-l}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2808
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2809 In recent IDLWAVE versions, the breakpoint line is highlighted when the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2810 mouse is moved over it, and a tooltip pops up describing the break
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2811 details. @kbd{Mouse-3} on the breakpoint line pops up a menu of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2812 breakpoint actions, including clearing, disabling, and adding or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2813 changing break conditions or ``after'' break count.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2814
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2815 Once the program has stopped somewhere, you can step through it. The
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2816 most important stepping commands are @kbd{C-c C-d C-s} to execute one
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2817 line of IDL code ("step into"); @kbd{C-c C-d C-n} to step a single line,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2818 treating procedure and function calls as a single step ("step over");
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2819 @kbd{C-c C-d C-h} to continue execution to the line at the cursor and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2820 @kbd{C-c C-d C-r} to continue execution. @xref{Commands Sent to the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2821 Shell}, for information on displaying or hiding the breakpoint and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2822 stepping commands the shell receives. Here is a summary of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2823 breakpoint and stepping commands:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2824
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2825 @multitable @columnfractions .23 .77
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2826 @item @kbd{C-c C-d C-b}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2827 @tab Set breakpoint (@code{idlwave-shell-break-here})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2828 @item @kbd{C-c C-d C-i}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2829 @tab Set breakpoint in module named here (@code{idlwave-shell-break-in})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2830 @item @kbd{C-c C-d C-d}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2831 @tab Clear current breakpoint (@code{idlwave-shell-clear-current-bp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2832 @item @kbd{C-c C-d C-a}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2833 @tab Clear all breakpoints (@code{idlwave-shell-clear-all-bp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2834 @item @kbd{C-c C-d [}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2835 @tab Go to the previous breakpoint (@code{idlwave-shell-goto-previous-bp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2836 @item @kbd{C-c C-d ]}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2837 @tab Go to the next breakpoint (@code{idlwave-shell-goto-next-bp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2838 @item @kbd{C-c C-d C-\}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2839 @tab Disable/Enable current breakpoint (@code{idlwave-shell-toggle-enable-current-bp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2840 @item @kbd{C-c C-d C-j}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2841 @tab Set a breakpoint at the beginning of the enclosing routine.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2842 @item @kbd{C-c C-d C-s}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2843 @tab Step, into function calls (@code{idlwave-shell-step})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2844 @item @kbd{C-c C-d C-n}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2845 @tab Step, over function calls (@code{idlwave-shell-stepover})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2846 @item @kbd{C-c C-d C-k}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2847 @tab Skip one statement (@code{idlwave-shell-skip})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2848 @item @kbd{C-c C-d C-u}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2849 @tab Continue to end of block (@code{idlwave-shell-up})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2850 @item @kbd{C-c C-d C-m}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2851 @tab Continue to end of function (@code{idlwave-shell-return})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2852 @item @kbd{C-c C-d C-o}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2853 @tab Continue past end of function (@code{idlwave-shell-out})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2854 @item @kbd{C-c C-d C-h}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2855 @tab Continue to line at cursor position (@code{idlwave-shell-to-here})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2856 @item @kbd{C-c C-d C-r}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2857 @tab Continue execution to next breakpoint, if any (@code{idlwave-shell-cont})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2858 @item @kbd{C-c C-d C-up}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2859 @tab Show higher level in calling stack (@code{idlwave-shell-stack-up})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2860 @item @kbd{C-c C-d C-down}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2861 @tab Show lower level in calling stack (@code{idlwave-shell-stack-down})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2862 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2863
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2864 All of these commands have equivalents in Electric Debug Mode, which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2865 provides faster single-key access (@pxref{Electric Debug Mode}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2866
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2867 The line where IDL is currently stopped, at breakpoints, halts, and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2868 errors, etc., is marked with a color overlay or arrow, depending on the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2869 setting in @code{idlwave-shell-mark-stop-line}. If an overlay face is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2870 used to mark the stop line (as it is by default), when stepping through
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2871 code, the face color is temporarily changed to gray, until IDL completes
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2872 the next command and moves to the new line.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2873
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2874 @defopt idlwave-shell-mark-breakpoints (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2875 Non-@code{nil} means mark breakpoints in the source file buffers. The
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2876 value indicates the preferred method. Valid values are @code{nil},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2877 @code{t}, @code{face}, and @code{glyph}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2878 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2879
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2880 @defopt idlwave-shell-breakpoint-face
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2881 The face for breakpoint lines in the source code if
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2882 @code{idlwave-shell-mark-breakpoints} has the value @code{face}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2883 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2884
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2885 @defopt idlwave-shell-breakpoint-popup-menu (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2886 Whether to pop-up a menu and present a tooltip description on
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2887 breakpoint lines.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2888 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2889
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2890 @defopt idlwave-shell-mark-stop-line (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2891 Non-@code{nil} means mark the source code line where IDL is currently
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2892 stopped. The value specifies the preferred method. Valid values are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2893 @code{nil}, @code{t}, @code{arrow}, and @code{face}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2894 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2895
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2896 @defopt idlwave-shell-overlay-arrow (@code{">"})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2897 The overlay arrow to display at source lines where execution halts, if
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2898 configured in @code{idlwave-shell-mark-stop-line}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2899 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2900
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2901 @defopt idlwave-shell-stop-line-face
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2902 The face which highlights the source line where IDL is stopped, if
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2903 configured in @code{idlwave-shell-mark-stop-line}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2904 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2905
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2906
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2907 @node Compiling Programs, Walking the Calling Stack, Breakpoints and Stepping, Debugging IDL Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2908 @subsection Compiling Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2909 @cindex Compiling programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2910 @cindex Programs, compiling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2911 @cindex Default command line, executing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2912 @cindex Executing a default command line
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2913
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2914 @kindex C-c C-d C-c
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2915 In order to compile the current buffer under the IDLWAVE shell, press
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2916 @kbd{C-c C-d C-c} (@code{idlwave-save-and-run}). This first saves the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2917 current buffer and then sends the command @samp{.run path/to/file} to the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2918 shell. You can also execute @kbd{C-c C-d C-c} from the shell buffer, in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2919 which case the most recently compiled buffer will be saved and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2920 re-compiled.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2921
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2922 When developing or debugging a program, it is often necessary to execute
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2923 the same command line many times. A convenient way to do this is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2924 @kbd{C-c C-d C-y} (@code{idlwave-shell-execute-default-command-line}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2925 This command first resets IDL from a state of interrupted execution by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2926 closing all files and returning to the main interpreter level. Then a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2927 default command line is send to the shell. To edit the default command
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2928 line, call @code{idlwave-shell-execute-default-command-line} with a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2929 prefix argument: @kbd{C-u C-c C-d C-y}. If no default command line has
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2930 been set (or you give two prefix arguments), the last command on the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2931 @code{comint} input history is sent.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2932
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2933 @kindex C-c C-d C-e
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2934 @cindex Compiling regions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2935 For quickly compiling and running the currently marked region as a main
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2936 level program @kbd{C-c C-d C-e} (@code{idlwave-shell-run-region}) is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2937 very useful. A temporary file is created holding the contents of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2938 current region (with @code{END} appended), and run from the shell.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2939
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2940 @node Walking the Calling Stack, Electric Debug Mode, Compiling Programs, Debugging IDL Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2941 @subsection Walking the Calling Stack
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2942 @cindex Calling stack, walking
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2943
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2944 While debugging a program, it can be very useful to check the context in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2945 which the current routine was called, for instance to help understand
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2946 the value of the arguments passed. To do so conveniently you need to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2947 examine the calling stack. If execution is stopped somewhere deep in a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2948 program, you can use the commands @kbd{C-c C-d C-@key{UP}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2949 (@code{idlwave-shell-stack-up}) and @kbd{C-c C-d C-@key{DOWN}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2950 (@code{idlwave-shell-stack-down}), or the corresponding toolbar buttons,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2951 to move up or down through the calling stack. The mode line of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2952 shell window will indicate the position within the stack with a label
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2953 like @samp{[-3:MYPRO]}. The line of IDL code at that stack position
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2954 will be highlighted. If you continue execution, IDLWAVE will
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2955 automatically return to the current level. @xref{Examining Variables},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2956 for information how to examine the value of variables and expressions on
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2957 higher calling stack levels.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2958
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2959 @html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2960 <A NAME="EDEBUG"></A>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2961 @end html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2962 @node Electric Debug Mode, , Walking the Calling Stack, Debugging IDL Programs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2963 @subsection Electric Debug Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2964 @cindex Electric Debug Mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2965 @cindex @samp{*Debugging*}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2966
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2967 Even with a convenient debug key prefix enabled, repetitive stepping,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2968 variable examination (@pxref{Examining Variables}), and other debugging
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2969 activities can be awkward and slow using commands which require multiple
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2970 keystrokes. Luckily, there's a better way, inspired by the lisp e-debug
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2971 mode, and available through the @emph{Electric Debug Mode}. By default,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2972 as soon as a breakpoint is hit, this minor mode is enabled. The buffer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2973 showing the line where execution has halted is switched to Electric
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2974 Debug Mode. This mode is visible as @samp{*Debugging*} in the mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2975 line, and a different face (violet by default, if color is available)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2976 for the line stopped at point. The buffer is made read-only and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2977 single-character bindings for the most commonly used debugging commands
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2978 are enabled. These character commands (a list of which is available
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2979 with @kbd{C-?}) are:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2980
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2981 @multitable @columnfractions .2 .8
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2982 @item @kbd{a}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2983 @tab Clear all breakpoints (@code{idlwave-shell-clear-all-bp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2984 @item @kbd{b}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2985 @tab Set breakpoint, @kbd{C-u b} for a conditional break, @kbd{C-n b} for nth hit (@code{idlwave-shell-break-here})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2986 @item @kbd{d}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2987 @tab Clear current breakpoint (@code{idlwave-shell-clear-current-bp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2988 @item @kbd{e}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2989 @tab Prompt for expression to print (@code{idlwave-shell-clear-current-bp}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2990 @item @kbd{h}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2991 @tab Continue to the line at cursor position (@code{idlwave-shell-to-here})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2992 @item @kbd{i}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2993 @tab Set breakpoint in module named here (@code{idlwave-shell-break-in})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2994 @item @kbd{[}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2995 @tab Go to the previous breakpoint in the file (@code{idlwave-shell-goto-previous-bp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2996 @item @kbd{]}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2997 @tab Go to the next breakpoint in the file
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2998 (@code{idlwave-shell-goto-next-bp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
2999 @item @kbd{\}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3000 @tab Disable/Enable current breakpoint (@code{idlwave-shell-toggle-enable-current-bp})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3001 @item @kbd{j}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3002 @tab Set breakpoint at beginning of enclosing routine (@code{idlwave-shell-break-this-module})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3003 @item @kbd{k}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3004 @tab Skip one statement (@code{idlwave-shell-skip})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3005 @item @kbd{m}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3006 @tab Continue to end of function (@code{idlwave-shell-return})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3007 @item @kbd{n}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3008 @tab Step, over function calls (@code{idlwave-shell-stepover})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3009 @item @kbd{o}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3010 @tab Continue past end of function (@code{idlwave-shell-out})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3011 @item @kbd{p}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3012 @tab Print expression near point or in region with @kbd{C-u p} (@code{idlwave-shell-print})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3013 @item @kbd{q}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3014 @tab End the debugging session and return to the Shell's main level
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3015 (@code{idlwave-shell-retall})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3016 @item @kbd{r}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3017 @tab Continue execution to next breakpoint, if any (@code{idlwave-shell-cont})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3018 @item @kbd{s} or @kbd{@key{SPACE}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3019 @tab Step, into function calls (@code{idlwave-shell-step})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3020 @item @kbd{t}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3021 @tab Print a calling-level traceback in the shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3022 @item @kbd{u}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3023 @tab Continue to end of block (@code{idlwave-shell-up})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3024 @item @kbd{v}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3025 @tab Turn Electric Debug Mode off
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3026 (@code{idlwave-shell-electric-debug-mode})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3027 @item @kbd{x}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3028 @tab Examine expression near point (or in region with @kbd{C-u x})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3029 with shortcut of examine type.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3030 @item @kbd{z}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3031 @tab Reset IDL (@code{idlwave-shell-reset})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3032 @item @kbd{+} or @kbd{=}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3033 @tab Show higher level in calling stack (@code{idlwave-shell-stack-up})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3034 @item @kbd{-} or @kbd{_}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3035 @tab Show lower level in calling stack (@code{idlwave-shell-stack-down})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3036 @item @kbd{?}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3037 @tab Help on expression near point or in region with @kbd{C-u ?}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3038 (@code{idlwave-shell-help-expression})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3039 @item @kbd{C-?}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3040 @tab Show help on the commands available.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3041 @end multitable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3042
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3043 Most single-character electric debug bindings use the final keystroke
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3044 of the equivalent multiple key commands (which are of course also
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3045 still available), but some differ (e.g. @kbd{e},@kbd{t},@kbd{q},@kbd{x}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3046 Some have additional convenience bindings (like @kbd{@key{SPACE}} for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3047 stepping). All prefix and other argument options described in this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3048 section for the commands invoked by electric debug bindings are still
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3049 valid. For example, @kbd{C-u b} sets a conditional breakpoint, just
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3050 as it did with @kbd{C-u C-c C-d C-b}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3051
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3052 You can toggle the electric debug mode at any time in a buffer using
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3053 @kbd{C-c C-d C-v} (@kbd{v} to turn it off while in the mode), or from
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3054 the Debug menu. Normally the mode will be enabled and disabled at the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3055 appropriate times, but occasionally you might want to edit a file
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3056 while still debugging it, or switch to the mode for conveniently
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3057 setting lots of breakpoints.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3058
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3059 To quickly abandon a debugging session and return to normal editing at
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3060 the Shell's main level, use @kbd{q} (@code{idlwave-shell-retall}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3061 This disables electric debug mode in all IDLWAVE buffers@footnote{Note
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3062 that this binding is not symmetric: @kbd{C-c C-d C-q} is bound to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3063 @code{idlwave-shell-quit}, which quits your IDL session.}. Help is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3064 available for the command shortcuts with @kbd{C-?}. If you find this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3065 mode gets in your way, you can keep it from automatically activating
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3066 by setting the variable @code{idlwave-shell-automatic-electric-debug}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3067 to @code{nil}, or @code{'breakpoint}. If you'd like the convenient
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3068 electric debug shortcuts available also when run-time errors are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3069 encountered, set to @code{t}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3070
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3071 @defopt idlwave-shell-automatic-electric-debug (@code{'breakpoint})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3072 Whether to enter electric debug mode automatically when a breakpoint
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3073 or run-time error is encountered, and then disable it in all buffers
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3074 when the $MAIN$ level is reached (either through normal program
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3075 execution, or retall). In addition to @code{nil} for never, and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3076 @code{t} for both breakpoints and errors, this can be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3077 @code{'breakpoint} (the default) to enable it only at breakpoint
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3078 halts.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3079 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3080
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3081 @defopt idlwave-shell-electric-stop-color (Violet)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3082 Default color of the stopped line overlay when in electric debug mode.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3083 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3084
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3085 @defopt idlwave-shell-electric-stop-line-face
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3086 The face to use for the stopped line. Defaults to a face similar to the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3087 modeline, with color @code{idlwave-shell-electric-stop-color}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3088 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3089
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3090 @defopt idlwave-shell-electric-zap-to-file (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3091 If set, when entering electric debug mode, select the window displaying
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3092 the file where point is stopped. This takes point away from the shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3093 window, but is useful for immediate stepping, etc.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3094 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3095
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3096 @html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3097 <A NAME="EXAMINE"></A>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3098 @end html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3099 @node Examining Variables, Custom Expression Examination, Debugging IDL Programs, The IDLWAVE Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3100 @section Examining Variables
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3101 @cindex @code{PRINT} expressions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3102 @cindex @code{HELP}, on expressions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3103 @cindex Expressions, printing & help
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3104 @cindex Examining expressions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3105 @cindex Printing expressions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3106 @cindex Mouse binding to print expressions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3107
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3108 @kindex C-c C-d C-p
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3109 Do you find yourself repeatedly typing, e.g. @code{print,n_elements(x)},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3110 and similar statements to remind yourself of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3111 type/size/structure/value/etc. of variables and expressions in your code
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3112 or at the command line? IDLWAVE has a suite of special commands to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3113 automate these types of variable or expression examinations. They work
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3114 by sending statements to the shell formatted to include the indicated
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3115 expression, and can be accessed in several ways.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3116
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3117 These @emph{examine} commands can be used in the shell or buffer at any
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3118 time (as long as the shell is running), and are very useful when
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3119 execution is stopped in a buffer due to a triggered breakpoint or error,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3120 or while composing a long command in the IDLWAVE shell. In the latter
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3121 case, the command is sent to the shell and its output is visible, but
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3122 point remains unmoved in the command being composed --- you can inspect
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3123 the constituents of a command you're building without interrupting the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3124 process of building it! You can even print arbitrary expressions from
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3125 older input or output further up in the shell window --- any expression,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3126 variable, number, or function you see can be examined.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3127
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3128 If the variable @code{idlwave-shell-separate-examine-output} is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3129 non-@code{nil} (the default), all examine output will be sent to a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3130 special @file{*Examine*} buffer, rather than the shell. The output of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3131 prior examine commands is saved in this buffer. In this buffer @key{c}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3132 clears the contents, and @key{q} hides the buffer.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3133
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3134 The two most basic examine commands are bound to @kbd{C-c C-d C-p}, to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3135 print the expression at point, and @kbd{C-c C-d ?}, to invoke help on
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3136 this expression@footnote{Available as @kbd{p} and @kbd{?} in Electric
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3137 Debug Mode (@pxref{Electric Debug Mode})}. The expression at point is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3138 either an array expression or a function call, or the contents of a pair
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3139 of parentheses. The chosen expression is highlighted, and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3140 simultaneously the resulting output is highlighted in the shell or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3141 separate output buffer. Calling the above commands with a prefix
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3142 argument will use the current region as expression instead of using the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3143 one at point. which can be useful for examining complicated, multi-line
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3144 expressions. Two prefix arguments (@kbd{C-u C-u C-c C-d C-p}) will
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3145 prompt for an expression to print directly. By default, when invoking
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3146 print, only an initial portion of long arrays will be printed, up to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3147 @code{idlwave-shell-max-print-length}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3148
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3149 For added speed and convenience, there are mouse bindings which allow
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3150 you to click on expressions and examine their values. Use
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3151 @kbd{S-Mouse-2} to print an expression and @kbd{C-M-Mouse-2} to invoke
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3152 help (i.e. you need to hold down @key{META} and @key{CONTROL} while
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3153 clicking with the middle mouse button). If you simply click, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3154 nearest expression will be selected in the same manner as described
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3155 above. You can also @emph{drag} the mouse in order to highlight
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3156 exactly the specific expression or sub-expression you want to examine.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3157 For custom expression examination, and the powerful customizable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3158 pop-up examine selection, @xref{Custom Expression Examination}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3159
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3160 @cindex Printing expressions, on calling stack
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3161 @cindex Restrictions for expression printing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3162 The same variable inspection commands work both in the IDL Shell and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3163 IDLWAVE buffers, and even for variables at higher levels of the calling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3164 stack. For instance, if you're stopped at a breakpoint in a routine,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3165 you can examine the values of variables and expressions inside its
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3166 calling routine, and so on, all the way up through the calling stack.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3167 Simply step up the stack, and print variables as you see them
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3168 (@pxref{Walking the Calling Stack}, for information on stepping back
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3169 through the calling stack). The following restrictions apply for all
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3170 levels except the current:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3171
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3172 @itemize @bullet
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3173 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3174 Array expressions must use the @samp{[ ]} index delimiters. Identifiers
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3175 with a @samp{( )} will be interpreted as function calls.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3176 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3177 @cindex ROUTINE_NAMES, IDL procedure
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3178 N.B.: printing values of expressions on higher levels of the calling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3179 stack uses the @emph{unsupported} IDL routine @code{ROUTINE_NAMES},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3180 which may or may not be available in future versions of IDL. Caveat
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3181 Examinor.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3182 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3183
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3184 @defopt idlwave-shell-expression-face
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3185 The face for @code{idlwave-shell-expression-overlay}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3186 Allows you to choose the font, color and other properties for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3187 the expression printed by IDL.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3188 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3189
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3190 @defopt idlwave-shell-output-face
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3191 The face for @code{idlwave-shell-output-overlay}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3192 Allows to choose the font, color and other properties for the most
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3193 recent output of IDL when examining an expression."
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3194 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3195
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3196 @defopt idlwave-shell-separate-examine-output (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3197 If non-@code{nil}, re-direct the output of examine commands to a special
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3198 @file{*Examine*} buffer, instead of in the shell itself.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3199 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3200
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3201 @defopt idlwave-shell-max-print-length (200)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3202 The maximum number of leading array entries to print, when examining
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3203 array expressions.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3204 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3205
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3206 @node Custom Expression Examination, , Examining Variables, The IDLWAVE Shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3207 @section Custom Expression Examination
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3208 @cindex Expressions, custom examination
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3209 @cindex Custom expression examination
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3210
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3211 The variety of possible variable and expression examination commands is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3212 endless (just look, for instance, at the keyword list to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3213 @code{widget_info()}). Rather than attempt to include them all, IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3214 provides two easy methods to customize your own commands, with a special
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3215 mouse examine command, and two macros for generating your own examine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3216 key and mouse bindings.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3217
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3218 The most powerful and flexible mouse examine command of all is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3219 available on @kbd{C-S-Mouse-2}. Just as for all the other mouse
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3220 examine commands, it permits click or drag expression selection, but
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3221 instead of sending hard-coded commands to the shell, it pops-up a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3222 customizable selection list of examine functions to choose among,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3223 configured with the @code{idlwave-shell-examine-alist}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3224 variable@footnote{In Electric Debug Mode (@pxref{Electric Debug
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3225 Mode}), the key @kbd{x} provides a single-character shortcut interface
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3226 to the same examine functions for the expression at point or marked by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3227 the region.}. This variable is a list of key-value pairs (an
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3228 @emph{alist} in Emacs parlance), where the key gives a name to be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3229 shown for the examine command, and the value is the command strings
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3230 itself, in which the text @code{___} (three underscores) will be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3231 replaced by the selected expression before being sent to the shell.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3232 An example might be key @code{Structure Help} with value
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3233 @code{help,___,/STRUCTURE}. In that case, you'd be prompted with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3234 @emph{Structure Help}, which might send something like
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3235 @code{help,var,/STRUCTURE} to the shell for output.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3236 @code{idlwave-shell-examine-alist} comes configured by default with a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3237 large list of examine commands, but you can easily customize it to add
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3238 your own.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3239
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3240 In addition to configuring the functions available to the pop-up mouse
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3241 command, you can easily create your own customized bindings to inspect
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3242 expressions using the two convenience macros
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3243 @code{idlwave-shell-examine} and @code{idlwave-shell-mouse-examine}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3244 These create keyboard or mouse-based custom inspections of variables,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3245 sharing all the same properties of the built-in examine commands.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3246 Both functions take a single string argument sharing the syntax of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3247 @code{idlwave-shell-examine-alist} values, e.g.:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3248
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3249 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3250 (add-hook 'idlwave-shell-mode-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3251 (lambda ()
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3252 (idlwave-shell-define-key-both [s-down-mouse-2]
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3253 (idlwave-shell-mouse-examine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3254 "print, size(___,/DIMENSIONS)"))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3255 (idlwave-shell-define-key-both [f9] (idlwave-shell-examine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3256 "print, size(___,/DIMENSIONS)"))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3257 (idlwave-shell-define-key-both [f10] (idlwave-shell-examine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3258 "print,size(___,/TNAME)"))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3259 (idlwave-shell-define-key-both [f11] (idlwave-shell-examine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3260 "help,___,/STRUCTURE"))))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3261 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3262
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3263 @noindent Now pressing @key{f9}, or middle-mouse dragging with the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3264 @key{SUPER} key depressed, will print the dimensions of the nearby or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3265 highlighted expression. Pressing @key{f10} will give the type string,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3266 and @key{f11} will show the contents of a nearby structure. As you can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3267 see, the possibilities are only marginally finite.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3268
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3269 @defopt idlwave-shell-examine-alist
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3270 An alist of examine commands in which the keys name the command and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3271 are displayed in the selection pop-up, and the values are custom IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3272 examine command strings to send, after all instances of @code{___}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3273 (three underscores) are replaced by the indicated expression.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3274 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3275
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3276 @node Acknowledgements, Sources of Routine Info, The IDLWAVE Shell, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3277 @chapter Acknowledgements
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3278 @cindex Acknowledgements
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3279 @cindex Maintainer, of IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3280 @cindex Authors, of IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3281 @cindex Contributors, to IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3282 @cindex Email address, of Maintainer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3283 @cindex Thanks
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3284
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3285 @noindent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3286 The main contributors to the IDLWAVE package have been:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3287
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3288 @itemize @minus
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3289 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3290 @uref{mailto:chase@@att.com, @b{Chris Chase}}, the original author.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3291 Chris wrote @file{idl.el} and @file{idl-shell.el} and maintained them
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3292 for several years.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3293
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3294 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3295 @uref{mailto:dominik@@astro.uva.nl, @b{Carsten Dominik}} was in charge
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3296 of the package from version 3.0, during which time he overhauled almost
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3297 everything, modernized IDLWAVE with many new features, and developed the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3298 manual.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3299
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3300 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3301 @uref{mailto:jdsmith@@as.arizona.edu, @b{J.D. Smith}}, the current
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3302 maintainer, as of version 4.10, helped shape object method completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3303 and most new features introduced in versions 4.x, and introduced many
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3304 new features for IDLWAVE versions 5.x and 6.x.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3305 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3306
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3307 @noindent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3308 The following people have also contributed to the development of IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3309 with patches, ideas, bug reports and suggestions.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3310
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3311 @itemize @minus
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3312 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3313 Ulrik Dickow <dickow__at__nbi.dk>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3314 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3315 Eric E. Dors <edors__at__lanl.gov>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3316 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3317 Stein Vidar H. Haugan <s.v.h.haugan__at__astro.uio.no>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3318 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3319 David Huenemoerder <dph__at__space.mit.edu>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3320 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3321 Kevin Ivory <Kevin.Ivory__at__linmpi.mpg.de>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3322 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3323 Dick Jackson <dick__at__d-jackson.com>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3324 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3325 Xuyong Liu <liu__at__stsci.edu>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3326 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3327 Simon Marshall <Simon.Marshall__at__esrin.esa.it>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3328 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3329 Craig Markwardt <craigm__at__cow.physics.wisc.edu>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3330 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3331 Laurent Mugnier <mugnier__at__onera.fr>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3332 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3333 Lubos Pochman <lubos__at__rsinc.com>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3334 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3335 Bob Portmann <portmann__at__al.noaa.gov>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3336 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3337 Patrick M. Ryan <pat__at__jaameri.gsfc.nasa.gov>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3338 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3339 Marty Ryba <ryba__at__ll.mit.edu>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3340 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3341 Phil Williams <williams__at__irc.chmcc.org>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3342 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3343 Phil Sterne <sterne__at__dublin.llnl.gov>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3344 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3345 Paul Sorenson <aardvark62__at__msn.com>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3346 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3347
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3348 Doug Dirks was instrumental in providing the crucial IDL XML catalog to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3349 support HTML help with IDL v6.2 and later, and Ali Bahrami provided
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3350 scripts and documentation to interface with the IDL Assistant.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3351
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3352 @noindent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3353 Thanks to everyone!
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3354
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3355 @node Sources of Routine Info, HTML Help Browser Tips, Acknowledgements, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3356 @appendix Sources of Routine Info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3357
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3358 @cindex Sources of routine information
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3359 In @ref{Routine Info} and @ref{Completion} we showed how IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3360 displays the calling sequence and keywords of routines, and completes
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3361 routine names and keywords. For these features to work, IDLWAVE must
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3362 know about the accessible routines.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3363
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3364 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3365 * Routine Definitions:: Where IDL Routines are defined.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3366 * Routine Information Sources:: So how does IDLWAVE know about...
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3367 * Catalogs::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3368 * Load-Path Shadows:: Routines defined in several places
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3369 * Documentation Scan:: Scanning the IDL Manuals
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3370 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3371
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3372 @node Routine Definitions, Routine Information Sources, Sources of Routine Info, Sources of Routine Info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3373 @appendixsec Routine Definitions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3374 @cindex Routine definitions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3375 @cindex IDL variable @code{!PATH}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3376 @cindex @code{!PATH}, IDL variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3377 @cindex @code{CALL_EXTERNAL}, IDL routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3378 @cindex @code{LINKIMAGE}, IDL routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3379 @cindex External routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3380
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3381 @noindent Routines which can be used in an IDL program can be defined in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3382 several places:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3383
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3384 @enumerate
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3385 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3386 @emph{Builtin routines} are defined inside IDL itself. The source code
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3387 of such routines is not available, but instead are learned about through
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3388 the IDL documentation.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3389 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3390 Routines which are @emph{part of the current program}, are defined in a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3391 file explicitly compiled by the user. This file may or may not be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3392 located on the IDL search path.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3393 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3394 @emph{Library routines} are defined in files located on IDL's search
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3395 path. When a library routine is called for the first time, IDL will
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3396 find the source file and compile it dynamically. A special sub-category
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3397 of library routines are the @emph{system routines} distributed with IDL,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3398 and usually available in the @file{lib} subdirectory of the IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3399 distribution.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3400 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3401 External routines written in other languages (like Fortran or C) can be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3402 called with @code{CALL_EXTERNAL}, linked into IDL via @code{LINKIMAGE},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3403 or included as dynamically loaded modules (DLMs). Currently IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3404 cannot provide routine info and completion for such external routines,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3405 except by querying the Shell for calling information (DLMs only).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3406 @end enumerate
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3407
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3408 @node Routine Information Sources, Catalogs, Routine Definitions, Sources of Routine Info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3409 @appendixsec Routine Information Sources
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3410 @cindex Routine info sources
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3411 @cindex Builtin list of routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3412 @cindex Updating routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3413 @cindex Scanning buffers for routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3414 @cindex Buffers, scanning for routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3415 @cindex Shell, querying for routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3416
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3417 @noindent To maintain the most comprehensive information about all IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3418 routines on a system, IDLWAVE collects data from many sources:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3419
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3420 @enumerate
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3421
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3422 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3423 It has a @emph{builtin list} with information about the routines IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3424 ships with. IDLWAVE @value{VERSION} is distributed with a list of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3425 @value{NSYSROUTINES} routines and object methods, reflecting IDL version
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3426 @value{IDLVERSION}. As of IDL v6.2, the routine info is distributed
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3427 directly with IDL in the form of an XML catalog which IDLWAVE scans.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3428 Formerly, this list was created by scanning the IDL manuals to produce
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3429 the file @file{idlw-rinfo.el}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3430
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3431 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3432 IDLWAVE @emph{scans} all its @emph{buffers} in the current Emacs session
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3433 for routine definitions. This is done automatically when routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3434 information or completion is first requested by the user. Each new
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3435 buffer and each buffer saved after making changes is also scanned. The
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3436 command @kbd{C-c C-i} (@code{idlwave-update-routine-info}) can be used
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3437 at any time to rescan all buffers.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3438
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3439 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3440 If you have an IDLWAVE-Shell running in the Emacs session, IDLWAVE will
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3441 @emph{query the shell} for compiled routines and their arguments. This
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3442 happens automatically when routine information or completion is first
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3443 requested by the user. Each time an Emacs buffer is compiled with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3444 @kbd{C-c C-d C-c}, the routine info for that file is queried. Though
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3445 rarely necessary, the command @kbd{C-c C-i}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3446 (@code{idlwave-update-routine-info}) can be used to explicitly update
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3447 the shell routine data.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3448
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3449 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3450 Many popular libraries are distributed with routine information already
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3451 scanned into @emph{library catalogs} (@pxref{Library Catalogs}). These
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3452 per-directory catalog files can also be built by the user with the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3453 supplied @file{idlwave_catalog} tool. They are automatically discovered
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3454 by IDLWAVE.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3455
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3456 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3457 IDLWAVE can scan selected directories of source files and store the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3458 result in a single @emph{user catalog} file which will be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3459 automatically loaded just like @file{idlw-rinfo.el}. @xref{User
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3460 Catalog}, for information on how to scan files in this way.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3461 @end enumerate
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3462
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3463 Loading all the routine and catalog information can be a time consuming
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3464 process, especially over slow networks. Depending on the system and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3465 network configuration it could take up to 30 seconds (though locally on
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3466 fast systems is usually only a few seconds). In order to minimize the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3467 wait time upon your first completion or routine info command in a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3468 session, IDLWAVE uses Emacs idle time to do the initialization in six
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3469 steps, yielding to user input in between. If this gets into your way,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3470 set the variable @code{idlwave-init-rinfo-when-idle-after} to 0 (zero).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3471 The more routines documented in library and user catalogs, the slower
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3472 the loading will be, so reducing this number can help alleviate any long
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3473 load times.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3474
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3475 @defopt idlwave-init-rinfo-when-idle-after (@code{10})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3476 Seconds of idle time before routine info is automatically initialized.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3477 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3478
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3479 @defopt idlwave-scan-all-buffers-for-routine-info (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3480 Non-@code{nil} means scan all buffers for IDL programs when updating
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3481 info.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3482 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3483
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3484 @defopt idlwave-query-shell-for-routine-info (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3485 Non-@code{nil} means query the shell for info about compiled routines.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3486 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3487
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3488 @defopt idlwave-auto-routine-info-updates
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3489 Controls under what circumstances routine info is updated automatically.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3490 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3491
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3492 @html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3493 <A NAME="CATALOGS"></A>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3494 @end html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3495 @node Catalogs, Load-Path Shadows, Routine Information Sources, Sources of Routine Info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3496 @appendixsec Catalogs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3497 @cindex Catalogs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3498
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3499 @emph{Catalogs} are files containing scanned information on individual
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3500 routines, including arguments and keywords, calling sequence, file path,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3501 class and procedure vs. function type, etc. They represent a way of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3502 extending the internal built-in information available for IDL system
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3503 routines (@pxref{Routine Info}) to other source collections.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3504
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3505 Starting with version 5.0, there are two types of catalogs available
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3506 with IDLWAVE. The traditional @emph{user catalog} and the newer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3507 @emph{library catalogs}. Although they can be used interchangeably, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3508 library catalogs are more flexible, and preferred. There are few
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3509 occasions when a user catalog might be preferred --- read below. Both
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3510 types of catalogs can coexist without causing problems.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3511
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3512 To facilitate the catalog systems, IDLWAVE stores information it gathers
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3513 from the shell about the IDL search paths, and can write this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3514 information out automatically, or on-demand (menu @code{Debug->Save Path
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3515 Info}). On systems with no shell from which to discover the path
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3516 information (e.g. Windows), a library path must be specified in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3517 @code{idlwave-library-path} to allow library catalogs to be located, and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3518 to setup directories for user catalog scan (@pxref{User Catalog} for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3519 more on this variable). Note that, before the shell is running, IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3520 can only know about the IDL search path by consulting the file pointed
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3521 to by @code{idlwave-path-file} (@file{~/.idlwave/idlpath.el}, by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3522 default). If @code{idlwave-auto-write-path} is enabled (which is the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3523 default), the paths are written out whenever the IDLWAVE shell is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3524 started.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3525
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3526 @defopt idlwave-auto-write-path (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3527 Write out information on the !PATH and !DIR paths from IDL automatically
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3528 when they change and when the Shell is closed. These paths are needed
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3529 to locate library catalogs.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3530 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3531
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3532 @defopt idlwave-library-path
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3533 IDL library path for Windows and MacOS. Under Unix/MacOSX, will be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3534 obtained from the Shell when run.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3535 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3536
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3537 @defopt idlwave-system-directory
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3538 The IDL system directory for Windows and MacOS. Also needed for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3539 locating HTML help and the IDL Assistant for IDL v6.2 and later. Under
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3540 Unix/MacOSX, will be obtained from the Shell and recorded, if run.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3541 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3542
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3543 @defopt idlwave-config-directory (@file{~/.idlwave})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3544 Default path where IDLWAVE saves configuration information, a user
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3545 catalog (if any), and a cached scan of the XML catalog (IDL v6.2 and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3546 later).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3547 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3548
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3549 @menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3550 * Library Catalogs::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3551 * User Catalog::
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3552 @end menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3553
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3554 @html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3555 <A NAME="LIBRARY_CATALOGS"></A>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3556 @end html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3557 @node Library Catalogs, User Catalog, Catalogs, Catalogs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3558 @appendixsubsec Library Catalogs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3559 @cindex @file{.idlwave_catalog}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3560 @cindex Library catalogs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3561 @cindex @code{idlwave_catalog}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3562
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3563 Library catalogs consist of files named @file{.idlwave_catalog} stored
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3564 in directories containing @code{.pro} routine files. They are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3565 discovered on the IDL search path and loaded automatically when routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3566 information is read. Each catalog file documents the routines found in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3567 that directory --- one catalog per directory. Every catalog has a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3568 library name associated with it (e.g. @emph{AstroLib}). This name will
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3569 be shown briefly when the catalog is found, and in the routine info of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3570 routines it documents.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3571
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3572 Many popular libraries of routines are shipped with IDLWAVE catalog
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3573 files by default, and so will be automatically discovered. Library
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3574 catalogs are scanned externally to Emacs using a tool provided with
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3575 IDLWAVE. Each catalog can be re-scanned independently of any other.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3576 Catalogs can easily be made available system-wide with a common source
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3577 repository, providing uniform routine information, and lifting the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3578 burden of scanning from the user (who may not even know they're using a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3579 scanned catalog). Since all catalogs are independent, they can be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3580 re-scanned automatically to gather updates, e.g. in a @file{cron} job.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3581 Scanning is much faster than with the built-in user catalog method. One
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3582 minor disadvantage: the entire IDL search path is scanned for catalog
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3583 files every time IDLWAVE starts up, which might be slow if accessing IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3584 routines over a slow network.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3585
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3586 A Perl tool to create library catalogs is distributed with IDLWAVE:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3587 @code{idlwave_catalog}. It can be called quite simply:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3588 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3589 idlwave_catalog MyLib
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3590 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3591
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3592 @noindent This will scan all directories recursively beneath the current and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3593 populate them with @file{.idlwave_catalog} files, tagging the routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3594 found there with the name library ``MyLib''. The full usage
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3595 information:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3596
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3597 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3598 Usage: idlwave_catalog [-l] [-v] [-d] [-s] [-f] [-h] libname
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3599 libname - Unique name of the catalog (4 or more alphanumeric
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3600 characters).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3601 -l - Scan local directory only, otherwise recursively
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3602 catalog all directories at or beneath this one.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3603 -v - Print verbose information.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3604 -d - Instead of scanning, delete all .idlwave_catalog files
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3605 here or below.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3606 -s - Be silent.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3607 -f - Force overwriting any catalogs found with a different
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3608 library name.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3609 -h - Print this usage.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3610 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3611
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3612 To re-load the library catalogs on the IDL path, force a system routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3613 info update using a single prefix to @code{idlwave-update-routine-info}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3614 @kbd{C-u C-c C-i}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3615
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3616 @defopt idlwave-use-library-catalogs (@code{t})
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3617 Whether to search for and load library catalogs. Disable if load
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3618 performance is a problem and/or the catalogs are not needed.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3619 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3620
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3621 @node User Catalog, , Library Catalogs, Catalogs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3622 @appendixsubsec User Catalog
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3623 @cindex User catalog
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3624 @cindex IDL library routine info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3625 @cindex Windows
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3626 @cindex MacOS
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3627 @cindex IDL variable @code{!DIR}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3628 @cindex @code{!DIR}, IDL variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3629
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3630 The user catalog is the old routine catalog system. It is produced
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3631 within Emacs, and stored in a single file in the user's home directory
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3632 (@file{.idlwave/idlusercat.el} by default). Although library catalogs
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3633 are more flexible, there may be reasons to prefer a user catalog
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3634 instead, including:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3635
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3636 @itemize @bullet
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3637 @item The scan is internal to Emacs, so you don't need a working Perl
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3638 installation, as you do for library catalogs.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3639 @item Can be used to scan directories for which the user has no write
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3640 privileges.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3641 @item Easy widget-based path selection.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3642 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3643
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3644 However, no routine info is available in the user catalog by default;
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3645 the user must actively complete a scan. In addition, this type of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3646 catalog is all or nothing: if a single routine changes, the entire
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3647 catalog must be rescanned to update it. Creating the user catalog is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3648 also much slower than scanning library catalogs.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3649
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3650 You can scan any of the directories on the currently known path. Under
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3651 Windows and MacOS (not OSX), you need to specify the IDL search path in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3652 the variable @code{idlwave-library-path}, and the location of the IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3653 directory (the value of the @code{!DIR} system variable) in the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3654 @code{idlwave-system-directory}, like this@footnote{The initial @samp{+}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3655 leads to recursive expansion of the path, just like in IDL}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3656
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3657 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3658 (setq idlwave-library-path
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3659 '("+c:/RSI/IDL56/lib/" "+c:/user/me/idllibs"))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3660 (setq idlwave-system-directory "c:/RSI/IDL56/")
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3661 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3662
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3663 @noindent Under GNU/Linux and UNIX, these values will be automatically
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3664 gathered from the IDLWAVE shell, if run.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3665
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3666 The command @kbd{M-x idlwave-create-user-catalog-file} (or the menu item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3667 @samp{IDLWAVE->Routine Info->Select Catalog Directories}) can then be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3668 used to create a user catalog. It brings up a widget in which you can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3669 select some or all directories on the search path. Directories which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3670 already contain a library catalog are marked with @samp{[LIB]}, and need
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3671 not be scanned (although there is no harm if you do so, other than the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3672 additional memory used for the duplication).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3673
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3674 After selecting directories, click on the @w{@samp{[Scan & Save]}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3675 button in the widget to scan all files in the selected directories and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3676 write out the resulting routine information. In order to update the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3677 library information using the directory selection, call the command
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3678 @code{idlwave-update-routine-info} with a double prefix argument:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3679 @w{@kbd{C-u C-u C-c C-i}}. This will rescan files in the previously
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3680 selected directories, write an updated version of the user catalog file
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3681 and rebuild IDLWAVE's internal lists. If you give three prefix
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3682 arguments @w{@kbd{C-u C-u C-u C-c C-i}}, updating will be done with a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3683 background job@footnote{Unix systems only, I think.}. You can continue
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3684 to work, and the library catalog will be re-read when it is ready. If
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3685 you find you need to update the user catalog often, you should consider
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3686 building a library catalog for your routines instead (@pxref{Library
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3687 Catalogs}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3688
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3689 @defopt idlwave-special-lib-alist
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3690 Alist of regular expressions matching special library directories for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3691 labeling in routine-info display.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3692 @end defopt
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3693
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3694 @node Load-Path Shadows, Documentation Scan, Catalogs, Sources of Routine Info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3695 @appendixsec Load-Path Shadows
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3696 @cindex Load-path shadows
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3697 @cindex Shadows, load-path
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3698 @cindex Duplicate routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3699 @cindex Multiply defined routines
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3700 @cindex Routine definitions, multiple
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3701 @cindex Application, testing for shadowing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3702 @cindex Buffer, testing for shadowing
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3703
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3704 IDLWAVE can compile a list of routines which are (re-)defined in more
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3705 than one file. Since one definition will hide (shadow) the others
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3706 depending on which file is compiled first, such multiple definitions are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3707 called "load-path shadows". IDLWAVE has several routines to scan for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3708 load path shadows. The output is placed into the special buffer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3709 @file{*Shadows*}. The format of the output is identical to the source
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3710 section of the routine info buffer (@pxref{Routine Info}). The
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3711 different definitions of a routine are ordered by @emph{likelihood of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3712 use}. So the first entry will be most likely the one you'll get if an
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3713 unsuspecting command uses that routine. Before listing shadows, you
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3714 should make sure that routine info is up-to-date by pressing @kbd{C-c
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3715 C-i}. Here are the different routines (also available in the Menu
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3716 @samp{IDLWAVE->Routine Info}):
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3717
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3718 @table @asis
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3719 @item @kbd{M-x idlwave-list-buffer-load-path-shadows}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3720 This commands checks the names of all routines defined in the current
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3721 buffer for shadowing conflicts with other routines accessible to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3722 IDLWAVE. The command also has a key binding: @kbd{C-c C-b}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3723 @item @kbd{M-x idlwave-list-shell-load-path-shadows}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3724 Checks all routines compiled under the shell for shadowing. This is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3725 very useful when you have written a complete application. Just compile
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3726 the application, use @code{RESOLVE_ALL} to compile any routines used by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3727 your code, update the routine info inside IDLWAVE with @kbd{C-c C-i} and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3728 then check for shadowing.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3729 @item @kbd{M-x idlwave-list-all-load-path-shadows}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3730 This command checks all routines accessible to IDLWAVE for conflicts.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3731 @end table
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3732
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3733 For these commands to work fully you need to scan the entire load path
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3734 in either a user or library catalog. Also, IDLWAVE should be able to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3735 distinguish between the system library files (normally installed in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3736 @file{/usr/local/rsi/idl/lib}) and any site specific or user specific
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3737 files. Therefore, such local files should not be installed inside the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3738 @file{lib} directory of the IDL directory. This is also advisable for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3739 many other reasons.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3740
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3741 @cindex Windows
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3742 @cindex MacOS
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3743 @cindex IDL variable @code{!DIR}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3744 @cindex @code{!DIR}, IDL variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3745 Users of Windows and MacOS (not X) also must set the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3746 @code{idlwave-system-directory} to the value of the @code{!DIR} system
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3747 variable in IDL. IDLWAVE appends @file{lib} to the value of this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3748 variable and assumes that all files found on that path are system
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3749 routines.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3750
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3751 Another way to find out if a specific routine has multiple definitions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3752 on the load path is routine info display (@pxref{Routine Info}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3753
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3754 @node Documentation Scan, , Load-Path Shadows, Sources of Routine Info
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3755 @appendixsec Documentation Scan
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3756 @cindex @file{get_html_rinfo}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3757 @cindex @file{idlw-rinfo.el}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3758 @cindex Scanning the documentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3759 @cindex Perl program, to create @file{idlw-rinfo.el}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3760
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3761 @strong{Starting with version 6.2, IDL is distributed directly with HTML
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3762 online help, and an XML-based catalog of routine information}. This
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3763 makes scanning the manuals with the tool @file{get_html_rinfo}, and the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3764 @file{idlw-rinfo.el} file it produced, as described here, entirely
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3765 unnecessary. The information is left here for users wishing to produce
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3766 a catalog of older IDL versions' help.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3767
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3768
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3769 IDLWAVE derives its knowledge about system routines from the IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3770 manuals. The file @file{idlw-rinfo.el} contains the routine information
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3771 for the IDL system routines, and links to relevant sections of the HTML
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3772 documentation. The Online Help feature of IDLWAVE requires HTML
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3773 versions of the IDL manuals to be available; the HTML documentation is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3774 not distributed with IDLWAVE by default, but must be downloaded
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3775 separately.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3776
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3777 The HTML files and related images can be produced from the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3778 @file{idl.chm} HTMLHelp file distributed with IDL using the free
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3779 Microsoft HTML Help Workshop. If you are lucky, the maintainer of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3780 IDLWAVE will always have access to the newest version of IDL and provide
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3781 updates. The IDLWAVE distribution also contains the Perl program
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3782 @file{get_html_rinfo} which constructs the @file{idlw-rinfo.el} file by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3783 scanning the HTML documents produced from the IDL documentation.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3784 Instructions on how to use @file{get_html_rinfo} are in the program
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3785 itself.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3786
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3787 @node HTML Help Browser Tips, Configuration Examples, Sources of Routine Info, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3788 @appendix HTML Help Browser Tips
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3789 @cindex Browser Tips
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3790
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3791 There are a wide variety of possible browsers to use for displaying
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3792 the online HTML help available with IDLWAVE (starting with version
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3793 5.0). Since IDL v6.2, a single cross-platform HTML help browser, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3794 @emph{IDL Assistant} is distributed with IDL. If this help browser is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3795 available, it is the preferred choice, and the default. The variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3796 @code{idlwave-help-use-assistant}, enabled by default, controls
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3797 whether this help browser is used. If you use the IDL Assistant, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3798 tips here are not relevant.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3799
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3800 Since IDLWAVE runs on a many different system types, a single browser
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3801 configuration is not possible, but choices abound. On many systems,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3802 the default browser configured in @code{browse-url-browser-function},
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3803 and hence inherited by default by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3804 @code{idlwave-help-browser-function}, is Netscape. Unfortunately, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3805 HTML manuals decompiled from the original source contain formatting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3806 structures which Netscape 4.x does not handle well, though they are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3807 still readable. A much better choice is Mozilla, or one of the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3808 Mozilla-derived browsers such as
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3809 @uref{http://galeon.sourceforge.net/,Galeon} (GNU/Linux),
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3810 @uref{http://www.mozilla.org/projects/camino/,Camino} (MacOSX), or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3811 @uref{http://www.mozilla.org/projects/firebird/,Firebird} (all
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3812 platforms). Newer versions of Emacs provide a browser-function choice
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3813 @code{browse-url-gnome-moz} which uses the Gnome-configured browser.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3814
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3815 Note that the HTML files decompiled from the help sources contain
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3816 specific references to the @samp{Symbol} font, which by default is not
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3817 permitted in normal encodings (it's invalid, technically). Though it
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3818 only impacts a few symbols, you can trick Mozilla-based browsers into
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3819 recognizing @samp{Symbol} by following the directions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3820 @uref{http://hutchinson.belmont.ma.us/tth/Xfonts.html, here}. With
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3821 this fix in place, HTML help pages look almost identical to their PDF
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3822 equivalents (yet can be bookmarked, browsed as history, searched,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3823 etc.).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3824
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3825 @noindent Individual platform recommendations:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3826
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3827 @itemize @bullet
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3828 @item Unix/MacOSX: The @uref{http://www.w3m.org,@code{w3m}} browser
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3829 and its associated
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3830 @uref{http://emacs-w3m.namazu.org/,@code{emacs-w3m}} emacs mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3831 provide in-buffer browsing with image display, and excellent speed and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3832 formatting. Both the Emacs mode and the browser itself must be
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3833 downloaded separately. To use this browser, include
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3834
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3835 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3836 (setq idlwave-help-browser-function 'w3m-browse-url)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3837 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3838
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3839 in your @file{.emacs}. Setting a few other nice @code{w3m} options
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3840 cuts down on screen clutter:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3841
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3842 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3843 (setq w3m-use-tab nil
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3844 w3m-use-header-line nil
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3845 w3m-use-toolbar nil)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3846 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3847
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3848 If you use a dedicated frame for help, you might want to add the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3849 following, to get consistent behavior with the @kbd{q} key:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3850
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3851 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3852 ;; Close my help window when w3m closes.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3853 (defadvice w3m-close-window (after idlwave-close activate)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3854 (if (boundp 'idlwave-help-frame)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3855 (idlwave-help-quit)))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3856 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3857
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3858 Note that you can open the file in an external browser from within
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3859 @code{w3m} using @kbd{M}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3860 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3861
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3862 @node Configuration Examples, Windows and MacOS, HTML Help Browser Tips, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3863 @appendix Configuration Examples
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3864 @cindex Configuration examples
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3865 @cindex Example configuration
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3866 @cindex @file{.emacs}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3867 @cindex Default settings, of options
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3868 @cindex Interview, with the maintainer
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3869
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3870 @noindent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3871 @b{Question:} You have all these complicated configuration options in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3872 your package, but which ones do @emph{you} as the maintainer actually
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3873 set in your own configuration?
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3874
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3875 @noindent
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3876 @b{Answer:} Not many, beyond custom key bindings. I set most defaults
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3877 the way that seems best. However, the default settings do not turn on
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3878 features which:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3879
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3880 @itemize @minus
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3881 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3882 are not self-evident (i.e. too magic) when used by an unsuspecting user.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3883 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3884 are too intrusive.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3885 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3886 will not work properly on all Emacs installations.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3887 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3888 break with widely used standards.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3889 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3890 use function or other non-standard keys.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3891 @item
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3892 are purely personal customizations, like additional key bindings, and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3893 library names.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3894 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3895
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3896 @noindent To see what I mean, here is the @emph{entire} configuration
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3897 the old maintainer had in his @file{.emacs}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3898
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3899 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3900 (setq idlwave-shell-debug-modifiers '(control shift)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3901 idlwave-store-inquired-class t
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3902 idlwave-shell-automatic-start t
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3903 idlwave-main-block-indent 2
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3904 idlwave-init-rinfo-when-idle-after 2
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3905 idlwave-help-dir "~/lib/emacs/idlwave"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3906 idlwave-special-lib-alist '(("/idl-astro/" . "AstroLib")
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3907 ("/jhuapl/" . "JHUAPL-Lib")
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3908 ("/dominik/lib/idl/" . "MyLib")))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3909 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3910
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3911 However, if you are an Emacs power-user and want IDLWAVE to work
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3912 completely differently, you can change almost every aspect of it. Here
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3913 is an example of a much more extensive configuration of IDLWAVE. The
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3914 user is King!
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3915
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3916 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3917 ;;; Settings for IDLWAVE mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3918
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3919 (setq idlwave-block-indent 3) ; Indentation settings
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3920 (setq idlwave-main-block-indent 3)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3921 (setq idlwave-end-offset -3)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3922 (setq idlwave-continuation-indent 1)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3923 (setq idlwave-begin-line-comment "^;[^;]") ; Leave ";" but not ";;"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3924 ; anchored at start of line.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3925 (setq idlwave-surround-by-blank t) ; Turn on padding ops =,<,>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3926 (setq idlwave-pad-keyword nil) ; Remove spaces for keyword '='
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3927 (setq idlwave-expand-generic-end t) ; convert END to ENDIF etc...
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3928 (setq idlwave-reserved-word-upcase t) ; Make reserved words upper case
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3929 ; (with abbrevs only)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3930 (setq idlwave-abbrev-change-case nil) ; Don't force case of expansions
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3931 (setq idlwave-hang-indent-regexp ": ") ; Change from "- " for auto-fill
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3932 (setq idlwave-show-block nil) ; Turn off blinking to begin
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3933 (setq idlwave-abbrev-move t) ; Allow abbrevs to move point
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3934 (setq idlwave-query-class '((method-default . nil) ; No query for method
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3935 (keyword-default . nil); or keyword completion
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3936 ("INIT" . t) ; except for these
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3937 ("CLEANUP" . t)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3938 ("SETPROPERTY" .t)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3939 ("GETPROPERTY" .t)))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3940
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3941 ;; Using w3m for help (must install w3m and emacs-w3m)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3942 (autoload 'w3m-browse-url "w3m" "Interface for w3m on Emacs." t)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3943 (setq idlwave-help-browser-function 'w3m-browse-url
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3944 w3m-use-tab nil ; no tabs, location line, or toolbar
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3945 w3m-use-header-line nil
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3946 w3m-use-toolbar nil)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3947
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3948 ;; Close my help window or frame when w3m closes with `q'
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3949 (defadvice w3m-close-window (after idlwave-close activate)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3950 (if (boundp 'idlwave-help-frame)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3951 (idlwave-help-quit)))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3952
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3953 ;; Some setting can only be done from a mode hook. Here is an example:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3954 (add-hook 'idlwave-mode-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3955 (lambda ()
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3956 (setq case-fold-search nil) ; Make searches case sensitive
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3957 ;; Run other functions here
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3958 (font-lock-mode 1) ; Turn on font-lock mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3959 (idlwave-auto-fill-mode 0) ; Turn off auto filling
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3960 (setq idlwave-help-browser-function 'browse-url-w3)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3961
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3962 ;; Pad with 1 space (if -n is used then make the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3963 ;; padding a minimum of n spaces.) The defaults use -1
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3964 ;; instead of 1.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3965 (idlwave-action-and-binding "=" '(idlwave-expand-equal 1 1))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3966 (idlwave-action-and-binding "<" '(idlwave-surround 1 1))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3967 (idlwave-action-and-binding ">" '(idlwave-surround 1 1 '(?-)))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3968 (idlwave-action-and-binding "&" '(idlwave-surround 1 1))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3969
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3970 ;; Only pad after comma and with exactly 1 space
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3971 (idlwave-action-and-binding "," '(idlwave-surround nil 1))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3972 (idlwave-action-and-binding "&" '(idlwave-surround 1 1))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3973
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3974 ;; Pad only after `->', remove any space before the arrow
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3975 (idlwave-action-and-binding "->" '(idlwave-surround 0 -1 nil 2))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3976
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3977 ;; Set some personal bindings
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3978 ;; (In this case, makes `,' have the normal self-insert behavior.)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3979 (local-set-key "," 'self-insert-command)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3980 (local-set-key [f5] 'idlwave-shell-break-here)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3981 (local-set-key [f6] 'idlwave-shell-clear-current-bp)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3982
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3983 ;; Create a newline, indenting the original and new line.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3984 ;; A similar function that does _not_ reindent the original
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3985 ;; line is on "\C-j" (The default for emacs programming modes).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3986 (local-set-key "\n" 'idlwave-newline)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3987 ;; (local-set-key "\C-j" 'idlwave-newline) ; My preference.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3988
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3989 ;; Some personal abbreviations
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3990 (define-abbrev idlwave-mode-abbrev-table
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3991 (concat idlwave-abbrev-start-char "wb") "widget_base()"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3992 (idlwave-keyword-abbrev 1))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3993 (define-abbrev idlwave-mode-abbrev-table
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3994 (concat idlwave-abbrev-start-char "on") "obj_new()"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3995 (idlwave-keyword-abbrev 1))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3996 ))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3997
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3998 ;;; Settings for IDLWAVE SHELL mode
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
3999
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4000 (setq idlwave-shell-overlay-arrow "=>") ; default is ">"
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4001 (setq idlwave-shell-use-dedicated-frame t) ; Make a dedicated frame
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4002 (setq idlwave-shell-prompt-pattern "^WAVE> ") ; default is "^IDL> "
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4003 (setq idlwave-shell-explicit-file-name "wave")
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4004 (setq idlwave-shell-process-name "wave")
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4005 (setq idlwave-shell-use-toolbar nil) ; No toolbar
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4006
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4007 ;; Most shell interaction settings can be done from the shell-mode-hook.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4008 (add-hook 'idlwave-shell-mode-hook
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4009 (lambda ()
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4010 ;; Set up some custom key and mouse examine commands
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4011 (idlwave-shell-define-key-both [s-down-mouse-2]
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4012 (idlwave-shell-mouse-examine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4013 "print, size(___,/DIMENSIONS)"))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4014 (idlwave-shell-define-key-both [f9] (idlwave-shell-examine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4015 "print, size(___,/DIMENSIONS)"))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4016 (idlwave-shell-define-key-both [f10] (idlwave-shell-examine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4017 "print,size(___,/TNAME)"))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4018 (idlwave-shell-define-key-both [f11] (idlwave-shell-examine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4019 "help,___,/STRUCTURE"))))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4020 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4021
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4022 @html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4023 <A NAME="WIN_MAC"></A>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4024 @end html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4025 @node Windows and MacOS, Troubleshooting, Configuration Examples, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4026 @appendix Windows and MacOS
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4027 @cindex Windows
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4028 @cindex MacOS
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4029 @cindex MacOSX
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4030
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4031 IDLWAVE was developed on a UNIX system. However, thanks to the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4032 portability of Emacs, much of IDLWAVE does also work under different
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4033 operating systems like Windows (with NTEmacs or NTXEmacs) or MacOS.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4034
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4035 The only real problem is that there is no command-line version of IDL
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4036 for Windows or MacOS(<=9) with which IDLWAVE can interact. As a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4037 result, the IDLWAVE Shell does not work and you have to rely on IDLDE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4038 to run and debug your programs. However, editing IDL source files
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4039 with Emacs/IDLWAVE works with all bells and whistles, including
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4040 routine info, completion and fast online help. Only a small amount of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4041 additional information must be specified in your @file{.emacs} file:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4042 the path names which, on a UNIX system, are automatically gathered by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4043 talking to the IDL program.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4044
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4045 Here is an example of the additional configuration needed for a Windows
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4046 system. I am assuming that IDLWAVE has been installed in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4047 @w{@samp{C:\Program Files\IDLWAVE}} and that IDL is installed in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4048 @w{@samp{C:\RSI\IDL63}}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4049
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4050 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4051 ;; location of the lisp files (only needed if IDLWAVE is not part of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4052 ;; your default X/Emacs installation)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4053 (setq load-path (cons "c:/program files/IDLWAVE" load-path))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4054
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4055 ;; The location of the IDL library directories, both standard, and your own.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4056 ;; note that the initial "+" expands the path recursively
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4057 (setq idlwave-library-path
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4058 '("+c:/RSI/IDL63/lib/" "+c:/path/to/my/idllibs" ))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4059
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4060 ;; location of the IDL system directory (try "print,!DIR")
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4061 (setq idlwave-system-directory "c:/RSI/IDL63/")
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4062
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4063 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4064
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4065 @noindent Furthermore, Windows sometimes tries to outsmart you --- make
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4066 sure you check the following things:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4067
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4068 @itemize @bullet
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4069 @item When you download the IDLWAVE distribution, make sure you save the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4070 file under the names @file{idlwave.tar.gz}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4071 @item M-TAB switches among running programs --- use Esc-TAB
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4072 instead.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4073 @item Other issues as yet unnamed...
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4074 @end itemize
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4075
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4076 Windows users who'd like to make use of IDLWAVE's context-aware HTML
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4077 help can skip the browser and use the HTMLHelp functionality directly.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4078 @xref{Help with HTML Documentation}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4079
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4080 @html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4081 <A NAME="TROUBLE"></A>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4082 @end html
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4083 @node Troubleshooting, GNU Free Documentation License, Windows and MacOS, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4084 @appendix Troubleshooting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4085 @cindex Troubleshooting
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4086
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4087 Although IDLWAVE usually installs and works without difficulty, a few
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4088 common problems and their solutions are documented below.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4089
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4090 @enumerate
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4091
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4092 @item @strong{Whenever an IDL error occurs or a breakpoint is hit, I get
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4093 errors or strange behavior when I try to type anything into some of my
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4094 IDLWAVE buffers.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4095
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4096 This is a @emph{feature}, not an error. You're in @emph{Electric
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4097 Debug Mode} (@pxref{Electric Debug Mode}). You should see
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4098 @code{*Debugging*} in the mode-line. The buffer is read-only and all
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4099 debugging and examination commands are available as single keystrokes;
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4100 @kbd{C-?} lists these shortcuts. Use @kbd{q} to quit the mode, and
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4101 customize the variable @code{idlwave-shell-automatic-electric-debug}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4102 if you prefer not to enter electric debug on breakpoints@dots{} but
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4103 you really should try it before you disable it! You can also
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4104 customize this variable to enter debug mode when errors are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4105 encountered.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4106
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4107 @item @strong{I get errors like @samp{Searching for program: no such
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4108 file or directory, idl} when attempting to start the IDL shell.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4109
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4110 IDLWAVE needs to know where IDL is in order to run it as a process.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4111 By default, it attempts to invoke it simply as @samp{idl}, which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4112 presumes such an executable is on your search path. You need to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4113 ensure @samp{idl} is on your @samp{$PATH}, or specify the full
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4114 pathname to the idl program with the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4115 @code{idlwave-shell-explicit-file-name}. Note that you may need to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4116 set your shell search path in two places when running Emacs as an Aqua
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4117 application with MacOSX; see the next topic.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4118
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4119 @item @strong{IDLWAVE is disregarding my @samp{IDL_PATH} which I set
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4120 under MacOSX}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4121
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4122 If you run Emacs directly as an Aqua application, rather than from the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4123 console shell, the environment is set not from your usual shell
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4124 configuration files (e.g. @file{.cshrc}), but from the file
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4125 @file{~/.MacOSX/environment.plist}. Either include your path settings
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4126 there, or start Emacs and IDLWAVE from the shell.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4127
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4128 @item @strong{I get errors like @samp{Symbol's function is void:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4129 overlayp}}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4130
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4131 You don't have the @samp{fsf-compat} package installed, which IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4132 needs to run under XEmacs. Install it, or find an XEmacs distribution
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4133 which includes it by default.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4134
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4135 @item @strong{I'm getting errors like @samp{Symbol's value as variable is void:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4136 cl-builtin-gethash} on completion or routine info.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4137
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4138 This error arises if you upgraded Emacs from 20.x to 21.x without
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4139 re-installing IDLWAVE. Old Emacs and new Emacs are not byte-compatible
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4140 in compiled lisp files. Presumably, you kept the original .elc files in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4141 place, and this is the source of the error. If you recompile (or just
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4142 "make; make install") from source, it should resolve this problem.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4143 Another option is to recompile the @file{idlw*.el} files by hand using
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4144 @kbd{M-x byte-compile-file}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4145
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4146 @item @strong{@kbd{M-@key{TAB}} doesn't complete words, it switches
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4147 windows on my desktop.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4148
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4149 Your system is trapping @kbd{M-@key{TAB}} and using it for its own
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4150 nefarious purposes: Emacs never sees the keystrokes. On many Unix
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4151 systems, you can reconfigure your window manager to use another key
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4152 sequence for switching among windows. Another option is to use the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4153 equivalent sequence @kbd{@key{ESC}-@key{TAB}}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4154
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4155 @item @strong{When stopping at breakpoints or errors, IDLWAVE does not
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4156 seem to highlight the relevant line in the source.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4157
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4158 IDLWAVE scans for error and halt messages and highlights the stop
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4159 location in the correct file. However, if you've changed the system
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4160 variable @samp{!ERROR_STATE.MSG_PREFIX}, it is unable to parse these
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4161 message correctly. Don't do that.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4162
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4163 @item @strong{IDLWAVE doesn't work correctly when using ENVI.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4164
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4165 Though IDLWAVE was not written with ENVI in mind, it works just fine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4166 with it, as long as you update the prompt it's looking for (@samp{IDL>
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4167 } by default). You can do this with the variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4168 @code{idlwave-shell-prompt-pattern} (@pxref{Starting the Shell}), e.g.,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4169 in your @file{.emacs}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4170
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4171 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4172 (setq idlwave-shell-prompt-pattern "^\r? ?\\(ENVI\\|IDL\\)> ")
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4173 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4174
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4175 @item @strong{Attempts to set breakpoints fail: no breakpoint is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4176 indicated in the IDLWAVE buffer.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4177
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4178 IDL changed its breakpoint reporting format starting with IDLv5.5. The
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4179 first version of IDLWAVE to support the new format is IDLWAVE v4.10. If
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4180 you have an older version and are using IDL >v5.5, you need to upgrade,
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4181 and/or make sure your recent version of IDLWAVE is being found on the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4182 Emacs load-path (see the next entry). You can list the version being
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4183 used with @kbd{C-h v idlwave-mode-version @key{RET}}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4184
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4185 @item @strong{I installed a new version of IDLWAVE, but the old
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4186 version is still being used} or @strong{IDLWAVE works, but when I
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4187 tried to install the optional modules @file{idlw-roprompt.el} or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4188 @file{idlw-complete-structtag}, I get errors like @samp{Cannot open
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4189 load file}}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4190
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4191 The problem is that your Emacs is not finding the version of IDLWAVE you
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4192 installed. Many Emacsen come with an older bundled copy of IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4193 (e.g. v4.7 for Emacs 21.x), which is likely what's being used instead.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4194 You need to make sure your Emacs @emph{load-path} contains the directory
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4195 where IDLWAVE is installed (@file{/usr/local/share/emacs/site-lisp}, by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4196 default), @emph{before} Emacs' default search directories. You can
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4197 accomplish this by putting the following in your @file{.emacs}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4198
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4199 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4200 (setq load-path (cons "/usr/local/share/emacs/site-lisp" load-path))
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4201 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4202
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4203 @noindent You can check on your load-path value using @kbd{C-h v
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4204 load-path @key{RET}}, and @kbd{C-h m} in an IDLWAVE buffer should show
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4205 you the version Emacs is using.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4206
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4207 @item @strong{IDLWAVE is screwing up the formatting of my @file{.idl} files.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4208
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4209 Actually, this isn't IDLWAVE at all, but @samp{idl-mode}, an unrelated
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4210 programming mode for CORBA's Interface Definition Language (you should
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4211 see @samp{(IDL)}, not @samp{(IDLWAVE)} in the mode-line). One
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4212 solution: don't name your file @file{.idl}, but rather @file{.pro}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4213 Another solution: make sure @file{.idl} files load IDLWAVE instead of
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4214 @samp{idl-mode} by adding the following to your @file{.emacs}:
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4215
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4216 @lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4217 (setcdr (rassoc 'idl-mode auto-mode-alist) 'idlwave-mode)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4218 @end lisp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4219
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4220 @item @strong{The routine info for my local routines is out of date!}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4221
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4222 IDLWAVE collects routine info from various locations (@pxref{Routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4223 Information Sources}). Routines in files visited in a buffer or
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4224 compiled in the shell should be up to date. For other routines, the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4225 information is only as current as the most recent scan. If you have a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4226 rapidly changing set of routines, and you'd like the latest routine
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4227 information to be available for it, one powerful technique is to make
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4228 use of the library catalog tool, @samp{idlwave_catalog}. Simply add a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4229 line to your @samp{cron} file (@samp{crontab -e} will let you edit this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4230 on some systems), like this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4231
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4232 @example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4233 45 3 * * 1-5 (cd /path/to/myidllib; /path/to/idlwave_catalog MyLib)
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4234 @end example
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4235
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4236 @noindent where @samp{MyLib} is the name of your library. This will
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4237 rescan all @file{.pro} files at or below @file{/path/to/myidllib} every
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4238 week night at 3:45am. You can even scan site-wide libraries with this
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4239 method, and the most recent information will be available to all users.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4240 Since the scanning is very fast, there is very little impact.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4241
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4242 @item @strong{All the Greek-font characters in the HTML help are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4243 displayed as Latin characters!}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4244
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4245 Unfortunately, the HTMLHelp files RSI provides attempt to switch to
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4246 @samp{Symbol} font to display Greek characters, which is not really an
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4247 permitted method for doing this in HTML. There is a "workaround" for
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4248 some browsers: @xref{HTML Help Browser Tips}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4249
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4250 @item @strong{In the shell, my long commands are truncated at 256 characters!}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4251
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4252 This actually happens when running IDL in an XTerm as well. There are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4253 a couple of workarounds: @code{define_key,/control,'^d'} (e.g. in
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4254 your @file{$IDL_STARTUP} file) will disable the @samp{EOF} character
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4255 and give you a 512 character limit. You won't be able to use
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4256 @key{C-d} to quit the shell, however. Another possibility is
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4257 @code{!EDIT_INPUT=0}, which gives you an @emph{infinite} limit (OK, a
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4258 memory-bounded limit), but disables the processing of background
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4259 widget events (those with @code{/NO_BLOCK} passed to @code{XManager}).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4260
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4261 @item @strong{When I invoke IDL HTML help on a routine, the page which
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4262 is loaded is one page off, e.g. for @code{CONVERT_COORD}, I get
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4263 @code{CONTOUR}.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4264
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4265 You have a mismatch between your help index and the HTML help package
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4266 you downloaded. You need to ensure you download a ``downgrade kit'' if
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4267 you are using anything older than the latest HTML help package. A new
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4268 help package appears with each IDL release (assuming the documentation
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4269 is updated).
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4270 Starting with IDL 6.2, the HTML help and its catalog are
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4271 distributed with IDL, and so should never be inconsistent.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4272
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4273 @item @strong{I get errors such as @samp{void-variable
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4274 browse-url-browser-function} or similar when attempting to load IDLWAVE
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4275 under XEmacs.}
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4276
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4277 You don't have the @samp{browse-url} (or other required) XEmacs package.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4278 Unlike GNU Emacs, XEmacs distributes many packages separately from the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4279 main program. IDLWAVE is actually among these, but is not always the
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4280 most up to date. When installing IDLWAVE as an XEmacs package, it
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4281 should prompt you for required additional packages. When installing it
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4282 from source, it won't and you'll get this error. The easiest solution
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4283 is to install all the packages when you install XEmacs (the so-called
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4284 @samp{sumo} bundle). The minimum set of XEmacs packages required by
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4285 IDLWAVE is @samp{fsf-compat, xemacs-base, mail-lib}.
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4286
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4287 @end enumerate
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4288
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4289 @node GNU Free Documentation License, Index, Troubleshooting, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4290 @appendix GNU Free Documentation License
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4291 @include doclicense.texi
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4292
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4293 @node Index, , GNU Free Documentation License, Top
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4294 @unnumbered Index
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4295 @printindex cp
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4296
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4297 @bye
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4298
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4299 @ignore
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4300 arch-tag: f1d73958-1423-4127-b8aa-f7b953d64492
b1be51c0fa80 Move here from ../../man
Glenn Morris <rgm@gnu.org>
parents:
diff changeset
4301 @end ignore