Mercurial > emacs
annotate man/idlwave.texi @ 69826:84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
blocks not suitable for inclusion with Emacs using PARTOFEMACS variable.
author | J.D. Smith <jdsmith@as.arizona.edu> |
---|---|
date | Thu, 06 Apr 2006 18:56:09 +0000 |
parents | 11b616eddda4 |
children | 7b91d87287ef |
rev | line source |
---|---|
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1 \input texinfo @c -*-texinfo-*- |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2 @c %**start of header |
58524
92dc214c88ac
Fix the setfilename directive to put the produced file in ../info.
Eli Zaretskii <eliz@gnu.org>
parents:
58296
diff
changeset
|
3 @setfilename ../info/idlwave |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4 @settitle IDLWAVE User Manual |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
5 @dircategory Emacs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
6 @direntry |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
7 * IDLWAVE: (idlwave). Major mode and shell for IDL files. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
8 @end direntry |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
9 @synindex ky cp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
10 @syncodeindex vr cp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
11 @syncodeindex fn cp |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
12 @set VERSION 6.0 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
13 @set EDITION 6.0 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
14 @set IDLVERSION 6.2 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
15 @set NSYSROUTINES 1966 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
16 @set DATE Feb, 2006 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
17 @set AUTHOR J.D. Smith & Carsten Dominik |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
18 @set AUTHOREMAIL jdsmith@@as.arizona.edu |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
19 @set MAINTAINER J.D. Smith |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
20 @set MAINTAINEREMAIL jdsmith@@as.arizona.edu |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
21 @set PARTOFEMACS |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
22 @set IDLWAVEHOMEPAGE http://idlwave.org/ |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
23 @c %**end of header |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
24 @finalout |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
25 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
26 @ifinfo |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
27 This file documents IDLWAVE, a major mode for editing IDL files with |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
28 Emacs, and interacting with an IDL shell run as a subprocess. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
29 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
30 This is edition @value{EDITION} of the IDLWAVE User Manual for IDLWAVE |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
31 @value{VERSION} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
32 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
33 Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
34 2006 Free Software Foundation, Inc. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
35 |
46534
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
36 Permission is granted to copy, distribute and/or modify this document |
65555
69b3598a61c5
Update all manuals to specify GFDL version 1.2.
Romain Francoise <romain@orebokech.com>
parents:
64890
diff
changeset
|
37 under the terms of the GNU Free Documentation License, Version 1.2 or |
46534
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
38 any later version published by the Free Software Foundation; with no |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
39 Invariant Sections, with the Front-Cover texts being ``A GNU |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
40 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
41 license is included in the section entitled ``GNU Free Documentation |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
42 License'' in the Emacs manual. |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
43 |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
44 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
45 this GNU Manual, like GNU software. Copies published by the Free |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
46 Software Foundation raise funds for GNU development.'' |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
47 |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
48 This document is part of a collection distributed under the GNU Free |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
49 Documentation License. If you want to distribute this document |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
50 separately from the collection, you can do so by adding a copy of the |
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
51 license to the document, as described in section 6 of the license. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
52 @end ifinfo |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
53 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
54 @titlepage |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
55 @title IDLWAVE User Manual |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
56 @subtitle Emacs major mode and shell for IDL |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
57 @subtitle Edition @value{EDITION}, @value{DATE} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
58 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
59 @author by J.D. Smith & Carsten Dominik |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
60 @page |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
61 This is edition @value{EDITION} of the @cite{IDLWAVE User Manual} for |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
62 IDLWAVE version @value{VERSION}, @value{DATE}. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
63 @sp 2 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
64 Copyright @copyright{} 1999, 2000, 2001, 2002, 2003, 2004, 2005, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
65 2006 Free Software Foundation, Inc. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
66 @sp 2 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
67 @cindex Copyright, of IDLWAVE |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
68 Permission is granted to copy, distribute and/or modify this document |
65555
69b3598a61c5
Update all manuals to specify GFDL version 1.2.
Romain Francoise <romain@orebokech.com>
parents:
64890
diff
changeset
|
69 under the terms of the GNU Free Documentation License, Version 1.2 or |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
70 any later version published by the Free Software Foundation; with no |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
71 Invariant Sections, with the Front-Cover texts being ``A GNU |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
72 Manual'', and with the Back-Cover Texts as in (a) below. A copy of the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
73 license is included in the section entitled ``GNU Free Documentation |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
74 License'' in the Emacs manual. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
75 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
76 (a) The FSF's Back-Cover Text is: ``You have freedom to copy and modify |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
77 this GNU Manual, like GNU software. Copies published by the Free |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
78 Software Foundation raise funds for GNU development.'' |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
79 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
80 This document is part of a collection distributed under the GNU Free |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
81 Documentation License. If you want to distribute this document |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
82 separately from the collection, you can do so by adding a copy of the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
83 license to the document, as described in section 6 of the license. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
84 @end titlepage |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
85 @contents |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
86 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
87 @page |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
88 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
89 @ifnottex |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
90 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
91 @node Top, Introduction, (dir), (dir) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
92 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
93 IDLWAVE is a package which supports editing source code written in the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
94 Interactive Data Language (IDL), and running IDL as an inferior shell. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
95 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
96 @end ifnottex |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
97 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
98 @menu |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
99 * Introduction:: What IDLWAVE is, and what it is not |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
100 * IDLWAVE in a Nutshell:: One page quick-start guide |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
101 * Getting Started:: Tutorial |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
102 * The IDLWAVE Major Mode:: The mode for editing IDL programs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
103 * The IDLWAVE Shell:: The mode for running IDL as an inferior program |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
104 @ifclear PARTOFEMACS |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
105 * Installation:: How to Install or Upgrade |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
106 @end ifclear |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
107 * Acknowledgements:: Who did what |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
108 * Sources of Routine Info:: How does IDLWAVE know about routine XYZ |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
109 * HTML Help Browser Tips:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
110 * Configuration Examples:: The user is king |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
111 * Windows and MacOS:: What still works, and how |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
112 * Troubleshooting:: When good computers turn bad |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
113 * Index:: Fast access |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
114 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
115 @detailmenu |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
116 --- The Detailed Node Listing --- |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
117 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
118 Getting Started (Tutorial) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
119 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
120 * Lesson I -- Development Cycle:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
121 * Lesson II -- Customization:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
122 * Lesson III -- User Catalog:: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
123 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
124 The IDLWAVE Major Mode |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
125 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
126 * Code Formatting:: Making code look nice |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
127 * Routine Info:: Calling Sequence and Keyword List |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
128 * Online Help:: One key press from source to help |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
129 * Completion:: Completing routine names and Keywords |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
130 * Routine Source:: Finding routines, the easy way |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
131 * Resolving Routines:: Force the Shell to compile a routine |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
132 * Code Templates:: Frequent code constructs |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
133 * Abbreviations:: Abbreviations for common commands |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
134 * Actions:: Changing case, Padding, End checking |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
135 * Doc Header:: Inserting a standard header |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
136 * Motion Commands:: Moving through the structure of a program |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
137 * Misc Options:: Things that fit nowhere else |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
138 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
139 Code Formatting |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
140 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
141 * Code Indentation:: Reflecting the logical structure |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
142 * Continued Statement Indentation:: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
143 * Comment Indentation:: Special indentation for comment lines |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
144 * Continuation Lines:: Splitting statements over lines |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
145 * Syntax Highlighting:: Font-lock support |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
146 * Octals and Highlighting:: Why "123 causes problems |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
147 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
148 Online Help |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
149 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
150 * Help with HTML Documentation:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
151 * Help with Source:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
152 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
153 Completion |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
154 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
155 * Case of Completed Words:: CaseOFcomPletedWords |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
156 * Object Method Completion and Class Ambiguity:: obj->Method, what? |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
157 * Object Method Completion in the Shell:: |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
158 * Class and Keyword Inheritance:: obj->Method, _EXTRA=e |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
159 * Structure Tag Completion:: Completing state.Tag |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
160 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
161 Actions |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
162 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
163 * Block Boundary Check:: Is the END statement correct? |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
164 * Padding Operators:: Enforcing space around `=' etc |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
165 * Case Changes:: Enforcing upper case keywords |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
166 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
167 The IDLWAVE Shell |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
168 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
169 * Starting the Shell:: How to launch IDL as a subprocess |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
170 * Using the Shell:: Interactively working with the Shell |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
171 * Commands Sent to the Shell:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
172 * Debugging IDL Programs:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
173 * Examining Variables:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
174 * Custom Expression Examination:: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
175 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
176 Debugging IDL Programs |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
177 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
178 * A Tale of Two Modes:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
179 * Debug Key Bindings:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
180 * Breakpoints and Stepping:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
181 * Compiling Programs:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
182 * Walking the Calling Stack:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
183 * Electric Debug Mode:: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
184 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
185 @ifclear PARTOFEMACS |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
186 Installation |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
187 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
188 * Installing IDLWAVE:: How to install the distribution |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
189 * Installing Online Help:: Where to get the additional files needed |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
190 @end ifclear |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
191 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
192 Sources of Routine Info |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
193 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
194 * Routine Definitions:: Where IDL Routines are defined. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
195 * Routine Information Sources:: So how does IDLWAVE know about... |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
196 * Catalogs:: |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
197 * Load-Path Shadows:: Routines defined in several places |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
198 * Documentation Scan:: Scanning the IDL Manuals |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
199 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
200 Catalogs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
201 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
202 * Library Catalogs:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
203 * User Catalog:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
204 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
205 @end detailmenu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
206 @end menu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
207 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
208 @node Introduction, IDLWAVE in a Nutshell, Top, Top |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
209 @chapter Introduction |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
210 @cindex Introduction |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
211 @cindex CORBA (Common Object Request Broker Architecture) |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
212 @cindex Interface Definition Language |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
213 @cindex Interactive Data Language |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
214 @cindex cc-mode.el |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
215 @cindex @file{idl.el} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
216 @cindex @file{idl-shell.el} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
217 @cindex Feature overview |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
218 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
219 IDLWAVE is a package which supports editing source files written in |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
220 the Interactive Data Language (IDL@c |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
221 @ifclear PARTOFEMACS |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
222 @footnote{IDL is a registered |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
223 trademark of Research Systems, Inc.}@c |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
224 @end ifclear |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
225 ), and running IDL as an inferior shell@footnote{IDLWAVE can also be used |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
226 for editing source files for the related WAVE/CL language, but with only |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
227 limited support.}. It is a feature-rich replacement for the IDLDE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
228 development environment included with IDL, and uses the full power of |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
229 Emacs to make editing and running IDL programs easier, quicker, and more |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
230 structured. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
231 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
232 IDLWAVE consists of two main parts: a major mode for editing IDL |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
233 source files (@code{idlwave-mode}) and a mode for running the IDL |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
234 program as an inferior shell (@code{idlwave-shell-mode}). Although |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
235 one mode can be used without the other, both work together closely to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
236 form a complete development environment. Here is a brief summary of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
237 what IDLWAVE does: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
238 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
239 @itemize @bullet |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
240 @item |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
241 Smart code indentation and automatic-formatting. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
242 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
243 Three level syntax highlighting support. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
244 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
245 Context-sensitive display of calling sequences and keywords for more |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
246 than 1000 native IDL routines, extendible to any additional number of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
247 local routines, and already available with many pre-scanned libraries. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
248 @item |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
249 Fast, context-sensitive online HTML help, or source-header help for |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
250 undocumented routines. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
251 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
252 Context sensitive completion of routine names, keywords, system |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
253 variables, class names and much more. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
254 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
255 Easy insertion of code templates and abbreviations of common constructs. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
256 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
257 Automatic corrections to enforce a variety of customizable coding |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
258 standards. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
259 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
260 Integrity checks and auto-termination of logical blocks. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
261 @item |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
262 Routine name space conflict search with likelihood-of-use ranking. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
263 @item |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
264 Support for @file{imenu} (Emacs) and @file{func-menu} (XEmacs). |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
265 @item |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
266 Documentation support. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
267 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
268 Running IDL as an inferior Shell with history search, command line |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
269 editing and all the completion and routine info capabilities present in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
270 IDL source buffers. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
271 @item |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
272 Full handling of debugging with breakpoints, with interactive setting |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
273 of break conditions, and easy stepping through code. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
274 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
275 Compilation, execution and interactive single-keystroke debugging of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
276 programs directly from the source buffer. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
277 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
278 Quick, source-guided navigation of the calling stack, with variable |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
279 inspection, etc. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
280 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
281 Examining variables and expressions with a mouse click. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
282 @item |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
283 And much, much more... |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
284 @end itemize |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
285 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
286 @ifnottex |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
287 @cindex Screenshots |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
288 Here are a number of screenshots showing IDLWAVE in action: |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
289 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
290 @itemize @bullet |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
291 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
292 @uref{http://idlwave.org/screenshots/emacs_21_nav.gif,An IDLWAVE buffer} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
293 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
294 @uref{http://idlwave.org/screenshots/emacs_21_keys.gif,A keyword being completed} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
295 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
296 @uref{http://idlwave.org/screenshots/emacs_21_help.gif,Online help text.} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
297 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
298 @uref{http://idlwave.org/screenshots/emacs_21_ri.gif,Routine information displayed} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
299 @item |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
300 @uref{http://idlwave.org/screenshots/emacs_21_bp.gif,Debugging code |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
301 stopped at a breakpoint} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
302 @end itemize |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
303 @end ifnottex |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
304 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
305 IDLWAVE is the distant successor to the @file{idl.el} and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
306 @file{idl-shell.el} files written by Chris Chase. The modes and files |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
307 had to be renamed because of a name space conflict with CORBA's |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
308 @code{idl-mode}, defined in Emacs in the file @file{cc-mode.el}. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
309 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
310 In this manual, each section ends with a list of related user options. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
311 Don't be confused by the sheer number of options available --- in most |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
312 cases the default settings are just fine. The variables are listed here |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
313 to make sure you know where to look if you want to change anything. For |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
314 a full description of what a particular variable does and how to |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
315 configure it, see the documentation string of that variable (available |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
316 with @kbd{C-h v}). Some configuration examples are also given in the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
317 appendix. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
318 |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
319 @node IDLWAVE in a Nutshell, Getting Started, Introduction, Top |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
320 @chapter IDLWAVE in a Nutshell |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
321 @cindex Summary of important commands |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
322 @cindex IDLWAVE in a Nutshell |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
323 @cindex Nutshell, IDLWAVE in a |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
324 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
325 @subheading Editing IDL Programs |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
326 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
327 @multitable @columnfractions .15 .85 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
328 @item @key{TAB} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
329 @tab Indent the current line relative to context. |
40705 | 330 @item @kbd{C-M-\} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
331 @tab Re-indent all lines in the current region. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
332 @item @kbd{C-M-q} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
333 @tab Re-indent all lines in the current routine. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
334 @item @kbd{C-u @key{TAB}} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
335 @tab Re-indent all lines in the current statement. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
336 @item @kbd{M-@key{RET}} |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
337 @tab Start a continuation line, splitting the current line at point. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
338 @item @kbd{M-q} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
339 @tab Fill the current comment paragraph. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
340 @item @kbd{C-c ?} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
341 @tab Display calling sequence and keywords for the procedure or function call |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
342 at point. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
343 @item @kbd{M-?} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
344 @tab Load context sensitive online help for nearby routine, keyword, etc. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
345 @item @kbd{M-@key{TAB}} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
346 @tab Complete a procedure name, function name or keyword in the buffer. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
347 @item @kbd{C-c C-i} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
348 @tab Update IDLWAVE's knowledge about functions and procedures. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
349 @item @kbd{C-c C-v} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
350 @tab Visit the source code of a procedure/function. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
351 @item @kbd{C-u C-c C-v} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
352 @tab Visit the source code of a procedure/function in this buffer. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
353 @item @kbd{C-c C-h} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
354 @tab Insert a standard documentation header. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
355 @item @kbd{C-c @key{RET}} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
356 @tab Insert a new timestamp and history item in the documentation header. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
357 @end multitable |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
358 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
359 @subheading Running the IDLWAVE Shell, Debugging Programs |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
360 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
361 @multitable @columnfractions .15 .85 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
362 @item @kbd{C-c C-s} |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
363 @tab Start IDL as a subprocess and/or switch to the shell buffer. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
364 @item @key{Up}, @kbd{M-p} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
365 @tab Cycle back through IDL command history. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
366 @item @key{Down},@kbd{M-n} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
367 @tab Cycle forward. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
368 @item @kbd{@key{TAB}} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
369 @tab Complete a procedure name, function name or keyword in the shell buffer. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
370 @item @kbd{C-c C-d C-c} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
371 @tab Save and compile the source file in the current buffer. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
372 @item @kbd{C-c C-d C-x} |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
373 @tab Go to next syntax error. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
374 @item @kbd{C-c C-d C-v} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
375 @tab Switch to electric debug mode. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
376 @item @kbd{C-c C-d C-b} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
377 @tab Set a breakpoint at the nearest viable source line. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
378 @item @kbd{C-c C-d C-d} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
379 @tab Clear the nearest breakpoint. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
380 @item @kbd{C-c C-d [} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
381 @tab Go to the previous breakpoint. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
382 @item @kbd{C-c C-d ]} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
383 @tab Go to the next breakpoint. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
384 @item @kbd{C-c C-d C-p} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
385 @tab Print the value of the expression near point in IDL. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
386 @end multitable |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
387 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
388 @subheading Commonly used Settings in @file{.emacs} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
389 @lisp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
390 ;; Change the indentation preferences |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
391 ;; Start autoloading routine info after 2 idle seconds |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
392 (setq idlwave-init-rinfo-when-idle-after 2) |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
393 ;; Pad operators with spaces |
27600 | 394 (setq idlwave-do-actions t |
395 idlwave-surround-by-blank t) | |
396 ;; Syntax Highlighting | |
397 (add-hook 'idlwave-mode-hook 'turn-on-font-lock) | |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
398 ;; Automatically start the shell when needed |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
399 (setq idlwave-shell-automatic-start t) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
400 ;; Bind debugging commands with CONTROL and SHIFT modifiers |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
401 (setq idlwave-shell-debug-modifiers '(control shift)) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
402 @end lisp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
403 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
404 @html |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
405 <A NAME="TUTORIAL"></A> |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
406 @end html |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
407 |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
408 @node Getting Started, The IDLWAVE Major Mode, IDLWAVE in a Nutshell, Top |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
409 @chapter Getting Started (Tutorial) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
410 @cindex Quick-Start |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
411 @cindex Tutorial |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
412 @cindex Getting Started |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
413 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
414 @menu |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
415 * Lesson I -- Development Cycle:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
416 * Lesson II -- Customization:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
417 * Lesson III -- User Catalog:: |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
418 @end menu |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
419 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
420 @node Lesson I -- Development Cycle, Lesson II -- Customization, Getting Started, Getting Started |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
421 @section Lesson I: Development Cycle |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
422 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
423 The purpose of this tutorial is to guide you through a very basic |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
424 development cycle using IDLWAVE. We will paste a simple program into |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
425 a buffer and use the shell to compile, debug and run it. On the way |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
426 we will use many of the important IDLWAVE commands. Note, however, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
427 that IDLWAVE has many more capabilities than covered here, which can |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
428 be discovered by reading the entire manual, or hovering over the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
429 shoulder of your nearest IDLWAVE guru for a few days. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
430 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
431 It is assumed that you have access to Emacs or XEmacs with the full |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
432 IDLWAVE package including online help@c |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
433 @ifclear PARTOFEMACS |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
434 @ (@pxref{Installation})@c |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
435 @end ifclear |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
436 . We also assume that you are familiar with Emacs and can read the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
437 nomenclature of key presses in Emacs (in particular, @kbd{C} stands |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
438 for @key{CONTROL} and @kbd{M} for @key{META} (often the @key{ALT} key |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
439 carries this functionality)). |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
440 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
441 Open a new source file by typing: |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
442 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
443 @example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
444 @kbd{C-x C-f tutorial.pro @key{RET}} |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
445 @end example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
446 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
447 A buffer for this file will pop up, and it should be in IDLWAVE mode, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
448 indicated in the mode line just below the editing window. Also, the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
449 menu bar should contain @samp{IDLWAVE}. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
450 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
451 Now cut-and-paste the following code, also available as |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
452 @file{tutorial.pro} in the IDLWAVE distribution. |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
453 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
454 @example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
455 function daynr,d,m,y |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
456 ;; compute a sequence number for a date |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
457 ;; works 1901-2099. |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
458 if y lt 100 then y = y+1900 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
459 if m le 2 then delta = 1 else delta = 0 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
460 m1 = m + delta*12 + 1 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
461 y1 = y * delta |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
462 return, d + floor(m1*30.6)+floor(y1*365.25)+5 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
463 end |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
464 |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
465 function weekday,day,month,year |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
466 ;; compute weekday number for date |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
467 nr = daynr(day,month,year) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
468 return, nr mod 7 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
469 end |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
470 |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
471 pro plot_wday,day,month |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
472 ;; Plot the weekday of a date in the first 10 years of this century. |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
473 years = 2000,+indgen(10) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
474 wdays = intarr(10) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
475 for i=0,n_elements(wdays)-1 do begin |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
476 wdays[i] = weekday(day,month,years[i]) |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
477 end |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
478 plot,years,wdays,YS=2,YT="Wday (0=Sunday)" |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
479 end |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
480 @end example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
481 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
482 The indentation probably looks funny, since it's different from the |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
483 settings you use, so use the @key{TAB} key in each line to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
484 automatically line it up (or, more quickly, @emph{select} the entire |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
485 buffer with @kbd{C-x h}, and indent the whole region with |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
486 @kbd{C-M-\}). Notice how different syntactical elements are |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
487 highlighted in different colors, if you have set up support for |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
488 font-lock. |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
489 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
490 Let's check out two particular editing features of IDLWAVE. Place the |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
491 cursor after the @code{end} statement of the @code{for} loop and press |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
492 @key{SPC}. IDLWAVE blinks back to the beginning of the block and |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
493 changes the generic @code{end} to the specific @code{endfor} |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
494 automatically (as long as the variable @code{idlwave-expand-generic-end} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
495 is turned on --- @pxref{Lesson II -- Customization}). Now place the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
496 cursor in any line you would like to split and press @kbd{M-@key{RET}}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
497 The line is split at the cursor position, with the continuation @samp{$} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
498 and indentation all taken care of. Use @kbd{C-/} to undo the last |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
499 change. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
500 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
501 The procedure @code{plot_wday} is supposed to plot the day of the week |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
502 of a given date for the first 10 years of the 21st century. As in |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
503 most code, there are a few bugs, which we are going to use IDLWAVE to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
504 help us fix. |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
505 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
506 First, let's launch the IDLWAVE shell. You do this with the command |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
507 @kbd{C-c C-s}. The Emacs window will split or another window will popup |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
508 to display IDL running in a shell interaction buffer. Type a few |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
509 commands like @code{print,!PI} to convince yourself that you can work |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
510 there just as well as in a terminal, or the IDLDE. Use the arrow keys |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
511 to cycle through your command history. Are we having fun now? |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
512 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
513 Now go back to the source window and type @kbd{C-c C-d C-c} to compile |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
514 the program. If you watch the shell buffer, you see that IDLWAVE types |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
515 @samp{.run "tutorial.pro"} for you. But the compilation fails because |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
516 there is a comma in the line @samp{years=...}. The line with the error |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
517 is highlighted and the cursor positioned at the error, so remove the |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
518 comma (you should only need to hit @kbd{Delete}!). Compile again, using |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
519 the same keystrokes as before. Notice that the file is automatically |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
520 saved for you. This time everything should work fine, and you should |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
521 see the three routines compile. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
522 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
523 Now we want to use the command to plot the day of the week on January |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
524 1st. We could type the full command ourselves, but why do that? Go |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
525 back to the shell window, type @samp{plot_} and hit @key{TAB}. After |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
526 a bit of a delay (while IDLWAVE initializes its routine info database, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
527 if necessary), the window will split to show all procedures it knows |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
528 starting with that string, and @w{@code{plot_wday}} should be one of |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
529 them. Saving the buffer alerted IDLWAVE about this new routine. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
530 Click with the middle mouse button on @code{plot_wday} and it will be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
531 copied to the shell buffer, or if you prefer, add @samp{w} to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
532 @samp{plot_} to make it unambiguous (depending on what other routines |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
533 starting with @samp{plot_} you have installed on your system), hit |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
534 @key{TAB} again, and the full routine name will be completed. Now |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
535 provide the two arguments: |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
536 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
537 @example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
538 plot_wday,1,1 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
539 @end example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
540 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
541 @noindent and press @key{RET}. This fails with an error message telling |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
542 you the @code{YT} keyword to plot is ambiguous. What are the allowed |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
543 keywords again? Go back to the source window and put the cursor into |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
544 the `plot' line and press @kbd{C-c ?}. This shows the routine info |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
545 window for the plot routine, which contains a list of keywords, along |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
546 with the argument list. Oh, we wanted @code{YTITLE}. Fix that up. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
547 Recompile with @kbd{C-c C-d C-c}. Jump back into the shell with |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
548 @kbd{C-c C-s}, press the @key{UP} arrow to recall the previous command |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
549 and execute again. |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
550 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
551 This time we get a plot, but it is pretty ugly --- the points are all |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
552 connected with a line. Hmm, isn't there a way for @code{plot} to use |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
553 symbols instead? What was that keyword? Position the cursor on the |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
554 plot line after a comma (where you'd normally type a keyword), and hit |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
555 @kbd{M-@key{Tab}}. A long list of plot's keywords appears. Aha, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
556 there it is, @code{PSYM}. Middle click to insert it. An @samp{=} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
557 sign is included for you too. Now what were the values of @code{PSYM} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
558 supposed to be? With the cursor on or after the keyword, press |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
559 @kbd{M-?} for online help (alternatively, you could have right clicked |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
560 on the colored keyword itself in the completion list). A browser will |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
561 pop up showing the HTML documentation for the @code{PYSM} keyword. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
562 OK, let's use diamonds=4. Fix this, recompile (you know the command |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
563 by now: @kbd{C-c C-d C-c}), go back to the shell (if it's vanished, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
564 you know what to do: @kbd{C-c C-s}) and execute again. Now things |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
565 look pretty good. |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
566 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
567 Let's try a different day --- how about April fool's day? |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
568 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
569 @example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
570 plot_wday,1,4 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
571 @end example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
572 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
573 Oops, this looks very wrong. All April Fool's days cannot be Fridays! |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
574 We've got a bug in the program, perhaps in the @code{daynr} function. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
575 Let's put a breakpoint on the last line there. Position the cursor on |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
576 the @samp{return, d+...} line and press @kbd{C-c C-d C-b}. IDL sets a |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
577 breakpoint (as you see in the shell window), and the break line is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
578 indicated. Back to the shell buffer, re-execute the previous command. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
579 IDL stops at the line with the breakpoint. Now hold down the SHIFT |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
580 key and click with the middle mouse button on a few variables there: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
581 @samp{d}, @samp{y}, @samp{m}, @samp{y1}, etc. Maybe @code{d} isn't |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
582 the correct type. CONTROL-SHIFT middle-click on it for help. Well, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
583 it's an integer, so that's not the problem. Aha, @samp{y1} is zero, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
584 but it should be the year, depending on delta. Shift click |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
585 @samp{delta} to see that it's 0. Below, we see the offending line: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
586 @samp{y1=y*delta...} the multiplication should have been a minus sign! |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
587 Hit @kbd{q} to exit the debugging mode, and fix the line to read: |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
588 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
589 @example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
590 y1 = y - delta |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
591 @end example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
592 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
593 Now remove all breakpoints: @kbd{C-c C-d C-a}. Recompile and rerun the |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
594 command. Everything should now work fine. How about those leap years? |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
595 Change the code to plot 100 years and see that every 28 years, the |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
596 sequence of weekdays repeats. |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
597 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
598 @node Lesson II -- Customization, Lesson III -- User Catalog, Lesson I -- Development Cycle, Getting Started |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
599 @section Lesson II: Customization |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
600 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
601 Emacs is probably the most customizable piece of software ever written, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
602 and it would be a shame if you did not make use of this to adapt IDLWAVE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
603 to your own preferences. Customizing Emacs or IDLWAVE is accomplished |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
604 by setting Lisp variables in the @file{.emacs} file in your home |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
605 directory --- but do not be dismayed; for the most part, you can just |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
606 copy and work from the examples given here. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
607 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
608 Let's first use a boolean variable. These are variables which you turn |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
609 on or off, much like a checkbox. A value of @samp{t} means on, a value |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
610 of @samp{nil} means off. Copy the following line into your |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
611 @file{.emacs} file, exit and restart Emacs. |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
612 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
613 @lisp |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
614 (setq idlwave-reserved-word-upcase t) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
615 @end lisp |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
616 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
617 When this option is turned on, each reserved word you type into an IDL |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
618 source buffer will be converted to upper case when you press @key{SPC} |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
619 or @key{RET} right after the word. Try it out! @samp{if} changes to |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
620 @samp{IF}, @samp{begin} to @samp{BEGIN}. If you don't like this |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
621 behavior, remove the option again from your @file{.emacs} file and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
622 restart Emacs. |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
623 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
624 You likely have your own indentation preferences for IDL code. For |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
625 example, some may prefer to indent the main block of an IDL program |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
626 slightly from the margin and use only 3 spaces as indentation between |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
627 @code{BEGIN} and @code{END}. Try the following lines in @file{.emacs}: |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
628 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
629 @lisp |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
630 (setq idlwave-main-block-indent 1) |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
631 (setq idlwave-block-indent 3) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
632 (setq idlwave-end-offset -3) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
633 @end lisp |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
634 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
635 Restart Emacs, and re-indent the program we developed in the first part |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
636 of this tutorial with @kbd{C-c h} and @kbd{C-M-\}. You may want to keep |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
637 these lines in @file{.emacs}, with values adjusted to your likings. If |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
638 you want to get more information about any of these variables, type, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
639 e.g., @kbd{C-h v idlwave-main-block-indent @key{RET}}. To find which |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
640 variables can be customized, look for items marked @samp{User Option:} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
641 throughout this manual. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
642 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
643 If you cannot seem to master this Lisp customization in @file{.emacs}, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
644 there is another, more user-friendly way to customize all the IDLWAVE |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
645 variables. You can access it through the IDLWAVE menu in one of the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
646 @file{.pro} buffers, menu item @code{Customize->Browse IDLWAVE |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
647 Group}. Here you'll be presented with all the various variables grouped |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
648 into categories. You can navigate the hierarchy (e.g. @samp{IDLWAVE |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
649 Code Formatting->Idlwave Abbrev And Indent Action->Idlwave Expand |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
650 Generic End} to turn on @code{END} expansion), read about the variables, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
651 change them, and `Save for Future Sessions'. Few of these variables |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
652 need customization, but you can exercise considerable control over |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
653 IDLWAVE's functionality with them. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
654 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
655 You may also find the key bindings used for the debugging commands too |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
656 long and complicated. Often we have heard complaints along the lines |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
657 of, ``Do I really have to go through the finger gymnastics of @kbd{C-c |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
658 C-d C-c} to run a simple command?'' Due to Emacs rules and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
659 conventions, shorter bindings cannot be set by default, but you can |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
660 easily enable them. First, there is a way to assign all debugging |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
661 commands in a single sweep to another simpler combination. The only |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
662 problem is that we have to use something which Emacs does not need for |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
663 other important commands. One good option is to execute debugging |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
664 commands by holding down @key{CONTROL} and @key{SHIFT} while pressing |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
665 a single character: @kbd{C-S-b} for setting a breakpoint, @kbd{C-S-c} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
666 for compiling the current source file, @kbd{C-S-a} for deleting all |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
667 breakpoints (try it, it's easier). You can enable this with: |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
668 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
669 @lisp |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
670 (setq idlwave-shell-debug-modifiers '(shift control)) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
671 @end lisp |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
672 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
673 @noindent If you have a special keyboard with, for example, a |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
674 @key{SUPER} key, you could even shorten that: |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
675 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
676 @lisp |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
677 (setq idlwave-shell-debug-modifiers '(super)) |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
678 @end lisp |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
679 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
680 @noindent to get compilation on @kbd{S-c}. Often, a modifier key like |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
681 @key{SUPER} or @key{HYPER} is bound or can be bound to an otherwise |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
682 unused key on your keyboard --- consult your system documentation. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
683 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
684 You can also assign specific commands to keys. This you must do in the |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
685 @emph{mode-hook}, a special function which is run when a new IDLWAVE |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
686 buffer gets set up. The possibilities for key customization are |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
687 endless. Here we set function keys f4-f8 to common debugging commands. |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
688 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
689 @lisp |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
690 ;; First for the source buffer |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
691 (add-hook 'idlwave-mode-hook |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
692 (lambda () |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
693 (local-set-key [f4] 'idlwave-shell-retall) |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
694 (local-set-key [f5] 'idlwave-shell-break-here) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
695 (local-set-key [f6] 'idlwave-shell-clear-current-bp) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
696 (local-set-key [f7] 'idlwave-shell-cont) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
697 (local-set-key [f8] 'idlwave-shell-clear-all-bp))) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
698 ;; Then for the shell buffer |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
699 (add-hook 'idlwave-shell-mode-hook |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
700 (lambda () |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
701 (local-set-key [f4] 'idlwave-shell-retall) |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
702 (local-set-key [f5] 'idlwave-shell-break-here) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
703 (local-set-key [f6] 'idlwave-shell-clear-current-bp) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
704 (local-set-key [f7] 'idlwave-shell-cont) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
705 (local-set-key [f8] 'idlwave-shell-clear-all-bp))) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
706 @end lisp |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
707 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
708 @node Lesson III -- User Catalog, , Lesson II -- Customization, Getting Started |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
709 @section Lesson III: User and Library Catalogs |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
710 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
711 We have already used the routine info display in the first part of this |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
712 tutorial. This was the invoked using @kbd{C-c ?}, and displays |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
713 information about the IDL routine near the cursor position. Wouldn't it |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
714 be nice to have the same kind of information available for your own |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
715 routines and for the huge amount of code in major libraries like JHUPL |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
716 or the IDL-Astro library? In many cases, you may already have this |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
717 information. Files named @file{.idlwave_catalog} in library directories |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
718 contain scanned information on the routines in that directory; many |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
719 popular libraries ship with these ``library catalogs'' pre-scanned. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
720 Users can scan their own routines in one of two ways: either using the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
721 supplied tool to scan directories and build their own |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
722 @file{.idlwave_catalog} files, or using the built-in method to create a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
723 single ``user catalog'', which we'll show here. @xref{Catalogs}, for |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
724 more information on choosing which method to use. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
725 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
726 To build a user catalog, select @code{Routine Info/Select Catalog |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
727 Directories} from the IDLWAVE entry in the menu bar. If necessary, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
728 start the shell first with @kbd{C-c C-s} (@pxref{Starting the Shell}). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
729 IDLWAVE will find out about the IDL @code{!PATH} variable and offer a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
730 list of directories on the path. Simply select them all (or whichever |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
731 you want --- directories with existing library catalogs will not be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
732 selected by default) and click on the @samp{Scan&Save} button. Then |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
733 go for a cup of coffee while IDLWAVE collects information for each and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
734 every IDL routine on your search path. All this information is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
735 written to the file @file{.idlwave/idlusercat.el} in your home |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
736 directory and will from now on automatically load whenever you use |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
737 IDLWAVE. You may find it necessary to rebuild the catalog on occasion |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
738 as your local libraries change, or build a library catalog for those |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
739 directories instead. Invoke routine info (@kbd{C-c ?}) or completion |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
740 (@kbd{M-@key{TAB}}) on any routine or partial routine name you know to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
741 be located in the library. E.g., if you have scanned the IDL-Astro |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
742 library: |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
743 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
744 @example |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
745 a=readf@key{M-@key{TAB}} |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
746 @end example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
747 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
748 expands to `readfits('. Then try |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
749 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
750 @example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
751 a=readfits(@key{C-c ?} |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
752 @end example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
753 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
754 and you get: |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
755 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
756 @example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
757 Usage: Result = READFITS(filename, header, heap) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
758 ... |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
759 @end example |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
760 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
761 I hope you made it until here. Now you are set to work with IDLWAVE. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
762 On the way you will want to change other things, and to learn more |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
763 about the possibilities not discussed in this short tutorial. Read |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
764 the manual, look at the documentation strings of interesting variables |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
765 (with @kbd{C-h v idlwave<-variable-name> @key{RET}}) and ask the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
766 remaining questions on the newsgroup @code{comp.lang.idl-pvwave}. |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
767 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
768 @node The IDLWAVE Major Mode, The IDLWAVE Shell, Getting Started, Top |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
769 @chapter The IDLWAVE Major Mode |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
770 @cindex IDLWAVE major mode |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
771 @cindex Major mode, @code{idlwave-mode} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
772 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
773 The IDLWAVE major mode supports editing IDL source files. In this |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
774 chapter we describe the main features of the mode and how to customize |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
775 them. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
776 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
777 @menu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
778 * Code Formatting:: Making code look nice |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
779 * Routine Info:: Calling Sequence and Keyword List |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
780 * Online Help:: One key press from source to help |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
781 * Completion:: Completing routine names and Keywords |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
782 * Routine Source:: Finding routines, the easy way |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
783 * Resolving Routines:: Force the Shell to compile a routine |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
784 * Code Templates:: Frequent code constructs |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
785 * Abbreviations:: Abbreviations for common commands |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
786 * Actions:: Changing case, Padding, End checking |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
787 * Doc Header:: Inserting a standard header |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
788 * Motion Commands:: Moving through the structure of a program |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
789 * Misc Options:: Things that fit nowhere else |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
790 @end menu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
791 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
792 @node Code Formatting, Routine Info, The IDLWAVE Major Mode, The IDLWAVE Major Mode |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
793 @section Code Formatting |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
794 @cindex Code formatting |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
795 @cindex Formatting, of code |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
796 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
797 @menu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
798 * Code Indentation:: Reflecting the logical structure |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
799 * Continued Statement Indentation:: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
800 * Comment Indentation:: Special indentation for comment lines |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
801 * Continuation Lines:: Splitting statements over lines |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
802 * Syntax Highlighting:: Font-lock support |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
803 * Octals and Highlighting:: Why "123 causes problems |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
804 @end menu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
805 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
806 The IDL language, with its early roots in FORTRAN, modern |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
807 implementation in C, and liberal borrowing of features of many vector |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
808 and other languages along its 25+ year history, has inherited an |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
809 unusual mix of syntax elements. Left to his or her own devices, a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
810 novice IDL programmer will often conjure code which is very difficult |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
811 to read and impossible to adapt. Much can be gleaned from studying |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
812 available IDL code libraries for coding style pointers, but, due to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
813 the variety of IDL syntax elements, replicating this style can be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
814 challenging at best. Luckily, IDLWAVE understands the structure of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
815 IDL code very well, and takes care of almost all formatting issues for |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
816 you. After configuring it to match your coding standards, you can |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
817 rely on it to help keep your code neat and organized. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
818 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
819 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
820 @node Code Indentation, Continued Statement Indentation, Code Formatting, Code Formatting |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
821 @subsection Code Indentation |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
822 @cindex Code indentation |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
823 @cindex Indentation |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
824 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
825 Like all Emacs programming modes, IDLWAVE performs code indentation. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
826 The @key{TAB} key indents the current line relative to context. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
827 @key{LFD} insert a newline and indents the new line. The indentation is |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
828 governed by a number of variables. IDLWAVE indents blocks (between |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
829 @code{PRO}/@code{FUNCTION}/@code{BEGIN} and @code{END}), and |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
830 continuation lines. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
831 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
832 @cindex Foreign code, adapting |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
833 @cindex Indentation, of foreign code |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
834 @kindex C-M-\ |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
835 To re-indent a larger portion of code (e.g. when working with foreign |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
836 code written with different conventions), use @kbd{C-M-\} |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
837 (@code{indent-region}) after marking the relevant code. Useful marking |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
838 commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
839 subprogram). The command @kbd{C-M-q} reindents the entire current |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
840 routine. @xref{Actions}, for information how to impose additional |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
841 formatting conventions on foreign code. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
842 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
843 @defopt idlwave-main-block-indent (@code{2}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
844 Extra indentation for the main block of code. That is the block between |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
845 the FUNCTION/PRO statement and the END statement for that program |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
846 unit. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
847 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
848 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
849 @defopt idlwave-block-indent (@code{3}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
850 Extra indentation applied to block lines. If you change this, you |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
851 probably also want to change @code{idlwave-end-offset}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
852 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
853 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
854 @defopt idlwave-end-offset (@code{-3}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
855 Extra indentation applied to block END lines. A value equal to negative |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
856 @code{idlwave-block-indent} will make END lines line up with the block |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
857 BEGIN lines. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
858 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
859 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
860 @node Continued Statement Indentation, Comment Indentation, Code Indentation, Code Formatting |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
861 @subsection Continued Statement Indentation |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
862 @cindex Indentation, continued statement |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
863 @cindex Continued statement indentation |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
864 Continuation lines (following a line ending with @code{$}) can receive a |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
865 fixed indentation offset from the main level, but in several situations |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
866 IDLWAVE can use a special form of indentation which aligns continued |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
867 statements more naturally. Special indentation is calculated for |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
868 continued routine definition statements and calls, enclosing parentheses |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
869 (like function calls, structure/class definitions, explicit structures |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
870 or lists, etc.), and continued assignments. An attempt is made to line |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
871 up with the first non-whitespace character after the relevant opening |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
872 punctuation mark (@code{,},@code{(},@code{@{},@code{[},@code{=}). For |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
873 lines without any non-comment characters on the line with the opening |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
874 punctuation, the continued line(s) are aligned just past the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
875 punctuation. An example: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
876 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
877 @example |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
878 function foo, a, b, $ |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
879 c, d |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
880 bar = sin( a + b + $ |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
881 c + d) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
882 end |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
883 @end example |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
884 @noindent |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
885 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
886 The only drawback to this special continued statement indentation is |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
887 that it consumes more space, e.g., for long function names or left hand |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
888 sides of an assignment: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
889 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
890 @example |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
891 function thisfunctionnameisverylongsoitwillleavelittleroom, a, b, $ |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
892 c, d |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
893 @end example |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
894 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
895 You can instruct IDLWAVE when to avoid using this special continuation |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
896 indentation by setting the variable |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
897 @code{idlwave-max-extra-continuation-indent}, which specifies the |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
898 maximum additional indentation beyond the basic indent to be |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
899 tolerated, otherwise defaulting to a fixed-offset from the enclosing |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
900 indent (the size of which offset is set in |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
901 @code{idlwave-continuation-indent}). As a special case, continuations |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
902 of routine calls without any arguments or keywords will @emph{not} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
903 align the continued line, under the assumption that you continued |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
904 because you needed the space. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
905 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
906 Also, since the indentation level can be somewhat dynamic in continued |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
907 statements with special continuation indentation, especially if |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
908 @code{idlwave-max-extra-continuation-indent} is small, the key |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
909 @kbd{C-u @key{TAB}} will re-indent all lines in the current statement. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
910 Note that @code{idlwave-indent-to-open-paren}, if non-@code{nil}, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
911 overrides the @code{idlwave-max-extra-continuation-indent} limit, for |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
912 parentheses only, forcing them always to line up. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
913 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
914 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
915 @defopt idlwave-continuation-indent (@code{2}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
916 Extra indentation applied to normal continuation lines. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
917 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
918 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
919 @defopt idlwave-max-extra-continuation-indent (@code{20}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
920 The maximum additional indentation (over the basic continuation-indent) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
921 that will be permitted for special continues. To effectively disable |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
922 special continuation indentation, set to @code{0}. To enable it |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
923 constantly, set to a large number (like @code{100}). Note that the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
924 indentation in a long continued statement never decreases from line to |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
925 line, outside of nested parentheses statements. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
926 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
927 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
928 @defopt idlwave-indent-to-open-paren (@code{t}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
929 Non-@code{nil} means indent continuation lines to innermost open |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
930 parenthesis, regardless of whether the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
931 @code{idlwave-max-extra-continuation-indent} limit is satisfied. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
932 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
933 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
934 @node Comment Indentation, Continuation Lines, Continued Statement Indentation, Code Formatting |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
935 @subsection Comment Indentation |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
936 @cindex Comment indentation |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
937 @cindex Hanging paragraphs |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
938 @cindex Paragraphs, filling |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
939 @cindex Paragraphs, hanging |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
940 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
941 In IDL, lines starting with a @samp{;} are called @emph{comment lines}. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
942 Comment lines are indented as follows: |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
943 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
944 @multitable @columnfractions .1 .90 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
945 @item @code{;;;} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
946 @tab The indentation of lines starting with three semicolons remains |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
947 unchanged. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
948 @item @code{;;} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
949 @tab Lines starting with two semicolons are indented like the surrounding code. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
950 @item @code{;} |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
951 @tab Lines starting with a single semicolon are indented to a minimum column. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
952 @end multitable |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
953 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
954 @noindent |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
955 The indentation of comments starting in column 0 is never changed. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
956 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
957 @defopt idlwave-no-change-comment |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
958 The indentation of a comment starting with this regexp will not be |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
959 changed. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
960 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
961 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
962 @defopt idlwave-begin-line-comment |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
963 A comment anchored at the beginning of line. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
964 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
965 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
966 @defopt idlwave-code-comment |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
967 A comment that starts with this regexp is indented as if it is a part of |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
968 IDL code. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
969 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
970 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
971 @node Continuation Lines, Syntax Highlighting, Comment Indentation, Code Formatting |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
972 @subsection Continuation Lines and Filling |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
973 @cindex Continuation lines |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
974 @cindex Line splitting |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
975 @cindex String splitting |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
976 @cindex Splitting, of lines |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
977 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
978 @kindex M-@key{RET} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
979 In IDL, a newline character terminates a statement unless preceded by a |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
980 @samp{$}. If you would like to start a continuation line, use |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
981 @kbd{M-@key{RET}}, which calls the command @code{idlwave-split-line}. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
982 It inserts the continuation character @samp{$}, terminates the line and |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
983 indents the new line. The command @kbd{M-@key{RET}} can also be invoked |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
984 inside a string to split it at that point, in which case the @samp{+} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
985 concatenation operator is used. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
986 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
987 @cindex Filling |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
988 @cindex @code{auto-fill-mode} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
989 @cindex Hanging paragraphs |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
990 When filling comment paragraphs, IDLWAVE overloads the normal filling |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
991 functions and uses a function which creates the hanging paragraphs |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
992 customary in IDL routine headers. When @code{auto-fill-mode} is turned |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
993 on (toggle with @kbd{C-c C-a}), comments will be auto-filled. If the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
994 first line of a paragraph contains a match for |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
995 @code{idlwave-hang-indent-regexp} (a dash-space by default), subsequent |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
996 lines are positioned to line up after it, as in the following example. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
997 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
998 @example |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
999 @group |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1000 ;================================= |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1001 ; x - an array containing |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1002 ; lots of interesting numbers. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1003 ; |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1004 ; y - another variable where |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1005 ; a hanging paragraph is used |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1006 ; to describe it. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1007 ;================================= |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1008 @end group |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1009 @end example |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1010 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1011 @kindex M-q |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1012 You can also refill a comment at any time paragraph with @kbd{M-q}. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1013 Comment delimiting lines as in the above example, consisting of one or |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1014 more @samp{;} followed by one or more of the characters @samp{+=-_*}, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1015 are kept in place, as is. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1016 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1017 @defopt idlwave-fill-comment-line-only (@code{t}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1018 Non-@code{nil} means auto fill will only operate on comment lines. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1019 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1020 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1021 @defopt idlwave-auto-fill-split-string (@code{t}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1022 Non-@code{nil} means auto fill will split strings with the IDL @samp{+} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1023 operator. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1024 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1025 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1026 @defopt idlwave-split-line-string (@code{t}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1027 Non-@code{nil} means @code{idlwave-split-line} will split strings with |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1028 @samp{+}. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1029 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1030 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1031 @defopt idlwave-hanging-indent (@code{t}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1032 Non-@code{nil} means comment paragraphs are indented under the hanging |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1033 indent given by @code{idlwave-hang-indent-regexp} match in the first |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1034 line of the paragraph. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1035 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1036 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1037 @defopt idlwave-hang-indent-regexp (@code{"- "}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1038 Regular expression matching the position of the hanging indent |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1039 in the first line of a comment paragraph. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1040 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1041 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1042 @defopt idlwave-use-last-hang-indent (@code{nil}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1043 Non-@code{nil} means use last match on line for |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1044 @code{idlwave-indent-regexp}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1045 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1046 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1047 @node Syntax Highlighting, Octals and Highlighting, Continuation Lines, Code Formatting |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1048 @subsection Syntax Highlighting |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1049 @cindex Syntax highlighting |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1050 @cindex Highlighting of syntax |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1051 @cindex Font lock |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1052 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1053 Highlighting of keywords, comments, strings etc. can be accomplished |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1054 with @code{font-lock}. If you are using @code{global-font-lock-mode} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1055 (in Emacs), or have @code{font-lock} turned on in any other buffer in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1056 XEmacs, it should also automatically work in IDLWAVE buffers. If you'd |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1057 prefer invoking font-lock individually by mode, you can enforce it in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1058 @code{idlwave-mode} with the following line in your @file{.emacs}: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1059 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1060 @lisp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1061 (add-hook 'idlwave-mode-hook 'turn-on-font-lock) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1062 @end lisp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1063 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1064 @noindent IDLWAVE supports 3 increasing levels of syntax highlighting. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1065 The variable @code{font-lock-maximum-decoration} determines which level |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1066 is selected. Individual categories of special tokens can be selected |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1067 for highlighting using the variable |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1068 @code{idlwave-default-font-lock-items}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1069 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1070 @defopt idlwave-default-font-lock-items |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1071 Items which should be fontified on the default fontification level |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1072 2. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1073 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1074 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1075 @node Octals and Highlighting, , Syntax Highlighting, Code Formatting |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1076 @subsection Octals and Highlighting |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1077 @cindex Syntax highlighting, Octals |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1078 @cindex Highlighting of syntax, Octals |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1079 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1080 A rare syntax highlighting problem results from an extremely unfortunate |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1081 notation for octal numbers in IDL: @code{"123}. This unpaired quotation |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1082 mark is very difficult to parse, given that it can be mixed on a single |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1083 line with any number of strings. Emacs will incorrectly identify this |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1084 as a string, and the highlighting of following lines of code can be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1085 distorted, since the string is never terminated. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1086 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1087 One solution to this involves terminating the mistakenly identified |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1088 string yourself by providing a closing quotation mark in a comment: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1089 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1090 @example |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1091 string("305B) + $ ;" <--- for font-lock |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1092 ' is an Angstrom.' |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1093 @end example |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1094 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1095 @noindent A far better solution is to abandon this notation for octals |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1096 altogether, and use the more sensible alternative IDL provides: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1097 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1098 @example |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1099 string('305'OB) + ' is an Angstrom.' |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1100 @end example |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1101 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1102 @noindent This simultaneously solves the font-lock problem and is more |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1103 consistent with the notation for hexadecimal numbers, e.g. @code{'C5'XB}. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1104 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1105 @node Routine Info, Online Help, Code Formatting, The IDLWAVE Major Mode |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1106 @section Routine Info |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1107 @cindex Routine info |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1108 @cindex Updating routine info |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1109 @cindex Scanning buffers for routine info |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1110 @cindex Buffers, scanning for routine info |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1111 @cindex Shell, querying for routine info |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1112 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1113 @kindex C-c C-i |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1114 IDL comes bundled with more than one thousand procedures, functions |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1115 and object methods, and large libraries typically contain hundreds or |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1116 even thousands more (each with a few to tens of keywords and |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1117 arguments). This large command set can make it difficult to remember |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1118 the calling sequence and keywords for the routines you use, but |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1119 IDLWAVE can help. It builds up routine information from a wide |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1120 variety of sources; IDLWAVE in fact knows far more about the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1121 @samp{.pro} routines on your system than IDL itself! It maintains a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1122 list of all built-in routines, with calling sequences and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1123 keywords@footnote{This list is created by scanning the IDL manuals and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1124 might contain (very few) errors. Please report any errors to the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1125 maintainer, so that they can be fixed.}. It also scans Emacs buffers |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1126 for routine definitions, queries the IDLWAVE-Shell for information |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1127 about routines currently compiled there, and automatically locates |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1128 library and user-created catalogs. This information is updated |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1129 automatically, and so should usually be current. To force a global |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1130 update and refresh the routine information, use @kbd{C-c C-i} |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1131 (@code{idlwave-update-routine-info}). |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1132 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1133 @kindex C-c ? |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1134 To display the information about a routine, press @kbd{C-c ?}, which |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1135 calls the command @code{idlwave-routine-info}. When the current cursor |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1136 position is on the name or in the argument list of a procedure or |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1137 function, information will be displayed about the routine. For example, |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1138 consider the indicated cursor positions in the following line: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1139 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1140 @example |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1141 plot,x,alog(x+5*sin(x) + 2), |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1142 | | | | | | | | |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1143 1 2 3 4 5 6 7 8 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1144 @end example |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1145 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1146 @cindex Default routine, for info and help |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1147 On positions 1,2 and 8, information about the @samp{plot} procedure will |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1148 be shown. On positions 3,4, and 7, the @samp{alog} function will be |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1149 described, while positions 5 and 6 will investigate the @samp{sin} |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1150 function. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1151 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1152 When you ask for routine information about an object method, and the |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1153 method exists in several classes, IDLWAVE queries for the class of the |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1154 object, unless the class is already known through a text property on the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1155 @samp{->} operator (@pxref{Object Method Completion and Class |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1156 Ambiguity}), or by having been explicity included in the call |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1157 (e.g. @code{a->myclass::Foo}). |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1158 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1159 @cindex Calling sequences |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1160 @cindex Keywords of a routine |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1161 @cindex Routine source information |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1162 The description displayed contains the calling sequence, the list of |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1163 keywords and the source location of this routine. It looks like this: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1164 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1165 @example |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1166 Usage: XMANAGER, NAME, ID |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1167 Keywords: BACKGROUND CATCH CLEANUP EVENT_HANDLER GROUP_LEADER |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1168 JUST_REG MODAL NO_BLOCK |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1169 Source: SystemLib [LCSB] /soft1/idl53/lib/xmanager.pro |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1170 @end example |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1171 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1172 @cindex Categories, of routines |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1173 @cindex Load-path shadows |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1174 @cindex Shadows, load-path |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1175 @cindex IDL variable @code{!PATH} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1176 @cindex @code{!PATH}, IDL variable |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1177 @cindex IDL variable @code{!DIR} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1178 @cindex @code{!DIR}, IDL variable |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1179 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1180 If a definition of this routine exists in several files accessible to |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1181 IDLWAVE, several @samp{Source} lines will point to the different |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1182 files. This may indicate that your routine is shadowing a system |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1183 library routine, which may or may not be what you want |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1184 (@pxref{Load-Path Shadows}). The information about the calling |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1185 sequence and keywords is derived from the first source listed. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1186 Library routines are available only if you have scanned your local IDL |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1187 directories or are using pre-scanned libraries (@pxref{Catalogs}). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1188 The source entry consists of a @emph{source category}, a set of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1189 @emph{flags} and the path to the @emph{source file}. The following |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1190 default categories exist: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1191 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1192 @multitable @columnfractions .15 .85 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1193 @item @i{System} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1194 @tab A system routine of unknown origin. When the system library has |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1195 been scanned as part of a catalog (@pxref{Catalogs}), this category |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1196 will automatically split into the next two. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1197 @item @i{Builtin} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1198 @tab A builtin system routine with no source code available. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1199 @item @i{SystemLib} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1200 @tab A library system routine in the official lib directory @file{!DIR/lib}. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1201 @item @i{Obsolete} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1202 @tab A library routine in the official lib directory @file{!DIR/lib/obsolete}. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1203 @item @i{Library} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1204 @tab A routine in a file on IDL's search path @code{!PATH}. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1205 @item @i{Other} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1206 @tab Any other routine with a file not known to be on the search path. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1207 @item @i{Unresolved} |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1208 @tab An otherwise unkown routine the shell lists as unresolved |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1209 (referenced, but not compiled). |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1210 @end multitable |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1211 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1212 Any routines discovered in library catalogs (@pxref{Library |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1213 Catalogs}), will display the category assigned during creation, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1214 e.g. @samp{NasaLib}. For routines not discovered in this way, you can |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1215 create additional categories based on the routine's filename using the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1216 variable @code{idlwave-special-lib-alist}. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1217 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1218 @cindex Flags, in routine info |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1219 @cindex Duplicate routines |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1220 @cindex Multiply defined routines |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1221 @cindex Routine definitions, multiple |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1222 The flags @code{[LCSB]} indicate the source of the information IDLWAVE |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1223 has regarding the file: from a library catalog (@w{@code{[L---]}}), |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1224 from a user catalog (@w{@code{[-C--]}}, from the IDL Shell |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1225 (@w{@code{[--S-]}}) or from an Emacs buffer (@w{@code{[---B]}}). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1226 Combinations are possible (a compiled library routine visited in a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1227 buffer might read @w{@code{[L-SB]}}). If a file contains multiple |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1228 definitions of the same routine, the file name will be prefixed with |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1229 @samp{(Nx)} where @samp{N} is the number of definitions. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1230 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1231 @cindex Online Help from the routine info buffer |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1232 @cindex Active text, in routine info |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1233 @cindex Inserting keywords, from routine info |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1234 @cindex Source file, access from routine info |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1235 Some of the text in the @file{*Help*} routine info buffer will be active |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1236 (it is highlighted when the mouse moves over it). Typically, clicking |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1237 with the right mouse button invokes online help lookup, and clicking |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1238 with the middle mouse button inserts keywords or visits files: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1239 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1240 @multitable @columnfractions 0.15 0.85 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1241 @item @i{Usage} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1242 @tab If online help is installed, a click with the @emph{right} mouse |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1243 button on the @i{Usage:} line will access the help for the |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1244 routine (@pxref{Online Help}). |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1245 @item @i{Keyword} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1246 @tab Online help about keywords is also available with the |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1247 @emph{right} mouse button. Clicking on a keyword with the @emph{middle} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1248 mouse button will insert this keyword in the buffer from where |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1249 @code{idlwave-routine-info} was called. Holding down @key{SHIFT} while |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1250 clicking also adds the initial @samp{/}. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1251 @item @i{Source} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1252 @tab Clicking with the @emph{middle} mouse button on a @samp{Source} line |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1253 finds the source file of the routine and visits it in another window. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1254 Another click on the same line switches back to the buffer from which |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1255 @kbd{C-c ?} was called. If you use the @emph{right} mouse button, the |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1256 source will not be visited by a buffer, but displayed in the online help |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1257 window. |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
1258 @item @i{Classes} |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
1259 @tab The @i{Classes} line is only included in the routine info window if |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
1260 the current class inherits from other classes. You can click with the |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
1261 @emph{middle} mouse button to display routine info about the current |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1262 method in other classes on the inheritance chain, if such a method |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1263 exists there. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1264 @end multitable |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1265 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1266 @defopt idlwave-resize-routine-help-window (@code{t}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1267 Non-@code{nil} means resize the Routine-info @file{*Help*} window to |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1268 fit the content. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1269 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1270 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1271 @defopt idlwave-special-lib-alist |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1272 Alist of regular expressions matching special library directories. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1273 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1274 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1275 @defopt idlwave-rinfo-max-source-lines (@code{5}) |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1276 Maximum number of source files displayed in the Routine Info window. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1277 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1278 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1279 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1280 @html |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1281 <A NAME="ONLINE_HELP"></A> |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1282 @end html |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1283 @node Online Help, Completion, Routine Info, The IDLWAVE Major Mode |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1284 @section Online Help |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1285 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1286 @cindex Online Help |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1287 @cindex @file{idlw-help.txt} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1288 @cindex @file{idlw-help.el} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1289 @cindex Installing online help |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1290 @cindex Online Help, Installation |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1291 @cindex Speed, of online help |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1292 @cindex XML Help Catalog |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1293 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1294 For IDL system routines, extensive documentation is supplied with IDL. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1295 IDLWAVE can access the HTML version of this documentation very quickly |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1296 and accurately, based on the local context. This can be @emph{much} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1297 faster than using the IDL online help application, because IDLWAVE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1298 usually gets you to the right place in the documentation directly --- |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1299 e.g. a specific keyword of a routine --- without any additional browsing |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1300 and scrolling. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1301 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1302 For this online help to work, an HTML version of the IDL documentation |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1303 is required. Beginning with IDL 6.2, HTML documentation is distributed |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1304 directly with IDL, along with an XML-based catalog of routine |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1305 information. By default, IDLWAVE automatically attempts to convert this |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1306 XML catalog into a format Emacs can more easily understand, and caches |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1307 this information in your @code{idlwave_config_directory} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1308 (@file{~/.idlwave/}, by default). It also re-scans the XML catalog if |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1309 it is newer than the current cached version. You can force rescan with |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1310 the menu entry @code{IDLWAVE->Routine Info->Rescan XML Help Catalog}. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1311 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1312 Before IDL 6.2, the HTML help was not distributed with IDL, and was not |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1313 part of the standalone IDLWAVE distribution, but had to be downloaded |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1314 separately. This is no longer necessary: all help and routine |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1315 information is supplied with IDL versions 6.2 and later. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1316 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1317 There are a variety of options for displaying the HTML help: see below. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1318 Help for routines without HTML documentation is also available, by using |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1319 the routine documentation header and/or routine source. |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1320 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1321 @kindex M-? |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1322 In any IDL program (or, as with most IDLWAVE commands, in the IDL |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1323 Shell), press @kbd{M-?} (@code{idlwave-context-help}), or click with |
46534
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
1324 @kbd{S-Mouse-3} to access context sensitive online help. The following |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1325 locations are recognized context for help: |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1326 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1327 @cindex Context, for online help |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1328 @multitable @columnfractions .25 .75 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1329 @item @i{Routine names} |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1330 @tab The name of a routine (function, procedure, method). |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1331 @item @i{Keyword Parameters} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1332 @tab A keyword parameter of a routine. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1333 @item @i{System Variables} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1334 @tab System variables like @code{!DPI}. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1335 @item @i{System Variable Tags} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1336 @tab System variables tags like @code{!D.X_SIZE}. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1337 @item @i{IDL Statements} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1338 @tab Statements like @code{PRO}, @code{REPEAT}, @code{COMPILE_OPT}, etc. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1339 @item @i{IDL Controls} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1340 @tab Control structures like @code{FOR}, @code{SWITCH}, etc. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1341 @item @i{Class names} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1342 @tab A class name in an @code{OBJ_NEW} call. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1343 @item @i{Class Init Keywords} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1344 @tab Beyond the class name in an @code{OBJ_NEW} call. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1345 @item @i{Executive Command} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1346 @tab An executive command like @code{.RUN}. Mostly useful in the shell. |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1347 @item @i{Structure Tags} |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1348 @tab Structure tags like @code{state.xsize} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1349 @item @i{Class Tags} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1350 @tab Class tags like @code{self.value}. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1351 @item @i{Default} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1352 @tab The routine that would be selected for routine info display. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1353 @end multitable |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1354 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1355 @cindex @code{OBJ_NEW}, special online help |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1356 Note that the @code{OBJ_NEW} function is special in that the help |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1357 displayed depends on the cursor position. If the cursor is on the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1358 @samp{OBJ_NEW}, this function is described. If it is on the class |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1359 name inside the quotes, the documentation for the class is pulled up. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1360 If the cursor is @emph{after} the class name, anywhere in the argument |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1361 list, the documentation for the corresponding @code{Init} method and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1362 its keywords is targeted. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1363 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1364 Apart from an IDLWAVE buffer or shell, there are two more places from |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1365 which online help can be accessed. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1366 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1367 @itemize @bullet |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1368 @item |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1369 Online help for routines and keywords can be accessed through the |
46534
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
1370 Routine Info display. Click with @kbd{Mouse-3} on an item to see the |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1371 corresponding help (@pxref{Routine Info}). |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1372 @item |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1373 When using completion and Emacs pops up a @file{*Completions*} buffer |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1374 with possible completions, clicking with @kbd{Mouse-3} on a completion |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1375 item invokes help on that item (@pxref{Completion}). Items for which |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1376 help is available in the online system documentation (vs. just the |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1377 program source itself) will be emphasized (e.g. colored blue). |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1378 @end itemize |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1379 @noindent |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1380 In both cases, a blue face indicates that the item is documented in |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1381 the IDL manual, but an attempt will be made to visit non-blue items |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1382 directly in the originating source file. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1383 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1384 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1385 @menu |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1386 * Help with HTML Documentation:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1387 * Help with Source:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1388 @end menu |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1389 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1390 @node Help with HTML Documentation, Help with Source, Online Help, Online Help |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1391 @subsection Help with HTML Documentation |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1392 @cindex HTML Help |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1393 @cindex Help using HTML manuals |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1394 @cindex IDL manual, HTML version |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1395 @cindex IDL Assistant |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1396 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1397 Help using the HTML documentation is invoked with the built-in Emacs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1398 command @code{browse-url}, which displays the relevant help topic in a |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1399 browser of your choosing. Beginning with version 6.2, IDL comes with |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1400 the help browser @emph{IDL Assistant}, which it uses by default for |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1401 displaying online help on all supported platforms. This browser |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1402 offers topical searches, an index, and is also now the default and |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1403 recommended IDLWAVE help browser. The variable |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1404 @code{idlwave-help-use-assistant} controls whether this browser is |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1405 used. Note that, due to limitations in the Assistant, invoking help |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1406 within IDLWAVE and @code{? topic} within IDL will result in two |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1407 running copies of Assistant. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1408 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1409 Aside from the IDL Assistant, there are many possible browsers to choose |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1410 among, with differing advantages and disadvantages. The variable |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1411 @code{idlwave-help-browser-function} controls which browser help is sent |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1412 to (as long as @code{idlwave-help-use-assistant} is not set). This |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1413 function is used to set the variable @code{browse-url-browser-function} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1414 locally for IDLWAVE help only. Customize the latter variable to see |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1415 what choices of browsers your system offers. Certain browsers like |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1416 @code{w3} (bundled with many versions of Emacs) and @code{w3m} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1417 (@uref{http://emacs-w3m.namazu.org/}) are run within Emacs, and use |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1418 Emacs buffers to display the HTML help. This can be convenient, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1419 especially on small displays, and images can even be displayed in-line |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1420 on newer Emacs versions. However, better formatting results are often |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1421 achieved with external browsers, like Mozilla. IDLWAVE assumes any |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1422 browser function containing "w3" is displayed in a local buffer. If you |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1423 are using another Emacs-local browser for which this is not true, set |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1424 the variable @code{idlwave-help-browser-is-local}. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1425 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1426 With IDL 6.2 or later, it is important to ensure that the variable |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1427 @code{idlwave-system-directory} is set (@pxref{Catalogs}). One easy way |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1428 to ensure this is to run the IDL Shell (@kbd{C-c C-s}). It will be |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1429 queried for this directory, and the results will be cached to file for |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1430 subsequent use. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1431 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1432 @xref{HTML Help Browser Tips}, for more information on selecting and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1433 configuring a browser for use with IDL's HTML help system. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1434 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1435 @defopt idlwave-html-system-help-location @file{help/online_help} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1436 Relative directory of the system-supplied HTML help directory, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1437 considered with respect to @code{idlwave-system-directory}. Relevant |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1438 for IDL 6.2 and greater. Should not change. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1439 @end defopt |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1440 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1441 @defopt idlwave-html-help-location @file{/usr/local/etc/} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1442 The directory where the @file{idl_html_help} HTML directory live. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1443 Obsolete and ignored for IDL 6.2 and greater |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1444 (@code{idlwave-html-system-help-location} is used instead). |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1445 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1446 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1447 @defopt idlwave-help-use-assistant @code{t} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1448 If set, use the IDL Assistant if possible for online HTML help, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1449 otherwise use the browser function specified in |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1450 @code{idlwave-help-browser-function}. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1451 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1452 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1453 @defopt idlwave-help-browser-function |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1454 The browser function to use to display IDLWAVE HTML help. Should be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1455 one of the functions available for setting |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1456 @code{browse-url-browser-function}, which see. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1457 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1458 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1459 @defopt idlwave-help-browser-is-local |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1460 Is the browser selected in @code{idlwave-help-browser-function} run in a |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1461 local Emacs buffer or window? Defaults to @code{t} if the function |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1462 contains "-w3". |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1463 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1464 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1465 @defopt idlwave-help-link-face |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1466 The face for links to IDLWAVE online help. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1467 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1468 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1469 @node Help with Source, , Help with HTML Documentation, Online Help |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1470 @subsection Help with Source |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1471 @cindex Help using routine source |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1472 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1473 @cindex Source code, as online help |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1474 @cindex DocLib header, as online help |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1475 For routines which are not documented in an HTML manual (for example |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1476 personal or library routines), the source code itself is used as help |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1477 text. If the requested information can be found in a (more or less) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1478 standard DocLib file header, IDLWAVE shows the header (scrolling down to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1479 a keyword, if appropriate). Otherwise the routine definition statement |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1480 (@code{pro}/@code{function}) is shown. The doclib header sections which |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1481 are searched for include @samp{NAME} and @samp{KEYWORDS}. Localization |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1482 support can be added by customizing the @code{idlwave-help-doclib-name} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1483 and @code{idlwave-help-doclib-keyword} variables. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1484 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1485 @cindex Structure tags, in online help |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1486 @cindex Class tags, in online help |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1487 Help is also available for class structure tags (@code{self.TAG}), and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1488 generic structure tags, if structure tag completion is enabled |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1489 (@pxref{Structure Tag Completion}). This is implemented by visiting the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1490 tag within the class or structure definition source itself. Help is not |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1491 available on built-in system class tags. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1492 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1493 The help window is normally displayed in the same frame, but can be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1494 popped-up in a separate frame. The following commands can be used to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1495 navigate inside the help system for source files: |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1496 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1497 @multitable @columnfractions .15 .85 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1498 @item @kbd{@key{SPACE}} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1499 @tab Scroll forward one page. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1500 @item @kbd{@key{RET}} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1501 @tab Scroll forward one line. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1502 @item @kbd{@key{DEL}} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1503 @tab Scroll back one page. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1504 @item @kbd{h} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1505 @tab Jump to DocLib Header of the routine whose source is displayed |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1506 as help. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1507 @item @kbd{H} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1508 @tab Jump to the first DocLib Header in the file. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1509 @item @kbd{.} @r{(Dot)} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1510 @tab Jump back and forth between the routine definition (the |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1511 @code{pro}/@code{function} statement) and the description of the help |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1512 item in the DocLib header. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1513 @item @kbd{F} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1514 @tab Fontify the buffer like source code. See the variable @code{idlwave-help-fontify-source-code}. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1515 @item @kbd{q} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1516 @tab Kill the help window. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1517 @end multitable |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1518 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1519 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1520 @defopt idlwave-help-use-dedicated-frame (@code{nil}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1521 Non-@code{nil} means use a separate frame for Online Help if possible. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1522 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1523 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1524 @defopt idlwave-help-frame-parameters |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1525 The frame parameters for the special Online Help frame. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1526 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1527 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1528 @defopt idlwave-max-popup-menu-items (@code{20}) |
46534
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
1529 Maximum number of items per pane in pop-up menus. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1530 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1531 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1532 @defopt idlwave-extra-help-function |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1533 Function to call for help if the normal help fails. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1534 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1535 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1536 @defopt idlwave-help-fontify-source-code (@code{nil}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1537 Non-@code{nil} means fontify source code displayed as help. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1538 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1539 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1540 @defopt idlwave-help-source-try-header (@code{t}) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1541 Non-@code{nil} means try to find help in routine header when |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1542 displaying source file. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1543 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1544 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1545 @defopt idlwave-help-doclib-name (@code{"name"}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1546 The case-insensitive heading word in doclib headers to locate the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1547 @emph{name} section. Can be a regexp, e.g. @code{"\\(name\\|nom\\)"}. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1548 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1549 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1550 @defopt idlwave-help-doclib-keyword (@code{"KEYWORD"}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1551 The case-insensitive heading word in doclib headers to locate the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1552 @emph{keywords} section. Can be a regexp. |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
1553 @end defopt |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
1554 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1555 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1556 @node Completion, Routine Source, Online Help, The IDLWAVE Major Mode |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1557 @section Completion |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1558 @cindex Completion |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1559 @cindex Keyword completion |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1560 @cindex Method completion |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1561 @cindex Object method completion |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1562 @cindex Class name completion |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1563 @cindex Function name completion |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1564 @cindex Procedure name completion |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1565 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1566 @kindex M-@key{TAB} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1567 @kindex C-c C-i |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1568 IDLWAVE offers completion for class names, routine names, keywords, |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1569 system variables, system variable tags, class structure tags, regular |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1570 structure tags and file names. As in many programming modes, completion |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1571 is bound to @kbd{M-@key{TAB}} (or simply @kbd{@key{TAB}} in the IDLWAVE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1572 Shell --- @pxref{Using the Shell}). Completion uses exactly the same |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1573 internal information as routine info, so when necessary (rarely) it can |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1574 be updated with @kbd{C-c C-i} (@code{idlwave-update-routine-info}). |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1575 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1576 The completion function is context sensitive and figures out what to |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1577 complete based on the location of the point. Here are example lines and |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1578 what @kbd{M-@key{TAB}} would try to complete when the cursor is on the |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1579 position marked with a @samp{_}: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1580 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1581 @example |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1582 plo_ @r{Procedure} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1583 x = a_ @r{Function} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1584 plot,xra_ @r{Keyword of @code{plot} procedure} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1585 plot,x,y,/x_ @r{Keyword of @code{plot} procedure} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1586 plot,min(_ @r{Keyword of @code{min} function} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1587 obj -> a_ @r{Object method (procedure)} |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1588 a[2,3] = obj -> a_ @r{Object method (function)} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1589 x = obj_new('IDL_ @r{Class name} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1590 x = obj_new('MyCl',a_ @r{Keyword to @code{Init} method in class @code{MyCl}} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1591 pro A_ @r{Class name} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1592 pro _ @r{Fill in @code{Class::} of first method in this file} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1593 !v_ @r{System variable} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1594 !version.t_ @r{Structure tag of system variable} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1595 self.g_ @r{Class structure tag in methods} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1596 state.w_ @r{Structure tag, if tag completion enabled} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1597 name = 'a_ @r{File name (default inside quotes)} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1598 @end example |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1599 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1600 @cindex Completion, ambiguity |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1601 @cindex Completion, forcing function name |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1602 The only place where completion is ambiguous is procedure/function |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1603 @emph{keywords} versus @emph{functions}. After @samp{plot,x,_}, IDLWAVE |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1604 will always assume a keyword to @samp{plot}. However, a function is |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1605 also a possible completion here. You can force completion of a function |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1606 name at such a location by using a prefix arg: @kbd{C-u M-@key{TAB}}. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1607 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1608 Giving two prefix arguments (@kbd{C-u C-u M-@key{TAB}}) prompts for a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1609 regular expression to search among the commands to be completed. As |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1610 an example, completing a blank line in this way will allow you to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1611 search for a procedure matching a regexp. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1612 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1613 @cindex Scrolling the @file{*Completions*} window |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1614 @cindex Completion, scrolling |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1615 @cindex Completion, Online Help |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1616 @cindex Online Help in @file{*Completions*} buffer |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1617 If the list of completions is too long to fit in the |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1618 @file{*Completions*} window, the window can be scrolled by pressing |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1619 @kbd{M-@key{TAB}} repeatedly. Online help (if installed) for each |
46534
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
1620 possible completion is available by clicking with @kbd{Mouse-3} on the |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1621 item. Items for which system online help (from the IDL manual) is |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1622 available will be emphasized (e.g. colored blue). For other items, the |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1623 corresponding source code or DocLib header will be used as the help |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1624 text. |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1625 |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1626 @cindex Completion, cancelling |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1627 @cindex Cancelling completion |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1628 Completion is not a blocking operation --- you are free to continue |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1629 editing, enter commands, or simply ignore the @file{*Completions*} |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1630 buffer during a completion operation. If, however, the most recent |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1631 command was a completion, @kbd{C-g} will remove the buffer and restore |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1632 the window configuration. You can also remove the buffer at any time |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1633 with no negative consequences. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1634 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1635 @defopt idlwave-keyword-completion-adds-equal (@code{t}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1636 Non-@code{nil} means completion automatically adds @samp{=} after |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1637 completed keywords. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1638 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1639 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1640 @defopt idlwave-function-completion-adds-paren (@code{t}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1641 Non-@code{nil} means completion automatically adds @samp{(} after |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1642 completed function. A value of `2' means also add the closing |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1643 parenthesis and position the cursor between the two. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1644 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1645 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1646 @defopt idlwave-completion-restore-window-configuration (@code{t}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1647 Non-@code{nil} means restore window configuration after successful |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1648 completion. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1649 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1650 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1651 @defopt idlwave-highlight-help-links-in-completion (@code{t}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1652 Non-@code{nil} means highlight completions for which system help is |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1653 available. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1654 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1655 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1656 @menu |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1657 * Case of Completed Words:: CaseOFcomPletedWords |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1658 * Object Method Completion and Class Ambiguity:: obj->Method, what? |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1659 * Object Method Completion in the Shell:: |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1660 * Class and Keyword Inheritance:: obj->Method, _EXTRA=e |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1661 * Structure Tag Completion:: Completing state.Tag |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1662 @end menu |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1663 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1664 @node Case of Completed Words, Object Method Completion and Class Ambiguity, Completion, Completion |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1665 @subsection Case of Completed Words |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1666 @cindex Case of completed words |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1667 @cindex Mixed case completion |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1668 IDL is a case-insensitive language, so casing is a matter of style |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1669 only. IDLWAVE helps maintain a consistent casing style for completed |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1670 items. The case of the completed words is determined by what is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1671 already in the buffer. As an exception, when the partial word being |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1672 completed is all lower case, the completion will be lower case as |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1673 well. If at least one character is upper case, the string will be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1674 completed in upper case or mixed case, depending on the value of the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1675 variable @code{idlwave-completion-case}. The default is to use upper |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1676 case for procedures, functions and keywords, and mixed case for object |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1677 class names and methods, similar to the conventions in the IDL |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1678 manuals. For instance, to enable mixed-case completion for routines |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1679 in addition to classes and methods, you need an entry such as |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1680 @code{(routine . preserve)} in that variable. To enable total control |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1681 over the case of completed items, independent of buffer context, set |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1682 @code{idlwave-completion-force-default-case} to non-@code{nil}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1683 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1684 @defopt idlwave-completion-case |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1685 Association list setting the case (UPPER/lower/Capitalized/MixedCase...) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1686 of completed words. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1687 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1688 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1689 @defopt idlwave-completion-force-default-case (@code{nil}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1690 Non-@code{nil} means completion will always honor the settings in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1691 @code{idlwave-completion-case}. When nil (the default), entirely lower |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1692 case strings will always be completed to lower case, no matter what the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1693 settings in @code{idlwave-completion-case}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1694 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1695 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1696 @defopt idlwave-complete-empty-string-as-lower-case (@code{nil}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1697 Non-@code{nil} means the empty string is considered lower case for |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1698 completion. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1699 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1700 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1701 @node Object Method Completion and Class Ambiguity, Object Method Completion in the Shell, Case of Completed Words, Completion |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1702 @subsection Object Method Completion and Class Ambiguity |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1703 @cindex Object methods |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1704 @cindex Class ambiguity |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1705 @cindex @code{self} object, default class |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1706 An object method is not uniquely determined without the object's class. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1707 Since the class is almost always omitted in the calling source (as |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1708 required to obtain the true benefits of object-based programming), |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1709 IDLWAVE considers all available methods in all classes as possible |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1710 method name completions. The combined list of keywords of the current |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1711 method in @emph{all} known classes which contain that method will be |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1712 considered for keyword completion. In the @file{*Completions*} buffer, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1713 the matching classes will be shown next to each item (see option |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1714 @code{idlwave-completion-show-classes}). As a special case, the class |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1715 of an object called @samp{self} is always taken to be the class of the |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1716 current routine, when in an IDLWAVE buffer. All inherits classes are |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1717 considered as well. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1718 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1719 @cindex Forcing class query. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1720 @cindex Class query, forcing |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1721 You can also call @code{idlwave-complete} with a prefix arg: @kbd{C-u |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1722 M-@key{TAB}}. IDLWAVE will then prompt you for the class in order to |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1723 narrow down the number of possible completions. The variable |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1724 @code{idlwave-query-class} can be configured to make such prompting the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1725 default for all methods (not recommended), or selectively for very |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1726 common methods for which the number of completing keywords would be too |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1727 large (e.g. @code{Init,SetProperty,GetProperty}). |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1728 |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1729 @cindex Saving object class on @code{->} |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1730 @cindex @code{->} |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1731 After you have specified the class for a particular statement (e.g. when |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1732 completing the method), IDLWAVE can remember it for the rest of the |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1733 editing session. Subsequent completions in the same statement |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1734 (e.g. keywords) can then reuse this class information. This works by |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1735 placing a text property on the method invocation operator @samp{->}, |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1736 after which the operator will be shown in a different face (bold by |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1737 default). The variable @code{idlwave-store-inquired-class} can be used |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1738 to turn it off or on. |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
1739 |
27600 | 1740 @defopt idlwave-completion-show-classes (@code{1}) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1741 Non-@code{nil} means show up to that many classes in |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1742 @file{*Completions*} buffer when completing object methods and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1743 keywords. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1744 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1745 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1746 @defopt idlwave-completion-fontify-classes (@code{t}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1747 Non-@code{nil} means fontify the classes in completions buffer. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1748 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1749 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1750 @defopt idlwave-query-class (@code{nil}) |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1751 Association list governing query for object classes during completion. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1752 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1753 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1754 @defopt idlwave-store-inquired-class (@code{t}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1755 Non-@code{nil} means store class of a method call as text property on |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1756 @samp{->}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1757 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1758 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1759 @defopt idlwave-class-arrow-face |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1760 Face to highlight object operator arrows @samp{->} which carry a saved |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1761 class text property. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1762 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1763 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1764 @node Object Method Completion in the Shell, Class and Keyword Inheritance, Object Method Completion and Class Ambiguity, Completion |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1765 @subsection Object Method Completion in the Shell |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1766 @cindex Method Completion in Shell |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1767 In the IDLWAVE Shell (@pxref{The IDLWAVE Shell}), objects on which |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1768 methods are being invoked have a special property: they must exist as |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1769 variables, and so their class can be determined (for instance, using the |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1770 @code{obj_class()} function). In the Shell, when attempting completion, |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1771 routine info, or online help within a method routine, a query is sent to |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1772 determine the class of the object. If this query is successful, the |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1773 class found will be used to select appropriate completions, routine |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1774 info, or help. If unsuccessful, information from all known classes will |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1775 be used (as in the buffer). |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1776 |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1777 @node Class and Keyword Inheritance, Structure Tag Completion, Object Method Completion in the Shell, Completion |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1778 @subsection Class and Keyword Inheritance |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1779 @cindex Inheritance, class |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1780 @cindex Keyword inheritance |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1781 @cindex Inheritance, keyword |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1782 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1783 Class inheritance affects which methods are called in IDL. An object of |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1784 a class which inherits methods from one or more superclasses can |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1785 override that method by defining its own method of the same name, extend |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1786 the method by calling the method(s) of its superclass(es) in its |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1787 version, or inherit the method directly by making no modifications. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1788 IDLWAVE examines class definitions during completion and routine |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1789 information display, and records all inheritance information it finds. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1790 This information is displayed if appropriate with the calling sequence |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1791 for methods (@pxref{Routine Info}), as long as variable |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1792 @code{idlwave-support-inheritance} is non-@code{nil}. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1793 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1794 In many class methods, @emph{keyword} inheritance (@code{_EXTRA} and |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1795 @code{_REF_EXTRA}) is used hand-in-hand with class inheritance and |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1796 method overriding. E.g., in a @code{SetProperty} method, this technique |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1797 allows a single call @code{obj->SetProperty} to set properties up the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1798 entire class inheritance chain. This is often referred to as |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1799 @emph{chaining}, and is characterized by chained method calls like |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1800 @w{@code{self->MySuperClass::SetProperty,_EXTRA=e}}. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1801 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1802 IDLWAVE can accomodate this special synergy between class and keyword |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1803 inheritance: if @code{_EXTRA} or @code{_REF_EXTRA} is detected among a |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1804 method's keyword parameters, all keywords of superclass versions of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1805 the method being considered can be included in completion. There is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1806 of course no guarantee that this type of keyword chaining actually |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1807 occurrs, but for some methods it's a very convenient assumption. The |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1808 variable @code{idlwave-keyword-class-inheritance} can be used to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1809 configure which methods have keyword inheritance treated in this |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1810 simple, class-driven way. By default, only @code{Init} and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1811 @code{(Get|Set)Property} are. The completion buffer will label |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1812 keywords based on their originating class. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1813 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1814 @defopt idlwave-support-inheritance (@code{t}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1815 Non-@code{nil} means consider inheritance during completion, online help etc. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1816 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1817 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1818 @defopt idlwave-keyword-class-inheritance |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1819 A list of regular expressions to match methods for which simple |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1820 class-driven keyword inheritance will be used for Completion. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1821 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1822 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1823 @node Structure Tag Completion, , Class and Keyword Inheritance, Completion |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1824 @subsection Structure Tag Completion |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1825 @cindex Completion, structure tag |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1826 @cindex Structure tag completion |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1827 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1828 In many programs, especially those involving widgets, large structures |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1829 (e.g. the @samp{state} structure) are used to communicate among |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1830 routines. It is very convenient to be able to complete structure tags, |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1831 in the same way as for instance variables (tags) of the @samp{self} |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1832 object (@pxref{Object Method Completion and Class Ambiguity}). Add-in |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1833 code for structure tag completion is available in the form of a loadable |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1834 completion module: @file{idlw-complete-structtag.el}. Tag completion in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1835 structures is highly ambiguous (much more so than @samp{self} |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1836 completion), so @code{idlw-complete-structtag} makes an unusual and very |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1837 specific assumption: the exact same variable name is used to refer to |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1838 the structure in all parts of the program. This is entirely unenforced |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1839 by the IDL language, but is a typical convention. If you consistently |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1840 refer to the same structure with the same variable name |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1841 (e.g. @samp{state}), structure tags which are read from its definition |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1842 in the same file can be used for completion. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1843 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1844 Structure tag completion is not enabled by default. To enable it, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1845 simply add the following to your @file{.emacs}: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1846 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1847 @lisp |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1848 (add-hook 'idlwave-load-hook |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1849 (lambda () (require 'idlw-complete-structtag))) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1850 @end lisp |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1851 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1852 Once enabled, you'll also be able to access online help on the structure |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1853 tags, using the usual methods (@pxref{Online Help}). In addition, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1854 structure variables in the shell will be queried for tag names, similar |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1855 to the way object variables in the shell are queried for method names. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1856 So, e.g.: |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1857 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1858 @example |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1859 IDL> st.[Tab] |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1860 @end example |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1861 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1862 @noindent will complete with all structure fields of the structure |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1863 @code{st}. |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1864 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1865 @node Routine Source, Resolving Routines, Completion, The IDLWAVE Major Mode |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1866 @section Routine Source |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1867 @cindex Routine source file |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1868 @cindex Module source file |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1869 @cindex Source file, of a routine |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1870 @kindex C-c C-v |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1871 In addition to clicking on a @i{Source:} line in the routine info |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1872 window, there is another way to quickly visit the source file of a |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1873 routine. The command @kbd{C-c C-v} (@code{idlwave-find-module}) asks |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1874 for a module name, offering the same default as |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1875 @code{idlwave-routine-info} would have used, taken from nearby buffer |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1876 contents. In the minibuffer, specify a complete routine name (including |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1877 any class part). IDLWAVE will display the source file in another |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1878 window, positioned at the routine in question. You can also limit this |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1879 to a routine in the current buffer only, with completion, and a |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1880 context-sensitive default, by using a single prefix (@kbd{C-u C-c C-v}) |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1881 or the convenience binding @kbd{C-c C-t}. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1882 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1883 @cindex Buffers, killing |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1884 @cindex Killing autoloaded buffers |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1885 Since getting the source of a routine into a buffer is so easy with |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1886 IDLWAVE, too many buffers visiting different IDL source files are |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1887 sometimes created. The special command @kbd{C-c C-k} |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1888 (@code{idlwave-kill-autoloaded-buffers}) can be used to easily remove |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
1889 these buffers. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1890 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1891 @node Resolving Routines, Code Templates, Routine Source, The IDLWAVE Major Mode |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1892 @section Resolving Routines |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1893 @cindex @code{RESOLVE_ROUTINE} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1894 @cindex Compiling library modules |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1895 @cindex Routines, resolving |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1896 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1897 The key sequence @kbd{C-c =} calls the command @code{idlwave-resolve} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1898 and sends the line @samp{RESOLVE_ROUTINE, '@var{routine_name}'} to IDL |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1899 in order to resolve (compile) it. The default routine to be resolved is |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1900 taken from context, but you get a chance to edit it. Usually this is |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
1901 not necessary, since IDL automatically discovers routines on its path. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1902 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1903 @code{idlwave-resolve} is one way to get a library module within reach |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1904 of IDLWAVE's routine info collecting functions. A better way is to |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1905 keep routine information available in catalogs (@pxref{Catalogs}). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1906 Routine info on modules will then be available without the need to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
1907 compile the modules first, and even without a running shell. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1908 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1909 @xref{Sources of Routine Info}, for more information on the ways IDLWAVE |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1910 collects data about routines, and how to update this information. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
1911 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1912 @node Code Templates, Abbreviations, Resolving Routines, The IDLWAVE Major Mode |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1913 @section Code Templates |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1914 @cindex Code templates |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1915 @cindex Templates |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1916 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1917 IDLWAVE can insert IDL code templates into the buffer. For a few |
46534
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
1918 templates, this is done with direct key bindings: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1919 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1920 @multitable @columnfractions .15 .85 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1921 @item @kbd{C-c C-c} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1922 @tab @code{CASE} statement template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1923 @item @kbd{C-c C-f} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1924 @tab @code{FOR} loop template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1925 @item @kbd{C-c C-r} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1926 @tab @code{REPEAT} loop template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1927 @item @kbd{C-c C-w} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1928 @tab @code{WHILE} loop template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1929 @end multitable |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1930 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1931 All code templates are also available as abbreviations |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1932 (@pxref{Abbreviations}). |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1933 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1934 @node Abbreviations, Actions, Code Templates, The IDLWAVE Major Mode |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1935 @section Abbreviations |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1936 @cindex Abbreviations |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1937 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1938 Special abbreviations exist to enable rapid entry of commonly used |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1939 commands. Emacs abbreviations are expanded by typing text into the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1940 buffer and pressing @key{SPC} or @key{RET}. The special abbreviations |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1941 used to insert code templates all start with a @samp{\} (the backslash), |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1942 or, optionally, any other character set in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1943 @code{idlwave-abbrev-start-char}. IDLWAVE ensures that abbreviations are |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1944 only expanded where they should be (i.e., not in a string or comment), |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1945 and permits the point to be moved after an abbreviation expansion --- |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1946 very useful for positioning the mark inside of parentheses, etc. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1947 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1948 Special abbreviations are pre-defined for code templates and other |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1949 useful items. To visit the full list of abbreviations, use @kbd{M-x |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1950 idlwave-list-abbrevs}. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1951 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1952 Template abbreviations: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1953 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1954 @multitable @columnfractions .15 .85 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1955 @item @code{\pr} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1956 @tab @code{PROCEDURE} template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1957 @item @code{\fu} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1958 @tab @code{FUNCTION} template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1959 @item @code{\c} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1960 @tab @code{CASE} statement template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1961 @item @code{\f} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1962 @tab @code{FOR} loop template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1963 @item @code{\r} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1964 @tab @code{REPEAT} loop template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1965 @item @code{\w} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1966 @tab @code{WHILE} loop template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1967 @item @code{\i} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1968 @tab @code{IF} statement template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1969 @item @code{\elif} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1970 @tab @code{IF-ELSE} statement template |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
1971 @end multitable |
27600 | 1972 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1973 String abbreviations: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1974 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1975 @multitable @columnfractions .15 .85 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1976 @item @code{\ap} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1977 @tab @code{arg_present()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1978 @item @code{\b} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1979 @tab @code{begin} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1980 @item @code{\cb} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1981 @tab @code{byte()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1982 @item @code{\cc} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1983 @tab @code{complex()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1984 @item @code{\cd} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1985 @tab @code{double()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1986 @item @code{\cf} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1987 @tab @code{float()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1988 @item @code{\cl} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1989 @tab @code{long()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1990 @item @code{\co} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1991 @tab @code{common} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1992 @item @code{\cs} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1993 @tab @code{string()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1994 @item @code{\cx} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1995 @tab @code{fix()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1996 @item @code{\e} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1997 @tab @code{else} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1998 @item @code{\ec} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
1999 @tab @code{endcase} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2000 @item @code{\ee} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2001 @tab @code{endelse} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2002 @item @code{\ef} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2003 @tab @code{endfor} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2004 @item @code{\ei} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2005 @tab @code{endif else if} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2006 @item @code{\el} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2007 @tab @code{endif else} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2008 @item @code{\en} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2009 @tab @code{endif} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2010 @item @code{\er} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2011 @tab @code{endrep} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2012 @item @code{\es} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2013 @tab @code{endswitch} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2014 @item @code{\ew} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2015 @tab @code{endwhile} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2016 @item @code{\g} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2017 @tab @code{goto,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2018 @item @code{\h} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2019 @tab @code{help,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2020 @item @code{\ik} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2021 @tab @code{if keyword_set() then} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2022 @item @code{\iap} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2023 @tab @code{if arg_present() then} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2024 @item @code{\ine} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2025 @tab @code{if n_elements() eq 0 then} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2026 @item @code{\inn} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2027 @tab @code{if n_elements() ne 0 then} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2028 @item @code{\k} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2029 @tab @code{keyword_set()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2030 @item @code{\n} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2031 @tab @code{n_elements()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2032 @item @code{\np} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2033 @tab @code{n_params()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2034 @item @code{\oi} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2035 @tab @code{on_ioerror,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2036 @item @code{\or} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2037 @tab @code{openr,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2038 @item @code{\ou} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2039 @tab @code{openu,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2040 @item @code{\ow} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2041 @tab @code{openw,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2042 @item @code{\p} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2043 @tab @code{print,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2044 @item @code{\pt} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2045 @tab @code{plot,} |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2046 @item @code{\pv} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2047 @tab @code{ptr_valid()} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2048 @item @code{\re} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2049 @tab @code{read,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2050 @item @code{\rf} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2051 @tab @code{readf,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2052 @item @code{\rt} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2053 @tab @code{return} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2054 @item @code{\ru} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2055 @tab @code{readu,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2056 @item @code{\s} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2057 @tab @code{size()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2058 @item @code{\sc} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2059 @tab @code{strcompress()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2060 @item @code{\sl} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2061 @tab @code{strlowcase()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2062 @item @code{\sm} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2063 @tab @code{strmid()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2064 @item @code{\sn} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2065 @tab @code{strlen()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2066 @item @code{\sp} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2067 @tab @code{strpos()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2068 @item @code{\sr} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2069 @tab @code{strtrim()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2070 @item @code{\st} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2071 @tab @code{strput()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2072 @item @code{\su} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2073 @tab @code{strupcase()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2074 @item @code{\t} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2075 @tab @code{then} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2076 @item @code{\u} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2077 @tab @code{until} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2078 @item @code{\wc} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2079 @tab @code{widget_control,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2080 @item @code{\wi} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2081 @tab @code{widget_info()} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2082 @item @code{\wu} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2083 @tab @code{writeu,} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2084 @end multitable |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2085 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2086 @noindent You can easily add your own abbreviations or override existing |
46534
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
2087 abbrevs with @code{define-abbrev} in your mode hook, using the |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2088 convenience function @code{idlwave-define-abbrev}: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2089 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2090 @lisp |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2091 (add-hook 'idlwave-mode-hook |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2092 (lambda () |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2093 (idlwave-define-abbrev "wb" "widget_base()" |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2094 (idlwave-keyword-abbrev 1)) |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2095 (idlwave-define-abbrev "ine" "IF N_Elements() EQ 0 THEN" |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2096 (idlwave-keyword-abbrev 11)))) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2097 @end lisp |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2098 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2099 Notice how the abbreviation (here @emph{wb}) and its expansion |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2100 (@emph{widget_base()}) are given as arguments, and the single argument to |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2101 @code{idlwave-keyword-abbrev} (here @emph{1}) specifies how far back to |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2102 move the point upon expansion (in this example, to put it between the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2103 parentheses). |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2104 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2105 The abbreviations are expanded in upper or lower case, depending upon |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2106 the variables @code{idlwave-abbrev-change-case} and, for reserved word |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2107 templates, @code{idlwave-reserved-word-upcase} (@pxref{Case Changes}). |
27600 | 2108 |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2109 @defopt idlwave-abbrev-start-char (@code{"\"}) |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2110 A single character string used to start abbreviations in abbrev mode. |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2111 Beware of common characters which might naturally occur in sequence with |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2112 abbreviation strings. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2113 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2114 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2115 @defopt idlwave-abbrev-move (@code{t}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2116 Non-@code{nil} means the abbrev hook can move point, e.g. to end up |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2117 between the parentheses of a function call. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2118 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2119 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2120 @node Actions, Doc Header, Abbreviations, The IDLWAVE Major Mode |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2121 @section Actions |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2122 @cindex Actions |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2123 @cindex Coding standards, enforcing |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2124 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2125 @emph{Actions} are special formatting commands which are executed |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2126 automatically while you write code in order to check the structure of |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2127 the program or to enforce coding standards. Most actions which have |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2128 been implemented in IDLWAVE are turned off by default, assuming that the |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2129 average user wants her code the way she writes it. But if you are a |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2130 lazy typist and want your code to adhere to certain standards, actions |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2131 can be helpful. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2132 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2133 Actions can be applied in three ways: |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2134 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2135 @itemize @bullet |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2136 @item |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2137 Some actions are applied directly while typing. For example, pressing |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2138 @samp{=} can run a check to make sure that this operator is surrounded |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2139 by spaces and insert these spaces if necessary. Pressing @key{SPC} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2140 after a reserved word can call a command to change the word to upper |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2141 case. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2142 @item |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2143 When a line is re-indented with @key{TAB}, actions can be applied to the |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2144 entire line. To enable this, the variable @code{idlwave-do-actions} |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2145 must be non-@code{nil}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2146 @item |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2147 @cindex Foreign code, adapting |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2148 @cindex Actions, applied to foreign code |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2149 Actions can also be applied to a larger piece of code, e.g. to convert |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2150 foreign code to your own style. To do this, mark the relevant part of |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2151 the code and execute @kbd{M-x expand-region-abbrevs}. Useful marking |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2152 commands are @kbd{C-x h} (the entire file) or @kbd{C-M-h} (the current |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2153 subprogram). @xref{Code Indentation}, for information how to adjust the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2154 indentation of the code. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2155 @end itemize |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2156 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2157 @defopt idlwave-do-actions (@code{nil}) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2158 Non-@code{nil} means performs actions when indenting. Individual action |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2159 settings are described below and set separately. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2160 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2161 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2162 @menu |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2163 * Block Boundary Check:: Is the END statement correct? |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2164 * Padding Operators:: Enforcing space around `=' etc |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2165 * Case Changes:: Enforcing upper case keywords |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2166 @end menu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2167 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2168 @node Block Boundary Check, Padding Operators, Actions, Actions |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2169 @subsection Block Boundary Check |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2170 @cindex Block boundary check |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2171 @cindex @code{END} type checking |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2172 @cindex @code{END}, automatic insertion |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2173 @cindex @code{END}, expanding |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2174 @cindex Block, closing |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2175 @cindex Closing a block |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2176 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2177 Whenever you type an @code{END} statement, IDLWAVE finds the |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2178 corresponding start of the block and the cursor blinks back to that |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2179 location for a second. If you have typed a specific @code{END}, like |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2180 @code{ENDIF} or @code{ENDCASE}, you get a warning if that terminator |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2181 does not match the type of block it terminates. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2182 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2183 Set the variable @code{idlwave-expand-generic-end} in order to have all |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2184 generic @code{END} statements automatically expanded to the appropriate |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2185 type. You can also type @kbd{C-c ]} to close the current block by |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2186 inserting the appropriate @code{END} statement. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2187 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2188 @defopt idlwave-show-block (@code{t}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2189 Non-@code{nil} means point blinks to block beginning for |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2190 @code{idlwave-show-begin}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2191 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2192 |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2193 @defopt idlwave-expand-generic-end (@code{t}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2194 Non-@code{nil} means expand generic END to ENDIF/ENDELSE/ENDWHILE etc. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2195 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2196 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2197 @defopt idlwave-reindent-end (@code{t}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2198 Non-@code{nil} means re-indent line after END was typed. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2199 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2200 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2201 @node Padding Operators, Case Changes, Block Boundary Check, Actions |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2202 @subsection Padding Operators |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2203 @cindex Padding operators with spaces |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2204 @cindex Operators, padding with spaces |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2205 @cindex Space, around operators |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2206 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2207 Some operators can be automatically surrounded by spaces. This can |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2208 happen when the operator is typed, or later when the line is indented. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2209 IDLWAVE can pad the operators @samp{<}, @samp{>}, @samp{,}, @samp{=}, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2210 and @samp{->}, as well as the modified assignment operators |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2211 (@samp{AND=}, @samp{OR=}, etc.). This feature is turned off by default. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2212 If you want to turn it on, customize the variables |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2213 @code{idlwave-surround-by-blank} and @code{idlwave-do-actions} and turn |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2214 both on. You can also define similar actions for other operators by |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2215 using the function @code{idlwave-action-and-binding} in the mode hook. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2216 For example, to enforce space padding of the @samp{+} and @samp{*} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2217 operators (outside of strings and comments, of course), try this in |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2218 @file{.emacs} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2219 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2220 @lisp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2221 (add-hook 'idlwave-mode-hook |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2222 (lambda () |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2223 (setq idlwave-surround-by-blank t) ; Turn this type of actions on |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2224 (idlwave-action-and-binding "*" '(idlwave-surround 1 1)) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2225 (idlwave-action-and-binding "+" '(idlwave-surround 1 1)))) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2226 @end lisp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2227 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2228 Note that the modified assignment operators which begin with a word |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2229 (@samp{AND=}, @samp{OR=}, @samp{NOT=}, etc.) require a leading space to |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2230 be recognized (e.g @code{vAND=4} would be intepreted as a variable |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2231 @code{vAND}). Also note that, since e.g., @code{>} and @code{>=} are |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2232 both valid operators, it is impossible to surround both by blanks while |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2233 they are being typed. Similarly with @code{&} and @code{&&}. For |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2234 these, a compromise is made: the padding is placed on the left, and if |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2235 the longer operator is keyed in, on the right as well (otherwise you |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2236 must insert spaces to pad right yourself, or press simply press Tab to |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2237 repad everything if @code{idlwave-do-actions} is on). |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2238 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2239 @defopt idlwave-surround-by-blank (@code{nil}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2240 Non-@code{nil} means enable @code{idlwave-surround}. If non-@code{nil}, |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2241 @samp{=}, @samp{<}, @samp{>}, @samp{&}, @samp{,}, @samp{->}, and the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2242 modified assignment operators (@samp{AND=}, @samp{OR=}, etc.) are |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2243 surrounded with spaces by @code{idlwave-surround}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2244 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2245 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2246 @defopt idlwave-pad-keyword (@code{t}) |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2247 Non-@code{nil} means space-pad the @samp{=} in keyword assignments. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2248 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2249 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2250 @node Case Changes, , Padding Operators, Actions |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2251 @subsection Case Changes |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2252 @cindex Case changes |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2253 @cindex Upcase, enforcing for reserved words |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2254 @cindex Downcase, enforcing for reserved words |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2255 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2256 Actions can be used to change the case of reserved words or expanded |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2257 abbreviations by customizing the variables |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2258 @code{idlwave-abbrev-change-case} and |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2259 @code{idlwave-reserved-word-upcase}. If you want to change the case of |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2260 additional words automatically, put something like the following into |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2261 your @file{.emacs} file: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2262 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2263 @lisp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2264 (add-hook 'idlwave-mode-hook |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2265 (lambda () |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2266 ;; Capitalize system vars |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2267 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2268 ;; Capitalize procedure name |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2269 (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<" |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2270 '(capitalize-word 1) t) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2271 ;; Capitalize common block name |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2272 (idlwave-action-and-binding "\\<common\\>[ \t]+\\<" |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2273 '(capitalize-word 1) t))) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2274 @end lisp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2275 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2276 For more information, see the documentation string for the function |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2277 @code{idlwave-action-and-binding}. For information on controlling the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2278 case of routines, keywords, classes, and methods as they are completed, see |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2279 @ref{Completion}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2280 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2281 @defopt idlwave-abbrev-change-case (@code{nil}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2282 Non-@code{nil} means all abbrevs will be forced to either upper or lower |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60880
diff
changeset
|
2283 case. Valid values are @code{nil}, @code{t}, and @code{down}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2284 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2285 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2286 @defopt idlwave-reserved-word-upcase (@code{nil}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2287 Non-@code{nil} means reserved words will be made upper case via abbrev |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2288 expansion. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2289 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2290 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2291 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2292 @node Doc Header, Motion Commands, Actions, The IDLWAVE Major Mode |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2293 @section Documentation Header |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2294 @cindex Documentation header |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2295 @cindex DocLib header |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2296 @cindex Modification timestamp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2297 @cindex Header, for file documentation |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2298 @cindex Timestamp, in doc header. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2299 @cindex Changelog, in doc header. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2300 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2301 @kindex C-c C-h |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2302 @kindex C-c C-m |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2303 The command @kbd{C-c C-h} inserts a standard routine header into the |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2304 buffer, with the usual fields for documentation (a different header can |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2305 be specified with @code{idlwave-file-header}). One of the keywords is |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2306 @samp{MODIFICATION HISTORY} under which the changes to a routine can be |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2307 recorded. The command @kbd{C-c C-m} jumps to the @samp{MODIFICATION |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2308 HISTORY} of the current routine or file and inserts the user name with a |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2309 timestamp. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2310 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2311 @defopt idlwave-file-header |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2312 The doc-header template or a path to a file containing it. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2313 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2314 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2315 @defopt idlwave-header-to-beginning-of-file (@code{nil}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2316 Non-@code{nil} means the documentation header will always be at start |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2317 of file. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2318 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2319 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2320 @defopt idlwave-timestamp-hook |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2321 The hook function used to update the timestamp of a function. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2322 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2323 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2324 @defopt idlwave-doc-modifications-keyword |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2325 The modifications keyword to use with the log documentation commands. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2326 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2327 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2328 @defopt idlwave-doclib-start |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2329 Regexp matching the start of a document library header. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2330 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2331 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2332 @defopt idlwave-doclib-end |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2333 Regexp matching the start of a document library header. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2334 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2335 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2336 @node Motion Commands, Misc Options, Doc Header, The IDLWAVE Major Mode |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2337 @section Motion Commands |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2338 @cindex Motion commands |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2339 @cindex Program structure, moving through |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2340 @cindex Code structure, moving through |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2341 @cindex @file{Func-menu}, XEmacs package |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2342 @cindex @file{Imenu}, Emacs package |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2343 @cindex Function definitions, jumping to |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2344 @cindex Procedure definitions, jumping to |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2345 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2346 IDLWAVE supports both @file{Imenu} and @file{Func-menu}, two packages |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2347 which make it easy to jump to the definitions of functions and |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2348 procedures in the current file with a pop-up selection. To bind |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2349 @file{Imenu} to a mouse-press, use in your @file{.emacs}: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2350 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2351 @lisp |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2352 (define-key global-map [S-down-mouse-3] 'imenu) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2353 @end lisp |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2354 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2355 @cindex @file{Speedbar}, Emacs package |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2356 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2357 In addition, @file{Speedbar} support allows convenient navigation of a |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2358 source tree of IDL routine files, quickly stepping to routine |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2359 definitions. See @code{Tools->Display Speedbar}. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2360 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2361 Several commands allow you to move quickly through the structure of an |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2362 IDL program: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2363 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2364 @multitable @columnfractions .15 .85 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2365 @item @kbd{C-M-a} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2366 @tab Beginning of subprogram |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2367 @item @kbd{C-M-e} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2368 @tab End of subprogram |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2369 @item @kbd{C-c @{} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2370 @tab Beginning of block (stay inside the block) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2371 @item @kbd{C-c @}} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2372 @tab End of block (stay inside the block) |
40705 | 2373 @item @kbd{C-M-n} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2374 @tab Forward block (on same level) |
40705 | 2375 @item @kbd{C-M-p} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2376 @tab Backward block (on same level) |
40705 | 2377 @item @kbd{C-M-d} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2378 @tab Down block (enters a block) |
40705 | 2379 @item @kbd{C-M-u} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2380 @tab Backward up block (leaves a block) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2381 @item @kbd{C-c C-n} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2382 @tab Next Statement |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2383 @end multitable |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2384 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2385 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2386 @node Misc Options, , Motion Commands, The IDLWAVE Major Mode |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2387 @section Miscellaneous Options |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2388 @cindex Hooks |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2389 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2390 @defopt idlwave-help-application |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2391 The external application providing reference help for programming. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2392 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2393 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2394 @defopt idlwave-startup-message (@code{t}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2395 Non-@code{nil} means display a startup message when @code{idlwave-mode}' |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2396 is first called. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2397 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2398 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2399 @defopt idlwave-mode-hook |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2400 Normal hook. Executed when a buffer is put into @code{idlwave-mode}. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2401 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2402 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2403 @defopt idlwave-load-hook |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2404 Normal hook. Executed when @file{idlwave.el} is loaded. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2405 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2406 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2407 @ifset PARTOFEMACS |
60880
78ef32e30574
Don't say where to get IDL or its non-free manual.
Richard M. Stallman <rms@gnu.org>
parents:
58527
diff
changeset
|
2408 @node The IDLWAVE Shell, Acknowledgements, The IDLWAVE Major Mode, Top |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2409 @end ifset |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2410 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2411 @ifclear PARTOFEMACS |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2412 @node The IDLWAVE Shell, Installation, The IDLWAVE Major Mode, Top |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2413 @end ifclear |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2414 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2415 @chapter The IDLWAVE Shell |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2416 @cindex IDLWAVE shell |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2417 @cindex Major mode, @code{idlwave-shell-mode} |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2418 @cindex IDL, as Emacs subprocess |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2419 @cindex Subprocess of Emacs, IDL |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2420 @cindex Comint, Emacs package |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2421 @cindex Windows |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2422 @cindex MacOS |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2423 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2424 The IDLWAVE shell is an Emacs major mode which permits running the IDL |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2425 program as an inferior process of Emacs, and works closely with the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2426 IDLWAVE major mode in buffers. It can be used to work with IDL |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2427 interactively, to compile and run IDL programs in Emacs buffers and to |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2428 debug these programs. The IDLWAVE shell is built on @file{comint}, an |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2429 Emacs packages which handles the communication with the IDL program. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2430 Unfortunately, IDL for Windows does not have command-prompt versions and |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2431 thus do not allow the interaction with Emacs --- so the IDLWAVE shell |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2432 currently only works under Unix and MacOSX. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2433 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2434 @menu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2435 * Starting the Shell:: How to launch IDL as a subprocess |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2436 * Using the Shell:: Interactively working with the Shell |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2437 * Commands Sent to the Shell:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2438 * Debugging IDL Programs:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2439 * Examining Variables:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2440 * Custom Expression Examination:: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2441 @end menu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2442 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2443 @node Starting the Shell, Using the Shell, The IDLWAVE Shell, The IDLWAVE Shell |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2444 @section Starting the Shell |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2445 @cindex Starting the shell |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2446 @cindex Shell, starting |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2447 @cindex Dedicated frame, for shell buffer |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2448 @cindex Frame, for shell buffer |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2449 @cindex Subprocess of Emacs, IDL |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2450 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2451 @kindex C-c C-s |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2452 The IDLWAVE shell can be started with the command @kbd{M-x |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2453 idlwave-shell}. In @code{idlwave-mode} the function is bound to |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2454 @kbd{C-c C-s}. It creates a buffer @file{*idl*} which is used to |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2455 interact with the shell. If the shell is already running, @kbd{C-c |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2456 C-s} will simply switch to the shell buffer. The command @kbd{C-c |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2457 C-l} (@code{idlwave-shell-recenter-shell-window}) displays the shell |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2458 window without selecting it. The shell can also be started |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2459 automatically when another command tries to send a command to it. To |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2460 enable auto start, set the variable |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2461 @code{idlwave-shell-automatic-start} to @code{t}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2462 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2463 In order to create a separate frame for the IDLWAVE shell buffer, call |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2464 @code{idlwave-shell} with a prefix argument: @kbd{C-u C-c C-s} or |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2465 @kbd{C-u C-c C-l}. If you always want a dedicated frame for the shell |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2466 window, configure the variable |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2467 @code{idlwave-shell-use-dedicated-frame}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2468 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2469 To launch a quick IDLWAVE shell directly from a shell prompt without |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2470 an IDLWAVE buffer (e.g., as a replacement for running inside an |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2471 xterm), define a system alias with the following content: |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2472 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2473 @example |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2474 emacs -geometry 80x32 -eval "(idlwave-shell 'quick)" |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2475 @end example |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2476 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2477 Replace the @samp{-geometry 80x32} option with @samp{-nw} if you prefer |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2478 the Emacs process to run directly inside the terminal window. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2479 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2480 @cindex ENVI |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2481 @cindex IDL> Prompt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2482 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2483 To use IDLWAVE with ENVI or other custom packages which change the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2484 @samp{IDL> } prompt, you must change the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2485 @code{idlwave-shell-prompt-pattern}, which defaults to @samp{"^ ?IDL> |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2486 "}. Normally, you can just replace the @samp{IDL} in this expression |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2487 with the prompt you see. A suitable pattern which matches the prompt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2488 for both ENVI and IDL simultaneously is @samp{"^ ?\\(ENVI\\|IDL\\)> "}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2489 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2490 @defopt idlwave-shell-explicit-file-name (@file{idl}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2491 This is the command to run IDL. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2492 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2493 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2494 @defopt idlwave-shell-command-line-options |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2495 A list of command line options for calling the IDL program. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2496 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2497 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2498 @defopt idlwave-shell-prompt-pattern |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2499 Regexp to match IDL prompt at beginning of a line. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2500 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2501 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2502 @defopt idlwave-shell-process-name |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2503 Name to be associated with the IDL process. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2504 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2505 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2506 @defopt idlwave-shell-automatic-start (@code{nil}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2507 Non-@code{nil} means attempt to invoke idlwave-shell if not already |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2508 running. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2509 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2510 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2511 @defopt idlwave-shell-initial-commands |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2512 Initial commands, separated by newlines, to send to IDL. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2513 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2514 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2515 @defopt idlwave-shell-save-command-history (@code{t}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2516 Non-@code{nil} means preserve command history between sessions. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2517 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2518 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2519 @defopt idlwave-shell-command-history-file (@file{~/.idlwave/.idlwhist}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2520 The file in which the command history of the idlwave shell is saved. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2521 Unless it's an absolute path, it goes in |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2522 @code{idlwave-config-directory}. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2523 @end defopt |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2524 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2525 @defopt idlwave-shell-use-dedicated-frame (@code{nil}) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2526 Non-@code{nil} means IDLWAVE should use a special frame to display the |
49600
23a1cea22d13
Trailing whitespace deleted.
Juanma Barranquero <lekktu@gmail.com>
parents:
47737
diff
changeset
|
2527 shell buffer. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2528 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2529 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2530 @defopt idlwave-shell-use-dedicated-window (@code{nil}) |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2531 Non-@code{nil} means use a dedicated window for the shell, taking care |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2532 not it replace it with other buffers. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2533 @end defopt |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2534 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2535 @defopt idlwave-shell-frame-parameters |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2536 The frame parameters for a dedicated idlwave-shell frame. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2537 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2538 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2539 @defopt idlwave-shell-raise-frame (@code{t}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2540 Non-@code{nil} means `idlwave-shell' raises the frame showing the shell |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2541 window. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2542 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2543 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2544 @defopt idlwave-shell-temp-pro-prefix |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2545 The prefix for temporary IDL files used when compiling regions. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2546 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2547 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2548 @cindex Hooks |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2549 @defopt idlwave-shell-mode-hook |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2550 Hook for customizing @code{idlwave-shell-mode}. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2551 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2552 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2553 @node Using the Shell, Commands Sent to the Shell, Starting the Shell, The IDLWAVE Shell |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2554 @section Using the Shell |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2555 @cindex Comint |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2556 @cindex Shell, basic commands |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2557 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2558 The IDLWAVE shell works in the same fashion as other shell modes in |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2559 Emacs. It provides command history, command line editing and job |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2560 control. The @key{UP} and @key{DOWN} arrows cycle through the input |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2561 history just like in an X terminal@footnote{This is different from |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2562 normal Emacs/Comint behavior, but more like an xterm. If you prefer the |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2563 default comint functionality, check the variable |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2564 @code{idlwave-shell-arrows-do-history}.}. The history is preserved |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2565 between emacs and IDL sessions. Here is a list of commonly used |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2566 commands: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2567 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2568 @multitable @columnfractions .12 .88 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2569 @item @key{UP}, @key{M-p} |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2570 @tab Cycle backwards in input history |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2571 @item @key{DOWN}, @key{M-n} |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2572 @tab Cycle forwards in input history |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2573 @item @kbd{M-r} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2574 @tab Previous input matching a regexp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2575 @item @kbd{M-s} |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2576 @tab Next input matching a regexp |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2577 @item @kbd{return} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2578 @tab Send input or copy line to current prompt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2579 @item @kbd{C-c C-a} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2580 @tab Beginning of line; skip prompt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2581 @item @kbd{C-c C-u} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2582 @tab Kill input to beginning of line |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2583 @item @kbd{C-c C-w} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2584 @tab Kill word before cursor |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2585 @item @kbd{C-c C-c} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2586 @tab Send ^C |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2587 @item @kbd{C-c C-z} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2588 @tab Send ^Z |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2589 @item @kbd{C-c C-\} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2590 @tab Send ^\ |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2591 @item @kbd{C-c C-o} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2592 @tab Delete last batch of process output |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2593 @item @kbd{C-c C-r} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2594 @tab Show last batch of process output |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2595 @item @kbd{C-c C-l} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2596 @tab List input history |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2597 @end multitable |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2598 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2599 In addition to these standard @file{comint} commands, |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2600 @code{idlwave-shell-mode} provides many of the same commands which |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2601 simplify writing IDL code available in IDLWAVE buffers. This includes |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2602 abbreviations, online help, and completion. See @ref{Routine Info} and |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2603 @ref{Online Help} and @ref{Completion} for more information on these |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2604 commands. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2605 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2606 @cindex Completion, in the shell |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2607 @cindex Routine info, in the shell |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2608 @cindex Online Help, in the shell |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2609 @multitable @columnfractions .12 .88 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2610 @item @kbd{@key{TAB}} |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2611 @tab Completion of file names (between quotes and after executive |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2612 commands @samp{.run} and @samp{.compile}), routine names, class names, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2613 keywords, system variables, system variable tags etc. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2614 (@code{idlwave-shell-complete}). |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2615 @item @kbd{M-@key{TAB}} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2616 @tab Same as @key{TAB} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2617 @item @kbd{C-c ?} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2618 @tab Routine Info display (@code{idlwave-routine-info}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2619 @item @kbd{M-?} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2620 @tab IDL online help on routine (@code{idlwave-routine-info-from-idlhelp}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2621 @item @kbd{C-c C-i} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2622 @tab Update routine info from buffers and shell |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2623 (@code{idlwave-update-routine-info}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2624 @item @kbd{C-c C-v} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2625 @tab Find the source file of a routine (@code{idlwave-find-module}) |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2626 @item @kbd{C-c C-t} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2627 @tab Find the source file of a routine in the currently visited file |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2628 (@code{idlwave-find-module-this-file}). |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2629 @item @kbd{C-c =} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2630 @tab Compile a library routine (@code{idlwave-resolve}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2631 @end multitable |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2632 |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2633 @defopt idlwave-shell-arrows-do-history (@code{t}) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2634 Non-@code{nil} means @key{UP} and @key{DOWN} arrows move through command |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2635 history like xterm. |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2636 @end defopt |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2637 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2638 @defopt idlwave-shell-comint-settings |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2639 Alist of special settings for the comint variables in the IDLWAVE Shell. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2640 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2641 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2642 @defopt idlwave-shell-file-name-chars |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2643 The characters allowed in file names, as a string. Used for file name |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2644 completion. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2645 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2646 |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2647 @defopt idlwave-shell-graphics-window-size |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2648 Size of IDL graphics windows popped up by special IDLWAVE command. |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2649 @end defopt |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2650 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2651 @cindex Input mode |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2652 @cindex Character input mode (Shell) |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2653 @cindex Line input mode (Shell) |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2654 @cindex Magic spells, for input mode |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2655 @cindex Spells, magic |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2656 IDLWAVE works in line input mode: You compose a full command line, using |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2657 all the power Emacs gives you to do this. When you press @key{RET}, the |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2658 whole line is sent to IDL. Sometimes it is necessary to send single |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2659 characters (without a newline), for example when an IDL program is |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2660 waiting for single character input with the @code{GET_KBRD} function. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2661 You can send a single character to IDL with the command @kbd{C-c C-x} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2662 (@code{idlwave-shell-send-char}). When you press @kbd{C-c C-y} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2663 (@code{idlwave-shell-char-mode-loop}), IDLWAVE runs a blocking loop |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2664 which accepts characters and immediately sends them to IDL. The loop |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2665 can be exited with @kbd{C-g}. It terminates also automatically when the |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2666 current IDL command is finished. Check the documentation of the two |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2667 variables described below for a way to make IDL programs trigger |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2668 automatic switches of the input mode. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2669 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2670 @defopt idlwave-shell-use-input-mode-magic (@code{nil}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2671 Non-@code{nil} means IDLWAVE should check for input mode spells in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2672 output. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2673 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2674 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2675 @defopt idlwave-shell-input-mode-spells |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2676 The three regular expressions which match the magic spells for input |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2677 modes. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2678 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2679 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2680 @node Commands Sent to the Shell, Debugging IDL Programs, Using the Shell, The IDLWAVE Shell |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2681 @section Commands Sent to the Shell |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2682 @cindex Commands in shell, showing |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2683 @cindex Showing commands in shell |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2684 |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2685 The IDLWAVE buffers and shell interact very closely. In addition to the |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2686 normal commands you enter at the @code{IDL>} prompt, many other special |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2687 commands are sent to the shell, sometimes as a direct result of invoking |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2688 a key command, menu item, or toolbar button, but also automatically, as |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2689 part of the normal flow of information updates between the buffer and |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2690 shell. |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2691 |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2692 The commands sent include @code{breakpoint}, @code{.step} and other |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2693 debug commands (@pxref{Debugging IDL Programs}), @code{.run} and other |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2694 compilation statements (@pxref{Compiling Programs}), examination |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2695 commands like @code{print} and @code{help} (@pxref{Examining |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2696 Variables}), and other special purpose commands designed to keep |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2697 information on the running shell current. |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2698 |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2699 By default, much of this background shell input and output is hidden |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2700 from the user, but this is configurable. The custom variable |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2701 @code{idlwave-abbrev-show-commands} allows you to configure which |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2702 commands sent to the shell are shown there. For a related customization |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2703 for separating the output of @emph{examine} commands, see @ref{Examining |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2704 Variables}. |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2705 |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2706 @defopt idlwave-shell-show-commands (@code{'(run misc breakpoint)}) |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2707 A list of command types to echo in the shell when sent. Possible values |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2708 are @code{run} for @code{.run}, @code{.compile} and other run commands, |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2709 @code{misc} for lesser used commands like @code{window}, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2710 @code{retall},@code{close}, etc., @code{breakpoint} for breakpoint |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2711 setting and clearing commands, and @code{debug} for other debug, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2712 stepping, and continue commands. In addition, if the variable is set to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2713 the single symbol @code{'everything}, all the copious shell input is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2714 displayed (which is probably only useful for debugging purposes). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2715 N.B. For hidden commands which produce output by side-effect, that |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2716 output remains hidden (e.g., stepping through a @code{print} command). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2717 As a special case, any error message in the output will be displayed |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2718 (e.g., stepping to an error). |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2719 @end defopt |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2720 |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2721 @node Debugging IDL Programs, Examining Variables, Commands Sent to the Shell, The IDLWAVE Shell |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2722 @section Debugging IDL Programs |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2723 @cindex Debugging |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2724 @cindex Keybindings for debugging |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2725 @cindex Toolbar |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2726 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2727 Programs can be compiled, run, and debugged directly from the source |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2728 buffer in Emacs, walking through arbitrarily deeply nested code, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2729 printing expressions and skipping up and down the calling stack along |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2730 the way. IDLWAVE makes compiling and debugging IDL programs far less |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2731 cumbersome by providing a full-featured, key/menu/toolbar-driven |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2732 interface to commands like @code{breakpoint}, @code{.step}, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2733 @code{.run}, etc. It can even perform complex debug operations not |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2734 natively supported by IDL (like continuing to the line at the cursor). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2735 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2736 The IDLWAVE shell installs key bindings both in the shell buffer and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2737 in all IDL code buffers of the current Emacs session, so debug |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2738 commands work in both places (in the shell, commands operate on the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2739 last file compiled). On Emacs versions which support it, a debugging |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2740 toolbar is also installed. The toolbar display can be toggled with |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2741 @kbd{C-c C-d C-t} (@code{idlwave-shell-toggle-toolbar}). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2742 |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2743 |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2744 @defopt idlwave-shell-use-toolbar (@code{t}) |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2745 Non-@code{nil} means use the debugging toolbar in all IDL related |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2746 buffers. |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2747 @end defopt |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2748 |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2749 @menu |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2750 * A Tale of Two Modes:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2751 * Debug Key Bindings:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2752 * Breakpoints and Stepping:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2753 * Compiling Programs:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2754 * Walking the Calling Stack:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2755 * Electric Debug Mode:: |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2756 @end menu |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2757 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2758 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2759 @node A Tale of Two Modes, Debug Key Bindings, Debugging IDL Programs, Debugging IDL Programs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2760 @subsection A Tale of Two Modes |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2761 @cindex Electric Debug Mode |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2762 @cindex Debugging Interface |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2763 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2764 The many debugging, compiling, and examination commands provided in |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2765 IDLWAVE are available simultaneously through two different interfaces: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2766 the original, multi-key command interface, and the new Electric Debug |
65575
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2767 Mode. The functionality they offer is similar, but the way you interact |
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2768 with them is quite different. The main difference is that, in Electric |
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2769 Debug Mode, the source buffers are made read-only, and single |
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2770 key-strokes are used to step through, examine expressions, set and |
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2771 remove breakpoints, etc. The same variables, prefix arguments, and |
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2772 settings apply to both versions, and both can be used interchangeably. |
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2773 By default, when breakpoints are hit, Electric Debug Mode is enabled. |
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2774 The traditional interface is described first. @xref{Electric Debug |
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2775 Mode}, for more on that mode. Note that electric debug mode can be |
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2776 prevented from activating automatically by customizing the variable |
2b96746de758
Fixed spurious cross-ref
J.D. Smith <jdsmith@as.arizona.edu>
parents:
65555
diff
changeset
|
2777 @code{idlwave-shell-automatic-electric-debug}. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2778 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2779 @node Debug Key Bindings, Breakpoints and Stepping, A Tale of Two Modes, Debugging IDL Programs |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2780 @subsection Debug Key Bindings |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2781 @kindex C-c C-d |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2782 @cindex Key bindings |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2783 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2784 The standard debugging key bindings are always available by default on |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2785 the prefix key @kbd{C-c C-d}, so, for example, setting a breakpoint is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2786 done with @kbd{C-c C-d C-b}, and compiling a source file with @kbd{C-c |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2787 C-d C-c}. You can also easily configure IDLWAVE to use one or more |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2788 modifier keys not in use by other commands, in lieu of the prefix |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2789 @kbd{C-c C-d} (though these bindings will typically also be available |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2790 --- see @code{idlwave-shell-activate-prefix-keybindings}). For |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2791 example, if you include in @file{.emacs}: |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2792 |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2793 @lisp |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2794 (setq idlwave-shell-debug-modifiers '(control shift)) |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2795 @end lisp |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2796 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2797 @noindent a breakpoint can then be set by pressing @kbd{b} while holding down |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2798 @kbd{shift} and @kbd{control} keys, i.e. @kbd{C-S-b}. Compiling a |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2799 source file will be on @kbd{C-S-c}, deleting a breakpoint @kbd{C-S-d}, |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2800 etc. In the remainder of this chapter we will assume that the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2801 @kbd{C-c C-d} bindings are active, but each of these bindings will |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2802 have an equivalent shortcut if modifiers are given in the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2803 @code{idlwave-shell-debug-modifiers} variable (@pxref{Lesson II -- |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2804 Customization}). A much simpler and faster form of debugging for |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2805 running code is also available by default --- see @ref{Electric Debug |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2806 Mode}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2807 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2808 @defopt idlwave-shell-prefix-key (@kbd{C-c C-d}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2809 The prefix key for the debugging map |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2810 @code{idlwave-shell-mode-prefix-map}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2811 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2812 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2813 @defopt idlwave-shell-activate-prefix-keybindings (@code{t}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2814 Non-@code{nil} means debug commands will be bound to the prefix |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2815 key, like @kbd{C-c C-d C-b}. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2816 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2817 |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
2818 @defopt idlwave-shell-debug-modifiers (@code{nil}) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2819 List of modifier keys to use for additional, alternative binding of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2820 debugging commands in the shell and source buffers. Can be one or |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2821 more of @code{control}, @code{meta}, @code{super}, @code{hyper}, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2822 @code{alt}, and @code{shift}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2823 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2824 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2825 @node Breakpoints and Stepping, Compiling Programs, Debug Key Bindings, Debugging IDL Programs |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2826 @subsection Breakpoints and Stepping |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2827 @cindex Breakpoints |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2828 @cindex Stepping |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2829 @cindex Execution, controlled |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2830 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2831 @kindex C-c C-d C-b |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2832 @kindex C-c C-d C-b |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2833 IDLWAVE helps you set breakpoints and step through code. Setting a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2834 breakpoint in the current line of the source buffer is accomplished |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2835 with @kbd{C-c C-d C-b} (@code{idlwave-shell-break-here}). With a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2836 prefix arg of 1 (i.e. @kbd{C-1 C-c C-d C-b}), the breakpoint gets a |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2837 @code{/ONCE} keyword, meaning that it will be deleted after first use. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2838 With a numeric prefix greater than one (e.g. @kbd{C-4 C-c C-d C-b}), |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2839 the breakpoint will only be active the @code{nth} time it is hit. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2840 With a single non-numeric prefix (i.e. @kbd{C-u C-c C-d C-b}), prompt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2841 for a condition --- an IDL expression to be evaulated and trigger the |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2842 breakpoint only if true. To clear the breakpoint in the current line, |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2843 use @kbd{C-c C-d C-d} (@code{idlwave-clear-current-bp}). When |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2844 executed from the shell window, the breakpoint where IDL is currently |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2845 stopped will be deleted. To clear all breakpoints, use @kbd{C-c C-d |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2846 C-a} (@code{idlwave-clear-all-bp}). Breakpoints can also be disabled |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2847 and re-enabled: @kbd{C-c C-d C-\} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2848 (@code{idlwave-shell-toggle-enable-current-bp}). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2849 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2850 Breakpoint lines are highlighted or indicated with an icon in the source |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2851 code (different icons for conditional, after, and other break types). |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2852 Disabled breakpoints are @emph{grayed out} by default. Note that IDL |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2853 places breakpoints as close as possible on or after the line you |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2854 specify. IDLWAVE queries the shell for the actual breakpoint location |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2855 which was set, so the exact line you specify may not be marked. You can |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2856 re-sync the breakpoint list and update the display at any time (e.g., if |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2857 you add or remove some on the command line) using @kbd{C-c C-d C-l}. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2858 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2859 In recent IDLWAVE versions, the breakpoint line is highlighted when the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2860 mouse is moved over it, and a tooltip pops up describing the break |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2861 details. @kbd{Mouse-3} on the breakpoint line pops up a menu of |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2862 breakpoint actions, including clearing, disabling, and adding or |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2863 changing break conditions or ``after'' break count. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2864 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2865 Once the program has stopped somewhere, you can step through it. The |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2866 most important stepping commands are @kbd{C-c C-d C-s} to execute one |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2867 line of IDL code ("step into"); @kbd{C-c C-d C-n} to step a single line, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2868 treating procedure and function calls as a single step ("step over"); |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2869 @kbd{C-c C-d C-h} to continue execution to the line at the cursor and |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2870 @kbd{C-c C-d C-r} to continue execution. @xref{Commands Sent to the |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2871 Shell}, for information on displaying or hiding the breakpoint and |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
2872 stepping commands the shell receives. Here is a summary of the |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2873 breakpoint and stepping commands: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2874 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2875 @multitable @columnfractions .23 .77 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2876 @item @kbd{C-c C-d C-b} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2877 @tab Set breakpoint (@code{idlwave-shell-break-here}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2878 @item @kbd{C-c C-d C-i} |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2879 @tab Set breakpoint in module named here (@code{idlwave-shell-break-in}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2880 @item @kbd{C-c C-d C-d} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2881 @tab Clear current breakpoint (@code{idlwave-shell-clear-current-bp}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2882 @item @kbd{C-c C-d C-a} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2883 @tab Clear all breakpoints (@code{idlwave-shell-clear-all-bp}) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2884 @item @kbd{C-c C-d [} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2885 @tab Go to the previous breakpoint (@code{idlwave-shell-goto-previous-bp}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2886 @item @kbd{C-c C-d ]} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2887 @tab Go to the next breakpoint (@code{idlwave-shell-goto-next-bp}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2888 @item @kbd{C-c C-d C-\} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2889 @tab Disable/Enable current breakpoint (@code{idlwave-shell-toggle-enable-current-bp}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2890 @item @kbd{C-c C-d C-j} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2891 @tab Set a breakpoint at the beginning of the enclosing routine. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2892 @item @kbd{C-c C-d C-s} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2893 @tab Step, into function calls (@code{idlwave-shell-step}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2894 @item @kbd{C-c C-d C-n} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2895 @tab Step, over function calls (@code{idlwave-shell-stepover}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2896 @item @kbd{C-c C-d C-k} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2897 @tab Skip one statement (@code{idlwave-shell-skip}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2898 @item @kbd{C-c C-d C-u} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2899 @tab Continue to end of block (@code{idlwave-shell-up}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2900 @item @kbd{C-c C-d C-m} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2901 @tab Continue to end of function (@code{idlwave-shell-return}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2902 @item @kbd{C-c C-d C-o} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2903 @tab Continue past end of function (@code{idlwave-shell-out}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2904 @item @kbd{C-c C-d C-h} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2905 @tab Continue to line at cursor position (@code{idlwave-shell-to-here}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2906 @item @kbd{C-c C-d C-r} |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2907 @tab Continue execution to next breakpoint, if any (@code{idlwave-shell-cont}) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2908 @item @kbd{C-c C-d C-up} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2909 @tab Show higher level in calling stack (@code{idlwave-shell-stack-up}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2910 @item @kbd{C-c C-d C-down} |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2911 @tab Show lower level in calling stack (@code{idlwave-shell-stack-down}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2912 @end multitable |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2913 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2914 All of these commands have equivalents in Electric Debug Mode, which |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2915 provides faster single-key access (@pxref{Electric Debug Mode}). |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2916 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2917 The line where IDL is currently stopped, at breakpoints, halts, and |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2918 errors, etc., is marked with a color overlay or arrow, depending on the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2919 setting in @code{idlwave-shell-mark-stop-line}. If an overlay face is |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2920 used to mark the stop line (as it is by default), when stepping through |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2921 code, the face color is temporarily changed to gray, until IDL completes |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2922 the next command and moves to the new line. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2923 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2924 @defopt idlwave-shell-mark-breakpoints (@code{t}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2925 Non-@code{nil} means mark breakpoints in the source file buffers. The |
60927
bae786986f2e
* calc.texi, cl.texi, gnus.texi, idlwave.texi, reftex.texi: Replace
Werner LEMBERG <wl@gnu.org>
parents:
60880
diff
changeset
|
2926 value indicates the preferred method. Valid values are @code{nil}, |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2927 @code{t}, @code{face}, and @code{glyph}. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2928 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2929 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2930 @defopt idlwave-shell-breakpoint-face |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2931 The face for breakpoint lines in the source code if |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
2932 @code{idlwave-shell-mark-breakpoints} has the value @code{face}. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2933 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
2934 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2935 @defopt idlwave-shell-breakpoint-popup-menu (@code{t}) |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2936 Whether to pop-up a menu and present a tooltip description on |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2937 breakpoint lines. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2938 @end defopt |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2939 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2940 @defopt idlwave-shell-mark-stop-line (@code{t}) |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2941 Non-@code{nil} means mark the source code line where IDL is currently |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2942 stopped. The value specifies the preferred method. Valid values are |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2943 @code{nil}, @code{t}, @code{arrow}, and @code{face}. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2944 @end defopt |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2945 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2946 @defopt idlwave-shell-overlay-arrow (@code{">"}) |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2947 The overlay arrow to display at source lines where execution halts, if |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2948 configured in @code{idlwave-shell-mark-stop-line}. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2949 @end defopt |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2950 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2951 @defopt idlwave-shell-stop-line-face |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2952 The face which highlights the source line where IDL is stopped, if |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2953 configured in @code{idlwave-shell-mark-stop-line}. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2954 @end defopt |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2955 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
2956 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2957 @node Compiling Programs, Walking the Calling Stack, Breakpoints and Stepping, Debugging IDL Programs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2958 @subsection Compiling Programs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2959 @cindex Compiling programs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2960 @cindex Programs, compiling |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2961 @cindex Default command line, executing |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2962 @cindex Executing a default command line |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2963 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2964 @kindex C-c C-d C-c |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2965 In order to compile the current buffer under the IDLWAVE shell, press |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2966 @kbd{C-c C-d C-c} (@code{idlwave-save-and-run}). This first saves the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2967 current buffer and then sends the command @samp{.run path/to/file} to the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2968 shell. You can also execute @kbd{C-c C-d C-c} from the shell buffer, in |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2969 which case the most recently compiled buffer will be saved and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2970 re-compiled. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2971 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2972 When developing or debugging a program, it is often necessary to execute |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2973 the same command line many times. A convenient way to do this is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2974 @kbd{C-c C-d C-y} (@code{idlwave-shell-execute-default-command-line}). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2975 This command first resets IDL from a state of interrupted execution by |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2976 closing all files and returning to the main interpreter level. Then a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2977 default command line is send to the shell. To edit the default command |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2978 line, call @code{idlwave-shell-execute-default-command-line} with a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2979 prefix argument: @kbd{C-u C-c C-d C-y}. If no default command line has |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2980 been set (or you give two prefix arguments), the last command on the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2981 @code{comint} input history is sent. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2982 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
2983 @node Walking the Calling Stack, Electric Debug Mode, Compiling Programs, Debugging IDL Programs |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2984 @subsection Walking the Calling Stack |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2985 @cindex Calling stack, walking |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2986 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2987 While debugging a program, it can be very useful to check the context in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2988 which the current routine was called, for instance to help understand |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2989 the value of the arguments passed. To do so conveniently you need to |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2990 examine the calling stack. If execution is stopped somewhere deep in a |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2991 program, you can use the commands @kbd{C-c C-d C-@key{UP}} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2992 (@code{idlwave-shell-stack-up}) and @kbd{C-c C-d C-@key{DOWN}} |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2993 (@code{idlwave-shell-stack-down}), or the corresponding toolbar buttons, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2994 to move up or down through the calling stack. The mode line of the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2995 shell window will indicate the position within the stack with a label |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2996 like @samp{[-3:MYPRO]}. The line of IDL code at that stack position |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2997 will be highlighted. If you continue execution, IDLWAVE will |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2998 automatically return to the current level. @xref{Examining Variables}, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
2999 for information how to examine the value of variables and expressions on |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3000 higher calling stack levels. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3001 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3002 @html |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3003 <A NAME="EDEBUG"></A> |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3004 @end html |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3005 @node Electric Debug Mode, , Walking the Calling Stack, Debugging IDL Programs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3006 @subsection Electric Debug Mode |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3007 @cindex Electric Debug Mode |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3008 @cindex @samp{*Debugging*} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3009 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3010 Even with a convenient debug key prefix enabled, repetitive stepping, |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3011 variable examination (@pxref{Examining Variables}), and other debugging |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3012 activities can be awkward and slow using commands which require multiple |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3013 keystrokes. Luckily, there's a better way, inspired by the lisp e-debug |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3014 mode, and available through the @emph{Electric Debug Mode}. By default, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3015 as soon as a breakpoint is hit, this minor mode is enabled. The buffer |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3016 showing the line where execution has halted is switched to Electric |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3017 Debug Mode. This mode is visible as @samp{*Debugging*} in the mode |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3018 line, and a different face (violet by default, if color is available) |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3019 for the line stopped at point. The buffer is made read-only and |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3020 single-character bindings for the most commonly used debugging commands |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3021 are enabled. These character commands (a list of which is available |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3022 with @kbd{C-?}) are: |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3023 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3024 @multitable @columnfractions .2 .8 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3025 @item @kbd{a} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3026 @tab Clear all breakpoints (@code{idlwave-shell-clear-all-bp}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3027 @item @kbd{b} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3028 @tab Set breakpoint, @kbd{C-u b} for a conditional break, @kbd{C-n b} for nth hit (@code{idlwave-shell-break-here}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3029 @item @kbd{d} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3030 @tab Clear current breakpoint (@code{idlwave-shell-clear-current-bp}) |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3031 @item @kbd{e} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3032 @tab Prompt for expression to print (@code{idlwave-shell-clear-current-bp}). |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3033 @item @kbd{h} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3034 @tab Continue to the line at cursor position (@code{idlwave-shell-to-here}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3035 @item @kbd{i} |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3036 @tab Set breakpoint in module named here (@code{idlwave-shell-break-in}) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3037 @item @kbd{[} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3038 @tab Go to the previous breakpoint in the file (@code{idlwave-shell-goto-previous-bp}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3039 @item @kbd{]} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3040 @tab Go to the next breakpoint in the file |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3041 (@code{idlwave-shell-goto-next-bp}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3042 @item @kbd{\} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3043 @tab Disable/Enable current breakpoint (@code{idlwave-shell-toggle-enable-current-bp}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3044 @item @kbd{j} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3045 @tab Set breakpoint at beginning of enclosing routine (@code{idlwave-shell-break-this-module}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3046 @item @kbd{k} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3047 @tab Skip one statement (@code{idlwave-shell-skip}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3048 @item @kbd{m} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3049 @tab Continue to end of function (@code{idlwave-shell-return}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3050 @item @kbd{n} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3051 @tab Step, over function calls (@code{idlwave-shell-stepover}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3052 @item @kbd{o} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3053 @tab Continue past end of function (@code{idlwave-shell-out}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3054 @item @kbd{p} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3055 @tab Print expression near point or in region with @kbd{C-u p} (@code{idlwave-shell-print}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3056 @item @kbd{q} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3057 @tab End the debugging session and return to the Shell's main level |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3058 (@code{idlwave-shell-retall}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3059 @item @kbd{r} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3060 @tab Continue execution to next breakpoint, if any (@code{idlwave-shell-cont}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3061 @item @kbd{s} or @kbd{@key{SPACE}} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3062 @tab Step, into function calls (@code{idlwave-shell-step}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3063 @item @kbd{t} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3064 @tab Print a calling-level traceback in the shell |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3065 @item @kbd{u} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3066 @tab Continue to end of block (@code{idlwave-shell-up}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3067 @item @kbd{v} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3068 @tab Turn Electric Debug Mode off |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3069 (@code{idlwave-shell-electric-debug-mode}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3070 @item @kbd{x} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3071 @tab Examine expression near point (or in region with @kbd{C-u x}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3072 with shortcut of examine type. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3073 @item @kbd{z} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3074 @tab Reset IDL (@code{idlwave-shell-reset}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3075 @item @kbd{+} or @kbd{=} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3076 @tab Show higher level in calling stack (@code{idlwave-shell-stack-up}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3077 @item @kbd{-} or @kbd{_} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3078 @tab Show lower level in calling stack (@code{idlwave-shell-stack-down}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3079 @item @kbd{?} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3080 @tab Help on expression near point or in region with @kbd{C-u ?} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3081 (@code{idlwave-shell-help-expression}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3082 @item @kbd{C-?} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3083 @tab Show help on the commands available. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3084 @end multitable |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3085 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3086 Most single-character electric debug bindings use the final keystroke |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3087 of the equivalent multiple key commands (which are of course also |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3088 still available), but some differ (e.g. @kbd{e},@kbd{t},@kbd{q},@kbd{x}). |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3089 Some have additional convenience bindings (like @kbd{@key{SPACE}} for |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3090 stepping). All prefix and other argument options described in this |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3091 section for the commands invoked by electric debug bindings are still |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3092 valid. For example, @kbd{C-u b} sets a conditional breakpoint, just |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3093 as it did with @kbd{C-u C-c C-d C-b}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3094 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3095 You can toggle the electric debug mode at any time in a buffer using |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3096 @kbd{C-c C-d C-v} (@kbd{v} to turn it off while in the mode), or from |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3097 the Debug menu. Normally the mode will be enabled and disabled at the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3098 appropriate times, but occassionally you might want to edit a file |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3099 while still debugging it, or switch to the mode for conveniently |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3100 setting lots of breakpoints. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3101 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3102 To quickly abandon a debugging session and return to normal editing at |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3103 the Shell's main level, use @kbd{q} (@code{idlwave-shell-retall}). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3104 This disables electric debug mode in all IDLWAVE buffers@footnote{Note |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3105 that this binding is not symmetric: @kbd{C-c C-d C-q} is bound to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3106 @code{idlwave-shell-quit}, which quits your IDL session.}. Help is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3107 available for the command shortcuts with @kbd{C-?}. If you find this |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3108 mode gets in your way, you can keep it from automatically activating |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3109 by setting the variable @code{idlwave-shell-automatic-electric-debug} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3110 to @code{nil}, or @code{'breakpoint}. If you'd like the convenient |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3111 electric debug shortcuts available also when run-time errors are |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3112 encountered, set to @code{t}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3113 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3114 @defopt idlwave-shell-automatic-electric-debug (@code{'breakpoint}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3115 Whether to enter electric debug mode automatically when a breakpoint |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3116 or run-time error is encountered, and then disable it in all buffers |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3117 when the $MAIN$ level is reached (either through normal program |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3118 execution, or retall). In addition to @code{nil} for never, and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3119 @code{t} for both breakpoints and errors, this can be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3120 @code{'breakpoint} (the default) to enable it only at breakpoint |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3121 halts. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3122 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3123 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3124 @defopt idlwave-shell-electric-stop-color (Violet) |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3125 Default color of the stopped line overlay when in electric debug mode. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3126 @end defopt |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3127 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3128 @defopt idlwave-shell-electric-stop-line-face |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3129 The face to use for the stopped line. Defaults to a face similar to the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3130 modeline, with color @code{idlwave-shell-electric-stop-color}. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3131 @end defopt |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3132 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3133 @defopt idlwave-shell-electric-zap-to-file (@code{t}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3134 If set, when entering electric debug mode, select the window displaying |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3135 the file where point is stopped. This takes point away from the shell |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3136 window, but is useful for immediate stepping, etc. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3137 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3138 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3139 @html |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
3140 <A NAME="EXAMINE"></A> |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3141 @end html |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3142 @node Examining Variables, Custom Expression Examination, Debugging IDL Programs, The IDLWAVE Shell |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3143 @section Examining Variables |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3144 @cindex @code{PRINT} expressions |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3145 @cindex @code{HELP}, on expressions |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3146 @cindex Expressions, printing & help |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3147 @cindex Examining expressions |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3148 @cindex Printing expressions |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3149 @cindex Mouse binding to print expressions |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3150 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3151 @kindex C-c C-d C-p |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3152 Do you find yourself repeatedly typing, e.g. @code{print,n_elements(x)}, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3153 and similar statements to remind yourself of the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3154 type/size/structure/value/etc. of variables and expressions in your code |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3155 or at the command line? IDLWAVE has a suite of special commands to |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3156 automate these types of variable or expression examinations. They work |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3157 by sending statements to the shell formatted to include the indicated |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3158 expression, and can be accessed in several ways. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3159 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3160 These @emph{examine} commands can be used in the shell or buffer at any |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3161 time (as long as the shell is running), and are very useful when |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3162 execution is stopped in a buffer due to a triggered breakpoint or error, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3163 or while composing a long command in the IDLWAVE shell. In the latter |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3164 case, the command is sent to the shell and its output is visible, but |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3165 point remains unmoved in the command being composed --- you can inspect |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3166 the contituents of a command you're building without interrupting the |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3167 process of building it! You can even print arbitrary expressions from |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3168 older input or output further up in the shell window --- any expression, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3169 variable, number, or function you see can be examined. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3170 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3171 If the variable @code{idlwave-shell-separate-examine-output} is |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3172 non-@code{nil} (the default), all examine output will be sent to a |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3173 special @file{*Examine*} buffer, rather than the shell. The output of |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3174 prior examine commands is saved in this buffer. In this buffer @key{c} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3175 clears the contents, and @key{q} hides the buffer. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3176 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3177 The two most basic examine commands are bound to @kbd{C-c C-d C-p}, to |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3178 print the expression at point, and @kbd{C-c C-d ?}, to invoke help on |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3179 this expression@footnote{Available as @kbd{p} and @kbd{?} in Electric |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3180 Debug Mode (@pxref{Electric Debug Mode})}. The expression at point is |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3181 either an array expression or a function call, or the contents of a pair |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3182 of parentheses. The chosen expression is highlighted, and |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3183 simultaneously the resulting output is highlighted in the shell or |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3184 separate output buffer. Calling the above commands with a prefix |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3185 argument will use the current region as expression instead of using the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3186 one at point. which can be useful for examining complicated, multi-line |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3187 expressions. Two prefix arguments (@kbd{C-u C-u C-c C-d C-p}) will |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3188 prompt for an expression to print directly. By default, when invoking |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3189 print, only an initial portion of long arrays will be printed, up to |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3190 @code{idlwave-shell-max-print-length}. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3191 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3192 For added speed and convenience, there are mouse bindings which allow |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3193 you to click on expressions and examine their values. Use |
46534
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
3194 @kbd{S-Mouse-2} to print an expression and @kbd{C-M-Mouse-2} to invoke |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3195 help (i.e. you need to hold down @key{META} and @key{CONTROL} while |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3196 clicking with the middle mouse button). If you simply click, the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3197 nearest expression will be selected in the same manner as described |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3198 above. You can also @emph{drag} the mouse in order to highlight |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3199 exactly the specific expression or sub-expression you want to examine. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3200 For custom expression examination, and the powerful customizable |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3201 pop-up examine selection, @xref{Custom Expression Examination}. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3202 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3203 @cindex Printing expressions, on calling stack |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3204 @cindex Restrictions for expression printing |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3205 The same variable inspection commands work both in the IDL Shell and |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3206 IDLWAVE buffers, and even for variables at higher levels of the calling |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3207 stack. For instance, if you're stopped at a breakpoint in a routine, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3208 you can examine the values of variables and expressions inside its |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3209 calling routine, and so on, all the way up through the calling stack. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3210 Simply step up the stack, and print variables as you see them |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3211 (@pxref{Walking the Calling Stack}, for information on stepping back |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3212 through the calling stack). The following restrictions apply for all |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3213 levels except the current: |
27600 | 3214 |
3215 @itemize @bullet | |
3216 @item | |
3217 Array expressions must use the @samp{[ ]} index delimiters. Identifiers | |
3218 with a @samp{( )} will be interpreted as function calls. | |
3219 @item | |
3220 @cindex ROUTINE_NAMES, IDL procedure | |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3221 N.B.: printing values of expressions on higher levels of the calling |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3222 stack uses the @emph{unsupported} IDL routine @code{ROUTINE_NAMES}, |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3223 which may or may not be available in future versions of IDL. Caveat |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3224 Examinor. |
27600 | 3225 @end itemize |
3226 | |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3227 @defopt idlwave-shell-expression-face |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3228 The face for @code{idlwave-shell-expression-overlay}. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3229 Allows you to choose the font, color and other properties for |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3230 the expression printed by IDL. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3231 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3232 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3233 @defopt idlwave-shell-output-face |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3234 The face for @code{idlwave-shell-output-overlay}. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3235 Allows to choose the font, color and other properties for the most |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3236 recent output of IDL when examining an expression." |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3237 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3238 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3239 @defopt idlwave-shell-separate-examine-output (@code{t}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3240 If non-@code{nil}, re-direct the output of examine commands to a special |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3241 @file{*Examine*} buffer, instead of in the shell itself. |
27600 | 3242 @end defopt |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3243 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3244 @defopt idlwave-shell-max-print-length (200) |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3245 The maximum number of leading array entries to print, when examining |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3246 array expressions. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3247 @end defopt |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3248 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3249 @node Custom Expression Examination, , Examining Variables, The IDLWAVE Shell |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3250 @section Custom Expression Examination |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3251 @cindex Expressions, custom examination |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3252 @cindex Custom expression examination |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3253 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3254 The variety of possible variable and expression examination commands is |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3255 endless (just look, for instance, at the keyword list to |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3256 @code{widget_info()}). Rather than attempt to include them all, IDLWAVE |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3257 provides two easy methods to customize your own commands, with a special |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3258 mouse examine command, and two macros for generating your own examine |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3259 key and mouse bindings. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3260 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3261 The most powerful and flexible mouse examine command of all is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3262 available on @kbd{C-S-Mouse-2}. Just as for all the other mouse |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3263 examine commands, it permits click or drag expression selection, but |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3264 instead of sending hard-coded commands to the shell, it pops-up a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3265 customizable selection list of examine functions to choose among, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3266 configured with the @code{idlwave-shell-examine-alist} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3267 variable@footnote{In Electric Debug Mode (@pxref{Electric Debug |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3268 Mode}), the key @kbd{x} provides a single-character shortcut interface |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3269 to the same examine functions for the expression at point or marked by |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3270 the region.}. This variable is a list of key-value pairs (an |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3271 @emph{alist} in Emacs parlance), where the key gives a name to be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3272 shown for the examine command, and the value is the command strings |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3273 itself, in which the text @code{___} (three underscores) will be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3274 replaced by the selected expression before being sent to the shell. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3275 An example might be key @code{Structure Help} with value |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3276 @code{help,___,/STRUCTURE}. In that case, you'd be prompted with |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3277 @emph{Structure Help}, which might send something like |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3278 @code{help,var,/STRUCTURE} to the shell for output. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3279 @code{idlwave-shell-examine-alist} comes configured by default with a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3280 large list of examine commands, but you can easily customize it to add |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3281 your own. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3282 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3283 In addition to configuring the functions available to the pop-up mouse |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3284 command, you can easily create your own customized bindings to inspect |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3285 expressions using the two convenience macros |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3286 @code{idlwave-shell-examine} and @code{idlwave-shell-mouse-examine}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3287 These create keyboard or mouse-based custom inspections of variables, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3288 sharing all the same properties of the built-in examine commands. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3289 Both functions take a single string argument sharing the syntax of the |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3290 @code{idlwave-shell-examine-alist} values, e.g.: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3291 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3292 @lisp |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3293 (add-hook 'idlwave-shell-mode-hook |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3294 (lambda () |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3295 (idlwave-shell-define-key-both [s-down-mouse-2] |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3296 (idlwave-shell-mouse-examine |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3297 "print, size(___,/DIMENSIONS)")) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3298 (idlwave-shell-define-key-both [f9] (idlwave-shell-examine |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3299 "print, size(___,/DIMENSIONS)")) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3300 (idlwave-shell-define-key-both [f10] (idlwave-shell-examine |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3301 "print,size(___,/TNAME)")) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3302 (idlwave-shell-define-key-both [f11] (idlwave-shell-examine |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3303 "help,___,/STRUCTURE")))) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3304 @end lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3305 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3306 @noindent Now pressing @key{f9}, or middle-mouse dragging with the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3307 @key{SUPER} key depressed, will print the dimensions of the nearby or |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3308 highlighted expression. Pressing @key{f10} will give the type string, |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3309 and @key{f11} will show the contents of a nearby structure. As you can |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3310 see, the possibilities are only marginally finite. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3311 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3312 @defopt idlwave-shell-examine-alist |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3313 An alist of examine commands in which the keys name the command and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3314 are displayed in the selection pop-up, and the values are custom IDL |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3315 examine command strings to send, after all instances of @code{___} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3316 (three underscores) are replaced by the indicated expression. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3317 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3318 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3319 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3320 @ifclear PARTOFEMACS |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3321 @node Installation, Acknowledgements, The IDLWAVE Shell, Top |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3322 @chapter Installation |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3323 @cindex Installation |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3324 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3325 @menu |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3326 * Installing IDLWAVE:: How to install the distribution |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3327 * Installing Online Help:: Where to get the additional files needed |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3328 @end menu |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3329 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3330 @node Installing IDLWAVE, Installing Online Help, Installation, Installation |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3331 @section Installing IDLWAVE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3332 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3333 @cindex FTP site |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3334 @cindex URL, homepage for IDLWAVE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3335 @cindex Homepage for IDLWAVE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3336 @cindex IDLWAVE, homepage |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3337 @cindex XEmacs package IDLWAVE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3338 @cindex Emacs, distributed with IDLWAVE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3339 IDLWAVE is part of Emacs 21.1 and later. It is also an XEmacs package |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3340 and can be installed from |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3341 @uref{ftp://ftp.xemacs.org/pub/xemacs/packages/,the XEmacs ftp site} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3342 with the normal package management system on XEmacs 21. You can also |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3343 download IDLWAVE and install it yourself from |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3344 @uref{@value{IDLWAVEHOMEPAGE}, the maintainers webpage}. Follow the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3345 instructions in the INSTALL file. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3346 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3347 @node Installing Online Help, , Installing IDLWAVE, Installation |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3348 @section Installing Online Help |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3349 @cindex Installing online help |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3350 @cindex Online Help, Installation |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3351 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3352 Starting with IDL v6.2, all necessary online help files and routine |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3353 information are distributed directly with IDL. Nothing additional is |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3354 required. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3355 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3356 For version of IDL prior to 6.2 (and IDLWAVE prior to version 6.0), if |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3357 you want to use the online help display, an additional set of files |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3358 (HTML versions of the IDL documentation) must be installed. These files |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3359 can also be downloaded from @uref{@value{IDLWAVEHOMEPAGE}, the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3360 maintainers webpage}. You need to place the files somewhere on your |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3361 system and tell IDLWAVE where they are with: |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3362 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3363 @lisp |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3364 ; e.g. /usr/local/etc/ |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3365 (setq idlwave-html-help-location "/path/to/help/dir/") |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3366 @end lisp |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3367 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3368 @noindent The default location is @file{/usr/local/etc}, and if you |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3369 install the directory there, you do not need to set this variable. Note |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3370 that the help package only changes with new versions of the IDL |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3371 documentation, and need not be updated unless your version of IDL |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3372 changes. Since the help system is distributed with IDL starting at |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3373 version 6.2, no new help packages will be created for these versions. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3374 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3375 @node Acknowledgements, Sources of Routine Info, Installation, Top |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3376 @end ifclear |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3377 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3378 @ifset PARTOFEMACS |
60880
78ef32e30574
Don't say where to get IDL or its non-free manual.
Richard M. Stallman <rms@gnu.org>
parents:
58527
diff
changeset
|
3379 @node Acknowledgements, Sources of Routine Info, The IDLWAVE Shell, Top |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3380 @end ifset |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3381 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3382 @chapter Acknowledgements |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3383 @cindex Acknowledgements |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3384 @cindex Maintainer, of IDLWAVE |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3385 @cindex Authors, of IDLWAVE |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3386 @cindex Contributors, to IDLWAVE |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3387 @cindex Email address, of Maintainer |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3388 @cindex Thanks |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3389 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3390 @noindent |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3391 The main contributors to the IDLWAVE package have been: |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3392 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3393 @itemize @minus |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3394 @item |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
3395 @uref{mailto:chase@@att.com, @b{Chris Chase}}, the original author. |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
3396 Chris wrote @file{idl.el} and @file{idl-shell.el} and maintained them |
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
3397 for several years. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3398 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3399 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3400 @uref{mailto:dominik@@astro.uva.nl, @b{Carsten Dominik}} was in charge |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3401 of the package from version 3.0, during which time he overhauled almost |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3402 everything, modernized IDLWAVE with many new features, and developed the |
41745 | 3403 manual. |
3404 | |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3405 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3406 @uref{mailto:jdsmith@@as.arizona.edu, @b{J.D. Smith}}, the current |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3407 maintainer, as of version 4.10, helped shape object method completion |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3408 and most new features introduced in versions 4.x, and introduced many |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3409 new features for IDLWAVE versions 5.x and 6.x. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3410 @end itemize |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3411 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3412 @noindent |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3413 The following people have also contributed to the development of IDLWAVE |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3414 with patches, ideas, bug reports and suggestions. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3415 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3416 @itemize @minus |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3417 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3418 Ulrik Dickow <dickow__at__nbi.dk> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3419 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3420 Eric E. Dors <edors__at__lanl.gov> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3421 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3422 Stein Vidar H. Haugan <s.v.h.haugan__at__astro.uio.no> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3423 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3424 David Huenemoerder <dph__at__space.mit.edu> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3425 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3426 Kevin Ivory <Kevin.Ivory__at__linmpi.mpg.de> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3427 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3428 Dick Jackson <dick__at__d-jackson.com> |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3429 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3430 Xuyong Liu <liu__at__stsci.edu> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3431 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3432 Simon Marshall <Simon.Marshall__at__esrin.esa.it> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3433 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3434 Craig Markwardt <craigm__at__cow.physics.wisc.edu> |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
3435 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3436 Laurent Mugnier <mugnier__at__onera.fr> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3437 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3438 Lubos Pochman <lubos__at__rsinc.com> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3439 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3440 Bob Portmann <portmann__at__al.noaa.gov> |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
3441 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3442 Patrick M. Ryan <pat__at__jaameri.gsfc.nasa.gov> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3443 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3444 Marty Ryba <ryba__at__ll.mit.edu> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3445 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3446 Phil Williams <williams__at__irc.chmcc.org> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3447 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3448 Phil Sterne <sterne__at__dublin.llnl.gov> |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3449 @item |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3450 Paul Sorenson <aardvark62__at__msn.com> |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3451 @end itemize |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3452 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3453 Doug Dirks was instrumental in providing the crucial IDL XML catalog to |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3454 support HTML help with IDL v6.2 and later, and Ali Bahrami provided |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3455 scripts and documentation to interface with the IDL Assistant. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3456 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3457 @noindent |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3458 Thanks to everyone! |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3459 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3460 @node Sources of Routine Info, HTML Help Browser Tips, Acknowledgements, Top |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3461 @appendix Sources of Routine Info |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3462 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3463 @cindex Sources of routine information |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3464 In @ref{Routine Info} and @ref{Completion} we showed how IDLWAVE |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3465 displays the calling sequence and keywords of routines, and completes |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3466 routine names and keywords. For these features to work, IDLWAVE must |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3467 know about the accessible routines. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3468 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3469 @menu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3470 * Routine Definitions:: Where IDL Routines are defined. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3471 * Routine Information Sources:: So how does IDLWAVE know about... |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3472 * Catalogs:: |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3473 * Load-Path Shadows:: Routines defined in several places |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3474 * Documentation Scan:: Scanning the IDL Manuals |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3475 @end menu |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3476 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3477 @node Routine Definitions, Routine Information Sources, Sources of Routine Info, Sources of Routine Info |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3478 @appendixsec Routine Definitions |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3479 @cindex Routine definitions |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3480 @cindex IDL variable @code{!PATH} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3481 @cindex @code{!PATH}, IDL variable |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3482 @cindex @code{CALL_EXTERNAL}, IDL routine |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3483 @cindex @code{LINKIMAGE}, IDL routine |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3484 @cindex External routines |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3485 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3486 @noindent Routines which can be used in an IDL program can be defined in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3487 several places: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3488 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3489 @enumerate |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3490 @item |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3491 @emph{Builtin routines} are defined inside IDL itself. The source code |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3492 of such routines is not available, but instead are learned about through |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3493 the IDL documentation. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3494 @item |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
3495 Routines which are @emph{part of the current program}, are defined in a |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
3496 file explicitly compiled by the user. This file may or may not be |
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
3497 located on the IDL search path. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3498 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3499 @emph{Library routines} are defined in files located on IDL's search |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3500 path. When a library routine is called for the first time, IDL will |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3501 find the source file and compile it dynamically. A special sub-category |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3502 of library routines are the @emph{system routines} distributed with IDL, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3503 and usually available in the @file{lib} subdirectory of the IDL |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3504 distribution. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3505 @item |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3506 External routines written in other languages (like Fortran or C) can be |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3507 called with @code{CALL_EXTERNAL}, linked into IDL via @code{LINKIMAGE}, |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3508 or included as dynamically loaded modules (DLMs). Currently IDLWAVE |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3509 cannot provide routine info and completion for such external routines, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3510 except by querying the Shell for calling information (DLMs only). |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3511 @end enumerate |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3512 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3513 @node Routine Information Sources, Catalogs, Routine Definitions, Sources of Routine Info |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3514 @appendixsec Routine Information Sources |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3515 @cindex Routine info sources |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3516 @cindex Builtin list of routines |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3517 @cindex Updating routine info |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3518 @cindex Scanning buffers for routine info |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3519 @cindex Buffers, scanning for routine info |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3520 @cindex Shell, querying for routine info |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3521 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3522 @noindent To maintain the most comprehensive information about all IDL |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3523 routines on a system, IDLWAVE collects data from many sources: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3524 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3525 @enumerate |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3526 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3527 @item |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3528 It has a @emph{builtin list} with information about the routines IDL |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3529 ships with. IDLWAVE @value{VERSION} is distributed with a list of |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3530 @value{NSYSROUTINES} routines, reflecting IDL version |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3531 @value{IDLVERSION}. As of IDL v6.2, the routine info is distributed |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3532 directly with IDL in the form of an XML catalog which IDLWAVE scans. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3533 Formerly, this list was created by scanning the IDL manuals to produce |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3534 the file @file{idlw-rinfo.el}. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3535 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3536 @item |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3537 IDLWAVE @emph{scans} all its @emph{buffers} in the current Emacs session |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3538 for routine definitions. This is done automatically when routine |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3539 information or completion is first requested by the user. Each new |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3540 buffer and each buffer saved after making changes is also scanned. The |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3541 command @kbd{C-c C-i} (@code{idlwave-update-routine-info}) can be used |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3542 at any time to rescan all buffers. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3543 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3544 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3545 If you have an IDLWAVE-Shell running in the Emacs session, IDLWAVE will |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3546 @emph{query the shell} for compiled routines and their arguments. This |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3547 happens automatically when routine information or completion is first |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3548 requested by the user. Each time an Emacs buffer is compiled with |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3549 @kbd{C-c C-d C-c}, the routine info for that file is queried. Though |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3550 rarely necessary, the command @kbd{C-c C-i} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3551 (@code{idlwave-update-routine-info}) can be used to explicitly update |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3552 the shell routine data. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3553 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3554 @item |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3555 Many popular libraries are distributed with routine information already |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3556 scanned into @emph{library catalogs} (@pxref{Library Catalogs}). These |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3557 per-directory catalog files can also be built by the user with the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3558 supplied @file{idlwave_catalog} tool. They are automatically discovered |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3559 by IDLWAVE. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3560 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3561 @item |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3562 IDLWAVE can scan selected directories of source files and store the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3563 result in a single @emph{user catalog} file which will be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3564 automatically loaded just like @file{idlw-rinfo.el}. @xref{User |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3565 Catalog}, for information on how to scan files in this way. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3566 @end enumerate |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3567 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3568 Loading all the routine and catalog information can be a time consuming |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3569 process, especially over slow networks. Depending on the system and |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3570 network configuration it could take up to 30 seconds (though locally on |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3571 fast systems is usually only a few seconds). In order to minimize the |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3572 wait time upon your first completion or routine info command in a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3573 session, IDLWAVE uses Emacs idle time to do the initialization in six |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3574 steps, yielding to user input in between. If this gets into your way, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3575 set the variable @code{idlwave-init-rinfo-when-idle-after} to 0 (zero). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3576 The more routines documented in library and user catalogs, the slower |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3577 the loading will be, so reducing this number can help alleviate any long |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3578 load times. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3579 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3580 @defopt idlwave-init-rinfo-when-idle-after (@code{10}) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3581 Seconds of idle time before routine info is automatically initialized. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3582 @end defopt |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3583 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3584 @defopt idlwave-scan-all-buffers-for-routine-info (@code{t}) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3585 Non-@code{nil} means scan all buffers for IDL programs when updating |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3586 info. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3587 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3588 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3589 @defopt idlwave-query-shell-for-routine-info (@code{t}) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3590 Non-@code{nil} means query the shell for info about compiled routines. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3591 @end defopt |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3592 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3593 @defopt idlwave-auto-routine-info-updates |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3594 Controls under what circumstances routine info is updated automatically. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3595 @end defopt |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3596 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3597 @html |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3598 <A NAME="CATALOGS"></A> |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3599 @end html |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3600 @node Catalogs, Load-Path Shadows, Routine Information Sources, Sources of Routine Info |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3601 @appendixsec Catalogs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3602 @cindex Catalogs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3603 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3604 @emph{Catalogs} are files containing scanned information on individual |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3605 routines, including arguments and keywords, calling sequence, file path, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3606 class and procedure vs. function type, etc. They represent a way of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3607 extending the internal built-in information available for IDL system |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3608 routines (@pxref{Routine Info}) to other source collections. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3609 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3610 Starting with version 5.0, there are two types of catalogs available |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3611 with IDLWAVE. The traditional @emph{user catalog} and the newer |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3612 @emph{library catalogs}. Although they can be used interchangeably, the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3613 library catalogs are more flexible, and preferred. There are few |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3614 occasions when a user catalog might be preferred --- read below. Both |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3615 types of catalogs can coexist without causing problems. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3616 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3617 To facilitate the catalog systems, IDLWAVE stores information it gathers |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3618 from the shell about the IDL search paths, and can write this |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3619 information out automatically, or on-demand (menu @code{Debug->Save Path |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3620 Info}). On systems with no shell from which to discover the path |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3621 information (e.g. Windows), a library path must be specified in |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3622 @code{idlwave-library-path} to allow library catalogs to be located, and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3623 to setup directories for user catalog scan (@pxref{User Catalog} for |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3624 more on this variable). Note that, before the shell is running, IDLWAVE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3625 can only know about the IDL search path by consulting the file pointed |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3626 to by @code{idlwave-path-file} (@file{~/.idlwave/idlpath.el}, by |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3627 default). If @code{idlwave-auto-write-path} is enabled (which is the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3628 default), the paths are written out whenever the IDLWAVE shell is |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3629 started. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3630 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3631 @defopt idlwave-auto-write-path (@code{t}) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3632 Write out information on the !PATH and !DIR paths from IDL automatically |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3633 when they change and when the Shell is closed. These paths are needed |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3634 to locate library catalogs. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3635 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3636 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3637 @defopt idlwave-library-path |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3638 IDL library path for Windows and MacOS. Under Unix/MacOSX, will be |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3639 obtained from the Shell when run. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3640 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3641 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3642 @defopt idlwave-system-directory |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3643 The IDL system directory for Windows and MacOS. Also needed for |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3644 locating HTML help and the IDL Assistant for IDL v6.2 and later. Under |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3645 Unix/MacOSX, will be obtained from the Shell and recorded, if run. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3646 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3647 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3648 @defopt idlwave-config-directory (@file{~/.idlwave}) |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3649 Default path where IDLWAVE saves configuration information, a user |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3650 catalog (if any), and a cached scan of the XML catalog (IDL v6.2 and |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3651 later). |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3652 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3653 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3654 @menu |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3655 * Library Catalogs:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3656 * User Catalog:: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3657 @end menu |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3658 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3659 @html |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3660 <A NAME="LIBRARY_CATALOGS"></A> |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3661 @end html |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3662 @node Library Catalogs, User Catalog, Catalogs, Catalogs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3663 @appendixsubsec Library Catalogs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3664 @cindex @file{.idlwave_catalog} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3665 @cindex Library catalogs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3666 @cindex @code{idlwave_catalog} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3667 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3668 Library catalogs consist of files named @file{.idlwave_catalog} stored |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3669 in directories containing @code{.pro} routine files. They are |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3670 discovered on the IDL search path and loaded automatically when routine |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3671 information is read. Each catalog file documents the routines found in |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3672 that directory --- one catalog per directory. Every catalog has a |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3673 library name associated with it (e.g. @emph{AstroLib}). This name will |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3674 be shown briefly when the catalog is found, and in the routine info of |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3675 routines it documents. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3676 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3677 Many popular libraries of routines are shipped with IDLWAVE catalog |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3678 files by default, and so will be automatically discovered. Library |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3679 catalogs are scanned externally to Emacs using a tool provided with |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3680 IDLWAVE. Each catalog can be re-scanned independently of any other. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3681 Catalogs can easily be made available system-wide with a common source |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3682 repository, providing uniform routine information, and lifting the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3683 burden of scanning from the user (who may not even know they're using a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3684 scanned catalog). Since all catalogs are independent, they can be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3685 re-scanned automatically to gather updates, e.g. in a @file{cron} job. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3686 Scanning is much faster than with the built-in user catalog method. One |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3687 minor disadvantage: the entire IDL search path is scanned for catalog |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3688 files every time IDLWAVE starts up, which might be slow if accessing IDL |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3689 routines over a slow network. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3690 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3691 A Perl tool to create library catalogs is distributed with IDLWAVE: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3692 @code{idlwave_catalog}. It can be called quite simply: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3693 @example |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3694 idlwave_catalog MyLib |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3695 @end example |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3696 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3697 @noindent This will scan all directories recursively beneath the current and |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3698 populate them with @file{.idlwave_catalog} files, tagging the routines |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3699 found there with the name library ``MyLib''. The full usage |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3700 information: |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3701 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3702 @example |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3703 Usage: idlwave_catalog [-l] [-v] [-d] [-s] [-f] [-h] libname |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3704 libname - Unique name of the catalog (4 or more alphanumeric |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3705 characters). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3706 -l - Scan local directory only, otherwise recursively |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3707 catalog all directories at or beneath this one. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3708 -v - Print verbose information. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3709 -d - Instead of scanning, delete all .idlwave_catalog files |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3710 here or below. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3711 -s - Be silent. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3712 -f - Force overwriting any catalogs found with a different |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3713 library name. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3714 -h - Print this usage. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3715 @end example |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3716 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3717 To re-load the library catalogs on the IDL path, force a system routine |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3718 info update using a single prefix to @code{idlwave-update-routine-info}: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3719 @kbd{C-u C-c C-i}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3720 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3721 @defopt idlwave-use-library-catalogs (@code{t}) |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3722 Whether to search for and load library catalogs. Disable if load |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3723 performance is a problem and/or the catalogs are not needed. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3724 @end defopt |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3725 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3726 @node User Catalog, , Library Catalogs, Catalogs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3727 @appendixsubsec User Catalog |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3728 @cindex User catalog |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3729 @cindex IDL library routine info |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3730 @cindex Windows |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3731 @cindex MacOS |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3732 @cindex IDL variable @code{!DIR} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3733 @cindex @code{!DIR}, IDL variable |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3734 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3735 The user catalog is the old routine catalog system. It is produced |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3736 within Emacs, and stored in a single file in the user's home directory |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3737 (@file{.idlwave/idlusercat.el} by default). Although library catalogs |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3738 are more flexible, there may be reasons to prefer a user catalog |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3739 instead, including: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3740 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3741 @itemize @bullet |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3742 @item The scan is internal to Emacs, so you don't need a working Perl |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3743 installation, as you do for library catalogs. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3744 @item Can be used to scan directories for which the user has no write |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3745 privileges. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3746 @item Easy widget-based path selection. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3747 @end itemize |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3748 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3749 However, no routine info is available in the user catalog by default; |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3750 the user must actively complete a scan. In addition, this type of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3751 catalog is all or nothing: if a single routine changes, the entire |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3752 catalog must be rescanned to update it. Creating the user catalog is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3753 also much slower than scanning library catalogs. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3754 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3755 You can scan any of the directories on the currently known path. Under |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3756 Windows and MacOS (not OSX), you need to specify the IDL search path in |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3757 the variable @code{idlwave-library-path}, and the location of the IDL |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3758 directory (the value of the @code{!DIR} system variable) in the variable |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3759 @code{idlwave-system-directory}, like this@footnote{The initial @samp{+} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3760 leads to recursive expansion of the path, just like in IDL}: |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3761 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3762 @lisp |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3763 (setq idlwave-library-path |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3764 '("+c:/RSI/IDL56/lib/" "+c:/user/me/idllibs")) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3765 (setq idlwave-system-directory "c:/RSI/IDL56/") |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3766 @end lisp |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3767 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3768 @noindent Under GNU/Linux and UNIX, these values will be automatically |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3769 gathered from the IDLWAVE shell, if run. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3770 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3771 The command @kbd{M-x idlwave-create-user-catalog-file} (or the menu item |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3772 @samp{IDLWAVE->Routine Info->Select Catalog Directories}) can then be |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3773 used to create a user catalog. It brings up a widget in which you can |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3774 select some or all directories on the search path. Directories which |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3775 already contain a library catalog are marked with @samp{[LIB]}, and need |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3776 not be scanned (although there is no harm if you do so, other than the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3777 additional memory used for the duplication). |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3778 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3779 After selecting directories, click on the @w{@samp{[Scan & Save]}} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3780 button in the widget to scan all files in the selected directories and |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3781 write out the resulting routine information. In order to update the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3782 library information using the directory selection, call the command |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3783 @code{idlwave-update-routine-info} with a double prefix argument: |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3784 @w{@kbd{C-u C-u C-c C-i}}. This will rescan files in the previously |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3785 selected directories, write an updated version of the user catalog file |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3786 and rebuild IDLWAVE's internal lists. If you give three prefix |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3787 arguments @w{@kbd{C-u C-u C-u C-c C-i}}, updating will be done with a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3788 background job@footnote{Unix systems only, I think.}. You can continue |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3789 to work, and the library catalog will be re-read when it is ready. If |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3790 you find you need to update the user catalog often, you should consider |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3791 building a library catalog for your routines instead (@pxref{Library |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3792 Catalogs}). |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3793 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3794 @defopt idlwave-special-lib-alist |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3795 Alist of regular expressions matching special library directories for |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3796 labeling in routine-info display. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3797 @end defopt |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3798 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3799 @node Load-Path Shadows, Documentation Scan, Catalogs, Sources of Routine Info |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3800 @appendixsec Load-Path Shadows |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3801 @cindex Load-path shadows |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3802 @cindex Shadows, load-path |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3803 @cindex Duplicate routines |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3804 @cindex Multiply defined routines |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3805 @cindex Routine definitions, multiple |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3806 @cindex Application, testing for shadowing |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3807 @cindex Buffer, testing for shadowing |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3808 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3809 IDLWAVE can compile a list of routines which are (re-)defined in more |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3810 than one file. Since one definition will hide (shadow) the others |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3811 depending on which file is compiled first, such multiple definitions are |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3812 called "load-path shadows". IDLWAVE has several routines to scan for |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
3813 load path shadows. The output is placed into the special buffer |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3814 @file{*Shadows*}. The format of the output is identical to the source |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
3815 section of the routine info buffer (@pxref{Routine Info}). The |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3816 different definitions of a routine are ordered by @emph{likelihood of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3817 use}. So the first entry will be most likely the one you'll get if an |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3818 unsuspecting command uses that routine. Before listing shadows, you |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3819 should make sure that routine info is up-to-date by pressing @kbd{C-c |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3820 C-i}. Here are the different routines (also available in the Menu |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3821 @samp{IDLWAVE->Routine Info}): |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3822 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3823 @table @asis |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3824 @item @kbd{M-x idlwave-list-buffer-load-path-shadows} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3825 This commands checks the names of all routines defined in the current |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3826 buffer for shadowing conflicts with other routines accessible to |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3827 IDLWAVE. The command also has a key binding: @kbd{C-c C-b} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3828 @item @kbd{M-x idlwave-list-shell-load-path-shadows}. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3829 Checks all routines compiled under the shell for shadowing. This is |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3830 very useful when you have written a complete application. Just compile |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3831 the application, use @code{RESOLVE_ALL} to compile any routines used by |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3832 your code, update the routine info inside IDLWAVE with @kbd{C-c C-i} and |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3833 then check for shadowing. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3834 @item @kbd{M-x idlwave-list-all-load-path-shadows} |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
3835 This command checks all routines accessible to IDLWAVE for conflicts. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3836 @end table |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3837 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3838 For these commands to work fully you need to scan the entire load path |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3839 in either a user or library catalog. Also, IDLWAVE should be able to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3840 distinguish between the system library files (normally installed in |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3841 @file{/usr/local/rsi/idl/lib}) and any site specific or user specific |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3842 files. Therefore, such local files should not be installed inside the |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3843 @file{lib} directory of the IDL directory. This is also advisable for |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3844 many other reasons. |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3845 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3846 @cindex Windows |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3847 @cindex MacOS |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3848 @cindex IDL variable @code{!DIR} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3849 @cindex @code{!DIR}, IDL variable |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3850 Users of Windows and MacOS (not X) also must set the variable |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3851 @code{idlwave-system-directory} to the value of the @code{!DIR} system |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3852 variable in IDL. IDLWAVE appends @file{lib} to the value of this |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3853 variable and assumes that all files found on that path are system |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3854 routines. |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3855 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3856 Another way to find out if a specific routine has multiple definitions |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3857 on the load path is routine info display (@pxref{Routine Info}). |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3858 |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3859 @node Documentation Scan, , Load-Path Shadows, Sources of Routine Info |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3860 @appendixsec Documentation Scan |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3861 @cindex @file{get_html_rinfo} |
27186
eb645a473bf8
New version is consistent with the changed names.
Carsten Dominik <dominik@science.uva.nl>
parents:
26960
diff
changeset
|
3862 @cindex @file{idlw-rinfo.el} |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3863 @cindex Scanning the documentation |
27186
eb645a473bf8
New version is consistent with the changed names.
Carsten Dominik <dominik@science.uva.nl>
parents:
26960
diff
changeset
|
3864 @cindex Perl program, to create @file{idlw-rinfo.el} |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3865 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3866 @strong{Starting with version 6.2, IDL is distributed directly with HTML |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3867 online help, and an XML-based catalog of routine information}. This |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3868 makes scanning the manuals with the tool @file{get_html_rinfo}, and the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3869 @file{idlw-rinfo.el} file it produced, as described here, entirely |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3870 unnecessary. The information is left here for users wishing to produce |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3871 a catalog of older IDL versions' help. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3872 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3873 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3874 IDLWAVE derives its knowledge about system routines from the IDL |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3875 manuals. The file @file{idlw-rinfo.el} contains the routine information |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3876 for the IDL system routines, and links to relevant sections of the HTML |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3877 documentation. The Online Help feature of IDLWAVE requires HTML |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3878 versions of the IDL manuals to be available; the HTML documentation is |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3879 not distributed with IDLWAVE by default, but must be downloaded |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3880 separately@c |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3881 @ifclear PARTOFEMACS |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3882 @ from @uref{@value{IDLWAVEHOMEPAGE}, the maintainers |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3883 webpage}@c |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3884 @end ifclear |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3885 . |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3886 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3887 The HTML files and related images can be produced from the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3888 @file{idl.chm} HTMLHelp file distributed with IDL using the free |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3889 Microsoft HTML Help Workshop. If you are lucky, the maintainer of |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3890 IDLWAVE will always have access to the newest version of IDL and provide |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3891 updates. The IDLWAVE distribution also contains the Perl program |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3892 @file{get_html_rinfo} which constructs the @file{idlw-rinfo.el} file by |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3893 scanning the HTML documents produced from the IDL documentation. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3894 Instructions on how to use @file{get_html_rinfo} are in the program |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3895 itself. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3896 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3897 @node HTML Help Browser Tips, Configuration Examples, Sources of Routine Info, Top |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3898 @appendix HTML Help Browser Tips |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3899 @cindex Browser Tips |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3900 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3901 There are a wide variety of possible browsers to use for displaying |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3902 the online HTML help available with IDLWAVE (starting with version |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3903 5.0). Since IDL v6.2, a single cross-platform HTML help browser, the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3904 @emph{IDL Assistant} is distributed with IDL. If this help browser is |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3905 available, it is the preferred choice, and the default. The variable |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3906 @code{idlwave-help-use-assistant}, enabled by default, controls |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3907 whether this help browser is used. If you use the IDL Assistant, the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3908 tips here are not relevant. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3909 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3910 Since IDLWAVE runs on a many different system types, a single browser |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3911 configuration is not possible, but choices abound. On many systems, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3912 the default browser configured in @code{browse-url-browser-function}, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3913 and hence inherited by default by |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3914 @code{idlwave-help-browser-function}, is Netscape. Unfortunately, the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3915 HTML manuals decompiled from the original source contain formatting |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3916 structures which Netscape 4.x does not handle well, though they are |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3917 still readable. A much better choice is Mozilla, or one of the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3918 Mozilla-derived browsers such as |
60880
78ef32e30574
Don't say where to get IDL or its non-free manual.
Richard M. Stallman <rms@gnu.org>
parents:
58527
diff
changeset
|
3919 @uref{http://galeon.sourceforge.net/,Galeon} (GNU/Linux), |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3920 @uref{http://www.mozilla.org/projects/camino/,Camino} (MacOSX), or |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3921 @uref{http://www.mozilla.org/projects/firebird/,Firebird} (all |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3922 platforms). Newer versions of Emacs provide a browser-function choice |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3923 @code{browse-url-gnome-moz} which uses the Gnome-configured browser. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3924 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3925 Note that the HTML files decompiled from the help sources contain |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3926 specific references to the @samp{Symbol} font, which by default is not |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3927 permitted in normal encodings (it's invalid, technically). Though it |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3928 only impacts a few symbols, you can trick Mozilla-based browsers into |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3929 recognizing @samp{Symbol} by following the directions |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3930 @uref{http://hutchinson.belmont.ma.us/tth/Xfonts.html, here}. With |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3931 this fix in place, HTML help pages look almost identical to their PDF |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3932 equivalents (yet can be bookmarked, browsed as history, searched, |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
3933 etc.). |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3934 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3935 @noindent Individual platform recommendations: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3936 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3937 @itemize @bullet |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3938 @item Unix/MacOSX: The @uref{http://www.w3m.org,@code{w3m}} browser |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3939 and its associated |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3940 @uref{http://emacs-w3m.namazu.org/,@code{emacs-w3m}} emacs mode |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3941 provide in-buffer browsing with image display, and excellent speed and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3942 formatting. Both the Emacs mode and the browser itself must be |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3943 downloaded separately. To use this browser, include |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3944 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3945 @lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3946 (setq idlwave-help-browser-function 'w3m-browse-url) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3947 @end lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3948 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3949 in your @file{.emacs}. Setting a few other nice @code{w3m} options |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3950 cuts down on screen clutter: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3951 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3952 @lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3953 (setq w3m-use-tab nil |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3954 w3m-use-header-line nil |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3955 w3m-use-toolbar nil) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3956 @end lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3957 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3958 If you use a dedicated frame for help, you might want to add the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3959 following, to get consistent behavior with the @kbd{q} key: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3960 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3961 @lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3962 ;; Close my help window when w3m closes. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3963 (defadvice w3m-close-window (after idlwave-close activate) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3964 (if (boundp 'idlwave-help-frame) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3965 (idlwave-help-quit))) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3966 @end lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3967 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3968 Note that you can open the file in an external browser from within |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3969 @code{w3m} using @kbd{M}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3970 @end itemize |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3971 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
3972 @node Configuration Examples, Windows and MacOS, HTML Help Browser Tips, Top |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3973 @appendix Configuration Examples |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3974 @cindex Configuration examples |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3975 @cindex Example configuration |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3976 @cindex @file{.emacs} |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3977 @cindex Default settings, of options |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3978 @cindex Interview, with the maintainer |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3979 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3980 @noindent |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3981 @b{Question:} You have all these complicated configuration options in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3982 your package, but which ones do @emph{you} as the maintainer actually |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3983 set in your own configuration? |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3984 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3985 @noindent |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3986 @b{Answer:} Not many, beyond custom key bindings. I set most defaults |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3987 the way that seems best. However, the default settings do not turn on |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3988 features which: |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3989 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3990 @itemize @minus |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3991 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3992 are not self-evident (i.e. too magic) when used by an unsuspecting user. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3993 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3994 are too intrusive. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3995 @item |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3996 will not work properly on all Emacs installations. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
3997 @item |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
3998 break with widely used standards. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
3999 @item |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4000 use function or other non-standard keys. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4001 @item |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4002 are purely personal customizations, like additional key bindings, and |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4003 library names. |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4004 @end itemize |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4005 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4006 @noindent To see what I mean, here is the @emph{entire} configuration |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4007 the old maintainer had in his @file{.emacs}: |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4008 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4009 @lisp |
34432
538246e4d1bc
Updated IDLWAVE manual to version 4.7
Carsten Dominik <dominik@science.uva.nl>
parents:
30009
diff
changeset
|
4010 (setq idlwave-shell-debug-modifiers '(control shift) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4011 idlwave-store-inquired-class t |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4012 idlwave-shell-automatic-start t |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
4013 idlwave-main-block-indent 2 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4014 idlwave-init-rinfo-when-idle-after 2 |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
4015 idlwave-help-dir "~/lib/emacs/idlwave" |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
4016 idlwave-special-lib-alist '(("/idl-astro/" . "AstroLib") |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
4017 ("/jhuapl/" . "JHUAPL-Lib") |
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
4018 ("/dominik/lib/idl/" . "MyLib"))) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4019 @end lisp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4020 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4021 However, if you are an Emacs power-user and want IDLWAVE to work |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4022 completely differently, you can change almost every aspect of it. Here |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4023 is an example of a much more extensive configuration of IDLWAVE. The |
29773
bdbce902ea81
Update to idlwave 4.2
Carsten Dominik <dominik@science.uva.nl>
parents:
29713
diff
changeset
|
4024 user is King! |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4025 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4026 @example |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4027 ;;; Settings for IDLWAVE mode |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4028 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4029 (setq idlwave-block-indent 3) ; Indentation settings |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4030 (setq idlwave-main-block-indent 3) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4031 (setq idlwave-end-offset -3) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4032 (setq idlwave-continuation-indent 1) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4033 (setq idlwave-begin-line-comment "^;[^;]") ; Leave ";" but not ";;" |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4034 ; anchored at start of line. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4035 (setq idlwave-surround-by-blank t) ; Turn on padding ops =,<,> |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4036 (setq idlwave-pad-keyword nil) ; Remove spaces for keyword '=' |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4037 (setq idlwave-expand-generic-end t) ; convert END to ENDIF etc... |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4038 (setq idlwave-reserved-word-upcase t) ; Make reserved words upper case |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4039 ; (with abbrevs only) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4040 (setq idlwave-abbrev-change-case nil) ; Don't force case of expansions |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4041 (setq idlwave-hang-indent-regexp ": ") ; Change from "- " for auto-fill |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4042 (setq idlwave-show-block nil) ; Turn off blinking to begin |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4043 (setq idlwave-abbrev-move t) ; Allow abbrevs to move point |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4044 (setq idlwave-query-class '((method-default . nil) ; No query for method |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4045 (keyword-default . nil); or keyword completion |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4046 ("INIT" . t) ; except for these |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4047 ("CLEANUP" . t) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4048 ("SETPROPERTY" .t) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4049 ("GETPROPERTY" .t))) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4050 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4051 ;; Using w3m for help (must install w3m and emacs-w3m) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4052 (autoload 'w3m-browse-url "w3m" "Interface for w3m on Emacs." t) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4053 (setq idlwave-help-browser-function 'w3m-browse-url |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4054 w3m-use-tab nil ; no tabs, location line, or toolbar |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4055 w3m-use-header-line nil |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4056 w3m-use-toolbar nil) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4057 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4058 ;; Close my help window or frame when w3m closes with `q' |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4059 (defadvice w3m-close-window (after idlwave-close activate) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4060 (if (boundp 'idlwave-help-frame) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4061 (idlwave-help-quit))) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4062 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4063 ;; Some setting can only be done from a mode hook. Here is an example: |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4064 (add-hook 'idlwave-mode-hook |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4065 (lambda () |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4066 (setq case-fold-search nil) ; Make searches case sensitive |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4067 ;; Run other functions here |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4068 (font-lock-mode 1) ; Turn on font-lock mode |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4069 (idlwave-auto-fill-mode 0) ; Turn off auto filling |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4070 (setq idlwave-help-browser-function 'browse-url-w3) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4071 |
46534
9059071c4fa9
Updated with patches from 1.8-1.17
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46530
diff
changeset
|
4072 ;; Pad with 1 space (if -n is used then make the |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4073 ;; padding a minimum of n spaces.) The defaults use -1 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4074 ;; instead of 1. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4075 (idlwave-action-and-binding "=" '(idlwave-expand-equal 1 1)) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4076 (idlwave-action-and-binding "<" '(idlwave-surround 1 1)) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4077 (idlwave-action-and-binding ">" '(idlwave-surround 1 1 '(?-))) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4078 (idlwave-action-and-binding "&" '(idlwave-surround 1 1)) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4079 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4080 ;; Only pad after comma and with exactly 1 space |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4081 (idlwave-action-and-binding "," '(idlwave-surround nil 1)) |
27600 | 4082 (idlwave-action-and-binding "&" '(idlwave-surround 1 1)) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4083 |
27600 | 4084 ;; Pad only after `->', remove any space before the arrow |
4085 (idlwave-action-and-binding "->" '(idlwave-surround 0 -1 nil 2)) | |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4086 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4087 ;; Set some personal bindings |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4088 ;; (In this case, makes `,' have the normal self-insert behavior.) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4089 (local-set-key "," 'self-insert-command) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4090 (local-set-key [f5] 'idlwave-shell-break-here) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4091 (local-set-key [f6] 'idlwave-shell-clear-current-bp) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4092 |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4093 ;; Create a newline, indenting the original and new line. |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4094 ;; A similar function that does _not_ reindent the original |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4095 ;; line is on "\C-j" (The default for emacs programming modes). |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4096 (local-set-key "\n" 'idlwave-newline) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4097 ;; (local-set-key "\C-j" 'idlwave-newline) ; My preference. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4098 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4099 ;; Some personal abbreviations |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4100 (define-abbrev idlwave-mode-abbrev-table |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4101 (concat idlwave-abbrev-start-char "wb") "widget_base()" |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4102 (idlwave-keyword-abbrev 1)) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4103 (define-abbrev idlwave-mode-abbrev-table |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4104 (concat idlwave-abbrev-start-char "on") "obj_new()" |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4105 (idlwave-keyword-abbrev 1)) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4106 )) |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4107 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4108 ;;; Settings for IDLWAVE SHELL mode |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4109 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4110 (setq idlwave-shell-overlay-arrow "=>") ; default is ">" |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4111 (setq idlwave-shell-use-dedicated-frame t) ; Make a dedicated frame |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4112 (setq idlwave-shell-prompt-pattern "^WAVE> ") ; default is "^IDL> " |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4113 (setq idlwave-shell-explicit-file-name "wave") |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4114 (setq idlwave-shell-process-name "wave") |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4115 (setq idlwave-shell-use-toolbar nil) ; No toolbar |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4116 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4117 ;; Most shell interaction settings can be done from the shell-mode-hook. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4118 (add-hook 'idlwave-shell-mode-hook |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4119 (lambda () |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4120 ;; Set up some custom key and mouse examine commands |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4121 (idlwave-shell-define-key-both [s-down-mouse-2] |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4122 (idlwave-shell-mouse-examine |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4123 "print, size(___,/DIMENSIONS)")) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4124 (idlwave-shell-define-key-both [f9] (idlwave-shell-examine |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4125 "print, size(___,/DIMENSIONS)")) |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4126 (idlwave-shell-define-key-both [f10] (idlwave-shell-examine |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4127 "print,size(___,/TNAME)")) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4128 (idlwave-shell-define-key-both [f11] (idlwave-shell-examine |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4129 "help,___,/STRUCTURE")))) |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4130 @end example |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4131 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4132 @html |
47440
0e5a022947e9
Updated to IDLWAVE version 4.15. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
46918
diff
changeset
|
4133 <A NAME="WIN_MAC"></A> |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4134 @end html |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4135 @node Windows and MacOS, Troubleshooting, Configuration Examples, Top |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4136 @appendix Windows and MacOS |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4137 @cindex Windows |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4138 @cindex MacOS |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4139 @cindex MacOSX |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4140 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4141 IDLWAVE was developed on a UNIX system. However, thanks to the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4142 portability of Emacs, much of IDLWAVE does also work under different |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4143 operating systems like Windows (with NTEmacs or NTXEmacs) or MacOS. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4144 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4145 The only real problem is that there is no command-line version of IDL |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4146 for Windows or MacOS(<=9) with which IDLWAVE can interact. As a |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4147 result, the IDLWAVE Shell does not work and you have to rely on IDLDE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4148 to run and debug your programs. However, editing IDL source files |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4149 with Emacs/IDLWAVE works with all bells and whistles, including |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4150 routine info, completion and fast online help. Only a small amount of |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4151 additional information must be specified in your @file{.emacs} file: |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4152 the path names which, on a UNIX system, are automatically gathered by |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4153 talking to the IDL program. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4154 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4155 Here is an example of the additional configuration needed for a Windows |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4156 system. I am assuming that IDLWAVE has been installed in |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4157 @w{@samp{C:\Program Files\IDLWAVE}} and that IDL is installed in |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4158 @w{@samp{C:\RSI\IDL62}}. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4159 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4160 @lisp |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4161 ;; location of the lisp files (only needed if IDLWAVE is not part of |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4162 ;; your default X/Emacs installation) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4163 (setq load-path (cons "c:/program files/IDLWAVE" load-path)) |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4164 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4165 ;; The location of the IDL library directories, both standard, and your own. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4166 ;; note that the initial "+" expands the path recursively |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4167 (setq idlwave-library-path |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4168 '("+c:/RSI/IDL55/lib/" "+c:/path/to/my/idllibs" )) |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4169 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4170 ;; location of the IDL system directory (try "print,!DIR") |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4171 (setq idlwave-system-directory "c:/RSI/IDL62/") |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4172 |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4173 @end lisp |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4174 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4175 @noindent Furthermore, Windows sometimes tries to outsmart you --- make |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4176 sure you check the following things: |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4177 |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4178 @itemize @bullet |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4179 @item When you download the IDLWAVE distribution, make sure you save the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4180 file under the names @file{idlwave.tar.gz}. |
46527
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4181 @item M-TAB switches among running programs --- use Esc-TAB |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4182 instead. |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4183 @item Other issues as yet unnamed... |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4184 @end itemize |
a687c07c44a6
Updated to IDLWAVE version 4.14.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
41745
diff
changeset
|
4185 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4186 Windows users who'd like to make use of IDLWAVE's context-aware HTML |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4187 help can skip the browser and use the HTMLHelp functionality directly. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4188 @xref{Help with HTML Documentation}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4189 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4190 @html |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4191 <A NAME="TROUBLE"></A> |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4192 @end html |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4193 @node Troubleshooting, Index, Windows and MacOS, Top |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4194 @appendix Troubleshooting |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4195 @cindex Troubleshooting |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4196 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4197 Although IDLWAVE usually installs and works without difficulty, a few |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4198 common problems and their solutions are documented below. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4199 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4200 @enumerate |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4201 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4202 @item @strong{Whenever an IDL error occurs or a breakpoint is hit, I get |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4203 errors or strange behavior when I try to type anything into some of my |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4204 IDLWAVE buffers.} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4205 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4206 This is a @emph{feature}, not an error. You're in @emph{Electric |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4207 Debug Mode} (@pxref{Electric Debug Mode}). You should see |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4208 @code{*Debugging*} in the mode-line. The buffer is read-only and all |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4209 debugging and examination commands are available as single keystrokes; |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4210 @kbd{C-?} lists these shortcuts. Use @kbd{q} to quit the mode, and |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4211 customize the variable @code{idlwave-shell-automatic-electric-debug} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4212 if you prefer not to enter electric debug on breakpoints@dots{} but |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4213 you really should try it before you disable it! You can also |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4214 customize this variable to enter debug mode when errors are |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4215 encountered. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4216 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4217 @item @strong{I get errors like @samp{Searching for program: no such |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4218 file or directory, idl} when attempting to start the IDL shell.} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4219 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4220 IDLWAVE needs to know where IDL is in order to run it as a process. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4221 By default, it attempts to invoke it simply as @samp{idl}, which |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4222 presumes such an executable is on your search path. You need to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4223 ensure @samp{idl} is on your @samp{$PATH}, or specify the full |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4224 pathname to the idl program with the variable |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4225 @code{idlwave-shell-explicit-file-name}. Note that you may need to |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4226 set your shell search path in two places when running Emacs as an Aqua |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4227 application with MacOSX; see the next topic. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4228 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4229 @item @strong{IDLWAVE is disregarding my @samp{IDL_PATH} which I set |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4230 under MacOSX} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4231 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4232 If you run Emacs directly as an Aqua application, rather than from the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4233 console shell, the environment is set not from your usual shell |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4234 configuration files (e.g. @file{.cshrc}), but from the file |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4235 @file{~/.MacOSX/environment.plist}. Either include your path settings |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4236 there, or start Emacs and IDLWAVE from the shell. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4237 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4238 @item @strong{I get errors like @samp{Symbol's function is void: |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4239 overlayp}} |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4240 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4241 You don't have the @samp{fsf-compat} package installed, which IDLWAVE |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4242 needs to run under XEmacs. Install it, or find an XEmacs distribution |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4243 which includes it by default. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4244 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4245 @item @strong{I'm getting errors like @samp{Symbol's value as variable is void: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4246 cl-builtin-gethash} on completion or routine info.} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4247 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4248 This error arises if you upgraded Emacs from 20.x to 21.x without |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4249 re-installing IDLWAVE. Old Emacs and new Emacs are not byte-compatible |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4250 in compiled lisp files. Presumably, you kept the original .elc files in |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4251 place, and this is the source of the error. If you recompile (or just |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4252 "make; make install") from source, it should resolve this problem. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4253 Another option is to recompile the @file{idlw*.el} files by hand using |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4254 @kbd{M-x byte-compile-file}. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4255 @ifclear PARTOFEMACS |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4256 Why not take the opportunity to grab the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4257 latest IDLWAVE version at @uref{@value{IDLWAVEHOMEPAGE}, the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4258 maintainers webpage}. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4259 @end ifclear |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4260 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4261 @item @strong{@kbd{M-@key{TAB}} doesn't complete words, it switches |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4262 windows on my desktop.} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4263 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4264 Your system is trapping @kbd{M-@key{TAB}} and using it for its own |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4265 nefarious purposes: Emacs never sees the keystrokes. On many Unix |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4266 systems, you can reconfigure your window manager to use another key |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4267 sequence for switching among windows. Another option is to use the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4268 equivalent sequence @kbd{@key{ESC}-@key{TAB}}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4269 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4270 @item @strong{When stopping at breakpoints or errors, IDLWAVE does not |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4271 seem to highlight the relevant line in the source.} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4272 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4273 IDLWAVE scans for error and halt messages and highlights the stop |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4274 location in the correct file. However, if you've changed the system |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4275 variable @samp{!ERROR_STATE.MSG_PREFIX}, it is unable to parse these |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4276 message correctly. Don't do that. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4277 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4278 @item @strong{IDLWAVE doesn't work correctly when using ENVI.} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4279 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4280 Though IDLWAVE was not written with ENVI in mind, it works just fine |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4281 with it, as long as you update the prompt it's looking for (@samp{IDL> |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4282 } by default). You can do this with the variable |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4283 @code{idlwave-shell-prompt-pattern} (@pxref{Starting the Shell}), e.g., |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4284 in your @file{.emacs}: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4285 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4286 @lisp |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4287 (setq idlwave-shell-prompt-pattern "^\r? ?\\(ENVI\\|IDL\\)> ") |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4288 @end lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4289 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4290 @item @strong{Attempts to set breakpoints fail: no breakpoint is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4291 indicated in the IDLWAVE buffer.} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4292 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4293 IDL changed its breakpoint reporting format starting with IDLv5.5. The |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4294 first version of IDLWAVE to support the new format is IDLWAVE v4.10. If |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4295 you have an older version and are using IDL >v5.5, you need to upgrade, |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4296 and/or make sure your recent version of IDLWAVE is being found on the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4297 Emacs load-path (see the next entry). You can list the version being |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4298 used with @kbd{C-h v idlwave-mode-version @key{RET}}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4299 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4300 @item @strong{I installed a new version of IDLWAVE, but the old |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4301 version is still being used} or @strong{IDLWAVE works, but when I |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4302 tried to install the optional modules @file{idlw-roprompt.el} or |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4303 @file{idlw-complete-structtag}, I get errors like @samp{Cannot open |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4304 load file}}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4305 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4306 The problem is that your Emacs is not finding the version of IDLWAVE you |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4307 installed. Many Emacsen come with an older bundled copy of IDLWAVE |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4308 (e.g. v4.7 for Emacs 21.x), which is likely what's being used instead. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4309 You need to make sure your Emacs @emph{load-path} contains the directory |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4310 where IDLWAVE is installed (@file{/usr/local/share/emacs/site-lisp}, by |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4311 default), @emph{before} Emacs' default search directories. You can |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4312 accomplish this by putting the following in your @file{.emacs}: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4313 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4314 @lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4315 (setq load-path (cons "/usr/local/share/emacs/site-lisp" load-path)) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4316 @end lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4317 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4318 @noindent You can check on your load-path value using @kbd{C-h v |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4319 load-path @key{RET}}, and @kbd{C-h m} in an IDLWAVE buffer should show |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4320 you the version Emacs is using. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4321 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4322 @item @strong{IDLWAVE is screwing up the formatting of my @file{.idl} files.} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4323 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4324 Actually, this isn't IDLWAVE at all, but @samp{idl-mode}, an unrelated |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4325 programming mode for CORBA's Interface Definition Language (you should |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4326 see @samp{(IDL)}, not @samp{(IDLWAVE)} in the mode-line). One |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4327 solution: don't name your file @file{.idl}, but rather @file{.pro}. |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4328 Another solution: make sure @file{.idl} files load IDLWAVE instead of |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4329 @samp{idl-mode} by adding the following to your @file{.emacs}: |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4330 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4331 @lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4332 (setcdr (rassoc 'idl-mode auto-mode-alist) 'idlwave-mode) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4333 @end lisp |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4334 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4335 @item @strong{The routine info for my local routines is out of date!} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4336 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4337 IDLWAVE collects routine info from various locations (@pxref{Routine |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4338 Information Sources}). Routines in files visited in a buffer or |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4339 compiled in the shell should be up to date. For other routines, the |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4340 information is only as current as the most recent scan. If you have a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4341 rapidly changing set of routines, and you'd like the latest routine |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4342 information to be available for it, one powerful technique is to make |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4343 use of the library catalog tool, @samp{idlwave_catalog}. Simply add a |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4344 line to your @samp{cron} file (@samp{crontab -e} will let you edit this |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4345 on some systems), like this |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4346 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4347 @example |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4348 45 3 * * 1-5 (cd /path/to/myidllib; /path/to/idlwave_catalog MyLib) |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4349 @end example |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4350 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4351 @noindent where @samp{MyLib} is the name of your library. This will |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4352 rescan all @file{.pro} files at or below @file{/path/to/myidllib} every |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4353 week night at 3:45am. You can even scan site-wide libraries with this |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4354 method, and the most recent information will be available to all users. |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4355 Since the scanning is very fast, there is very little impact. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4356 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4357 @item @strong{All the Greek-font characters in the HTML help are |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4358 displayed as Latin characters!} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4359 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4360 Unfortunately, the HTMLHelp files RSI provides attempt to switch to |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4361 @samp{Symbol} font to display Greek characters, which is not really an |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4362 permitted method for doing this in HTML. There is a "workaround" for |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4363 some browsers: @xref{HTML Help Browser Tips}. |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4364 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4365 @item @strong{In the shell, my long commands are truncated at 256 characters!} |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4366 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4367 This actually happens when running IDL in an XTerm as well. There are |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4368 a couple of work arounds: @code{define_key,/control,'^d'} (e.g. in |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4369 your @file{$IDL_STARTUP} file) will disable the @samp{EOF} character |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4370 and give you a 512 character limit. You won't be able to use |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4371 @key{C-d} to quit the shell, however. Another possibility is |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4372 @code{!EDIT_INPUT=0}, which gives you an @emph{infinite} limit (OK, a |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4373 memory-bounded limit), but disables the processing of background |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4374 widget events (those with @code{/NO_BLOCK} passed to @code{XManager}). |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4375 |
69826
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4376 @item @strong{When I invoke IDL HTML help on a routine, the page which |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4377 is loaded is one page off, e.g. for @code{CONVERT_COORD}, I get |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4378 @code{CONTOUR}.} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4379 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4380 You have a mismatch between your help index and the HTML help package |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4381 you downloaded. You need to ensure you download a ``downgrade kit'' if |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4382 you are using anything older than the latest HTML help package. A new |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4383 help package apppears with each IDL release (assuming the documentation |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4384 is updated). |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4385 @ifclear PARTOFEMACS |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4386 See @uref{@value{IDLWAVEHOMEPAGE}, the maintainers |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4387 webpage} for more. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4388 @end ifclear |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4389 Note that, starting with IDL 6.2, the HTML help and its catalog are |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4390 distributed with IDL, and so should never be inconsistent. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4391 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4392 @item @strong{I get errors such as @samp{void-variable |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4393 browse-url-browser-function} or similar when attempting to load IDLWAVE |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4394 under XEmacs.} |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4395 |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4396 You don't have the @samp{browse-url} (or other required) XEmacs package. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4397 Unlike GNU Emacs, XEmacs distributes many packages separately from the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4398 main program. IDLWAVE is actually among these, but is not always the |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4399 most up to date. When installing IDLWAVE as an XEmacs package, it |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4400 should prompt you for required additional packages. When installing it |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4401 from source, it won't and you'll get this error. The easiest solution |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4402 is to install all the packages when you install XEmacs (the so-called |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4403 @samp{sumo} bundle). The minimum set of XEmacs packages required by |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4404 IDLWAVE is @samp{fsf-compat, xemacs-base, mail-lib}. |
84148ade703d
Updated docs for IDLWAVE version 6.0; see idlwave.org. Factor out
J.D. Smith <jdsmith@as.arizona.edu>
parents:
69681
diff
changeset
|
4405 |
58294
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4406 @end enumerate |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4407 |
4fb51757e5ea
Updated to IDLWAVE version 5.5. See idlwave.org.
J.D. Smith <jdsmith@as.arizona.edu>
parents:
57912
diff
changeset
|
4408 @node Index, , Troubleshooting, Top |
26960
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4409 @unnumbered Index |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4410 @printindex cp |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4411 |
733eba22afe2
TeXInfo documentation of the IDLWAVE mode and shell
Carsten Dominik <dominik@science.uva.nl>
parents:
diff
changeset
|
4412 @bye |