Commit | Line | Data |
---|---|---|
52a244eb | 1 | ;; idlwave.el --- IDL editing mode for GNU Emacs |
d7a0267c | 2 | |
ab422c4d | 3 | ;; Copyright (C) 1999-2013 Free Software Foundation, Inc. |
f32b3b91 | 4 | |
52a244eb | 5 | ;; Authors: J.D. Smith <jdsmith@as.arizona.edu> |
65363a4e | 6 | ;; Carsten Dominik <dominik@science.uva.nl> |
52a244eb | 7 | ;; Chris Chase <chase@att.com> |
5e72c6b2 | 8 | ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu> |
bd78fa1d | 9 | ;; Version: 6.1.22 |
f32b3b91 CD |
10 | ;; Keywords: languages |
11 | ||
e8af40ee | 12 | ;; This file is part of GNU Emacs. |
f32b3b91 | 13 | |
b1fc2b50 | 14 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
f32b3b91 | 15 | ;; it under the terms of the GNU General Public License as published by |
b1fc2b50 GM |
16 | ;; the Free Software Foundation, either version 3 of the License, or |
17 | ;; (at your option) any later version. | |
f32b3b91 CD |
18 | |
19 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
20 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
21 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
22 | ;; GNU General Public License for more details. | |
23 | ||
24 | ;; You should have received a copy of the GNU General Public License | |
b1fc2b50 | 25 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
f32b3b91 CD |
26 | |
27 | ;;; Commentary: | |
28 | ||
f66f03de | 29 | ;; IDLWAVE enables feature-rich development and interaction with IDL, |
940e5099 | 30 | ;; the Interactive Data Language. It provides a compelling, |
f66f03de S |
31 | ;; full-featured alternative to the IDLDE development environment |
32 | ;; bundled with IDL. | |
3938cb82 | 33 | |
52a244eb S |
34 | ;; In the remotely distant past, based on pascal.el, though bears |
35 | ;; little resemblance to it now. | |
f32b3b91 CD |
36 | ;; |
37 | ;; Incorporates many ideas, such as abbrevs, action routines, and | |
38 | ;; continuation line indenting, from wave.el. | |
39 | ;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder. | |
40 | ;; | |
41 | ;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode") | |
42 | ;; for features, key bindings, and info. | |
43 | ;; Also, Info format documentation is available with `M-x idlwave-info' | |
44 | ;; | |
5e72c6b2 S |
45 | ;; New versions of IDLWAVE, documentation, and more information |
46 | ;; available from: | |
47 | ;; http://idlwave.org | |
f32b3b91 CD |
48 | ;; |
49 | ;; INSTALLATION | |
50 | ;; ============ | |
51 | ;; | |
52 | ;; Follow the instructions in the INSTALL file of the distribution. | |
53 | ;; In short, put this file on your load path and add the following | |
865fe16f | 54 | ;; lines to your init file: |
f32b3b91 CD |
55 | ;; |
56 | ;; (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t) | |
8c7b4ec8 | 57 | ;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t) |
f32b3b91 CD |
58 | ;; (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist)) |
59 | ;; | |
60 | ;; | |
61 | ;; SOURCE | |
62 | ;; ====== | |
63 | ;; | |
76959b77 | 64 | ;; The newest version of this file is available from the maintainer's |
52a244eb | 65 | ;; Webpage: |
f32b3b91 | 66 | ;; |
5e72c6b2 | 67 | ;; http://idlwave.org |
f32b3b91 CD |
68 | ;; |
69 | ;; DOCUMENTATION | |
70 | ;; ============= | |
71 | ;; | |
52a244eb S |
72 | ;; IDLWAVE is documented online in info format. A printable version |
73 | ;; of the documentation is available from the maintainers webpage (see | |
74 | ;; SOURCE). | |
775591f7 | 75 | ;; |
4b1aaa8b | 76 | ;; |
f32b3b91 CD |
77 | ;; ACKNOWLEDGMENTS |
78 | ;; =============== | |
79 | ;; | |
80 | ;; Thanks to the following people for their contributions and comments: | |
81 | ;; | |
52a244eb S |
82 | ;; Ulrik Dickow <dickow_at_nbi.dk> |
83 | ;; Eric E. Dors <edors_at_lanl.gov> | |
84 | ;; Stein Vidar H. Haugan <s.v.h.haugan_at_astro.uio.no> | |
85 | ;; David Huenemoerder <dph_at_space.mit.edu> | |
86 | ;; Kevin Ivory <Kevin.Ivory_at_linmpi.mpg.de> | |
87 | ;; Dick Jackson <dick_at_d-jackson.com> | |
88 | ;; Xuyong Liu <liu_at_stsci.edu> | |
89 | ;; Simon Marshall <Simon.Marshall_at_esrin.esa.it> | |
90 | ;; Laurent Mugnier <mugnier_at_onera.fr> | |
91 | ;; Lubos Pochman <lubos_at_rsinc.com> | |
92 | ;; Bob Portmann <portmann_at_al.noaa.gov> | |
93 | ;; Patrick M. Ryan <pat_at_jaameri.gsfc.nasa.gov> | |
94 | ;; Marty Ryba <ryba_at_ll.mit.edu> | |
95 | ;; Paul Sorenson <aardvark62_at_msn.com> | |
96 | ;; Phil Sterne <sterne_at_dublin.llnl.gov> | |
97 | ;; Phil Williams <williams_at_irc.chmcc.org> | |
f32b3b91 CD |
98 | ;; |
99 | ;; CUSTOMIZATION: | |
100 | ;; ============= | |
101 | ;; | |
52a244eb S |
102 | ;; IDLWAVE has extensive customize support; to learn about the |
103 | ;; variables which control the mode's behavior, use `M-x | |
104 | ;; idlwave-customize'. | |
f32b3b91 CD |
105 | ;; |
106 | ;; You can set your own preferred values with Customize, or with Lisp | |
107 | ;; code in .emacs. For an example of what to put into .emacs, check | |
52a244eb S |
108 | ;; the TexInfo documentation or see a complete .emacs available at the |
109 | ;; website. | |
f32b3b91 CD |
110 | ;; |
111 | ;; KNOWN PROBLEMS: | |
112 | ;; ============== | |
113 | ;; | |
76959b77 S |
114 | ;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual |
115 | ;; Numerics, Inc. is growing less and less complete as the two | |
116 | ;; languages grow increasingly apart. The mode probably shouldn't | |
3938cb82 | 117 | ;; even have "WAVE" in its title, but it's catchy, and was required |
52a244eb | 118 | ;; to avoid conflict with the CORBA idl.el mode. Caveat WAVEor. |
76959b77 | 119 | ;; |
f32b3b91 CD |
120 | ;; Moving the point backwards in conjunction with abbrev expansion |
121 | ;; does not work as I would like it, but this is a problem with | |
122 | ;; emacs abbrev expansion done by the self-insert-command. It ends | |
123 | ;; up inserting the character that expanded the abbrev after moving | |
124 | ;; point backward, e.g., "\cl" expanded with a space becomes | |
125 | ;; "LONG( )" with point before the close paren. This is solved by | |
4b1aaa8b | 126 | ;; using a temporary function in `post-command-hook' - not pretty, |
595ab50b | 127 | ;; but it works. |
f32b3b91 CD |
128 | ;; |
129 | ;; Tabs and spaces are treated equally as whitespace when filling a | |
130 | ;; comment paragraph. To accomplish this, tabs are permanently | |
131 | ;; replaced by spaces in the text surrounding the paragraph, which | |
132 | ;; may be an undesirable side-effect. Replacing tabs with spaces is | |
133 | ;; limited to comments only and occurs only when a comment | |
134 | ;; paragraph is filled via `idlwave-fill-paragraph'. | |
135 | ;; | |
52a244eb S |
136 | ;; Muti-statement lines (using "&") on block begin and end lines can |
137 | ;; ruin the formatting. For example, multiple end statements on a | |
138 | ;; line: endif & endif. Using "&" outside of block begin/end lines | |
139 | ;; should be okay. | |
f32b3b91 | 140 | ;; |
76959b77 S |
141 | ;; Determining the expression at point for printing and other |
142 | ;; examination commands is somewhat rough: currently only fairly | |
143 | ;; simple entities are found. You can always drag-select or examine | |
52a244eb | 144 | ;; a pre-selected region. |
f32b3b91 | 145 | ;; |
f32b3b91 CD |
146 | ;; When forcing completion of method keywords, the initial |
147 | ;; query for a method has multiple entries for some methods. Would | |
595ab50b | 148 | ;; be too difficult to fix this hardly used case. |
f32b3b91 CD |
149 | ;; |
150 | \f | |
151 | ;;; Code: | |
152 | ||
52a244eb | 153 | |
f32b3b91 | 154 | (eval-when-compile (require 'cl)) |
52a244eb S |
155 | (require 'idlw-help) |
156 | ||
157 | ;; For XEmacs | |
158 | (unless (fboundp 'line-beginning-position) | |
159 | (defalias 'line-beginning-position 'point-at-bol)) | |
160 | (unless (fboundp 'line-end-position) | |
161 | (defalias 'line-end-position 'point-at-eol)) | |
162 | (unless (fboundp 'char-valid-p) | |
163 | (defalias 'char-valid-p 'characterp)) | |
f66f03de S |
164 | (unless (fboundp 'match-string-no-properties) |
165 | (defalias 'match-string-no-properties 'match-string)) | |
f32b3b91 | 166 | |
3938cb82 S |
167 | (if (not (fboundp 'cancel-timer)) |
168 | (condition-case nil | |
169 | (require 'timer) | |
170 | (error nil))) | |
171 | ||
73e72da4 DN |
172 | (declare-function idlwave-shell-get-path-info "idlw-shell") |
173 | (declare-function idlwave-shell-temp-file "idlw-shell") | |
174 | (declare-function idlwave-shell-is-running "idlw-shell") | |
175 | (declare-function widget-value "wid-edit" (widget)) | |
176 | (declare-function comint-dynamic-complete-filename "comint" ()) | |
73e72da4 | 177 | |
f32b3b91 | 178 | (defgroup idlwave nil |
31b58798 | 179 | "Major mode for editing IDL .pro files." |
f32b3b91 | 180 | :tag "IDLWAVE" |
4b1aaa8b | 181 | :link '(url-link :tag "Home Page" |
5e72c6b2 | 182 | "http://idlwave.org") |
595ab50b CD |
183 | :link '(emacs-commentary-link :tag "Commentary in idlw-shell.el" |
184 | "idlw-shell.el") | |
f32b3b91 CD |
185 | :link '(emacs-commentary-link :tag "Commentary in idlwave.el" "idlwave.el") |
186 | :link '(custom-manual "(idlwave)Top") | |
187 | :prefix "idlwave" | |
188 | :group 'languages) | |
189 | ||
52a244eb | 190 | |
f32b3b91 CD |
191 | ;;; Variables for indentation behavior --------------------------------------- |
192 | ||
193 | (defgroup idlwave-code-formatting nil | |
194 | "Indentation and formatting options for IDLWAVE mode." | |
195 | :group 'idlwave) | |
196 | ||
f66f03de | 197 | (defcustom idlwave-main-block-indent 2 |
fb7ada5f | 198 | "Extra indentation for the main block of code. |
f32b3b91 CD |
199 | That is the block between the FUNCTION/PRO statement and the END |
200 | statement for that program unit." | |
201 | :group 'idlwave-code-formatting | |
202 | :type 'integer) | |
203 | ||
f66f03de | 204 | (defcustom idlwave-block-indent 3 |
fb7ada5f | 205 | "Extra indentation applied to block lines. |
f32b3b91 CD |
206 | If you change this, you probably also want to change `idlwave-end-offset'." |
207 | :group 'idlwave-code-formatting | |
208 | :type 'integer) | |
209 | ||
f66f03de | 210 | (defcustom idlwave-end-offset -3 |
fb7ada5f | 211 | "Extra indentation applied to block END lines. |
f32b3b91 CD |
212 | A value equal to negative `idlwave-block-indent' will make END lines |
213 | line up with the block BEGIN lines." | |
214 | :group 'idlwave-code-formatting | |
215 | :type 'integer) | |
216 | ||
f66f03de | 217 | (defcustom idlwave-continuation-indent 3 |
fb7ada5f | 218 | "Extra indentation applied to continuation lines. |
f32b3b91 | 219 | This extra offset applies to the first of a set of continuation lines. |
5e72c6b2 S |
220 | The following lines receive the same indentation as the first." |
221 | :group 'idlwave-code-formatting | |
222 | :type 'integer) | |
223 | ||
f66f03de | 224 | (defcustom idlwave-max-extra-continuation-indent 40 |
fb7ada5f | 225 | "Maximum additional indentation for special continuation indent. |
5e72c6b2 S |
226 | Several special indentations are tried to help line up continuation |
227 | lines in routine calls or definitions, other statements with | |
134b6671 | 228 | parentheses, or assignment statements. This variable specifies a |
5e72c6b2 S |
229 | maximum amount by which this special indentation can exceed the |
230 | standard continuation indentation, otherwise defaulting to a fixed | |
231 | offset. Set to 0 to effectively disable all special continuation | |
232 | indentation, or to a large number (like 100) to enable it in all | |
52a244eb | 233 | cases. See also `idlwave-indent-to-open-paren', which can override |
5e72c6b2 | 234 | this variable." |
f32b3b91 CD |
235 | :group 'idlwave-code-formatting |
236 | :type 'integer) | |
237 | ||
5e72c6b2 | 238 | (defcustom idlwave-indent-to-open-paren t |
fb7ada5f | 239 | "Non-nil means, indent continuation lines to innermost open parenthesis. |
5a0c3f56 | 240 | This indentation occurs even if otherwise disallowed by |
5e72c6b2 S |
241 | `idlwave-max-extra-continuation-indent'. Matching parens and the |
242 | interleaving args are lined up. Example: | |
243 | ||
244 | x = function_a(function_b(function_c( a, b, [1,2,3, $ | |
245 | 4,5,6 $ | |
246 | ], $ | |
247 | c, d $ | |
248 | ))) | |
249 | ||
250 | When this variable is nil, paren alignment may still occur, based on | |
5a0c3f56 JB |
251 | the value of `idlwave-max-extra-continuation-indent', which, if zero, |
252 | would yield: | |
5e72c6b2 S |
253 | |
254 | x = function_a(function_b(function_c( a, b, [1,2,3, $ | |
255 | 4,5,6 $ | |
256 | ], $ | |
257 | c, d $ | |
258 | )))" | |
5a0c3f56 | 259 | :group 'idlwave-code-formatting |
5e72c6b2 S |
260 | :type 'boolean) |
261 | ||
52a244eb | 262 | (defcustom idlwave-indent-parens-nested nil |
fb7ada5f | 263 | "Non-nil means, indent continuation lines with parens by nesting |
52a244eb S |
264 | lines at consecutively deeper levels." |
265 | :group 'idlwave-code-formatting | |
266 | :type 'boolean) | |
267 | ||
268 | ||
f32b3b91 | 269 | (defcustom idlwave-hanging-indent t |
fb7ada5f | 270 | "If set non-nil then comment paragraphs are indented under the |
f32b3b91 CD |
271 | hanging indent given by `idlwave-hang-indent-regexp' match in the first line |
272 | of the paragraph." | |
273 | :group 'idlwave-code-formatting | |
274 | :type 'boolean) | |
275 | ||
276 | (defcustom idlwave-hang-indent-regexp "- " | |
fb7ada5f | 277 | "Regular expression matching the position of the hanging indent |
5a0c3f56 | 278 | in the first line of a comment paragraph. The size of the indent |
f32b3b91 CD |
279 | extends to the end of the match for the regular expression." |
280 | :group 'idlwave-code-formatting | |
281 | :type 'regexp) | |
282 | ||
283 | (defcustom idlwave-use-last-hang-indent nil | |
fb7ada5f | 284 | "If non-nil then use last match on line for `idlwave-indent-regexp'." |
f32b3b91 CD |
285 | :group 'idlwave-code-formatting |
286 | :type 'boolean) | |
287 | ||
288 | (defcustom idlwave-fill-comment-line-only t | |
fb7ada5f | 289 | "If non-nil then auto fill will only operate on comment lines." |
f32b3b91 CD |
290 | :group 'idlwave-code-formatting |
291 | :type 'boolean) | |
292 | ||
293 | (defcustom idlwave-auto-fill-split-string t | |
fb7ada5f | 294 | "If non-nil then auto fill will split strings with the IDL `+' operator. |
4b1aaa8b PE |
295 | When the line end falls within a string, string concatenation with the |
296 | '+' operator will be used to distribute a long string over lines. | |
f32b3b91 CD |
297 | If nil and a string is split then a terminal beep and warning are issued. |
298 | ||
299 | This variable is ignored when `idlwave-fill-comment-line-only' is | |
300 | non-nil, since in this case code is not auto-filled." | |
301 | :group 'idlwave-code-formatting | |
302 | :type 'boolean) | |
303 | ||
304 | (defcustom idlwave-split-line-string t | |
fb7ada5f | 305 | "If non-nil then `idlwave-split-line' will split strings with `+'. |
f32b3b91 CD |
306 | When the splitting point of a line falls inside a string, split the string |
307 | using the `+' string concatenation operator. If nil and a string is | |
308 | split then a terminal beep and warning are issued." | |
309 | :group 'idlwave-code-formatting | |
310 | :type 'boolean) | |
311 | ||
312 | (defcustom idlwave-no-change-comment ";;;" | |
fb7ada5f | 313 | "The indentation of a comment that starts with this regular |
5a0c3f56 | 314 | expression will not be changed. Note that the indentation of a comment |
f32b3b91 CD |
315 | at the beginning of a line is never changed." |
316 | :group 'idlwave-code-formatting | |
317 | :type 'string) | |
318 | ||
319 | (defcustom idlwave-begin-line-comment nil | |
fb7ada5f | 320 | "A comment anchored at the beginning of line. |
f32b3b91 CD |
321 | A comment matching this regular expression will not have its |
322 | indentation changed. If nil the default is \"^;\", i.e., any line | |
323 | beginning with a \";\". Expressions for comments at the beginning of | |
324 | the line should begin with \"^\"." | |
325 | :group 'idlwave-code-formatting | |
326 | :type '(choice (const :tag "Any line beginning with `;'" nil) | |
327 | 'regexp)) | |
328 | ||
329 | (defcustom idlwave-code-comment ";;[^;]" | |
fb7ada5f | 330 | "A comment that starts with this regular expression on a line by |
f32b3b91 CD |
331 | itself is indented as if it is a part of IDL code. As a result if |
332 | the comment is not preceded by whitespace it is unchanged." | |
333 | :group 'idlwave-code-formatting | |
334 | :type 'regexp) | |
335 | ||
336 | ;; Comments not matching any of the above will be indented as a | |
337 | ;; right-margin comment, i.e., to a minimum of `comment-column'. | |
338 | ||
f32b3b91 CD |
339 | ;;; Routine Info and Completion --------------------------------------- |
340 | ||
15e42531 CD |
341 | (defgroup idlwave-routine-info nil |
342 | "Routine Info options for IDLWAVE mode." | |
f32b3b91 CD |
343 | :group 'idlwave) |
344 | ||
52a244eb | 345 | (defcustom idlwave-use-library-catalogs t |
fb7ada5f | 346 | "Non-nil means search the IDL path for library catalog files. |
52a244eb S |
347 | |
348 | These files, named .idlwave_catalog, document routine information for | |
349 | individual directories and libraries of IDL .pro files. Many popular | |
5a0c3f56 JB |
350 | libraries come with catalog files by default, so leaving this on is |
351 | usually a good idea." | |
52a244eb S |
352 | :group 'idlwave-routine-info |
353 | :type 'boolean) | |
5e72c6b2 S |
354 | |
355 | (defcustom idlwave-init-rinfo-when-idle-after 10 | |
fb7ada5f | 356 | "Seconds of idle time before routine info is automatically initialized. |
5a0c3f56 JB |
357 | Initializing the routine info can take a long time, in particular if a |
358 | large number of library catalogs are involved. When Emacs is idle for | |
359 | more than the number of seconds specified by this variable, it starts | |
360 | the initialization. The process is split into five steps, in order to | |
361 | keep work interruption as short as possible. If one of the steps | |
362 | finishes, and no user input has arrived in the mean time, initialization | |
363 | proceeds immediately to the next step. A good value for this variable | |
364 | is about 1/3 of the time initialization take in your setup. So if you | |
365 | have a fast machine and no problems with a slow network connection, | |
366 | don't hesitate to set this to 2 seconds. A value of 0 means, don't | |
367 | initialize automatically, but instead wait until routine information is | |
368 | needed, and initialize then." | |
5e72c6b2 S |
369 | :group 'idlwave-routine-info |
370 | :type 'number) | |
371 | ||
f32b3b91 | 372 | (defcustom idlwave-scan-all-buffers-for-routine-info t |
fb7ada5f | 373 | "Non-nil means, scan buffers for IDL programs when updating info. |
15e42531 CD |
374 | The scanning is done by the command `idlwave-update-routine-info'. |
375 | The following values are allowed: | |
376 | ||
377 | nil Don't scan any buffers. | |
5a0c3f56 | 378 | t Scan all `idlwave-mode' buffers in the current editing session. |
15e42531 CD |
379 | current Scan only the current buffer, but no other buffers." |
380 | :group 'idlwave-routine-info | |
381 | :type '(choice | |
382 | (const :tag "No buffer" nil) | |
383 | (const :tag "All buffers" t) | |
384 | (const :tag "Current buffer only" 'current))) | |
f32b3b91 CD |
385 | |
386 | (defcustom idlwave-query-shell-for-routine-info t | |
fb7ada5f | 387 | "Non-nil means query the shell for info about compiled routines. |
f32b3b91 CD |
388 | Querying the shell is useful to get information about compiled modules, |
389 | and it is turned on by default. However, when you have a complete library | |
390 | scan, this is not necessary." | |
15e42531 | 391 | :group 'idlwave-routine-info |
f32b3b91 CD |
392 | :type 'boolean) |
393 | ||
15e42531 CD |
394 | (defcustom idlwave-auto-routine-info-updates |
395 | '(find-file save-buffer kill-buffer compile-buffer) | |
fb7ada5f | 396 | "Controls under what circumstances routine info is updated automatically. |
15e42531 CD |
397 | Possible values: |
398 | nil Never | |
399 | t All available | |
5a0c3f56 | 400 | \(...) A list of circumstances. Allowed members are: |
15e42531 CD |
401 | find-file Add info for new IDLWAVE buffers. |
402 | save-buffer Update buffer info when buffer is saved | |
403 | kill-buffer Remove buffer info when buffer gets killed | |
404 | compile-buffer Update shell info after `idlwave-shell-save-and...'" | |
405 | :group 'idlwave-routine-info | |
406 | :type '(choice | |
407 | (const :tag "Never" nil) | |
408 | (const :tag "As often as possible" t) | |
409 | (set :tag "Checklist" :greedy t | |
410 | (const :tag "When visiting a file" find-file) | |
411 | (const :tag "When saving a buffer" save-buffer) | |
412 | (const :tag "After a buffer was killed" kill-buffer) | |
413 | (const :tag "After a buffer was compiled successfully, update shell info" compile-buffer)))) | |
4b1aaa8b | 414 | |
15e42531 | 415 | (defcustom idlwave-rinfo-max-source-lines 5 |
fb7ada5f | 416 | "Maximum number of source files displayed in the Routine Info window. |
15e42531 | 417 | When an integer, it is the maximum number of source files displayed. |
5a0c3f56 | 418 | A value of t means to show all source files." |
15e42531 CD |
419 | :group 'idlwave-routine-info |
420 | :type 'integer) | |
421 | ||
f32b3b91 | 422 | (defcustom idlwave-library-path nil |
8c43762b | 423 | "Library path for Windows and MacOS (OS9). Not needed under UNIX. |
f66f03de S |
424 | When selecting the directories to scan for IDL user catalog routine |
425 | info, IDLWAVE can, under UNIX, query the shell for the exact search | |
426 | path \(the value of !PATH). However, under Windows and MacOS | |
8c43762b | 427 | \(pre-OSX), the IDLWAVE shell does not work. In this case, this |
f66f03de S |
428 | variable can be set to specify the paths where IDLWAVE can find PRO |
429 | files. The shell will only be asked for a list of paths when this | |
430 | variable is nil. The value is a list of directories. A directory | |
97610156 | 431 | preceded by a `+' will be searched recursively. If you set this |
f66f03de S |
432 | variable on a UNIX system, the shell will not be queried. See also |
433 | `idlwave-system-directory'." | |
15e42531 | 434 | :group 'idlwave-routine-info |
f32b3b91 CD |
435 | :type '(repeat (directory))) |
436 | ||
15e42531 | 437 | (defcustom idlwave-system-directory "" |
52a244eb S |
438 | "The IDL system directory for Windows and MacOS. Not needed under |
439 | UNIX. Set this to the value of the `!DIR' system variable in IDL. | |
440 | IDLWAVE uses this to find out which of the library routines belong to | |
441 | the official system library. All files inside the `lib' subdirectory | |
442 | are considered system library files - so don't install private stuff | |
443 | in this directory. On UNIX systems, IDLWAVE queries the shell for the | |
444 | value of `!DIR'. See also `idlwave-library-path'." | |
15e42531 CD |
445 | :group 'idlwave-routine-info |
446 | :type 'directory) | |
447 | ||
f66f03de | 448 | ;; Configuration files |
4b1aaa8b | 449 | (defcustom idlwave-config-directory |
940e5099 | 450 | (locate-user-emacs-file "idlwave" ".idlwave") |
fb7ada5f | 451 | "Directory for configuration files and user-library catalog." |
15e42531 | 452 | :group 'idlwave-routine-info |
f32b3b91 CD |
453 | :type 'file) |
454 | ||
52a244eb | 455 | (defvar idlwave-user-catalog-file "idlusercat.el") |
f66f03de | 456 | (defvar idlwave-xml-system-rinfo-converted-file "idl_xml_rinfo.el") |
52a244eb S |
457 | (defvar idlwave-path-file "idlpath.el") |
458 | ||
15e42531 CD |
459 | (defcustom idlwave-special-lib-alist nil |
460 | "Alist of regular expressions matching special library directories. | |
461 | When listing routine source locations, IDLWAVE gives a short hint where | |
4b1aaa8b | 462 | the file defining the routine is located. By default it lists `SystemLib' |
15e42531 CD |
463 | for routines in the system library `!DIR/lib' and `Library' for anything |
464 | else. This variable can define additional types. The car of each entry | |
465 | is a regular expression matching the file name (they normally will match | |
466 | on the path). The cdr is the string to be used as identifier. Max 10 | |
467 | chars are allowed." | |
468 | :group 'idlwave-routine-info | |
469 | :type '(repeat | |
470 | (cons regexp string))) | |
471 | ||
52a244eb | 472 | (defcustom idlwave-auto-write-paths t |
4b1aaa8b | 473 | "Write out path (!PATH) and system directory (!DIR) info automatically. |
52a244eb S |
474 | Path info is needed to locate library catalog files. If non-nil, |
475 | whenever the path-list changes as a result of shell-query, etc., it is | |
476 | written to file. Otherwise, the menu option \"Write Paths\" can be | |
477 | used to force a write." | |
478 | :group 'idlwave-routine-info | |
05a1abfc | 479 | :type 'boolean) |
775591f7 | 480 | |
15e42531 CD |
481 | (defgroup idlwave-completion nil |
482 | "Completion options for IDLWAVE mode." | |
483 | :prefix "idlwave" | |
484 | :group 'idlwave) | |
485 | ||
f32b3b91 CD |
486 | (eval-and-compile |
487 | (defconst idlwave-tmp | |
488 | '(choice :tag "by applying the function" | |
489 | (const upcase) | |
490 | (const downcase) | |
491 | (const capitalize) | |
492 | (const preserve) | |
493 | (symbol :tag "Other")))) | |
494 | ||
f32b3b91 CD |
495 | (defcustom idlwave-completion-case '((routine . upcase) |
496 | (keyword . upcase) | |
497 | (class . preserve) | |
498 | (method . preserve)) | |
499 | "Association list setting the case of completed words. | |
500 | ||
501 | This variable determines the case (UPPER/lower/Capitalized...) of | |
502 | words inserted into the buffer by completion. The preferred case can | |
503 | be specified separately for routine names, keywords, classes and | |
4b1aaa8b | 504 | methods. |
f32b3b91 CD |
505 | This alist should therefore have entries for `routine' (normal |
506 | functions and procedures, i.e. non-methods), `keyword', `class', and | |
507 | `method'. Plausible values are | |
508 | ||
509 | upcase upcase whole word, like `BOX_CURSOR' | |
510 | downcase downcase whole word, like `read_ppm' | |
511 | capitalize capitalize each part, like `Widget_Control' | |
512 | preserve preserve case as is, like `IDLgrView' | |
513 | ||
514 | The value can also be any Emacs Lisp function which transforms the | |
515 | case of characters in a string. | |
516 | ||
517 | A value of `preserve' means that the case of the completed word is | |
518 | identical to the way it was written in the definition statement of the | |
519 | routine. This was implemented to allow for mixed-case completion, in | |
520 | particular of object classes and methods. | |
521 | If a completable word is defined in multiple locations, the meaning of | |
522 | `preserve' is not unique since the different definitions might be | |
523 | cased differently. Therefore IDLWAVE always takes the case of the | |
524 | *first* definition it encounters during routine info collection and | |
525 | uses the case derived from it consistently. | |
526 | ||
527 | Note that a lowercase-only string in the buffer will always be completed in | |
528 | lower case (but see the variable `idlwave-completion-force-default-case'). | |
529 | ||
530 | After changing this variable, you need to either restart Emacs or press | |
531 | `C-u C-c C-i' to update the internal lists." | |
15e42531 | 532 | :group 'idlwave-completion |
f32b3b91 CD |
533 | :type `(repeat |
534 | (cons (symbol :tag "Derive completion case for") | |
535 | ,idlwave-tmp))) | |
536 | ||
537 | (defcustom idlwave-completion-force-default-case nil | |
fb7ada5f | 538 | "Non-nil means, completion will always honor `idlwave-completion-case'. |
f32b3b91 CD |
539 | When nil, only the completion of a mixed case or upper case string |
540 | will honor the default settings in `idlwave-completion-case', while | |
541 | the completion of lower case strings will be completed entirely in | |
542 | lower case." | |
15e42531 | 543 | :group 'idlwave-completion |
f32b3b91 CD |
544 | :type 'boolean) |
545 | ||
546 | (defcustom idlwave-complete-empty-string-as-lower-case nil | |
fb7ada5f | 547 | "Non-nil means, the empty string is considered downcase for completion. |
f32b3b91 CD |
548 | The case of what is already in the buffer determines the case of completions. |
549 | When this variable is non-nil, the empty string is considered to be downcase. | |
550 | Completing on the empty string then offers downcase versions of the possible | |
551 | completions." | |
15e42531 | 552 | :group 'idlwave-completion |
f32b3b91 CD |
553 | :type 'boolean) |
554 | ||
f32b3b91 | 555 | (defcustom idlwave-buffer-case-takes-precedence nil |
fb7ada5f | 556 | "Non-nil means, the case of tokens in buffers dominates over system stuff. |
f32b3b91 CD |
557 | To make this possible, we need to re-case everything each time we update |
558 | the routine info from the buffers. This is slow. | |
559 | The default is to consider the case given in the system and library files | |
560 | first which makes updating much faster." | |
15e42531 CD |
561 | :group 'idlwave-completion |
562 | :type 'boolean) | |
563 | ||
564 | (defcustom idlwave-highlight-help-links-in-completion t | |
fb7ada5f | 565 | "Non-nil means, highlight completions for which system help is available. |
15e42531 CD |
566 | Help can then be accessed with mouse-3. |
567 | This option is only effective when the online help system is installed." | |
568 | :group 'idlwave-completion | |
f32b3b91 CD |
569 | :type 'boolean) |
570 | ||
05a1abfc CD |
571 | (defcustom idlwave-support-inheritance t |
572 | "Non-nil means, treat inheritance with completion, online help etc. | |
cef6cafe | 573 | When nil, IDLWAVE only knows about the native methods and tags of a class, |
05a1abfc CD |
574 | not about inherited ones." |
575 | :group 'idlwave-routine-info | |
576 | :type 'boolean) | |
577 | ||
5e72c6b2 S |
578 | (defcustom idlwave-keyword-class-inheritance '("^[gs]etproperty$" "^init$") |
579 | "List of regular expressions for class-driven keyword inheritance. | |
580 | Keyword inheritance is often tied to class inheritance by \"chaining\" | |
581 | up the class tree. While it cannot be assumed that the presence of an | |
582 | _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for | |
583 | certain methods this assumption is almost always true. The methods | |
584 | for which to assume this can be set here." | |
585 | :group 'idlwave-routine-info | |
586 | :type '(repeat (regexp :tag "Match method:"))) | |
4b1aaa8b | 587 | |
5e72c6b2 | 588 | |
f32b3b91 | 589 | (defcustom idlwave-completion-show-classes 1 |
fb7ada5f | 590 | "Number of classes to show when completing object methods and keywords. |
f32b3b91 | 591 | When completing methods or keywords for an object with unknown class, |
2e8b9c7d | 592 | the *Completions* buffer will show the valid classes for each completion |
f32b3b91 CD |
593 | like this: |
594 | ||
595 | MyMethod <Class1,Class2,Class3> | |
596 | ||
597 | The value of this variable may be nil to inhibit display, or an integer to | |
598 | indicate the maximum number of classes to display. | |
599 | ||
600 | On XEmacs, a full list of classes will also be placed into a `help-echo' | |
da6062e6 | 601 | property on the completion items, so that the list of classes for the current |
f32b3b91 CD |
602 | item is displayed in the echo area. If the value of this variable is a |
603 | negative integer, the `help-echo' property will be suppressed." | |
15e42531 | 604 | :group 'idlwave-completion |
f32b3b91 CD |
605 | :type '(choice (const :tag "Don't show" nil) |
606 | (integer :tag "Number of classes shown" 1))) | |
607 | ||
608 | (defcustom idlwave-completion-fontify-classes t | |
fb7ada5f | 609 | "Non-nil means, fontify the classes in completions buffer. |
f32b3b91 CD |
610 | This makes it easier to distinguish the completion items from the extra |
611 | class info listed. See `idlwave-completion-show-classes'." | |
15e42531 | 612 | :group 'idlwave-completion |
f32b3b91 CD |
613 | :type 'boolean) |
614 | ||
615 | (defcustom idlwave-query-class '((method-default . nil) | |
616 | (keyword-default . nil)) | |
617 | "Association list governing specification of object classes for completion. | |
618 | ||
5e72c6b2 S |
619 | When IDLWAVE tries to complete object-oriented methods, it usually |
620 | cannot determine the class of a given object from context. In order | |
621 | to provide the user with a correct list of methods or keywords, it | |
76959b77 S |
622 | needs to determine the appropriate class. IDLWAVE has two ways of |
623 | doing this (well, three ways if you count the shell... see | |
624 | `idlwave-shell-query-for-class'): | |
625 | ||
626 | 1. Combine the items of all available classes which contain this | |
627 | method for the purpose of completion. So when completing a method, | |
628 | all methods of all known classes are available, and when completing | |
629 | a keyword, all keywords allowed for this method in any class are | |
630 | shown. This behavior is very much like normal completion and is | |
631 | therefore the default. It works much better than one might think - | |
632 | only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists | |
633 | become uncomfortably long. See also | |
5e72c6b2 | 634 | `idlwave-completion-show-classes'. |
f32b3b91 CD |
635 | |
636 | 2. The second possibility is to ask the user on each occasion. To | |
637 | make this less interruptive, IDLWAVE can store the class as a text | |
638 | property on the object operator `->'. For a given object in the | |
639 | source code, class selection will then be needed only once | |
640 | - for example to complete the method. Keywords to the method can | |
641 | then be completed directly, because the class is already known. | |
642 | You will have to turn on the storage of the selected class | |
643 | explicitly with the variable `idlwave-store-inquired-class'. | |
644 | ||
5e72c6b2 S |
645 | This variable allows you to configure IDLWAVE's method and |
646 | method-keyword completion behavior. Its value is an alist, which | |
647 | should contain at least two elements: (method-default . VALUE) and | |
facebc7b | 648 | \(keyword-default . VALUE), where VALUE is either t or nil. These |
5e72c6b2 S |
649 | specify if the class should be found during method and keyword |
650 | completion, respectively. | |
f32b3b91 | 651 | |
4b1aaa8b | 652 | The alist may have additional entries specifying exceptions from the |
f32b3b91 CD |
653 | keyword completion rule for specific methods, like INIT or |
654 | GETPROPERTY. In order to turn on class specification for the INIT | |
655 | method, add an entry (\"INIT\" . t). The method name must be ALL-CAPS." | |
15e42531 | 656 | :group 'idlwave-completion |
f32b3b91 CD |
657 | :type '(list |
658 | (cons (const method-default) | |
659 | (boolean :tag "Determine class when completing METHODS ")) | |
660 | (cons (const keyword-default) | |
661 | (boolean :tag "Determine class when completing KEYWORDS ")) | |
662 | (repeat | |
663 | :tag "Exceptions to defaults" | |
664 | :inline t | |
665 | (cons (string :tag "MODULE" :value "") | |
666 | (boolean :tag "Determine class for this method"))))) | |
667 | ||
f66f03de | 668 | (defcustom idlwave-store-inquired-class t |
fb7ada5f | 669 | "Non-nil means, store class of a method call as text property on `->'. |
f32b3b91 CD |
670 | IDLWAVE sometimes has to ask the user for the class associated with a |
671 | particular object method call. This happens during the commands | |
672 | `idlwave-routine-info' and `idlwave-complete', depending upon the | |
673 | value of the variable `idlwave-query-class'. | |
674 | ||
675 | When you specify a class, this information can be stored as a text | |
4b1aaa8b | 676 | property on the `->' arrow in the source code, so that during the same |
f32b3b91 CD |
677 | editing session, IDLWAVE will not have to ask again. When this |
678 | variable is non-nil, IDLWAVE will store and reuse the class information. | |
679 | The class stored can be checked and removed with `\\[idlwave-routine-info]' | |
680 | on the arrow. | |
681 | ||
682 | The default of this variable is nil, since the result of commands then | |
683 | is more predictable. However, if you know what you are doing, it can | |
684 | be nice to turn this on. | |
685 | ||
686 | An arrow which knows the class will be highlighted with | |
687 | `idlwave-class-arrow-face'. The command \\[idlwave-routine-info] | |
688 | displays (with prefix arg: deletes) the class stored on the arrow | |
689 | at point." | |
15e42531 | 690 | :group 'idlwave-completion |
f32b3b91 CD |
691 | :type 'boolean) |
692 | ||
693 | (defcustom idlwave-class-arrow-face 'bold | |
fb7ada5f | 694 | "Face to highlight object operator arrows `->' which carry a class property. |
f32b3b91 | 695 | When IDLWAVE stores a class name as text property on an object arrow |
facebc7b | 696 | \(see variable `idlwave-store-inquired-class', it highlights the arrow |
f32b3b91 | 697 | with this font in order to remind the user that this arrow is special." |
15e42531 | 698 | :group 'idlwave-completion |
f32b3b91 CD |
699 | :type 'symbol) |
700 | ||
701 | (defcustom idlwave-resize-routine-help-window t | |
fb7ada5f | 702 | "Non-nil means, resize the Routine-info *Help* window to fit the content." |
15e42531 | 703 | :group 'idlwave-completion |
f32b3b91 CD |
704 | :type 'boolean) |
705 | ||
706 | (defcustom idlwave-keyword-completion-adds-equal t | |
fb7ada5f | 707 | "Non-nil means, completion automatically adds `=' after completed keywords." |
15e42531 | 708 | :group 'idlwave-completion |
f32b3b91 CD |
709 | :type 'boolean) |
710 | ||
711 | (defcustom idlwave-function-completion-adds-paren t | |
fb7ada5f | 712 | "Non-nil means, completion automatically adds `(' after completed function. |
0ff9b955 | 713 | nil means, don't add anything. |
f32b3b91 CD |
714 | A value of `2' means, also add the closing parenthesis and position cursor |
715 | between the two." | |
15e42531 | 716 | :group 'idlwave-completion |
f32b3b91 CD |
717 | :type '(choice (const :tag "Nothing" nil) |
718 | (const :tag "(" t) | |
719 | (const :tag "()" 2))) | |
720 | ||
721 | (defcustom idlwave-completion-restore-window-configuration t | |
fb7ada5f | 722 | "Non-nil means, try to restore the window configuration after completion. |
f32b3b91 CD |
723 | When completion is not unique, Emacs displays a list of completions. |
724 | This messes up your window configuration. With this variable set, IDLWAVE | |
725 | restores the old configuration after successful completion." | |
15e42531 | 726 | :group 'idlwave-completion |
f32b3b91 CD |
727 | :type 'boolean) |
728 | ||
729 | ;;; Variables for abbrev and action behavior ----------------------------- | |
730 | ||
731 | (defgroup idlwave-abbrev-and-indent-action nil | |
732 | "IDLWAVE performs actions when expanding abbreviations or indenting lines. | |
733 | The variables in this group govern this." | |
734 | :group 'idlwave) | |
735 | ||
736 | (defcustom idlwave-do-actions nil | |
fb7ada5f | 737 | "Non-nil means performs actions when indenting. |
f32b3b91 CD |
738 | The actions that can be performed are listed in `idlwave-indent-action-table'." |
739 | :group 'idlwave-abbrev-and-indent-action | |
740 | :type 'boolean) | |
741 | ||
742 | (defcustom idlwave-abbrev-start-char "\\" | |
fb7ada5f | 743 | "A single character string used to start abbreviations in abbrev mode. |
f32b3b91 CD |
744 | Possible characters to chose from: ~`\% |
745 | or even '?'. '.' is not a good choice because it can make structure | |
746 | field names act like abbrevs in certain circumstances. | |
747 | ||
748 | Changes to this in `idlwave-mode-hook' will have no effect. Instead a user | |
865fe16f | 749 | must set it directly using `setq' in the init file before idlwave.el |
f32b3b91 CD |
750 | is loaded." |
751 | :group 'idlwave-abbrev-and-indent-action | |
752 | :type 'string) | |
753 | ||
754 | (defcustom idlwave-surround-by-blank nil | |
fb7ada5f | 755 | "Non-nil means, enable `idlwave-surround'. |
595ab50b | 756 | If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by |
f32b3b91 CD |
757 | `idlwave-surround'. |
758 | See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'. | |
759 | ||
760 | Also see the default key bindings for keys using `idlwave-surround'. | |
761 | Keys are bound and made into actions calling `idlwave-surround' with | |
762 | `idlwave-action-and-binding'. | |
763 | See help for `idlwave-action-and-binding' for examples. | |
764 | ||
765 | Also see help for `idlwave-surround'." | |
766 | :group 'idlwave-abbrev-and-indent-action | |
767 | :type 'boolean) | |
768 | ||
769 | (defcustom idlwave-pad-keyword t | |
fb7ada5f | 770 | "Non-nil means pad '=' in keywords (routine calls or defs) like assignment. |
52a244eb S |
771 | Whenever `idlwave-surround' is non-nil then this affects how '=' is |
772 | padded for keywords and for variables. If t, pad the same as for | |
773 | assignments. If nil then spaces are removed. With any other value, | |
774 | spaces are left unchanged." | |
f32b3b91 | 775 | :group 'idlwave-abbrev-and-indent-action |
15e42531 CD |
776 | :type '(choice |
777 | (const :tag "Pad like assignments" t) | |
778 | (const :tag "Remove space near `='" nil) | |
779 | (const :tag "Keep space near `='" 'keep))) | |
f32b3b91 CD |
780 | |
781 | (defcustom idlwave-show-block t | |
fb7ada5f | 782 | "Non-nil means point blinks to block beginning for `idlwave-show-begin'." |
f32b3b91 CD |
783 | :group 'idlwave-abbrev-and-indent-action |
784 | :type 'boolean) | |
785 | ||
786 | (defcustom idlwave-expand-generic-end nil | |
fb7ada5f | 787 | "Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc." |
f32b3b91 CD |
788 | :group 'idlwave-abbrev-and-indent-action |
789 | :type 'boolean) | |
790 | ||
15e42531 | 791 | (defcustom idlwave-reindent-end t |
fb7ada5f | 792 | "Non-nil means re-indent line after END was typed." |
15e42531 CD |
793 | :group 'idlwave-abbrev-and-indent-action |
794 | :type 'boolean) | |
795 | ||
f32b3b91 | 796 | (defcustom idlwave-abbrev-move t |
fb7ada5f | 797 | "Non-nil means the abbrev hook can move point. |
5a0c3f56 | 798 | Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev |
f32b3b91 | 799 | definitions, use the command `list-abbrevs', for abbrevs that move |
5a0c3f56 | 800 | point. Moving point is useful, for example, to place point between |
f32b3b91 CD |
801 | parentheses of expanded functions. |
802 | ||
803 | See `idlwave-check-abbrev'." | |
804 | :group 'idlwave-abbrev-and-indent-action | |
805 | :type 'boolean) | |
806 | ||
807 | (defcustom idlwave-abbrev-change-case nil | |
fb7ada5f | 808 | "Non-nil means all abbrevs will be forced to either upper or lower case. |
f32b3b91 CD |
809 | If the value t, all expanded abbrevs will be upper case. |
810 | If the value is 'down then abbrevs will be forced to lower case. | |
811 | If nil, the case will not change. | |
812 | If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be | |
813 | upper case, regardless of this variable." | |
814 | :group 'idlwave-abbrev-and-indent-action | |
815 | :type 'boolean) | |
816 | ||
817 | (defcustom idlwave-reserved-word-upcase nil | |
fb7ada5f | 818 | "Non-nil means, reserved words will be made upper case via abbrev expansion. |
f32b3b91 CD |
819 | If nil case of reserved words is controlled by `idlwave-abbrev-change-case'. |
820 | Has effect only if in abbrev-mode." | |
821 | :group 'idlwave-abbrev-and-indent-action | |
822 | :type 'boolean) | |
823 | ||
824 | ;;; Action/Expand Tables. | |
825 | ;; | |
826 | ;; The average user may have difficulty modifying this directly. It | |
827 | ;; can be modified/set in idlwave-mode-hook, but it is easier to use | |
828 | ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for | |
829 | ;; examples of how to add an action. | |
830 | ;; | |
831 | ;; The action table is used by `idlwave-indent-line' whereas both the | |
832 | ;; action and expand tables are used by `idlwave-indent-and-action'. In | |
833 | ;; general, the expand table is only used when a line is explicitly | |
834 | ;; indented. Whereas, in addition to being used when the expand table | |
835 | ;; is used, the action table is used when a line is indirectly | |
836 | ;; indented via line splitting, auto-filling or a new line creation. | |
837 | ;; | |
838 | ;; Example actions: | |
839 | ;; | |
840 | ;; Capitalize system vars | |
841 | ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t) | |
842 | ;; | |
843 | ;; Capitalize procedure name | |
844 | ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<" | |
845 | ;; '(capitalize-word 1) t) | |
846 | ;; | |
847 | ;; Capitalize common block name | |
848 | ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<" | |
849 | ;; '(capitalize-word 1) t) | |
850 | ;; Capitalize label | |
851 | ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label) | |
852 | ;; '(capitalize-word -1) t) | |
853 | ||
854 | (defvar idlwave-indent-action-table nil | |
fb7ada5f | 855 | "Associated array containing action lists of search string (car), |
5a0c3f56 | 856 | and function as a cdr. This table is used by `idlwave-indent-line'. |
f32b3b91 CD |
857 | See documentation for `idlwave-do-action' for a complete description of |
858 | the action lists. | |
859 | ||
860 | Additions to the table are made with `idlwave-action-and-binding' when a | |
861 | binding is not requested. | |
862 | See help on `idlwave-action-and-binding' for examples.") | |
863 | ||
864 | (defvar idlwave-indent-expand-table nil | |
fb7ada5f | 865 | "Associated array containing action lists of search string (car), |
5a0c3f56 JB |
866 | and function as a cdr. The table is used by the |
867 | `idlwave-indent-and-action' function. See documentation for | |
f32b3b91 CD |
868 | `idlwave-do-action' for a complete description of the action lists. |
869 | ||
870 | Additions to the table are made with `idlwave-action-and-binding' when a | |
871 | binding is requested. | |
872 | See help on `idlwave-action-and-binding' for examples.") | |
873 | ||
874 | ;;; Documentation header and history keyword --------------------------------- | |
875 | ||
876 | (defgroup idlwave-documentation nil | |
877 | "Options for documenting IDLWAVE files." | |
878 | :group 'idlwave) | |
879 | ||
880 | ;; FIXME: make defcustom? | |
881 | (defvar idlwave-file-header | |
882 | (list nil | |
883 | ";+ | |
884 | ; NAME: | |
885 | ; | |
886 | ; | |
887 | ; | |
888 | ; PURPOSE: | |
889 | ; | |
890 | ; | |
891 | ; | |
892 | ; CATEGORY: | |
893 | ; | |
894 | ; | |
895 | ; | |
896 | ; CALLING SEQUENCE: | |
897 | ; | |
898 | ; | |
899 | ; | |
900 | ; INPUTS: | |
901 | ; | |
902 | ; | |
903 | ; | |
904 | ; OPTIONAL INPUTS: | |
905 | ; | |
906 | ; | |
907 | ; | |
908 | ; KEYWORD PARAMETERS: | |
909 | ; | |
910 | ; | |
911 | ; | |
912 | ; OUTPUTS: | |
913 | ; | |
914 | ; | |
915 | ; | |
916 | ; OPTIONAL OUTPUTS: | |
917 | ; | |
918 | ; | |
919 | ; | |
920 | ; COMMON BLOCKS: | |
921 | ; | |
922 | ; | |
923 | ; | |
924 | ; SIDE EFFECTS: | |
925 | ; | |
926 | ; | |
927 | ; | |
928 | ; RESTRICTIONS: | |
929 | ; | |
930 | ; | |
931 | ; | |
932 | ; PROCEDURE: | |
933 | ; | |
934 | ; | |
935 | ; | |
936 | ; EXAMPLE: | |
937 | ; | |
938 | ; | |
939 | ; | |
940 | ; MODIFICATION HISTORY: | |
941 | ; | |
942 | ;- | |
943 | ") | |
fb7ada5f | 944 | "A list (PATHNAME STRING) specifying the doc-header template to use for |
5a0c3f56 JB |
945 | summarizing a file. If PATHNAME is non-nil then this file will be included. |
946 | Otherwise STRING is used. If nil, the file summary will be omitted. | |
f32b3b91 CD |
947 | For example you might set PATHNAME to the path for the |
948 | lib_template.pro file included in the IDL distribution.") | |
949 | ||
f66f03de | 950 | (defcustom idlwave-header-to-beginning-of-file t |
fb7ada5f | 951 | "Non-nil means, the documentation header will always be at start of file. |
5e72c6b2 S |
952 | When nil, the header is positioned between the PRO/FUNCTION line of |
953 | the current routine and the code, allowing several routine headers in | |
954 | a file." | |
955 | :group 'idlwave-documentation | |
956 | :type 'boolean) | |
957 | ||
f32b3b91 | 958 | (defcustom idlwave-timestamp-hook 'idlwave-default-insert-timestamp |
fb7ada5f | 959 | "The hook function used to update the timestamp of a function." |
f32b3b91 CD |
960 | :group 'idlwave-documentation |
961 | :type 'function) | |
962 | ||
963 | (defcustom idlwave-doc-modifications-keyword "HISTORY" | |
fb7ada5f | 964 | "The modifications keyword to use with the log documentation commands. |
f32b3b91 CD |
965 | A ':' is added to the keyword end. |
966 | Inserted by doc-header and used to position logs by doc-modification. | |
967 | If nil it will not be inserted." | |
968 | :group 'idlwave-documentation | |
969 | :type 'string) | |
970 | ||
971 | (defcustom idlwave-doclib-start "^;+\\+" | |
fb7ada5f | 972 | "Regexp matching the start of a document library header." |
f32b3b91 CD |
973 | :group 'idlwave-documentation |
974 | :type 'regexp) | |
975 | ||
976 | (defcustom idlwave-doclib-end "^;+-" | |
fb7ada5f | 977 | "Regexp matching the end of a document library header." |
f32b3b91 CD |
978 | :group 'idlwave-documentation |
979 | :type 'regexp) | |
980 | ||
981 | ;;; External Programs ------------------------------------------------------- | |
982 | ||
983 | (defgroup idlwave-external-programs nil | |
05a1abfc | 984 | "Path locations of external commands used by IDLWAVE." |
f32b3b91 CD |
985 | :group 'idlwave) |
986 | ||
f32b3b91 | 987 | (defcustom idlwave-shell-explicit-file-name "idl" |
fb7ada5f | 988 | "If non-nil, this is the command to run IDL. |
f32b3b91 | 989 | Should be an absolute file path or path relative to the current environment |
5e72c6b2 | 990 | execution search path. If you want to specify command line switches |
5a0c3f56 | 991 | for the IDL program, use `idlwave-shell-command-line-options'. |
5e72c6b2 S |
992 | |
993 | I know the name of this variable is badly chosen, but I cannot change | |
5a0c3f56 | 994 | it without compromising backwards-compatibility." |
f32b3b91 CD |
995 | :group 'idlwave-external-programs |
996 | :type 'string) | |
997 | ||
f32b3b91 | 998 | (defcustom idlwave-shell-command-line-options nil |
fb7ada5f | 999 | "A list of command line options for calling the IDL program. |
5e72c6b2 S |
1000 | Since IDL is executed directly without going through a shell like /bin/sh, |
1001 | this should be a list of strings like '(\"-rt=file\" \"-nw\") with a separate | |
1002 | string for each argument. But you may also give a single string which | |
1003 | contains the options whitespace-separated. Emacs will be kind enough to | |
1004 | split it for you." | |
1005 | :type '(choice | |
1006 | string | |
1007 | (repeat (string :value ""))) | |
f32b3b91 CD |
1008 | :group 'idlwave-external-programs) |
1009 | ||
1010 | (defcustom idlwave-help-application "idlhelp" | |
fb7ada5f | 1011 | "The external application providing reference help for programming. |
f66f03de | 1012 | Obsolete, if the IDL Assistant is being used for help." |
f32b3b91 CD |
1013 | :group 'idlwave-external-programs |
1014 | :type 'string) | |
1015 | ||
05a1abfc CD |
1016 | ;;; Some Shell variables which must be defined here.----------------------- |
1017 | ||
1018 | (defcustom idlwave-shell-debug-modifiers '() | |
1019 | "List of modifiers to be used for the debugging commands. | |
1020 | Will be used to bind debugging commands in the shell buffer and in all | |
1021 | source buffers. These are additional convenience bindings, the debugging | |
1022 | commands are always available with the `C-c C-d' prefix. | |
1023 | If you set this to '(control shift), this means setting a breakpoint will | |
1024 | be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers | |
1025 | are `control', `meta', `super', `hyper', `alt', and `shift'." | |
1026 | :group 'idlwave-shell-general-setup | |
1027 | :type '(set :tag "Specify modifiers" | |
1028 | (const control) | |
1029 | (const meta) | |
1030 | (const super) | |
1031 | (const hyper) | |
1032 | (const alt) | |
1033 | (const shift))) | |
1034 | ||
1035 | (defcustom idlwave-shell-automatic-start nil | |
fb7ada5f | 1036 | "If non-nil attempt invoke `idlwave-shell' if not already running. |
05a1abfc CD |
1037 | This is checked when an attempt to send a command to an |
1038 | IDL process is made." | |
1039 | :group 'idlwave-shell-general-setup | |
1040 | :type 'boolean) | |
1041 | ||
f32b3b91 CD |
1042 | ;;; Miscellaneous variables ------------------------------------------------- |
1043 | ||
1044 | (defgroup idlwave-misc nil | |
1045 | "Miscellaneous options for IDLWAVE mode." | |
8ec3bce0 | 1046 | :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces) |
f32b3b91 CD |
1047 | :group 'idlwave) |
1048 | ||
1049 | (defcustom idlwave-startup-message t | |
fb7ada5f | 1050 | "Non-nil displays a startup message when `idlwave-mode' is first called." |
f32b3b91 CD |
1051 | :group 'idlwave-misc |
1052 | :type 'boolean) | |
1053 | ||
4b1aaa8b | 1054 | (defcustom idlwave-default-font-lock-items |
facebc7b | 1055 | '(pros-and-functions batch-files idlwave-idl-keywords label goto |
f32b3b91 CD |
1056 | common-blocks class-arrows) |
1057 | "Items which should be fontified on the default fontification level 2. | |
1058 | IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3 | |
1059 | is everything and level 2 is specified by this list. | |
5a0c3f56 JB |
1060 | This variable must be set before IDLWAVE gets loaded. |
1061 | It is a list of symbols; the following symbols are allowed: | |
f32b3b91 CD |
1062 | |
1063 | pros-and-functions Procedure and Function definitions | |
1064 | batch-files Batch Files | |
facebc7b | 1065 | idlwave-idl-keywords IDL Keywords |
f32b3b91 CD |
1066 | label Statement Labels |
1067 | goto Goto Statements | |
1068 | common-blocks Common Blocks | |
1069 | keyword-parameters Keyword Parameters in routine definitions and calls | |
1070 | system-variables System Variables | |
1071 | fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up) | |
1072 | class-arrows Object Arrows with class property" | |
1073 | :group 'idlwave-misc | |
1074 | :type '(set | |
1075 | :inline t :greedy t | |
1076 | (const :tag "Procedure and Function definitions" pros-and-functions) | |
facebc7b S |
1077 | (const :tag "Batch Files" batch-files) |
1078 | (const :tag "IDL Keywords (reserved words)" idlwave-idl-keywords) | |
1079 | (const :tag "Statement Labels" label) | |
1080 | (const :tag "Goto Statements" goto) | |
1081 | (const :tag "Tags in Structure Definition" structtag) | |
1082 | (const :tag "Structure Name" structname) | |
1083 | (const :tag "Common Blocks" common-blocks) | |
1084 | (const :tag "Keyword Parameters" keyword-parameters) | |
1085 | (const :tag "System Variables" system-variables) | |
1086 | (const :tag "FIXME: Warning" fixme) | |
f32b3b91 CD |
1087 | (const :tag "Object Arrows with class property " class-arrows))) |
1088 | ||
1089 | (defcustom idlwave-mode-hook nil | |
1090 | "Normal hook. Executed when a buffer is put into `idlwave-mode'." | |
1091 | :group 'idlwave-misc | |
1092 | :type 'hook) | |
1093 | ||
1094 | (defcustom idlwave-load-hook nil | |
1095 | "Normal hook. Executed when idlwave.el is loaded." | |
1096 | :group 'idlwave-misc | |
1097 | :type 'hook) | |
1098 | ||
15e42531 CD |
1099 | (defvar idlwave-experimental nil |
1100 | "Non-nil means turn on a few experimental features. | |
1101 | This variable is only for the maintainer, to test difficult stuff, | |
1102 | while still distributing stable releases. | |
1103 | As a user, you should not set this to t.") | |
1104 | ||
f32b3b91 CD |
1105 | ;;; |
1106 | ;;; End customization variables section | |
1107 | ;;; | |
1108 | ||
1109 | ;;; Non customization variables | |
1110 | ||
1111 | ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and | |
52a244eb | 1112 | ;;; Simon Marshall <simon_at_gnu.ai.mit.edu> |
f32b3b91 CD |
1113 | ;;; and Carsten Dominik... |
1114 | ||
76959b77 | 1115 | ;; The following are the reserved words in IDL. Maybe we should |
4b1aaa8b | 1116 | ;; highlight some more stuff as well? |
76959b77 S |
1117 | ;; Procedure declarations. Fontify keyword plus procedure name. |
1118 | (defvar idlwave-idl-keywords | |
4b1aaa8b | 1119 | ;; To update this regexp, update the list of keywords and |
76959b77 | 1120 | ;; evaluate the form. |
4b1aaa8b | 1121 | ;; (insert |
76959b77 | 1122 | ;; (prin1-to-string |
4b1aaa8b | 1123 | ;; (concat |
76959b77 | 1124 | ;; "\\<\\(" |
4b1aaa8b | 1125 | ;; (regexp-opt |
52a244eb | 1126 | ;; '("||" "&&" "and" "or" "xor" "not" |
4b1aaa8b | 1127 | ;; "eq" "ge" "gt" "le" "lt" "ne" |
76959b77 | 1128 | ;; "for" "do" "endfor" |
4b1aaa8b | 1129 | ;; "if" "then" "endif" "else" "endelse" |
76959b77 S |
1130 | ;; "case" "of" "endcase" |
1131 | ;; "switch" "break" "continue" "endswitch" | |
1132 | ;; "begin" "end" | |
1133 | ;; "repeat" "until" "endrep" | |
4b1aaa8b | 1134 | ;; "while" "endwhile" |
76959b77 S |
1135 | ;; "goto" "return" |
1136 | ;; "inherits" "mod" | |
1137 | ;; "compile_opt" "forward_function" | |
1138 | ;; "on_error" "on_ioerror")) ; on_error is not officially reserved | |
1139 | ;; "\\)\\>"))) | |
52a244eb S |
1140 | "\\<\\(&&\\|and\\|b\\(egin\\|reak\\)\\|c\\(ase\\|o\\(mpile_opt\\|ntinue\\)\\)\\|do\\|e\\(lse\\|nd\\(case\\|else\\|for\\|if\\|rep\\|switch\\|while\\)?\\|q\\)\\|for\\(ward_function\\)?\\|g\\(oto\\|[et]\\)\\|i\\(f\\|nherits\\)\\|l[et]\\|mod\\|n\\(e\\|ot\\)\\|o\\(n_\\(error\\|ioerror\\)\\|[fr]\\)\\|re\\(peat\\|turn\\)\\|switch\\|then\\|until\\|while\\|xor\\|||\\)\\>") |
1141 | ||
76959b77 | 1142 | |
facebc7b | 1143 | (let* (;; Procedure declarations. Fontify keyword plus procedure name. |
f32b3b91 CD |
1144 | ;; Function declarations. Fontify keyword plus function name. |
1145 | (pros-and-functions | |
1146 | '("\\<\\(function\\|pro\\)\\>[ \t]+\\(\\sw+\\(::\\sw+\\)?\\)" | |
1147 | (1 font-lock-keyword-face) | |
1148 | (2 font-lock-function-name-face nil t))) | |
1149 | ||
1150 | ;; Common blocks | |
1151 | (common-blocks | |
1152 | '("\\<\\(common\\)\\>[ \t]*\\(\\sw+\\)?[ \t]*,?" | |
1153 | (1 font-lock-keyword-face) ; "common" | |
6c27f0f8 | 1154 | (2 font-lock-constant-face nil t) ; block name |
f66f03de | 1155 | ("[ \t]*\\(\\sw+\\)[ ,]*" |
f32b3b91 | 1156 | ;; Start with point after block name and comma |
4b1aaa8b | 1157 | (goto-char (match-end 0)) ; needed for XEmacs, could be nil |
f32b3b91 CD |
1158 | nil |
1159 | (1 font-lock-variable-name-face) ; variable names | |
1160 | ))) | |
1161 | ||
1162 | ;; Batch files | |
1163 | (batch-files | |
1164 | '("^[ \t]*\\(@[^ \t\n]+\\)" (1 font-lock-string-face))) | |
1165 | ||
1166 | ;; FIXME warning. | |
1167 | (fixme | |
1168 | '("\\<FIXME:" (0 font-lock-warning-face t))) | |
1169 | ||
1170 | ;; Labels | |
1171 | (label | |
6c27f0f8 | 1172 | '("^[ \t]*\\([a-zA-Z]\\sw*:\\)" (1 font-lock-constant-face))) |
f32b3b91 CD |
1173 | |
1174 | ;; The goto statement and its label | |
1175 | (goto | |
1176 | '("\\(goto\\)[ \t]*,[ \t]*\\([a-zA-Z]\\sw*\\)" | |
1177 | (1 font-lock-keyword-face) | |
6c27f0f8 | 1178 | (2 font-lock-constant-face))) |
f32b3b91 | 1179 | |
52a244eb S |
1180 | ;; Tags in structure definitions. Note that this definition |
1181 | ;; actually collides with labels, so we have to use the same | |
1182 | ;; face. It also matches named subscript ranges, | |
1183 | ;; e.g. vec{bottom:top]. No good way around this. | |
05a1abfc | 1184 | (structtag |
6c27f0f8 | 1185 | '("\\<\\([a-zA-Z][a-zA-Z0-9_]*:\\)[^:]" (1 font-lock-constant-face))) |
05a1abfc CD |
1186 | |
1187 | ;; Structure names | |
1188 | (structname | |
1189 | '("\\({\\|\\<inherits\\s-\\)\\s-*\\([a-zA-Z][a-zA-Z0-9_]*\\)[},\t \n]" | |
1190 | (2 font-lock-function-name-face))) | |
1191 | ||
52a244eb | 1192 | ;; Keyword parameters, like /xlog or ,xrange=[] |
97610156 | 1193 | ;; This is anchored to the comma preceding the keyword. |
595ab50b CD |
1194 | ;; Treats continuation lines, works only during whole buffer |
1195 | ;; fontification. Slow, use it only in fancy fontification. | |
f32b3b91 | 1196 | (keyword-parameters |
0dc2be2f | 1197 | '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\([ \t]*\\(;.*\\)?\n\\)*[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)" |
6c27f0f8 | 1198 | (6 font-lock-constant-face))) |
f32b3b91 | 1199 | |
595ab50b | 1200 | ;; System variables start with a bang. |
f32b3b91 | 1201 | (system-variables |
15e42531 | 1202 | '("\\(![a-zA-Z_0-9]+\\(\\.\\sw+\\)?\\)" |
f32b3b91 CD |
1203 | (1 font-lock-variable-name-face))) |
1204 | ||
1205 | ;; Special and unusual operators (not used because too noisy) | |
8d222148 SM |
1206 | ;; (special-operators |
1207 | ;; '("[<>#]" (0 font-lock-keyword-face))) | |
f32b3b91 CD |
1208 | |
1209 | ;; All operators (not used because too noisy) | |
8d222148 SM |
1210 | ;; (all-operators |
1211 | ;; '("[-*^#+<>/]" (0 font-lock-keyword-face))) | |
4b1aaa8b | 1212 | |
f32b3b91 CD |
1213 | ;; Arrows with text property `idlwave-class' |
1214 | (class-arrows | |
facebc7b S |
1215 | '(idlwave-match-class-arrows (0 idlwave-class-arrow-face)))) |
1216 | ||
1217 | (defconst idlwave-font-lock-keywords-1 | |
1218 | (list pros-and-functions batch-files) | |
1219 | "Subdued level highlighting for IDLWAVE mode.") | |
f32b3b91 | 1220 | |
facebc7b S |
1221 | (defconst idlwave-font-lock-keywords-2 |
1222 | (mapcar 'symbol-value idlwave-default-font-lock-items) | |
1223 | "Medium level highlighting for IDLWAVE mode.") | |
f32b3b91 | 1224 | |
facebc7b | 1225 | (defconst idlwave-font-lock-keywords-3 |
f32b3b91 CD |
1226 | (list pros-and-functions |
1227 | batch-files | |
76959b77 | 1228 | idlwave-idl-keywords |
f32b3b91 | 1229 | label goto |
05a1abfc CD |
1230 | structtag |
1231 | structname | |
f32b3b91 CD |
1232 | common-blocks |
1233 | keyword-parameters | |
1234 | system-variables | |
facebc7b S |
1235 | class-arrows) |
1236 | "Gaudy level highlighting for IDLWAVE mode.")) | |
f32b3b91 CD |
1237 | |
1238 | (defun idlwave-match-class-arrows (limit) | |
1239 | ;; Match an object arrow with class property | |
1240 | (and idlwave-store-inquired-class | |
1241 | (re-search-forward "->" limit 'limit) | |
1242 | (get-text-property (match-beginning 0) 'idlwave-class))) | |
1243 | ||
1244 | (defvar idlwave-font-lock-keywords idlwave-font-lock-keywords-2 | |
1245 | "Default expressions to highlight in IDLWAVE mode.") | |
1246 | ||
1247 | (defvar idlwave-font-lock-defaults | |
1248 | '((idlwave-font-lock-keywords | |
4b1aaa8b | 1249 | idlwave-font-lock-keywords-1 |
f32b3b91 CD |
1250 | idlwave-font-lock-keywords-2 |
1251 | idlwave-font-lock-keywords-3) | |
4b1aaa8b PE |
1252 | nil t |
1253 | ((?$ . "w") (?_ . "w") (?. . "w") (?| . "w") (?& . "w")) | |
f32b3b91 CD |
1254 | beginning-of-line)) |
1255 | ||
4b1aaa8b | 1256 | (put 'idlwave-mode 'font-lock-defaults |
f32b3b91 CD |
1257 | idlwave-font-lock-defaults) ; XEmacs |
1258 | ||
1259 | (defconst idlwave-comment-line-start-skip "^[ \t]*;" | |
1260 | "Regexp to match the start of a full-line comment. | |
1261 | That is the _beginning_ of a line containing a comment delimiter `;' preceded | |
1262 | only by whitespace.") | |
1263 | ||
4b1aaa8b | 1264 | (defconst idlwave-begin-block-reg |
05a1abfc | 1265 | "\\<\\(pro\\|function\\|begin\\|case\\|switch\\)\\>" |
5a0c3f56 JB |
1266 | "Regular expression to find the beginning of a block. |
1267 | The case does not matter. The search skips matches in comments.") | |
f32b3b91 | 1268 | |
52a244eb | 1269 | (defconst idlwave-begin-unit-reg "^\\s-*\\(pro\\|function\\)\\>\\|\\`" |
5a0c3f56 JB |
1270 | "Regular expression to find the beginning of a unit. |
1271 | The case does not matter.") | |
f32b3b91 | 1272 | |
52a244eb | 1273 | (defconst idlwave-end-unit-reg "^\\s-*\\(pro\\|function\\)\\>\\|\\'" |
f32b3b91 | 1274 | "Regular expression to find the line that indicates the end of unit. |
5a0c3f56 JB |
1275 | This line is the end of buffer or the start of another unit. |
1276 | The case does not matter. The search skips matches in comments.") | |
f32b3b91 CD |
1277 | |
1278 | (defconst idlwave-continue-line-reg "\\<\\$" | |
1279 | "Regular expression to match a continued line.") | |
1280 | ||
1281 | (defconst idlwave-end-block-reg | |
05a1abfc | 1282 | "\\<end\\(\\|case\\|switch\\|else\\|for\\|if\\|rep\\|while\\)\\>" |
5a0c3f56 JB |
1283 | "Regular expression to find the end of a block. |
1284 | The case does not matter. The search skips matches in comments.") | |
f32b3b91 CD |
1285 | |
1286 | (defconst idlwave-block-matches | |
1287 | '(("pro" . "end") | |
1288 | ("function" . "end") | |
1289 | ("case" . "endcase") | |
1290 | ("else" . "endelse") | |
1291 | ("for" . "endfor") | |
1292 | ("then" . "endif") | |
1293 | ("repeat" . "endrep") | |
05a1abfc | 1294 | ("switch" . "endswitch") |
f32b3b91 CD |
1295 | ("while" . "endwhile")) |
1296 | "Matches between statements and the corresponding END variant. | |
1297 | The cars are the reserved words starting a block. If the block really | |
1298 | begins with BEGIN, the cars are the reserved words before the begin | |
1299 | which can be used to identify the block type. | |
1300 | This is used to check for the correct END type, to close blocks and | |
1301 | to expand generic end statements to their detailed form.") | |
1302 | ||
1303 | (defconst idlwave-block-match-regexp | |
1304 | "\\<\\(else\\|for\\|then\\|repeat\\|while\\)\\>" | |
1305 | "Regular expression matching reserved words which can stand before | |
1306 | blocks starting with a BEGIN statement. The matches must have associations | |
5a0c3f56 | 1307 | `idlwave-block-matches'.") |
f32b3b91 | 1308 | |
52a244eb | 1309 | (defconst idlwave-identifier "[a-zA-Z_][a-zA-Z0-9$_]*" |
f32b3b91 CD |
1310 | "Regular expression matching an IDL identifier.") |
1311 | ||
1312 | (defconst idlwave-sysvar (concat "!" idlwave-identifier) | |
1313 | "Regular expression matching IDL system variables.") | |
1314 | ||
1315 | (defconst idlwave-variable (concat idlwave-identifier "\\|" idlwave-sysvar) | |
1316 | "Regular expression matching IDL variable names.") | |
1317 | ||
1318 | (defconst idlwave-label (concat idlwave-identifier ":") | |
1319 | "Regular expression matching IDL labels.") | |
1320 | ||
52a244eb S |
1321 | (defconst idlwave-method-call (concat idlwave-identifier "\\s *->" |
1322 | "\\(\\s *" idlwave-identifier "::\\)?" | |
1323 | )) | |
1324 | ||
f32b3b91 CD |
1325 | (defconst idlwave-statement-match |
1326 | (list | |
aa87aafc | 1327 | ;; "endif else" is the only possible "end" that can be |
f32b3b91 CD |
1328 | ;; followed by a statement on the same line. |
1329 | '(endelse . ("end\\(\\|if\\)\\s +else" "end\\(\\|if\\)\\s +else")) | |
1330 | ;; all other "end"s can not be followed by a statement. | |
1331 | (cons 'end (list idlwave-end-block-reg nil)) | |
1332 | '(if . ("if\\>" "then")) | |
1333 | '(for . ("for\\>" "do")) | |
1334 | '(begin . ("begin\\>" nil)) | |
1335 | '(pdef . ("pro\\>\\|function\\>" nil)) | |
1336 | '(while . ("while\\>" "do")) | |
1337 | '(repeat . ("repeat\\>" "repeat")) | |
1338 | '(goto . ("goto\\>" nil)) | |
1339 | '(case . ("case\\>" nil)) | |
05a1abfc | 1340 | '(switch . ("switch\\>" nil)) |
4b1aaa8b | 1341 | (cons 'call (list (concat "\\(" idlwave-variable "\\) *= *" |
52a244eb S |
1342 | "\\(" idlwave-method-call "\\s *\\)?" |
1343 | idlwave-identifier | |
1344 | "\\s *(") nil)) | |
4b1aaa8b | 1345 | (cons 'call (list (concat |
52a244eb | 1346 | "\\(" idlwave-method-call "\\s *\\)?" |
4b1aaa8b | 1347 | idlwave-identifier |
52a244eb | 1348 | "\\( *\\($\\|\\$\\)\\|\\s *,\\)") nil)) |
4b1aaa8b | 1349 | (cons 'assign (list (concat |
52a244eb | 1350 | "\\(" idlwave-variable "\\) *=") nil))) |
4b1aaa8b | 1351 | |
f32b3b91 | 1352 | "Associated list of statement matching regular expressions. |
5a0c3f56 JB |
1353 | Each regular expression matches the start of an IDL statement. |
1354 | The first element of each association is a symbol giving the statement | |
f32b3b91 CD |
1355 | type. The associated value is a list. The first element of this list |
1356 | is a regular expression matching the start of an IDL statement for | |
1357 | identifying the statement type. The second element of this list is a | |
1358 | regular expression for finding a substatement for the type. The | |
1359 | substatement starts after the end of the found match modulo | |
1360 | whitespace. If it is nil then the statement has no substatement. The | |
1361 | list order matters since matching an assignment statement exactly is | |
1362 | not possible without parsing. Thus assignment statement become just | |
5a0c3f56 | 1363 | the leftover unidentified statements containing an equal sign.") |
f32b3b91 | 1364 | |
f44379e7 | 1365 | ;; FIXME: This var seems to only ever be set, but never actually used! |
f32b3b91 CD |
1366 | (defvar idlwave-fill-function 'auto-fill-function |
1367 | "IDL mode auto fill function.") | |
1368 | ||
1369 | (defvar idlwave-comment-indent-function 'comment-indent-function | |
1370 | "IDL mode comment indent function.") | |
1371 | ||
1372 | ;; Note that this is documented in the v18 manuals as being a string | |
1373 | ;; of length one rather than a single character. | |
1374 | ;; The code in this file accepts either format for compatibility. | |
4b1aaa8b | 1375 | (defvar idlwave-comment-indent-char ?\ |
f32b3b91 CD |
1376 | "Character to be inserted for IDL comment indentation. |
1377 | Normally a space.") | |
1378 | ||
1379 | (defconst idlwave-continuation-char ?$ | |
1380 | "Character which is inserted as a last character on previous line by | |
1381 | \\[idlwave-split-line] to begin a continuation line. Normally $.") | |
1382 | ||
e08734e2 | 1383 | (defconst idlwave-mode-version "6.1_em22") |
f32b3b91 CD |
1384 | |
1385 | (defmacro idlwave-keyword-abbrev (&rest args) | |
1386 | "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args." | |
8a946354 | 1387 | `(quote (lambda () |
5e72c6b2 | 1388 | ,(append '(idlwave-check-abbrev) args)))) |
f32b3b91 CD |
1389 | |
1390 | ;; If I take the time I can replace idlwave-keyword-abbrev with | |
1391 | ;; idlwave-code-abbrev and remove the quoted abbrev check from | |
1392 | ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes | |
1393 | ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change | |
1394 | ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev. | |
1395 | ||
1396 | (defmacro idlwave-code-abbrev (&rest args) | |
1397 | "Creates a function for abbrev hooks that ensures abbrevs are not quoted. | |
1398 | Specifically, if the abbrev is in a comment or string it is unexpanded. | |
1399 | Otherwise ARGS forms a list that is evaluated." | |
8d222148 SM |
1400 | ;; FIXME: it would probably be better to rely on the new :enable-function |
1401 | ;; to enforce the "don't expand in comments or strings". | |
1402 | `(lambda () | |
1403 | ,(prin1-to-string args) ;; Puts the code in the doc string | |
1404 | (if (idlwave-quoted) | |
1405 | (progn (unexpand-abbrev) nil) | |
1406 | ,(append args)))) | |
1407 | ||
1408 | (autoload 'idlwave-shell "idlw-shell" | |
1409 | "Run an inferior IDL, with I/O through buffer `(idlwave-shell-buffer)'." t) | |
1410 | (autoload 'idlwave-shell-send-command "idlw-shell") | |
1411 | (autoload 'idlwave-shell-recenter-shell-window "idlw-shell" | |
1412 | "Run `idlwave-shell' and switch back to current window" t) | |
1413 | (autoload 'idlwave-shell-save-and-run "idlw-shell" | |
1414 | "Save and run buffer under the shell." t) | |
1415 | (autoload 'idlwave-shell-break-here "idlw-shell" | |
1416 | "Set breakpoint in current line." t) | |
1417 | (autoload 'idlwave-shell-run-region "idlw-shell" | |
1418 | "Compile and run the region." t) | |
f32b3b91 | 1419 | |
8d222148 SM |
1420 | (fset 'idlwave-debug-map (make-sparse-keymap)) |
1421 | ||
1422 | (defvar idlwave-mode-map | |
1423 | (let ((map (make-sparse-keymap))) | |
1424 | (define-key map "\C-c " 'idlwave-hard-tab) | |
1425 | (define-key map [(control tab)] 'idlwave-hard-tab) | |
1426 | ;;(define-key map "\C-c\C- " 'idlwave-hard-tab) | |
1427 | (define-key map "'" 'idlwave-show-matching-quote) | |
1428 | (define-key map "\"" 'idlwave-show-matching-quote) | |
1429 | (define-key map "\C-g" 'idlwave-keyboard-quit) | |
1430 | (define-key map "\C-c;" 'idlwave-toggle-comment-region) | |
1431 | (define-key map "\C-\M-a" 'idlwave-beginning-of-subprogram) | |
1432 | (define-key map "\C-\M-e" 'idlwave-end-of-subprogram) | |
1433 | (define-key map "\C-c{" 'idlwave-beginning-of-block) | |
1434 | (define-key map "\C-c}" 'idlwave-end-of-block) | |
1435 | (define-key map "\C-c]" 'idlwave-close-block) | |
1436 | (define-key map [(meta control h)] 'idlwave-mark-subprogram) | |
1437 | (define-key map "\M-\C-n" 'idlwave-forward-block) | |
1438 | (define-key map "\M-\C-p" 'idlwave-backward-block) | |
1439 | (define-key map "\M-\C-d" 'idlwave-down-block) | |
1440 | (define-key map "\M-\C-u" 'idlwave-backward-up-block) | |
1441 | (define-key map "\M-\r" 'idlwave-split-line) | |
1442 | (define-key map "\M-\C-q" 'idlwave-indent-subprogram) | |
1443 | (define-key map "\C-c\C-p" 'idlwave-previous-statement) | |
1444 | (define-key map "\C-c\C-n" 'idlwave-next-statement) | |
1445 | ;; (define-key map "\r" 'idlwave-newline) | |
1446 | ;; (define-key map "\t" 'idlwave-indent-line) | |
1447 | (define-key map [(shift iso-lefttab)] 'idlwave-indent-statement) | |
1448 | (define-key map "\C-c\C-a" 'idlwave-auto-fill-mode) | |
1449 | (define-key map "\M-q" 'idlwave-fill-paragraph) | |
1450 | (define-key map "\M-s" 'idlwave-edit-in-idlde) | |
1451 | (define-key map "\C-c\C-h" 'idlwave-doc-header) | |
1452 | (define-key map "\C-c\C-m" 'idlwave-doc-modification) | |
1453 | (define-key map "\C-c\C-c" 'idlwave-case) | |
1454 | (define-key map "\C-c\C-d" 'idlwave-debug-map) | |
1455 | (when (and (listp idlwave-shell-debug-modifiers) | |
1456 | (not (equal idlwave-shell-debug-modifiers '()))) | |
1457 | ;; Bind the debug commands also with the special modifiers. | |
1458 | (let ((shift (memq 'shift idlwave-shell-debug-modifiers)) | |
1459 | (mods-noshift | |
1460 | (delq 'shift (copy-sequence idlwave-shell-debug-modifiers)))) | |
1461 | (define-key map | |
1462 | (vector (append mods-noshift (list (if shift ?C ?c)))) | |
1463 | 'idlwave-shell-save-and-run) | |
1464 | (define-key map | |
1465 | (vector (append mods-noshift (list (if shift ?B ?b)))) | |
1466 | 'idlwave-shell-break-here) | |
1467 | (define-key map | |
1468 | (vector (append mods-noshift (list (if shift ?E ?e)))) | |
1469 | 'idlwave-shell-run-region))) | |
1470 | (define-key map "\C-c\C-d\C-c" 'idlwave-shell-save-and-run) | |
1471 | (define-key map "\C-c\C-d\C-b" 'idlwave-shell-break-here) | |
1472 | (define-key map "\C-c\C-d\C-e" 'idlwave-shell-run-region) | |
1473 | (define-key map "\C-c\C-f" 'idlwave-for) | |
1474 | ;; (define-key map "\C-c\C-f" 'idlwave-function) | |
1475 | ;; (define-key map "\C-c\C-p" 'idlwave-procedure) | |
1476 | (define-key map "\C-c\C-r" 'idlwave-repeat) | |
1477 | (define-key map "\C-c\C-w" 'idlwave-while) | |
1478 | (define-key map "\C-c\C-k" 'idlwave-kill-autoloaded-buffers) | |
1479 | (define-key map "\C-c\C-s" 'idlwave-shell) | |
1480 | (define-key map "\C-c\C-l" 'idlwave-shell-recenter-shell-window) | |
1481 | (define-key map "\C-c\C-b" 'idlwave-list-buffer-load-path-shadows) | |
1482 | (define-key map "\C-c\C-v" 'idlwave-find-module) | |
1483 | (define-key map "\C-c\C-t" 'idlwave-find-module-this-file) | |
1484 | (define-key map "\C-c?" 'idlwave-routine-info) | |
1485 | (define-key map "\M-?" 'idlwave-context-help) | |
1486 | (define-key map [(control meta ?\?)] | |
1487 | 'idlwave-help-assistant-help-with-topic) | |
1488 | ;; Pickup both forms of Esc/Meta binding | |
1489 | (define-key map [(meta tab)] 'idlwave-complete) | |
1490 | (define-key map [?\e?\t] 'idlwave-complete) | |
1491 | (define-key map "\M-\C-i" 'idlwave-complete) | |
1492 | (define-key map "\C-c\C-i" 'idlwave-update-routine-info) | |
1493 | (define-key map "\C-c=" 'idlwave-resolve) | |
1494 | (define-key map | |
1495 | (if (featurep 'xemacs) [(shift button3)] [(shift mouse-3)]) | |
1496 | 'idlwave-mouse-context-help) | |
1497 | map) | |
f32b3b91 CD |
1498 | "Keymap used in IDL mode.") |
1499 | ||
8d222148 SM |
1500 | (defvar idlwave-mode-syntax-table |
1501 | (let ((st (make-syntax-table))) | |
1502 | (modify-syntax-entry ?+ "." st) | |
1503 | (modify-syntax-entry ?- "." st) | |
1504 | (modify-syntax-entry ?* "." st) | |
1505 | (modify-syntax-entry ?/ "." st) | |
1506 | (modify-syntax-entry ?^ "." st) | |
1507 | (modify-syntax-entry ?# "." st) | |
1508 | (modify-syntax-entry ?= "." st) | |
1509 | (modify-syntax-entry ?% "." st) | |
1510 | (modify-syntax-entry ?< "." st) | |
1511 | (modify-syntax-entry ?> "." st) | |
1512 | (modify-syntax-entry ?\' "\"" st) | |
1513 | (modify-syntax-entry ?\" "\"" st) | |
1514 | (modify-syntax-entry ?\\ "." st) | |
1515 | (modify-syntax-entry ?_ "_" st) | |
1516 | (modify-syntax-entry ?{ "(}" st) | |
1517 | (modify-syntax-entry ?} "){" st) | |
1518 | (modify-syntax-entry ?$ "_" st) | |
1519 | (modify-syntax-entry ?. "." st) | |
1520 | (modify-syntax-entry ?\; "<" st) | |
1521 | (modify-syntax-entry ?\n ">" st) | |
1522 | (modify-syntax-entry ?\f ">" st) | |
1523 | st) | |
f32b3b91 CD |
1524 | "Syntax table in use in `idlwave-mode' buffers.") |
1525 | ||
f32b3b91 | 1526 | (defvar idlwave-find-symbol-syntax-table |
8d222148 SM |
1527 | (let ((st (copy-syntax-table idlwave-mode-syntax-table))) |
1528 | (modify-syntax-entry ?$ "w" st) | |
1529 | (modify-syntax-entry ?_ "w" st) | |
1530 | (modify-syntax-entry ?! "w" st) | |
1531 | (modify-syntax-entry ?. "w" st) | |
1532 | st) | |
f32b3b91 CD |
1533 | "Syntax table that treats symbol characters as word characters.") |
1534 | ||
76959b77 S |
1535 | (defmacro idlwave-with-special-syntax (&rest body) |
1536 | "Execute BODY with a different syntax table." | |
05a1abfc CD |
1537 | `(let ((saved-syntax (syntax-table))) |
1538 | (unwind-protect | |
1539 | (progn | |
1540 | (set-syntax-table idlwave-find-symbol-syntax-table) | |
1541 | ,@body) | |
1542 | (set-syntax-table saved-syntax)))) | |
1543 | ||
76959b77 S |
1544 | ;(defmacro idlwave-with-special-syntax1 (&rest body) |
1545 | ; "Execute BODY with a different syntax table." | |
1546 | ; `(let ((saved-syntax (syntax-table))) | |
1547 | ; (unwind-protect | |
1548 | ; (progn | |
1549 | ; (set-syntax-table idlwave-find-symbol-syntax-table) | |
1550 | ; ,@body) | |
1551 | ; (set-syntax-table saved-syntax)))) | |
1552 | ||
f32b3b91 CD |
1553 | (defun idlwave-action-and-binding (key cmd &optional select) |
1554 | "KEY and CMD are made into a key binding and an indent action. | |
1555 | KEY is a string - same as for the `define-key' function. CMD is a | |
1556 | function of no arguments or a list to be evaluated. CMD is bound to | |
1557 | KEY in `idlwave-mode-map' by defining an anonymous function calling | |
1558 | `self-insert-command' followed by CMD. If KEY contains more than one | |
1559 | character a binding will only be set if SELECT is 'both. | |
1560 | ||
5e72c6b2 | 1561 | \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table', |
f32b3b91 CD |
1562 | replacing any previous value for KEY. If a binding is not set then it |
1563 | will instead be placed in `idlwave-indent-action-table'. | |
1564 | ||
1565 | If the optional argument SELECT is nil then an action and binding are | |
1566 | created. If SELECT is 'noaction, then a binding is always set and no | |
1567 | action is created. If SELECT is 'both then an action and binding | |
1568 | will both be created even if KEY contains more than one character. | |
1569 | Otherwise, if SELECT is non-nil then only an action is created. | |
1570 | ||
1571 | Some examples: | |
1572 | No spaces before and 1 after a comma | |
1573 | (idlwave-action-and-binding \",\" '(idlwave-surround 0 1)) | |
1574 | A minimum of 1 space before and after `=' (see `idlwave-expand-equal'). | |
1575 | (idlwave-action-and-binding \"=\" '(idlwave-expand-equal -1 -1)) | |
1576 | Capitalize system variables - action only | |
1577 | (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)" | |
1578 | (if (not (equal select 'noaction)) | |
1579 | ;; Add action | |
1580 | (let* ((table (if select 'idlwave-indent-action-table | |
1581 | 'idlwave-indent-expand-table)) | |
3938cb82 S |
1582 | (table-key (regexp-quote key)) |
1583 | (cell (assoc table-key (eval table)))) | |
f32b3b91 CD |
1584 | (if cell |
1585 | ;; Replace action command | |
1586 | (setcdr cell cmd) | |
1587 | ;; New action | |
3938cb82 | 1588 | (set table (append (eval table) (list (cons table-key cmd))))))) |
f32b3b91 CD |
1589 | ;; Make key binding for action |
1590 | (if (or (and (null select) (= (length key) 1)) | |
1591 | (equal select 'noaction) | |
1592 | (equal select 'both)) | |
1593 | (define-key idlwave-mode-map key | |
8d222148 SM |
1594 | `(lambda () |
1595 | (interactive) | |
1596 | (self-insert-command 1) | |
4111f0c7 | 1597 | ,(if (listp cmd) cmd (list cmd)))))) |
f32b3b91 CD |
1598 | |
1599 | ;; Set action and key bindings. | |
1600 | ;; See description of the function `idlwave-action-and-binding'. | |
1601 | ;; Automatically add spaces for the following characters | |
f66f03de S |
1602 | |
1603 | ;; Actions for & are complicated by && | |
1604 | (idlwave-action-and-binding "&" 'idlwave-custom-ampersand-surround) | |
1605 | ||
1606 | ;; Automatically add spaces to equal sign if not keyword. This needs | |
1607 | ;; to go ahead of > and <, so >= and <= will be treated correctly | |
f32b3b91 CD |
1608 | (idlwave-action-and-binding "=" '(idlwave-expand-equal -1 -1)) |
1609 | ||
4b1aaa8b | 1610 | ;; Actions for > and < are complicated by >=, <=, and ->... |
f66f03de S |
1611 | (idlwave-action-and-binding "<" '(idlwave-custom-ltgtr-surround nil)) |
1612 | (idlwave-action-and-binding ">" '(idlwave-custom-ltgtr-surround 'gtr)) | |
1613 | ||
1614 | (idlwave-action-and-binding "," '(idlwave-surround 0 -1 1)) | |
1615 | ||
1616 | ||
f32b3b91 CD |
1617 | ;;; |
1618 | ;;; Abbrev Section | |
1619 | ;;; | |
1620 | ;;; When expanding abbrevs and the abbrev hook moves backward, an extra | |
1621 | ;;; space is inserted (this is the space typed by the user to expanded | |
1622 | ;;; the abbrev). | |
1623 | ;;; | |
5e72c6b2 | 1624 | (defvar idlwave-mode-abbrev-table nil |
5a0c3f56 | 1625 | "Abbreviation table used for IDLWAVE mode.") |
5e72c6b2 S |
1626 | (define-abbrev-table 'idlwave-mode-abbrev-table ()) |
1627 | ||
1628 | (defun idlwave-define-abbrev (name expansion hook &optional noprefix table) | |
1629 | "Define-abbrev with backward compatibility. | |
1630 | ||
1631 | If NOPREFIX is non-nil, don't prepend prefix character. Installs into | |
5a0c3f56 | 1632 | `idlwave-mode-abbrev-table' unless TABLE is non-nil." |
5e72c6b2 S |
1633 | (let ((abbrevs-changed nil) ;; mask the current value to avoid save |
1634 | (args (list (or table idlwave-mode-abbrev-table) | |
1635 | (if noprefix name (concat idlwave-abbrev-start-char name)) | |
1636 | expansion | |
1637 | hook))) | |
1638 | (condition-case nil | |
1639 | (apply 'define-abbrev (append args '(0 t))) | |
1640 | (error (apply 'define-abbrev args))))) | |
f32b3b91 CD |
1641 | |
1642 | (condition-case nil | |
4b1aaa8b | 1643 | (modify-syntax-entry (string-to-char idlwave-abbrev-start-char) |
f32b3b91 CD |
1644 | "w" idlwave-mode-syntax-table) |
1645 | (error nil)) | |
1646 | ||
5e72c6b2 S |
1647 | ;; |
1648 | ;; Templates | |
1649 | ;; | |
1650 | (idlwave-define-abbrev "c" "" (idlwave-code-abbrev idlwave-case)) | |
1651 | (idlwave-define-abbrev "sw" "" (idlwave-code-abbrev idlwave-switch)) | |
1652 | (idlwave-define-abbrev "f" "" (idlwave-code-abbrev idlwave-for)) | |
1653 | (idlwave-define-abbrev "fu" "" (idlwave-code-abbrev idlwave-function)) | |
1654 | (idlwave-define-abbrev "pr" "" (idlwave-code-abbrev idlwave-procedure)) | |
1655 | (idlwave-define-abbrev "r" "" (idlwave-code-abbrev idlwave-repeat)) | |
1656 | (idlwave-define-abbrev "w" "" (idlwave-code-abbrev idlwave-while)) | |
1657 | (idlwave-define-abbrev "i" "" (idlwave-code-abbrev idlwave-if)) | |
1658 | (idlwave-define-abbrev "elif" "" (idlwave-code-abbrev idlwave-elif)) | |
1659 | ;; | |
1660 | ;; Keywords, system functions, conversion routines | |
1661 | ;; | |
1662 | (idlwave-define-abbrev "ap" "arg_present()" (idlwave-keyword-abbrev 1)) | |
1663 | (idlwave-define-abbrev "b" "begin" (idlwave-keyword-abbrev 0 t)) | |
1664 | (idlwave-define-abbrev "co" "common" (idlwave-keyword-abbrev 0 t)) | |
1665 | (idlwave-define-abbrev "cb" "byte()" (idlwave-keyword-abbrev 1)) | |
1666 | (idlwave-define-abbrev "cx" "fix()" (idlwave-keyword-abbrev 1)) | |
1667 | (idlwave-define-abbrev "cl" "long()" (idlwave-keyword-abbrev 1)) | |
1668 | (idlwave-define-abbrev "cf" "float()" (idlwave-keyword-abbrev 1)) | |
1669 | (idlwave-define-abbrev "cs" "string()" (idlwave-keyword-abbrev 1)) | |
1670 | (idlwave-define-abbrev "cc" "complex()" (idlwave-keyword-abbrev 1)) | |
1671 | (idlwave-define-abbrev "cd" "double()" (idlwave-keyword-abbrev 1)) | |
1672 | (idlwave-define-abbrev "e" "else" (idlwave-keyword-abbrev 0 t)) | |
1673 | (idlwave-define-abbrev "ec" "endcase" 'idlwave-show-begin) | |
1674 | (idlwave-define-abbrev "es" "endswitch" 'idlwave-show-begin) | |
1675 | (idlwave-define-abbrev "ee" "endelse" 'idlwave-show-begin) | |
1676 | (idlwave-define-abbrev "ef" "endfor" 'idlwave-show-begin) | |
1677 | (idlwave-define-abbrev "ei" "endif else if" 'idlwave-show-begin) | |
1678 | (idlwave-define-abbrev "el" "endif else" 'idlwave-show-begin) | |
1679 | (idlwave-define-abbrev "en" "endif" 'idlwave-show-begin) | |
1680 | (idlwave-define-abbrev "er" "endrep" 'idlwave-show-begin) | |
1681 | (idlwave-define-abbrev "ew" "endwhile" 'idlwave-show-begin) | |
1682 | (idlwave-define-abbrev "g" "goto," (idlwave-keyword-abbrev 0 t)) | |
1683 | (idlwave-define-abbrev "h" "help," (idlwave-keyword-abbrev 0)) | |
1684 | (idlwave-define-abbrev "k" "keyword_set()" (idlwave-keyword-abbrev 1)) | |
1685 | (idlwave-define-abbrev "n" "n_elements()" (idlwave-keyword-abbrev 1)) | |
1686 | (idlwave-define-abbrev "on" "on_error," (idlwave-keyword-abbrev 0)) | |
1687 | (idlwave-define-abbrev "oi" "on_ioerror," (idlwave-keyword-abbrev 0 1)) | |
1688 | (idlwave-define-abbrev "ow" "openw," (idlwave-keyword-abbrev 0)) | |
1689 | (idlwave-define-abbrev "or" "openr," (idlwave-keyword-abbrev 0)) | |
1690 | (idlwave-define-abbrev "ou" "openu," (idlwave-keyword-abbrev 0)) | |
1691 | (idlwave-define-abbrev "p" "print," (idlwave-keyword-abbrev 0)) | |
1692 | (idlwave-define-abbrev "pt" "plot," (idlwave-keyword-abbrev 0)) | |
1693 | (idlwave-define-abbrev "re" "read," (idlwave-keyword-abbrev 0)) | |
1694 | (idlwave-define-abbrev "rf" "readf," (idlwave-keyword-abbrev 0)) | |
1695 | (idlwave-define-abbrev "ru" "readu," (idlwave-keyword-abbrev 0)) | |
1696 | (idlwave-define-abbrev "rt" "return" (idlwave-keyword-abbrev 0)) | |
1697 | (idlwave-define-abbrev "sc" "strcompress()" (idlwave-keyword-abbrev 1)) | |
1698 | (idlwave-define-abbrev "sn" "strlen()" (idlwave-keyword-abbrev 1)) | |
1699 | (idlwave-define-abbrev "sl" "strlowcase()" (idlwave-keyword-abbrev 1)) | |
1700 | (idlwave-define-abbrev "su" "strupcase()" (idlwave-keyword-abbrev 1)) | |
1701 | (idlwave-define-abbrev "sm" "strmid()" (idlwave-keyword-abbrev 1)) | |
1702 | (idlwave-define-abbrev "sp" "strpos()" (idlwave-keyword-abbrev 1)) | |
1703 | (idlwave-define-abbrev "st" "strput()" (idlwave-keyword-abbrev 1)) | |
1704 | (idlwave-define-abbrev "sr" "strtrim()" (idlwave-keyword-abbrev 1)) | |
1705 | (idlwave-define-abbrev "t" "then" (idlwave-keyword-abbrev 0 t)) | |
1706 | (idlwave-define-abbrev "u" "until" (idlwave-keyword-abbrev 0 t)) | |
1707 | (idlwave-define-abbrev "wu" "writeu," (idlwave-keyword-abbrev 0)) | |
1708 | (idlwave-define-abbrev "iap" "if arg_present() then" (idlwave-keyword-abbrev 6)) | |
1709 | (idlwave-define-abbrev "ik" "if keyword_set() then" (idlwave-keyword-abbrev 6)) | |
1710 | (idlwave-define-abbrev "ine" "if n_elements() eq 0 then" (idlwave-keyword-abbrev 11)) | |
1711 | (idlwave-define-abbrev "inn" "if n_elements() ne 0 then" (idlwave-keyword-abbrev 11)) | |
1712 | (idlwave-define-abbrev "np" "n_params()" (idlwave-keyword-abbrev 0)) | |
1713 | (idlwave-define-abbrev "s" "size()" (idlwave-keyword-abbrev 1)) | |
1714 | (idlwave-define-abbrev "wi" "widget_info()" (idlwave-keyword-abbrev 1)) | |
1715 | (idlwave-define-abbrev "wc" "widget_control," (idlwave-keyword-abbrev 0)) | |
3938cb82 S |
1716 | (idlwave-define-abbrev "pv" "ptr_valid()" (idlwave-keyword-abbrev 1)) |
1717 | (idlwave-define-abbrev "ipv" "if ptr_valid() then" (idlwave-keyword-abbrev 6)) | |
ff689efd | 1718 | |
5e72c6b2 S |
1719 | ;; This section is reserved words only. (From IDL user manual) |
1720 | ;; | |
1721 | (idlwave-define-abbrev "and" "and" (idlwave-keyword-abbrev 0 t) t) | |
1722 | (idlwave-define-abbrev "begin" "begin" (idlwave-keyword-abbrev 0 t) t) | |
1723 | (idlwave-define-abbrev "break" "break" (idlwave-keyword-abbrev 0 t) t) | |
1724 | (idlwave-define-abbrev "case" "case" (idlwave-keyword-abbrev 0 t) t) | |
1725 | (idlwave-define-abbrev "common" "common" (idlwave-keyword-abbrev 0 t) t) | |
1726 | (idlwave-define-abbrev "continue" "continue" (idlwave-keyword-abbrev 0 t) t) | |
1727 | (idlwave-define-abbrev "do" "do" (idlwave-keyword-abbrev 0 t) t) | |
1728 | (idlwave-define-abbrev "else" "else" (idlwave-keyword-abbrev 0 t) t) | |
1729 | (idlwave-define-abbrev "end" "end" 'idlwave-show-begin-check t) | |
1730 | (idlwave-define-abbrev "endcase" "endcase" 'idlwave-show-begin-check t) | |
1731 | (idlwave-define-abbrev "endelse" "endelse" 'idlwave-show-begin-check t) | |
1732 | (idlwave-define-abbrev "endfor" "endfor" 'idlwave-show-begin-check t) | |
1733 | (idlwave-define-abbrev "endif" "endif" 'idlwave-show-begin-check t) | |
1734 | (idlwave-define-abbrev "endrep" "endrep" 'idlwave-show-begin-check t) | |
1735 | (idlwave-define-abbrev "endswitch" "endswitch" 'idlwave-show-begin-check t) | |
1736 | (idlwave-define-abbrev "endwhi" "endwhi" 'idlwave-show-begin-check t) | |
1737 | (idlwave-define-abbrev "endwhile" "endwhile" 'idlwave-show-begin-check t) | |
1738 | (idlwave-define-abbrev "eq" "eq" (idlwave-keyword-abbrev 0 t) t) | |
1739 | (idlwave-define-abbrev "for" "for" (idlwave-keyword-abbrev 0 t) t) | |
1740 | (idlwave-define-abbrev "function" "function" (idlwave-keyword-abbrev 0 t) t) | |
1741 | (idlwave-define-abbrev "ge" "ge" (idlwave-keyword-abbrev 0 t) t) | |
1742 | (idlwave-define-abbrev "goto" "goto" (idlwave-keyword-abbrev 0 t) t) | |
1743 | (idlwave-define-abbrev "gt" "gt" (idlwave-keyword-abbrev 0 t) t) | |
1744 | (idlwave-define-abbrev "if" "if" (idlwave-keyword-abbrev 0 t) t) | |
1745 | (idlwave-define-abbrev "le" "le" (idlwave-keyword-abbrev 0 t) t) | |
1746 | (idlwave-define-abbrev "lt" "lt" (idlwave-keyword-abbrev 0 t) t) | |
1747 | (idlwave-define-abbrev "mod" "mod" (idlwave-keyword-abbrev 0 t) t) | |
1748 | (idlwave-define-abbrev "ne" "ne" (idlwave-keyword-abbrev 0 t) t) | |
1749 | (idlwave-define-abbrev "not" "not" (idlwave-keyword-abbrev 0 t) t) | |
1750 | (idlwave-define-abbrev "of" "of" (idlwave-keyword-abbrev 0 t) t) | |
1751 | (idlwave-define-abbrev "on_ioerror" "on_ioerror" (idlwave-keyword-abbrev 0 t) t) | |
1752 | (idlwave-define-abbrev "or" "or" (idlwave-keyword-abbrev 0 t) t) | |
1753 | (idlwave-define-abbrev "pro" "pro" (idlwave-keyword-abbrev 0 t) t) | |
1754 | (idlwave-define-abbrev "repeat" "repeat" (idlwave-keyword-abbrev 0 t) t) | |
1755 | (idlwave-define-abbrev "switch" "switch" (idlwave-keyword-abbrev 0 t) t) | |
1756 | (idlwave-define-abbrev "then" "then" (idlwave-keyword-abbrev 0 t) t) | |
1757 | (idlwave-define-abbrev "until" "until" (idlwave-keyword-abbrev 0 t) t) | |
1758 | (idlwave-define-abbrev "while" "while" (idlwave-keyword-abbrev 0 t) t) | |
1759 | (idlwave-define-abbrev "xor" "xor" (idlwave-keyword-abbrev 0 t) t) | |
f32b3b91 CD |
1760 | |
1761 | (defvar imenu-create-index-function) | |
1762 | (defvar extract-index-name-function) | |
1763 | (defvar prev-index-position-function) | |
1764 | (defvar imenu-extract-index-name-function) | |
1765 | (defvar imenu-prev-index-position-function) | |
5e72c6b2 | 1766 | ;; defined later - so just make the compiler hush |
4b1aaa8b | 1767 | (defvar idlwave-mode-menu) |
f32b3b91 CD |
1768 | (defvar idlwave-mode-debug-menu) |
1769 | ||
1770 | ;;;###autoload | |
175069ef | 1771 | (define-derived-mode idlwave-mode prog-mode "IDLWAVE" |
e08734e2 | 1772 | "Major mode for editing IDL source files (version 6.1_em22). |
f32b3b91 CD |
1773 | |
1774 | The main features of this mode are | |
1775 | ||
1776 | 1. Indentation and Formatting | |
1777 | -------------------------- | |
1778 | Like other Emacs programming modes, C-j inserts a newline and indents. | |
1779 | TAB is used for explicit indentation of the current line. | |
1780 | ||
5e72c6b2 S |
1781 | To start a continuation line, use \\[idlwave-split-line]. This |
1782 | function can also be used in the middle of a line to split the line | |
1783 | at that point. When used inside a long constant string, the string | |
1784 | is split at that point with the `+' concatenation operator. | |
f32b3b91 CD |
1785 | |
1786 | Comments are indented as follows: | |
1787 | ||
1788 | `;;;' Indentation remains unchanged. | |
1789 | `;;' Indent like the surrounding code | |
1790 | `;' Indent to a minimum column. | |
1791 | ||
1792 | The indentation of comments starting in column 0 is never changed. | |
1793 | ||
5e72c6b2 S |
1794 | Use \\[idlwave-fill-paragraph] to refill a paragraph inside a |
1795 | comment. The indentation of the second line of the paragraph | |
1796 | relative to the first will be retained. Use | |
1797 | \\[idlwave-auto-fill-mode] to toggle auto-fill mode for these | |
1798 | comments. When the variable `idlwave-fill-comment-line-only' is | |
52a244eb | 1799 | nil, code can also be auto-filled and auto-indented. |
f32b3b91 CD |
1800 | |
1801 | To convert pre-existing IDL code to your formatting style, mark the | |
5e72c6b2 S |
1802 | entire buffer with \\[mark-whole-buffer] and execute |
1803 | \\[idlwave-expand-region-abbrevs]. Then mark the entire buffer | |
1804 | again followed by \\[indent-region] (`indent-region'). | |
f32b3b91 CD |
1805 | |
1806 | 2. Routine Info | |
1807 | ------------ | |
5e72c6b2 S |
1808 | IDLWAVE displays information about the calling sequence and the |
1809 | accepted keyword parameters of a procedure or function with | |
1810 | \\[idlwave-routine-info]. \\[idlwave-find-module] jumps to the | |
1811 | source file of a module. These commands know about system | |
1812 | routines, all routines in idlwave-mode buffers and (when the | |
1813 | idlwave-shell is active) about all modules currently compiled under | |
52a244eb S |
1814 | this shell. It also makes use of pre-compiled or custom-scanned |
1815 | user and library catalogs many popular libraries ship with by | |
1816 | default. Use \\[idlwave-update-routine-info] to update this | |
15e42531 CD |
1817 | information, which is also used for completion (see item 4). |
1818 | ||
1819 | 3. Online IDL Help | |
1820 | --------------- | |
f66f03de | 1821 | |
15e42531 | 1822 | \\[idlwave-context-help] displays the IDL documentation relevant |
f66f03de S |
1823 | for the system variable, keyword, or routines at point. A single |
1824 | key stroke gets you directly to the right place in the docs. See | |
52a244eb | 1825 | the manual to configure where and how the HTML help is displayed. |
f32b3b91 | 1826 | |
15e42531 | 1827 | 4. Completion |
f32b3b91 | 1828 | ---------- |
15e42531 | 1829 | \\[idlwave-complete] completes the names of procedures, functions |
52a244eb S |
1830 | class names, keyword parameters, system variables and tags, class |
1831 | tags, structure tags, filenames and much more. It is context | |
1832 | sensitive and figures out what is expected at point. Lower case | |
1833 | strings are completed in lower case, other strings in mixed or | |
1834 | upper case. | |
f32b3b91 | 1835 | |
15e42531 | 1836 | 5. Code Templates and Abbreviations |
f32b3b91 CD |
1837 | -------------------------------- |
1838 | Many Abbreviations are predefined to expand to code fragments and templates. | |
5a0c3f56 | 1839 | The abbreviations start generally with a `\\`. Some examples: |
f32b3b91 CD |
1840 | |
1841 | \\pr PROCEDURE template | |
1842 | \\fu FUNCTION template | |
1843 | \\c CASE statement template | |
05a1abfc | 1844 | \\sw SWITCH statement template |
f32b3b91 CD |
1845 | \\f FOR loop template |
1846 | \\r REPEAT Loop template | |
1847 | \\w WHILE loop template | |
1848 | \\i IF statement template | |
1849 | \\elif IF-ELSE statement template | |
1850 | \\b BEGIN | |
4b1aaa8b | 1851 | |
52a244eb S |
1852 | For a full list, use \\[idlwave-list-abbrevs]. Some templates also |
1853 | have direct keybindings - see the list of keybindings below. | |
775591f7 | 1854 | |
52a244eb S |
1855 | \\[idlwave-doc-header] inserts a documentation header at the |
1856 | beginning of the current program unit (pro, function or main). | |
1857 | Change log entries can be added to the current program unit with | |
1858 | \\[idlwave-doc-modification]. | |
f32b3b91 | 1859 | |
15e42531 | 1860 | 6. Automatic Case Conversion |
f32b3b91 CD |
1861 | ------------------------- |
1862 | The case of reserved words and some abbrevs is controlled by | |
1863 | `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'. | |
1864 | ||
15e42531 | 1865 | 7. Automatic END completion |
f32b3b91 CD |
1866 | ------------------------ |
1867 | If the variable `idlwave-expand-generic-end' is non-nil, each END typed | |
1868 | will be converted to the specific version, like ENDIF, ENDFOR, etc. | |
1869 | ||
15e42531 | 1870 | 8. Hooks |
f32b3b91 CD |
1871 | ----- |
1872 | Loading idlwave.el runs `idlwave-load-hook'. | |
1873 | Turning on `idlwave-mode' runs `idlwave-mode-hook'. | |
1874 | ||
15e42531 | 1875 | 9. Documentation and Customization |
f32b3b91 | 1876 | ------------------------------- |
5e72c6b2 S |
1877 | Info documentation for this package is available. Use |
1878 | \\[idlwave-info] to display (complain to your sysadmin if that does | |
1879 | not work). For Postscript, PDF, and HTML versions of the | |
855b42a2 | 1880 | documentation, check IDLWAVE's homepage at URL `http://idlwave.org'. |
f32b3b91 CD |
1881 | IDLWAVE has customize support - see the group `idlwave'. |
1882 | ||
15e42531 | 1883 | 10.Keybindings |
f32b3b91 CD |
1884 | ----------- |
1885 | Here is a list of all keybindings of this mode. | |
1886 | If some of the key bindings below show with ??, use \\[describe-key] | |
1887 | followed by the key sequence to see what the key sequence does. | |
1888 | ||
1889 | \\{idlwave-mode-map}" | |
175069ef | 1890 | :abbrev-table idlwave-mode-abbrev-table |
f32b3b91 CD |
1891 | (if idlwave-startup-message |
1892 | (message "Emacs IDLWAVE mode version %s." idlwave-mode-version)) | |
1893 | (setq idlwave-startup-message nil) | |
4b1aaa8b | 1894 | |
f32b3b91 | 1895 | (set (make-local-variable 'indent-line-function) 'idlwave-indent-and-action) |
4b1aaa8b | 1896 | |
175069ef SM |
1897 | (set (make-local-variable idlwave-comment-indent-function) |
1898 | #'idlwave-comment-hook) | |
4b1aaa8b | 1899 | |
f32b3b91 CD |
1900 | (set (make-local-variable 'comment-start-skip) ";+[ \t]*") |
1901 | (set (make-local-variable 'comment-start) ";") | |
0dc2be2f | 1902 | (set (make-local-variable 'comment-add) 1) ; ";;" for new and regions |
f32b3b91 CD |
1903 | (set (make-local-variable 'abbrev-all-caps) t) |
1904 | (set (make-local-variable 'indent-tabs-mode) nil) | |
1905 | (set (make-local-variable 'completion-ignore-case) t) | |
4b1aaa8b | 1906 | |
f32b3b91 CD |
1907 | (when (featurep 'easymenu) |
1908 | (easy-menu-add idlwave-mode-menu idlwave-mode-map) | |
1909 | (easy-menu-add idlwave-mode-debug-menu idlwave-mode-map)) | |
1910 | ||
f32b3b91 | 1911 | (setq abbrev-mode t) |
4b1aaa8b | 1912 | |
f32b3b91 CD |
1913 | (set (make-local-variable idlwave-fill-function) 'idlwave-auto-fill) |
1914 | (setq comment-end "") | |
1915 | (set (make-local-variable 'comment-multi-line) nil) | |
4b1aaa8b | 1916 | (set (make-local-variable 'paragraph-separate) |
5e72c6b2 | 1917 | "[ \t\f]*$\\|[ \t]*;+[ \t]*$\\|;+[+=-_*]+$") |
f32b3b91 CD |
1918 | (set (make-local-variable 'paragraph-start) "[ \t\f]\\|[ \t]*;+[ \t]") |
1919 | (set (make-local-variable 'paragraph-ignore-fill-prefix) nil) | |
76959b77 | 1920 | (set (make-local-variable 'parse-sexp-ignore-comments) t) |
775591f7 | 1921 | |
e08734e2 | 1922 | ;; ChangeLog |
8c43762b | 1923 | (set (make-local-variable 'add-log-current-defun-function) |
e08734e2 S |
1924 | 'idlwave-current-routine-fullname) |
1925 | ||
f32b3b91 CD |
1926 | ;; Set tag table list to use IDLTAGS as file name. |
1927 | (if (boundp 'tag-table-alist) | |
1928 | (add-to-list 'tag-table-alist '("\\.pro$" . "IDLTAGS"))) | |
4b1aaa8b | 1929 | |
e08734e2 | 1930 | ;; Font-lock additions |
52a244eb | 1931 | ;; Following line is for Emacs - XEmacs uses the corresponding property |
f32b3b91 CD |
1932 | ;; on the `idlwave-mode' symbol. |
1933 | (set (make-local-variable 'font-lock-defaults) idlwave-font-lock-defaults) | |
0dc2be2f S |
1934 | (set (make-local-variable 'font-lock-mark-block-function) |
1935 | 'idlwave-mark-subprogram) | |
1936 | (set (make-local-variable 'font-lock-fontify-region-function) | |
1937 | 'idlwave-font-lock-fontify-region) | |
f32b3b91 CD |
1938 | |
1939 | ;; Imenu setup | |
1940 | (set (make-local-variable 'imenu-create-index-function) | |
1941 | 'imenu-default-create-index-function) | |
1942 | (set (make-local-variable 'imenu-extract-index-name-function) | |
1943 | 'idlwave-unit-name) | |
1944 | (set (make-local-variable 'imenu-prev-index-position-function) | |
1945 | 'idlwave-prev-index-position) | |
1946 | ||
0dc2be2f S |
1947 | ;; HideShow setup |
1948 | (add-to-list 'hs-special-modes-alist | |
1949 | (list 'idlwave-mode | |
1950 | idlwave-begin-block-reg | |
1951 | idlwave-end-block-reg | |
1952 | ";" | |
1953 | 'idlwave-forward-block nil)) | |
4b1aaa8b | 1954 | |
f32b3b91 | 1955 | ;; Make a local post-command-hook and add our hook to it |
f66f03de S |
1956 | ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility |
1957 | ;; (make-local-hook 'post-command-hook) | |
15e42531 CD |
1958 | (add-hook 'post-command-hook 'idlwave-command-hook nil 'local) |
1959 | ||
1960 | ;; Make local hooks for buffer updates | |
f66f03de S |
1961 | ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility |
1962 | ;; (make-local-hook 'kill-buffer-hook) | |
15e42531 | 1963 | (add-hook 'kill-buffer-hook 'idlwave-kill-buffer-update nil 'local) |
f66f03de | 1964 | ;; (make-local-hook 'after-save-hook) |
e08734e2 | 1965 | (add-hook 'after-save-hook 'idlwave-save-buffer-update nil 'local) |
15e42531 CD |
1966 | (add-hook 'after-save-hook 'idlwave-revoke-license-to-kill nil 'local) |
1967 | ||
52a244eb S |
1968 | ;; Setup directories and file, if necessary |
1969 | (idlwave-setup) | |
1970 | ||
15e42531 CD |
1971 | ;; Update the routine info with info about current buffer? |
1972 | (idlwave-new-buffer-update) | |
f32b3b91 | 1973 | |
f66f03de | 1974 | ;; Check help location |
175069ef | 1975 | (idlwave-help-check-locations)) |
f32b3b91 | 1976 | |
52a244eb S |
1977 | (defvar idlwave-setup-done nil) |
1978 | (defun idlwave-setup () | |
1979 | (unless idlwave-setup-done | |
1980 | (if (not (file-directory-p idlwave-config-directory)) | |
1981 | (make-directory idlwave-config-directory)) | |
4b1aaa8b PE |
1982 | (setq |
1983 | idlwave-user-catalog-file (expand-file-name | |
1984 | idlwave-user-catalog-file | |
f66f03de | 1985 | idlwave-config-directory) |
4b1aaa8b PE |
1986 | idlwave-xml-system-rinfo-converted-file |
1987 | (expand-file-name | |
f66f03de S |
1988 | idlwave-xml-system-rinfo-converted-file |
1989 | idlwave-config-directory) | |
4b1aaa8b PE |
1990 | idlwave-path-file (expand-file-name |
1991 | idlwave-path-file | |
f66f03de | 1992 | idlwave-config-directory)) |
52a244eb S |
1993 | (idlwave-read-paths) ; we may need these early |
1994 | (setq idlwave-setup-done t))) | |
1995 | ||
0dc2be2f S |
1996 | (defun idlwave-font-lock-fontify-region (beg end &optional verbose) |
1997 | "Fontify continuation lines correctly." | |
1998 | (let (pos) | |
1999 | (save-excursion | |
2000 | (goto-char beg) | |
2001 | (forward-line -1) | |
2002 | (when (setq pos (idlwave-is-continuation-line)) | |
2003 | (goto-char pos) | |
2004 | (idlwave-beginning-of-statement) | |
2005 | (setq beg (point))))) | |
2006 | (font-lock-default-fontify-region beg end verbose)) | |
2007 | ||
f32b3b91 | 2008 | ;; |
52a244eb | 2009 | ;; Code Formatting ---------------------------------------------------- |
4b1aaa8b | 2010 | ;; |
f32b3b91 | 2011 | |
f32b3b91 | 2012 | (defun idlwave-hard-tab () |
5a0c3f56 | 2013 | "Insert TAB in buffer in current position." |
f32b3b91 CD |
2014 | (interactive) |
2015 | (insert "\t")) | |
2016 | ||
2017 | ;;; This stuff is experimental | |
2018 | ||
2019 | (defvar idlwave-command-hook nil | |
2020 | "If non-nil, a list that can be evaluated using `eval'. | |
2021 | It is evaluated in the lisp function `idlwave-command-hook' which is | |
2022 | placed in `post-command-hook'.") | |
2023 | ||
2024 | (defun idlwave-command-hook () | |
2025 | "Command run after every command. | |
2026 | Evaluates a non-nil value of the *variable* `idlwave-command-hook' and | |
2027 | sets the variable to zero afterwards." | |
2028 | (and idlwave-command-hook | |
2029 | (listp idlwave-command-hook) | |
2030 | (condition-case nil | |
2031 | (eval idlwave-command-hook) | |
2032 | (error nil))) | |
2033 | (setq idlwave-command-hook nil)) | |
2034 | ||
2035 | ;;; End experiment | |
2036 | ||
2037 | ;; It would be better to use expand.el for better abbrev handling and | |
2038 | ;; versatility. | |
2039 | ||
2040 | (defun idlwave-check-abbrev (arg &optional reserved) | |
5a0c3f56 | 2041 | "Reverse abbrev expansion if in comment or string. |
f32b3b91 CD |
2042 | Argument ARG is the number of characters to move point |
2043 | backward if `idlwave-abbrev-move' is non-nil. | |
2044 | If optional argument RESERVED is non-nil then the expansion | |
2045 | consists of reserved words, which will be capitalized if | |
2046 | `idlwave-reserved-word-upcase' is non-nil. | |
2047 | Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case' | |
2048 | is non-nil, unless its value is \`down in which case the abbrev will be | |
2049 | made into all lowercase. | |
2050 | Returns non-nil if abbrev is left expanded." | |
2051 | (if (idlwave-quoted) | |
2052 | (progn (unexpand-abbrev) | |
2053 | nil) | |
2054 | (if (and reserved idlwave-reserved-word-upcase) | |
2055 | (upcase-region last-abbrev-location (point)) | |
2056 | (cond | |
2057 | ((equal idlwave-abbrev-change-case 'down) | |
2058 | (downcase-region last-abbrev-location (point))) | |
2059 | (idlwave-abbrev-change-case | |
2060 | (upcase-region last-abbrev-location (point))))) | |
2061 | (if (and idlwave-abbrev-move (> arg 0)) | |
2062 | (if (boundp 'post-command-hook) | |
2063 | (setq idlwave-command-hook (list 'backward-char (1+ arg))) | |
2064 | (backward-char arg))) | |
2065 | t)) | |
2066 | ||
2067 | (defun idlwave-in-comment () | |
5a0c3f56 | 2068 | "Return t if point is inside a comment, nil otherwise." |
f32b3b91 CD |
2069 | (save-excursion |
2070 | (let ((here (point))) | |
2071 | (and (idlwave-goto-comment) (> here (point)))))) | |
2072 | ||
2073 | (defun idlwave-goto-comment () | |
2074 | "Move to start of comment delimiter on current line. | |
2075 | Moves to end of line if there is no comment delimiter. | |
2076 | Ignores comment delimiters in strings. | |
2077 | Returns point if comment found and nil otherwise." | |
9b026d9f | 2078 | (let ((eos (point-at-eol)) |
f32b3b91 CD |
2079 | (data (match-data)) |
2080 | found) | |
2081 | ;; Look for first comment delimiter not in a string | |
2082 | (beginning-of-line) | |
2083 | (setq found (search-forward comment-start eos 'lim)) | |
2084 | (while (and found (idlwave-in-quote)) | |
2085 | (setq found (search-forward comment-start eos 'lim))) | |
2086 | (store-match-data data) | |
2087 | (and found (not (idlwave-in-quote)) | |
2088 | (progn | |
2089 | (backward-char 1) | |
2090 | (point))))) | |
2091 | ||
5e72c6b2 | 2092 | (defun idlwave-region-active-p () |
a00e54f7 RS |
2093 | "Should we operate on an active region?" |
2094 | (if (fboundp 'use-region-p) | |
2095 | (use-region-p) | |
2096 | (region-active-p))) | |
5e72c6b2 | 2097 | |
f32b3b91 CD |
2098 | (defun idlwave-show-matching-quote () |
2099 | "Insert quote and show matching quote if this is end of a string." | |
2100 | (interactive) | |
2101 | (let ((bq (idlwave-in-quote)) | |
1ba983e8 | 2102 | (inq last-command-event)) |
f32b3b91 CD |
2103 | (if (and bq (not (idlwave-in-comment))) |
2104 | (let ((delim (char-after bq))) | |
2105 | (insert inq) | |
2106 | (if (eq inq delim) | |
2107 | (save-excursion | |
2108 | (goto-char bq) | |
2109 | (sit-for 1)))) | |
2110 | ;; Not the end of a string | |
2111 | (insert inq)))) | |
2112 | ||
2113 | (defun idlwave-show-begin-check () | |
2114 | "Ensure that the previous word was a token before `idlwave-show-begin'. | |
2115 | An END token must be preceded by whitespace." | |
5e72c6b2 S |
2116 | (if (not (idlwave-quoted)) |
2117 | (if | |
2118 | (save-excursion | |
2119 | (backward-word 1) | |
2120 | (backward-char 1) | |
2121 | (looking-at "[ \t\n\f]")) | |
2122 | (idlwave-show-begin)))) | |
f32b3b91 CD |
2123 | |
2124 | (defun idlwave-show-begin () | |
5a0c3f56 JB |
2125 | "Find the start of current block and blinks to it for a second. |
2126 | Also checks if the correct END statement has been used." | |
f32b3b91 | 2127 | ;; All end statements are reserved words |
76959b77 | 2128 | ;; Re-indent end line |
52a244eb S |
2129 | ;;(insert-char ?\ 1) ;; So indent, etc. work well |
2130 | ;;(backward-char 1) | |
76959b77 S |
2131 | (let* ((pos (point-marker)) |
2132 | (last-abbrev-marker (copy-marker last-abbrev-location)) | |
e180ab9f | 2133 | (eol-pos (point-at-eol)) |
76959b77 S |
2134 | begin-pos end-pos end end1 ) |
2135 | (if idlwave-reindent-end (idlwave-indent-line)) | |
52a244eb | 2136 | (setq last-abbrev-location (marker-position last-abbrev-marker)) |
f32b3b91 CD |
2137 | (when (and (idlwave-check-abbrev 0 t) |
2138 | idlwave-show-block) | |
2139 | (save-excursion | |
2140 | ;; Move inside current block | |
76959b77 | 2141 | (goto-char last-abbrev-marker) |
f32b3b91 | 2142 | (idlwave-block-jump-out -1 'nomark) |
76959b77 S |
2143 | (setq begin-pos (point)) |
2144 | (idlwave-block-jump-out 1 'nomark) | |
2145 | (setq end-pos (point)) | |
2146 | (if (> end-pos eol-pos) | |
2147 | (setq end-pos pos)) | |
2148 | (goto-char end-pos) | |
4b1aaa8b | 2149 | (setq end (buffer-substring |
76959b77 S |
2150 | (progn |
2151 | (skip-chars-backward "a-zA-Z") | |
2152 | (point)) | |
2153 | end-pos)) | |
2154 | (goto-char begin-pos) | |
f32b3b91 CD |
2155 | (when (setq end1 (cdr (idlwave-block-master))) |
2156 | (cond | |
5e72c6b2 | 2157 | ((null end1)) ; no-operation |
f32b3b91 CD |
2158 | ((string= (downcase end) (downcase end1)) |
2159 | (sit-for 1)) | |
2160 | ((string= (downcase end) "end") | |
2161 | ;; A generic end | |
2162 | (if idlwave-expand-generic-end | |
2163 | (save-excursion | |
2164 | (goto-char pos) | |
2165 | (backward-char 3) | |
2166 | (insert (if (string= end "END") (upcase end1) end1)) | |
2167 | (delete-char 3))) | |
2168 | (sit-for 1)) | |
2169 | (t | |
2170 | (beep) | |
4b1aaa8b | 2171 | (message "Warning: Shouldn't this be \"%s\" instead of \"%s\"?" |
f32b3b91 | 2172 | end1 end) |
52a244eb S |
2173 | (sit-for 1)))))))) |
2174 | ;;(delete-char 1)) | |
f32b3b91 CD |
2175 | |
2176 | (defun idlwave-block-master () | |
2177 | (let ((case-fold-search t)) | |
2178 | (save-excursion | |
2179 | (cond | |
05a1abfc | 2180 | ((looking-at "pro\\|case\\|switch\\|function\\>") |
f32b3b91 CD |
2181 | (assoc (downcase (match-string 0)) idlwave-block-matches)) |
2182 | ((looking-at "begin\\>") | |
4b1aaa8b PE |
2183 | (let ((limit (save-excursion |
2184 | (idlwave-beginning-of-statement) | |
f32b3b91 CD |
2185 | (point)))) |
2186 | (cond | |
52a244eb S |
2187 | ((re-search-backward ":[ \t]*\\=" limit t) |
2188 | ;; seems to be a case thing | |
2189 | '("begin" . "end")) | |
f32b3b91 CD |
2190 | ((re-search-backward idlwave-block-match-regexp limit t) |
2191 | (assoc (downcase (match-string 1)) | |
2192 | idlwave-block-matches)) | |
f32b3b91 | 2193 | (t |
52a244eb | 2194 | ;; Just a normal block |
f32b3b91 CD |
2195 | '("begin" . "end"))))) |
2196 | (t nil))))) | |
2197 | ||
2198 | (defun idlwave-close-block () | |
2199 | "Terminate the current block with the correct END statement." | |
2200 | (interactive) | |
f32b3b91 CD |
2201 | ;; Start new line if we are not in a new line |
2202 | (unless (save-excursion | |
2203 | (skip-chars-backward " \t") | |
2204 | (bolp)) | |
2205 | (let ((idlwave-show-block nil)) | |
2206 | (newline-and-indent))) | |
5e72c6b2 S |
2207 | (let ((last-abbrev-location (point))) ; for upcasing |
2208 | (insert "end") | |
2209 | (idlwave-show-begin))) | |
2210 | ||
f66f03de | 2211 | (defun idlwave-custom-ampersand-surround (&optional is-action) |
5a0c3f56 | 2212 | "Surround &, leaving room for && (which surround as well)." |
f66f03de S |
2213 | (let* ((prev-char (char-after (- (point) 2))) |
2214 | (next-char (char-after (point))) | |
2215 | (amp-left (eq prev-char ?&)) | |
2216 | (amp-right (eq next-char ?&)) | |
2217 | (len (if amp-left 2 1))) | |
2218 | (unless amp-right ;no need to do it twice, amp-left will catch it. | |
2219 | (idlwave-surround -1 (if (or is-action amp-left) -1) len)))) | |
2220 | ||
2221 | (defun idlwave-custom-ltgtr-surround (gtr &optional is-action) | |
2222 | "Surround > and < by blanks, leaving room for >= and <=, and considering ->." | |
2223 | (let* ((prev-char (char-after (- (point) 2))) | |
2224 | (next-char (char-after (point))) | |
2225 | (method-invoke (and gtr (eq prev-char ?-))) | |
2226 | (len (if method-invoke 2 1))) | |
2227 | (unless (eq next-char ?=) | |
2228 | ;; Key binding: pad only on left, to save for possible >=/<= | |
2229 | (idlwave-surround -1 (if (or is-action method-invoke) -1) len)))) | |
2230 | ||
2231 | (defun idlwave-surround (&optional before after length is-action) | |
595ab50b CD |
2232 | "Surround the LENGTH characters before point with blanks. |
2233 | LENGTH defaults to 1. | |
f32b3b91 | 2234 | Optional arguments BEFORE and AFTER affect the behavior before and |
595ab50b CD |
2235 | after the characters (see also description of `idlwave-make-space'): |
2236 | ||
2237 | nil do nothing | |
2238 | 0 force no spaces | |
2239 | integer > 0 force exactly n spaces | |
2240 | integer < 0 at least |n| spaces | |
f32b3b91 CD |
2241 | |
2242 | The function does nothing if any of the following conditions is true: | |
2243 | - `idlwave-surround-by-blank' is nil | |
f66f03de | 2244 | - the character before point is inside a string or comment" |
5e72c6b2 | 2245 | (when (and idlwave-surround-by-blank (not (idlwave-quoted))) |
f66f03de S |
2246 | (let ((length (or length 1))) ; establish a default for LENGTH |
2247 | (backward-char length) | |
2248 | (save-restriction | |
2249 | (let ((here (point))) | |
2250 | (skip-chars-backward " \t") | |
2251 | (if (bolp) | |
2252 | ;; avoid clobbering indent | |
2253 | (progn | |
2254 | (move-to-column (idlwave-calculate-indent)) | |
2255 | (if (<= (point) here) | |
2256 | (narrow-to-region (point) here)) | |
2257 | (goto-char here))) | |
2258 | (idlwave-make-space before)) | |
2259 | (skip-chars-forward " \t")) | |
2260 | (forward-char length) | |
2261 | (idlwave-make-space after) | |
2262 | ;; Check to see if the line should auto wrap | |
2263 | (if (and (equal (char-after (1- (point))) ?\ ) | |
2264 | (> (current-column) fill-column)) | |
2265 | (funcall auto-fill-function))))) | |
f32b3b91 CD |
2266 | |
2267 | (defun idlwave-make-space (n) | |
2268 | "Make space at point. | |
2269 | The space affected is all the spaces and tabs around point. | |
2270 | If n is non-nil then point is left abs(n) spaces from the beginning of | |
2271 | the contiguous space. | |
2272 | The amount of space at point is determined by N. | |
2273 | If the value of N is: | |
2274 | nil - do nothing. | |
595ab50b CD |
2275 | > 0 - exactly N spaces. |
2276 | < 0 - a minimum of -N spaces, i.e., do not change if there are | |
2277 | already -N spaces. | |
2278 | 0 - no spaces (i.e. remove any existing space)." | |
f32b3b91 CD |
2279 | (if (integerp n) |
2280 | (let | |
2281 | ((start-col (progn (skip-chars-backward " \t") (current-column))) | |
2282 | (left (point)) | |
2283 | (end-col (progn (skip-chars-forward " \t") (current-column)))) | |
2284 | (delete-horizontal-space) | |
2285 | (cond | |
2286 | ((> n 0) | |
2287 | (idlwave-indent-to (+ start-col n)) | |
2288 | (goto-char (+ left n))) | |
2289 | ((< n 0) | |
2290 | (idlwave-indent-to end-col (- n)) | |
2291 | (goto-char (- left n))) | |
2292 | ;; n = 0, done | |
2293 | )))) | |
2294 | ||
2295 | (defun idlwave-newline () | |
5a0c3f56 | 2296 | "Insert a newline and indent the current and previous line." |
f32b3b91 CD |
2297 | (interactive) |
2298 | ;; | |
2299 | ;; Handle unterminated single and double quotes | |
2300 | ;; If not in a comment and in a string then insertion of a newline | |
2301 | ;; will mean unbalanced quotes. | |
2302 | ;; | |
2303 | (if (and (not (idlwave-in-comment)) (idlwave-in-quote)) | |
2304 | (progn (beep) | |
2305 | (message "Warning: unbalanced quotes?"))) | |
2306 | (newline) | |
2307 | ;; | |
2308 | ;; The current line is being split, the cursor should be at the | |
2309 | ;; beginning of the new line skipping the leading indentation. | |
2310 | ;; | |
2311 | ;; The reason we insert the new line before indenting is that the | |
2312 | ;; indenting could be confused by keywords (e.g. END) on the line | |
2313 | ;; after the split point. This prevents us from just using | |
2314 | ;; `indent-for-tab-command' followed by `newline-and-indent'. | |
2315 | ;; | |
2316 | (beginning-of-line 0) | |
2317 | (idlwave-indent-line) | |
2318 | (forward-line) | |
2319 | (idlwave-indent-line)) | |
2320 | ||
2321 | ;; | |
2322 | ;; Use global variable 'comment-column' to set parallel comment | |
2323 | ;; | |
2324 | ;; Modeled on lisp.el | |
2325 | ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax | |
2326 | (defun idlwave-comment-hook () | |
2327 | "Compute indent for the beginning of the IDL comment delimiter." | |
2328 | (if (or (looking-at idlwave-no-change-comment) | |
8d222148 | 2329 | (looking-at (or idlwave-begin-line-comment "^;"))) |
f32b3b91 CD |
2330 | (current-column) |
2331 | (if (looking-at idlwave-code-comment) | |
2332 | (if (save-excursion (skip-chars-backward " \t") (bolp)) | |
2333 | ;; On line by itself, indent as code | |
2334 | (let ((tem (idlwave-calculate-indent))) | |
2335 | (if (listp tem) (car tem) tem)) | |
2336 | ;; after code - do not change | |
2337 | (current-column)) | |
2338 | (skip-chars-backward " \t") | |
2339 | (max (if (bolp) 0 (1+ (current-column))) | |
2340 | comment-column)))) | |
2341 | ||
2342 | (defun idlwave-split-line () | |
2343 | "Continue line by breaking line at point and indent the lines. | |
5a0c3f56 | 2344 | For a code line insert continuation marker. If the line is a line comment |
f32b3b91 CD |
2345 | then the new line will contain a comment with the same indentation. |
2346 | Splits strings with the IDL operator `+' if `idlwave-split-line-string' is | |
2347 | non-nil." | |
2348 | (interactive) | |
15e42531 CD |
2349 | ;; Expand abbreviation, just like normal RET would. |
2350 | (and abbrev-mode (expand-abbrev)) | |
f32b3b91 CD |
2351 | (let (beg) |
2352 | (if (not (idlwave-in-comment)) | |
2353 | ;; For code line add continuation. | |
2354 | ;; Check if splitting a string. | |
2355 | (progn | |
2356 | (if (setq beg (idlwave-in-quote)) | |
2357 | (if idlwave-split-line-string | |
2358 | ;; Split the string. | |
2359 | (progn (insert (setq beg (char-after beg)) " + " | |
2360 | idlwave-continuation-char beg) | |
5e72c6b2 S |
2361 | (backward-char 1) |
2362 | (newline-and-indent) | |
2363 | (forward-char 1)) | |
f32b3b91 CD |
2364 | ;; Do not split the string. |
2365 | (beep) | |
2366 | (message "Warning: continuation inside string!!") | |
2367 | (insert " " idlwave-continuation-char)) | |
2368 | ;; Not splitting a string. | |
15e42531 CD |
2369 | (if (not (member (char-before) '(?\ ?\t))) |
2370 | (insert " ")) | |
5e72c6b2 S |
2371 | (insert idlwave-continuation-char) |
2372 | (newline-and-indent))) | |
f32b3b91 CD |
2373 | (indent-new-comment-line)) |
2374 | ;; Indent previous line | |
2375 | (setq beg (- (point-max) (point))) | |
2376 | (forward-line -1) | |
2377 | (idlwave-indent-line) | |
2378 | (goto-char (- (point-max) beg)) | |
2379 | ;; Reindent new line | |
2380 | (idlwave-indent-line))) | |
2381 | ||
cca13260 | 2382 | (defun idlwave-beginning-of-subprogram (&optional nomark) |
5a0c3f56 | 2383 | "Move point to the beginning of the current program unit. |
cca13260 | 2384 | If NOMARK is non-nil, do not push mark." |
f32b3b91 | 2385 | (interactive) |
cca13260 | 2386 | (idlwave-find-key idlwave-begin-unit-reg -1 nomark)) |
f32b3b91 | 2387 | |
cca13260 | 2388 | (defun idlwave-end-of-subprogram (&optional nomark) |
5a0c3f56 | 2389 | "Move point to the start of the next program unit. |
cca13260 | 2390 | If NOMARK is non-nil, do not push mark." |
f32b3b91 CD |
2391 | (interactive) |
2392 | (idlwave-end-of-statement) | |
cca13260 | 2393 | (idlwave-find-key idlwave-end-unit-reg 1 nomark)) |
f32b3b91 CD |
2394 | |
2395 | (defun idlwave-mark-statement () | |
2396 | "Mark current IDL statement." | |
2397 | (interactive) | |
2398 | (idlwave-end-of-statement) | |
2399 | (let ((end (point))) | |
2400 | (idlwave-beginning-of-statement) | |
0dc2be2f | 2401 | (push-mark end nil t))) |
f32b3b91 CD |
2402 | |
2403 | (defun idlwave-mark-block () | |
2404 | "Mark containing block." | |
2405 | (interactive) | |
2406 | (idlwave-end-of-statement) | |
2407 | (idlwave-backward-up-block -1) | |
2408 | (idlwave-end-of-statement) | |
2409 | (let ((end (point))) | |
2410 | (idlwave-backward-block) | |
2411 | (idlwave-beginning-of-statement) | |
0dc2be2f | 2412 | (push-mark end nil t))) |
f32b3b91 CD |
2413 | |
2414 | ||
2415 | (defun idlwave-mark-subprogram () | |
2416 | "Put mark at beginning of program, point at end. | |
2417 | The marks are pushed." | |
2418 | (interactive) | |
2419 | (idlwave-end-of-statement) | |
2420 | (idlwave-beginning-of-subprogram) | |
2421 | (let ((beg (point))) | |
2422 | (idlwave-forward-block) | |
0dc2be2f | 2423 | (push-mark beg nil t)) |
f32b3b91 CD |
2424 | (exchange-point-and-mark)) |
2425 | ||
2426 | (defun idlwave-backward-up-block (&optional arg) | |
2427 | "Move to beginning of enclosing block if prefix ARG >= 0. | |
2428 | If prefix ARG < 0 then move forward to enclosing block end." | |
2429 | (interactive "p") | |
2430 | (idlwave-block-jump-out (- arg) 'nomark)) | |
2431 | ||
2432 | (defun idlwave-beginning-of-block () | |
2433 | "Go to the beginning of the current block." | |
2434 | (interactive) | |
2435 | (idlwave-block-jump-out -1 'nomark) | |
2436 | (forward-word 1)) | |
2437 | ||
2438 | (defun idlwave-end-of-block () | |
2439 | "Go to the beginning of the current block." | |
2440 | (interactive) | |
2441 | (idlwave-block-jump-out 1 'nomark) | |
2442 | (backward-word 1)) | |
2443 | ||
0dc2be2f | 2444 | (defun idlwave-forward-block (&optional arg) |
f32b3b91 CD |
2445 | "Move across next nested block." |
2446 | (interactive) | |
0dc2be2f S |
2447 | (let ((arg (or arg 1))) |
2448 | (if (idlwave-down-block arg) | |
2449 | (idlwave-block-jump-out arg 'nomark)))) | |
f32b3b91 CD |
2450 | |
2451 | (defun idlwave-backward-block () | |
2452 | "Move backward across previous nested block." | |
2453 | (interactive) | |
2454 | (if (idlwave-down-block -1) | |
2455 | (idlwave-block-jump-out -1 'nomark))) | |
2456 | ||
2457 | (defun idlwave-down-block (&optional arg) | |
2458 | "Go down a block. | |
2459 | With ARG: ARG >= 0 go forwards, ARG < 0 go backwards. | |
bbd240ce | 2460 | Returns non-nil if successful." |
f32b3b91 CD |
2461 | (interactive "p") |
2462 | (let (status) | |
2463 | (if (< arg 0) | |
2464 | ;; Backward | |
2465 | (let ((eos (save-excursion | |
2466 | (idlwave-block-jump-out -1 'nomark) | |
2467 | (point)))) | |
4b1aaa8b | 2468 | (if (setq status (idlwave-find-key |
f32b3b91 CD |
2469 | idlwave-end-block-reg -1 'nomark eos)) |
2470 | (idlwave-beginning-of-statement) | |
2471 | (message "No nested block before beginning of containing block."))) | |
2472 | ;; Forward | |
2473 | (let ((eos (save-excursion | |
2474 | (idlwave-block-jump-out 1 'nomark) | |
2475 | (point)))) | |
4b1aaa8b | 2476 | (if (setq status (idlwave-find-key |
f32b3b91 CD |
2477 | idlwave-begin-block-reg 1 'nomark eos)) |
2478 | (idlwave-end-of-statement) | |
2479 | (message "No nested block before end of containing block.")))) | |
2480 | status)) | |
2481 | ||
2482 | (defun idlwave-mark-doclib () | |
2483 | "Put point at beginning of doc library header, mark at end. | |
2484 | The marks are pushed." | |
2485 | (interactive) | |
2486 | (let (beg | |
2487 | (here (point))) | |
2488 | (goto-char (point-max)) | |
2489 | (if (re-search-backward idlwave-doclib-start nil t) | |
4b1aaa8b | 2490 | (progn |
f32b3b91 CD |
2491 | (setq beg (progn (beginning-of-line) (point))) |
2492 | (if (re-search-forward idlwave-doclib-end nil t) | |
2493 | (progn | |
2494 | (forward-line 1) | |
0dc2be2f | 2495 | (push-mark beg nil t) |
f32b3b91 CD |
2496 | (message "Could not find end of doc library header."))) |
2497 | (message "Could not find doc library header start.") | |
2498 | (goto-char here))))) | |
2499 | ||
e08734e2 S |
2500 | (defun idlwave-current-routine-fullname () |
2501 | (let ((name (idlwave-current-routine))) | |
2502 | (idlwave-make-full-name (nth 2 name) (car name)))) | |
2503 | ||
15e42531 CD |
2504 | (defun idlwave-current-routine () |
2505 | "Return (NAME TYPE CLASS) of current routine." | |
2506 | (idlwave-routines) | |
2507 | (save-excursion | |
cca13260 | 2508 | (idlwave-beginning-of-subprogram 'nomark) |
15e42531 CD |
2509 | (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)") |
2510 | (let* ((type (if (string= (downcase (match-string 1)) "pro") | |
2511 | 'pro 'function)) | |
2512 | (class (idlwave-sintern-class (match-string 3))) | |
2513 | (name (idlwave-sintern-routine-or-method (match-string 4) class))) | |
2514 | (list name type class))))) | |
2515 | ||
f32b3b91 CD |
2516 | (defvar idlwave-shell-prompt-pattern) |
2517 | (defun idlwave-beginning-of-statement () | |
2518 | "Move to beginning of the current statement. | |
2519 | Skips back past statement continuations. | |
2520 | Point is placed at the beginning of the line whether or not this is an | |
2521 | actual statement." | |
2522 | (interactive) | |
2523 | (cond | |
175069ef | 2524 | ((derived-mode-p 'idlwave-shell-mode) |
f32b3b91 CD |
2525 | (if (re-search-backward idlwave-shell-prompt-pattern nil t) |
2526 | (goto-char (match-end 0)))) | |
4b1aaa8b | 2527 | (t |
f32b3b91 CD |
2528 | (if (save-excursion (forward-line -1) (idlwave-is-continuation-line)) |
2529 | (idlwave-previous-statement) | |
2530 | (beginning-of-line))))) | |
2531 | ||
2532 | (defun idlwave-previous-statement () | |
5a0c3f56 | 2533 | "Move point to beginning of the previous statement. |
f32b3b91 CD |
2534 | Returns t if the current line before moving is the beginning of |
2535 | the first non-comment statement in the file, and nil otherwise." | |
2536 | (interactive) | |
2537 | (let (first-statement) | |
2538 | (if (not (= (forward-line -1) 0)) | |
2539 | ;; first line in file | |
2540 | t | |
2541 | ;; skip blank lines, label lines, include lines and line comments | |
2542 | (while (and | |
2543 | ;; The current statement is the first statement until we | |
2544 | ;; reach another statement. | |
2545 | (setq first-statement | |
2546 | (or | |
2547 | (looking-at idlwave-comment-line-start-skip) | |
2548 | (looking-at "[ \t]*$") | |
2549 | (looking-at (concat "[ \t]*" idlwave-label "[ \t]*$")) | |
2550 | (looking-at "^@"))) | |
2551 | (= (forward-line -1) 0))) | |
2552 | ;; skip continuation lines | |
2553 | (while (and | |
2554 | (save-excursion | |
2555 | (forward-line -1) | |
2556 | (idlwave-is-continuation-line)) | |
2557 | (= (forward-line -1) 0))) | |
2558 | first-statement))) | |
2559 | ||
f32b3b91 | 2560 | (defun idlwave-end-of-statement () |
5a0c3f56 | 2561 | "Move point to the end of the current IDL statement. |
05a1abfc CD |
2562 | If not in a statement just moves to end of line. Returns position." |
2563 | (interactive) | |
2564 | (while (and (idlwave-is-continuation-line) | |
2565 | (= (forward-line 1) 0)) | |
2566 | (while (and (idlwave-is-comment-or-empty-line) | |
2567 | (= (forward-line 1) 0)))) | |
2568 | (end-of-line) | |
2569 | (point)) | |
2570 | ||
2571 | (defun idlwave-end-of-statement0 () | |
5a0c3f56 JB |
2572 | "Move point to the end of the current IDL statement. |
2573 | If not in a statement just moves to end of line. Returns position." | |
f32b3b91 CD |
2574 | (interactive) |
2575 | (while (and (idlwave-is-continuation-line) | |
2576 | (= (forward-line 1) 0))) | |
2577 | (end-of-line) | |
2578 | (point)) | |
2579 | ||
2580 | (defun idlwave-next-statement () | |
5a0c3f56 JB |
2581 | "Move point to beginning of the next IDL statement. |
2582 | Returns t if that statement is the last non-comment IDL statement | |
2583 | in the file, and nil otherwise." | |
f32b3b91 CD |
2584 | (interactive) |
2585 | (let (last-statement) | |
2586 | (idlwave-end-of-statement) | |
2587 | ;; skip blank lines, label lines, include lines and line comments | |
2588 | (while (and (= (forward-line 1) 0) | |
2589 | ;; The current statement is the last statement until | |
2590 | ;; we reach a new statement. | |
2591 | (setq last-statement | |
2592 | (or | |
2593 | (looking-at idlwave-comment-line-start-skip) | |
2594 | (looking-at "[ \t]*$") | |
2595 | (looking-at (concat "[ \t]*" idlwave-label "[ \t]*$")) | |
2596 | (looking-at "^@"))))) | |
2597 | last-statement)) | |
2598 | ||
76959b77 S |
2599 | (defun idlwave-skip-multi-commands (&optional lim) |
2600 | "Skip past multiple commands on a line (with `&')." | |
2601 | (let ((save-point (point))) | |
2602 | (when (re-search-forward ".*&" lim t) | |
2603 | (goto-char (match-end 0)) | |
4b1aaa8b | 2604 | (if (idlwave-quoted) |
6b75c9af S |
2605 | (goto-char save-point) |
2606 | (if (eq (char-after (- (point) 2)) ?&) (goto-char save-point)))) | |
76959b77 S |
2607 | (point))) |
2608 | ||
15e42531 | 2609 | (defun idlwave-skip-label-or-case () |
f32b3b91 CD |
2610 | "Skip label or case statement element. |
2611 | Returns position after label. | |
2612 | If there is no label point is not moved and nil is returned." | |
15e42531 CD |
2613 | ;; Case expressions and labels are terminated by a colon. |
2614 | ;; So we find the first colon in the line and make sure | |
2615 | ;; - no `?' is before it (might be a ? b : c) | |
2616 | ;; - it is not in a comment | |
2617 | ;; - not in a string constant | |
2618 | ;; - not in parenthesis (like a[0:3]) | |
5e72c6b2 | 2619 | ;; - not followed by another ":" in explicit class, ala a->b::c |
15e42531 | 2620 | ;; As many in this mode, this function is heuristic and not an exact |
4b1aaa8b | 2621 | ;; parser. |
5e72c6b2 S |
2622 | (let* ((start (point)) |
2623 | (eos (save-excursion (idlwave-end-of-statement) (point))) | |
2624 | (end (idlwave-find-key ":" 1 'nomark eos))) | |
f32b3b91 | 2625 | (if (and end |
15e42531 | 2626 | (= (nth 0 (parse-partial-sexp start end)) 0) |
5e72c6b2 S |
2627 | (not (string-match "\\?" (buffer-substring start end))) |
2628 | (not (string-match "^::" (buffer-substring end eos)))) | |
f32b3b91 CD |
2629 | (progn |
2630 | (forward-char) | |
2631 | (point)) | |
2632 | (goto-char start) | |
2633 | nil))) | |
2634 | ||
2635 | (defun idlwave-start-of-substatement (&optional pre) | |
2636 | "Move to start of next IDL substatement after point. | |
2637 | Uses the type of the current IDL statement to determine if the next | |
2638 | statement is on a new line or is a subpart of the current statement. | |
2639 | Returns point at start of substatement modulo whitespace. | |
2640 | If optional argument is non-nil move to beginning of current | |
15e42531 | 2641 | substatement." |
f32b3b91 CD |
2642 | (let ((orig (point)) |
2643 | (eos (idlwave-end-of-statement)) | |
2644 | (ifnest 0) | |
2645 | st nst last) | |
2646 | (idlwave-beginning-of-statement) | |
15e42531 | 2647 | (idlwave-skip-label-or-case) |
52a244eb S |
2648 | (if (< (point) orig) |
2649 | (idlwave-skip-multi-commands orig)) | |
f32b3b91 CD |
2650 | (setq last (point)) |
2651 | ;; Continue looking for substatements until we are past orig | |
2652 | (while (and (<= (point) orig) (not (eobp))) | |
2653 | (setq last (point)) | |
2654 | (setq nst (nth 1 (cdr (setq st (car (idlwave-statement-type)))))) | |
2655 | (if (equal (car st) 'if) (setq ifnest (1+ ifnest))) | |
2656 | (cond ((and nst | |
2657 | (idlwave-find-key nst 1 'nomark eos)) | |
2658 | (goto-char (match-end 0))) | |
2659 | ((and (> ifnest 0) (idlwave-find-key "\\<else\\>" 1 'nomark eos)) | |
2660 | (setq ifnest (1- ifnest)) | |
2661 | (goto-char (match-end 0))) | |
2662 | (t (setq ifnest 0) | |
2663 | (idlwave-next-statement)))) | |
2664 | (if pre (goto-char last)) | |
15e42531 CD |
2665 | ;; If a continuation line starts here, move to next line |
2666 | (if (looking-at "[ \t]*\\$\\([ \t]*\\(;\\|$\\)\\)") | |
2667 | (beginning-of-line 2)) | |
f32b3b91 CD |
2668 | (point))) |
2669 | ||
2670 | (defun idlwave-statement-type () | |
2671 | "Return the type of the current IDL statement. | |
2672 | Uses `idlwave-statement-match' to return a cons of (type . point) with | |
5a0c3f56 | 2673 | point the ending position where the type was determined. Type is the |
f32b3b91 | 2674 | association from `idlwave-statement-match', i.e. the cons cell from the |
5a0c3f56 | 2675 | list not just the type symbol. Returns nil if not an identifiable |
f32b3b91 CD |
2676 | statement." |
2677 | (save-excursion | |
2678 | ;; Skip whitespace within a statement which is spaces, tabs, continuations | |
76959b77 S |
2679 | ;; and possibly comments |
2680 | (while (looking-at "[ \t]*\\$") | |
f32b3b91 CD |
2681 | (forward-line 1)) |
2682 | (skip-chars-forward " \t") | |
2683 | (let ((st idlwave-statement-match) | |
2684 | (case-fold-search t)) | |
2685 | (while (and (not (looking-at (nth 0 (cdr (car st))))) | |
2686 | (setq st (cdr st)))) | |
2687 | (if st | |
2688 | (append st (match-end 0)))))) | |
2689 | ||
f66f03de | 2690 | (defun idlwave-expand-equal (&optional before after is-action) |
5a0c3f56 JB |
2691 | "Pad '=' with spaces. |
2692 | Two cases: Assignment statement, and keyword assignment. | |
2693 | Which case is determined using `idlwave-start-of-substatement' and | |
2694 | `idlwave-statement-type'. The equal sign will be surrounded by BEFORE | |
2695 | and AFTER blanks. If `idlwave-pad-keyword' is t then keyword assignment | |
2696 | is treated just like assignment statements. When nil, spaces are | |
2697 | removed for keyword assignment. Any other value keeps the current space | |
2698 | around the `='. Limits in for loops are treated as keyword assignment. | |
52a244eb S |
2699 | |
2700 | Starting with IDL 6.0, a number of op= assignments are available. | |
2701 | Since ambiguities of the form: | |
2702 | ||
2703 | r and= b | |
2704 | rand= b | |
2705 | ||
2706 | can occur, alphanumeric operator assignment will never be pre-padded, | |
2707 | only post-padded. You must use a space before these to disambiguate | |
2708 | \(not just for padding, but for proper parsing by IDL too!). Other | |
2709 | operators, such as ##=, ^=, etc., will be pre-padded. | |
2710 | ||
f66f03de S |
2711 | IS-ACTION is ignored. |
2712 | ||
52a244eb | 2713 | See `idlwave-surround'." |
f32b3b91 | 2714 | (if idlwave-surround-by-blank |
4b1aaa8b | 2715 | (let |
52a244eb | 2716 | ((non-an-ops "\\(##\\|\\*\\|\\+\\|-\\|/\\|<\\|>\\|\\^\\)\\=") |
4b1aaa8b | 2717 | (an-ops |
52a244eb S |
2718 | "\\s-\\(AND\\|EQ\\|GE\\|GT\\|LE\\|LT\\|MOD\\|NE\\|OR\\|XOR\\)\\=") |
2719 | (len 1)) | |
4b1aaa8b PE |
2720 | |
2721 | (save-excursion | |
52a244eb S |
2722 | (let ((case-fold-search t)) |
2723 | (backward-char) | |
4b1aaa8b | 2724 | (if (or |
52a244eb S |
2725 | (re-search-backward non-an-ops nil t) |
2726 | ;; Why doesn't ##? work for both? | |
4b1aaa8b | 2727 | (re-search-backward "\\(#\\)\\=" nil t)) |
52a244eb S |
2728 | (setq len (1+ (length (match-string 1)))) |
2729 | (when (re-search-backward an-ops nil t) | |
3938cb82 | 2730 | ;(setq begin nil) ; won't modify begin |
52a244eb | 2731 | (setq len (1+ (length (match-string 1)))))))) |
4b1aaa8b PE |
2732 | |
2733 | (if (eq t idlwave-pad-keyword) | |
52a244eb | 2734 | ;; Everything gets padded equally |
f66f03de | 2735 | (idlwave-surround before after len) |
52a244eb S |
2736 | ;; Treating keywords/for variables specially... |
2737 | (let ((st (save-excursion ; To catch "for" variables | |
2738 | (idlwave-start-of-substatement t) | |
2739 | (idlwave-statement-type))) | |
2740 | (what (save-excursion ; To catch keywords | |
2741 | (skip-chars-backward "= \t") | |
2742 | (nth 2 (idlwave-where))))) | |
2743 | (cond ((or (memq what '(function-keyword procedure-keyword)) | |
4b1aaa8b PE |
2744 | (memq (caar st) '(for pdef))) |
2745 | (cond | |
52a244eb S |
2746 | ((null idlwave-pad-keyword) |
2747 | (idlwave-surround 0 0) | |
2748 | ) ; remove space | |
2749 | (t))) ; leave any spaces alone | |
f66f03de | 2750 | (t (idlwave-surround before after len)))))))) |
4b1aaa8b | 2751 | |
f32b3b91 | 2752 | |
5e72c6b2 S |
2753 | (defun idlwave-indent-and-action (&optional arg) |
2754 | "Call `idlwave-indent-line' and do expand actions. | |
2755 | With prefix ARG non-nil, indent the entire sub-statement." | |
2756 | (interactive "p") | |
05a1abfc | 2757 | (save-excursion |
4b1aaa8b PE |
2758 | (if (and idlwave-expand-generic-end |
2759 | (re-search-backward "\\<\\(end\\)\\s-*\\=" | |
05a1abfc CD |
2760 | (max 0 (- (point) 10)) t) |
2761 | (looking-at "\\(end\\)\\([ \n\t]\\|\\'\\)")) | |
2762 | (progn (goto-char (match-end 1)) | |
5e72c6b2 S |
2763 | ;;Expand the END abbreviation, just as RET or Space would have. |
2764 | (if abbrev-mode (expand-abbrev) | |
2765 | (idlwave-show-begin))))) | |
52a244eb S |
2766 | (when (and (not arg) current-prefix-arg) |
2767 | (setq arg current-prefix-arg) | |
2768 | (setq current-prefix-arg nil)) | |
4b1aaa8b | 2769 | (if arg |
5e72c6b2 S |
2770 | (idlwave-indent-statement) |
2771 | (idlwave-indent-line t))) | |
f32b3b91 CD |
2772 | |
2773 | (defun idlwave-indent-line (&optional expand) | |
5a0c3f56 | 2774 | "Indent current IDL line as code or as a comment. |
f32b3b91 CD |
2775 | The actions in `idlwave-indent-action-table' are performed. |
2776 | If the optional argument EXPAND is non-nil then the actions in | |
2777 | `idlwave-indent-expand-table' are performed." | |
2778 | (interactive) | |
2779 | ;; Move point out of left margin. | |
2780 | (if (save-excursion | |
2781 | (skip-chars-backward " \t") | |
2782 | (bolp)) | |
2783 | (skip-chars-forward " \t")) | |
2784 | (let ((mloc (point-marker))) | |
2785 | (save-excursion | |
2786 | (beginning-of-line) | |
2787 | (if (looking-at idlwave-comment-line-start-skip) | |
2788 | ;; Indentation for a line comment | |
2789 | (progn | |
2790 | (skip-chars-forward " \t") | |
2791 | (idlwave-indent-left-margin (idlwave-comment-hook))) | |
2792 | ;; | |
2793 | ;; Code Line | |
2794 | ;; | |
2795 | ;; Before indenting, run action routines. | |
2796 | ;; | |
2797 | (if (and expand idlwave-do-actions) | |
8ffcfb27 | 2798 | (mapc 'idlwave-do-action idlwave-indent-expand-table)) |
f32b3b91 CD |
2799 | ;; |
2800 | (if idlwave-do-actions | |
8ffcfb27 | 2801 | (mapc 'idlwave-do-action idlwave-indent-action-table)) |
f32b3b91 CD |
2802 | ;; |
2803 | ;; No longer expand abbrevs on the line. The user can do this | |
2804 | ;; manually using expand-region-abbrevs. | |
2805 | ;; | |
2806 | ;; Indent for code line | |
2807 | ;; | |
2808 | (beginning-of-line) | |
2809 | (if (or | |
2810 | ;; a label line | |
2811 | (looking-at (concat "^" idlwave-label "[ \t]*$")) | |
2812 | ;; a batch command | |
2813 | (looking-at "^[ \t]*@")) | |
2814 | ;; leave flush left | |
2815 | nil | |
2816 | ;; indent the line | |
2817 | (idlwave-indent-left-margin (idlwave-calculate-indent))) | |
2818 | ;; Adjust parallel comment | |
76959b77 S |
2819 | (end-of-line) |
2820 | (if (idlwave-in-comment) | |
2821 | ;; Emacs 21 is too smart with fill-column on comment indent | |
2822 | (let ((fill-column (if (fboundp 'comment-indent-new-line) | |
2823 | (1- (frame-width)) | |
2824 | fill-column))) | |
2825 | (indent-for-comment))))) | |
f32b3b91 CD |
2826 | (goto-char mloc) |
2827 | ;; Get rid of marker | |
76959b77 | 2828 | (set-marker mloc nil))) |
f32b3b91 CD |
2829 | |
2830 | (defun idlwave-do-action (action) | |
5a0c3f56 JB |
2831 | "Perform an action repeatedly on a line. |
2832 | ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is | |
2833 | either a function name to be called with `funcall' or a list to be | |
2834 | evaluated with `eval'. The action performed by FUNC should leave | |
2835 | point after the match for REG - otherwise an infinite loop may be | |
2836 | entered. FUNC is always passed a final argument of 'is-action, so it | |
2837 | can discriminate between being run as an action, or a key binding." | |
f32b3b91 CD |
2838 | (let ((action-key (car action)) |
2839 | (action-routine (cdr action))) | |
2840 | (beginning-of-line) | |
2841 | (while (idlwave-look-at action-key) | |
2842 | (if (listp action-routine) | |
f66f03de S |
2843 | (eval (append action-routine '('is-action))) |
2844 | (funcall action-routine 'is-action))))) | |
f32b3b91 CD |
2845 | |
2846 | (defun idlwave-indent-to (col &optional min) | |
2847 | "Indent from point with spaces until column COL. | |
2848 | Inserts space before markers at point." | |
2849 | (if (not min) (setq min 0)) | |
2850 | (insert-before-markers | |
15e42531 | 2851 | (make-string (max min (- col (current-column))) ?\ ))) |
f32b3b91 CD |
2852 | |
2853 | (defun idlwave-indent-left-margin (col) | |
2854 | "Indent the current line to column COL. | |
2855 | Indents such that first non-whitespace character is at column COL | |
2856 | Inserts spaces before markers at point." | |
2857 | (save-excursion | |
2858 | (beginning-of-line) | |
2859 | (delete-horizontal-space) | |
2860 | (idlwave-indent-to col))) | |
2861 | ||
2862 | (defun idlwave-indent-subprogram () | |
5a0c3f56 | 2863 | "Indent program unit which contains point." |
f32b3b91 CD |
2864 | (interactive) |
2865 | (save-excursion | |
2866 | (idlwave-end-of-statement) | |
2867 | (idlwave-beginning-of-subprogram) | |
2868 | (let ((beg (point))) | |
2869 | (idlwave-forward-block) | |
2870 | (message "Indenting subprogram...") | |
2871 | (indent-region beg (point) nil)) | |
2872 | (message "Indenting subprogram...done."))) | |
2873 | ||
5e72c6b2 S |
2874 | (defun idlwave-indent-statement () |
2875 | "Indent current statement, including all continuation lines." | |
2876 | (interactive) | |
2877 | (save-excursion | |
2878 | (idlwave-beginning-of-statement) | |
2879 | (let ((beg (point))) | |
2880 | (idlwave-end-of-statement) | |
2881 | (indent-region beg (point) nil)))) | |
2882 | ||
f32b3b91 CD |
2883 | (defun idlwave-calculate-indent () |
2884 | "Return appropriate indentation for current line as IDL code." | |
2885 | (save-excursion | |
2886 | (beginning-of-line) | |
2887 | (cond | |
2888 | ;; Check for beginning of unit - main (beginning of buffer), pro, or | |
2889 | ;; function | |
2890 | ((idlwave-look-at idlwave-begin-unit-reg) | |
2891 | 0) | |
2892 | ;; Check for continuation line | |
2893 | ((save-excursion | |
2894 | (and (= (forward-line -1) 0) | |
2895 | (idlwave-is-continuation-line))) | |
2896 | (idlwave-calculate-cont-indent)) | |
2897 | ;; calculate indent based on previous and current statements | |
52a244eb S |
2898 | (t (let* (beg-prev-pos |
2899 | (the-indent | |
2900 | ;; calculate indent based on previous statement | |
2901 | (save-excursion | |
2902 | (cond | |
2903 | ;; Beginning of file | |
4b1aaa8b | 2904 | ((prog1 |
52a244eb S |
2905 | (idlwave-previous-statement) |
2906 | (setq beg-prev-pos (point))) | |
2907 | 0) | |
2908 | ;; Main block | |
2909 | ((idlwave-look-at idlwave-begin-unit-reg t) | |
2910 | (+ (idlwave-current-statement-indent) | |
2911 | idlwave-main-block-indent)) | |
2912 | ;; Begin block | |
2913 | ((idlwave-look-at idlwave-begin-block-reg t) | |
4b1aaa8b | 2914 | (+ (idlwave-min-current-statement-indent) |
52a244eb S |
2915 | idlwave-block-indent)) |
2916 | ;; End Block | |
2917 | ((idlwave-look-at idlwave-end-block-reg t) | |
2918 | (progn | |
2919 | ;; Match to the *beginning* of the block opener | |
2920 | (goto-char beg-prev-pos) | |
2921 | (idlwave-block-jump-out -1 'nomark) ; go to begin block | |
2922 | (idlwave-min-current-statement-indent))) | |
2923 | ;; idlwave-end-offset | |
2924 | ;; idlwave-block-indent)) | |
4b1aaa8b | 2925 | |
52a244eb S |
2926 | ;; Default to current indent |
2927 | ((idlwave-current-statement-indent)))))) | |
f32b3b91 CD |
2928 | ;; adjust the indentation based on the current statement |
2929 | (cond | |
2930 | ;; End block | |
5e72c6b2 S |
2931 | ((idlwave-look-at idlwave-end-block-reg) |
2932 | (+ the-indent idlwave-end-offset)) | |
f32b3b91 CD |
2933 | (the-indent))))))) |
2934 | ||
2935 | ;; | |
52a244eb | 2936 | ;; Parentheses indent |
f32b3b91 CD |
2937 | ;; |
2938 | ||
5e72c6b2 S |
2939 | (defun idlwave-calculate-paren-indent (beg-reg end-reg close-exp) |
2940 | "Calculate the continuation indent inside a paren group. | |
4b1aaa8b | 2941 | Returns a cons-cell with (open . indent), where open is the |
5a0c3f56 | 2942 | location of the open paren." |
5e72c6b2 S |
2943 | (let ((open (nth 1 (parse-partial-sexp beg-reg end-reg)))) |
2944 | ;; Found an innermost open paren. | |
2945 | (when open | |
2946 | (goto-char open) | |
2947 | ;; Line up with next word unless this is a closing paren. | |
2948 | (cons open | |
2949 | (cond | |
52a244eb S |
2950 | ;; Plain Kernighan-style nested indent |
2951 | (idlwave-indent-parens-nested | |
2952 | (+ idlwave-continuation-indent (idlwave-current-indent))) | |
2953 | ||
5e72c6b2 S |
2954 | ;; This is a closed paren - line up under open paren. |
2955 | (close-exp | |
2956 | (current-column)) | |
52a244eb S |
2957 | |
2958 | ;; Empty (or just comment) follows -- revert to basic indent | |
5e72c6b2 S |
2959 | ((progn |
2960 | ;; Skip paren | |
2961 | (forward-char 1) | |
2962 | (looking-at "[ \t$]*\\(;.*\\)?$")) | |
52a244eb S |
2963 | nil) |
2964 | ||
2965 | ;; Line up with first word after any blank space | |
5e72c6b2 S |
2966 | ((progn |
2967 | (skip-chars-forward " \t") | |
2968 | (current-column)))))))) | |
2969 | ||
f32b3b91 | 2970 | (defun idlwave-calculate-cont-indent () |
5a0c3f56 JB |
2971 | "Calculates the IDL continuation indent column from the previous statement. |
2972 | Note that here previous statement usually means the beginning of the | |
2973 | current statement if this statement is a continuation of the previous | |
2974 | line. Various special types of continuations, including assignments, | |
2975 | routine definitions, and parenthetical groupings, are treated separately." | |
f32b3b91 | 2976 | (save-excursion |
52a244eb | 2977 | (let* ((case-fold-search t) |
f32b3b91 | 2978 | (end-reg (progn (beginning-of-line) (point))) |
52a244eb S |
2979 | (beg-last-statement (save-excursion (idlwave-previous-statement) |
2980 | (point))) | |
4b1aaa8b | 2981 | (beg-reg (progn (idlwave-start-of-substatement 'pre) |
52a244eb S |
2982 | (if (eq (line-beginning-position) end-reg) |
2983 | (goto-char beg-last-statement) | |
2984 | (point)))) | |
2985 | (basic-indent (+ (idlwave-min-current-statement-indent end-reg) | |
2986 | idlwave-continuation-indent)) | |
2987 | fancy-nonparen-indent fancy-paren-indent) | |
4b1aaa8b | 2988 | (cond |
52a244eb S |
2989 | ;; Align then with its matching if, etc. |
2990 | ((let ((matchers '(("\\<if\\>" . "[ \t]*then") | |
2991 | ("\\<\\(if\\|end\\(if\\)?\\)\\>" . "[ \t]*else") | |
2992 | ("\\<\\(for\\|while\\)\\>" . "[ \t]*do") | |
4b1aaa8b | 2993 | ("\\<\\(repeat\\|end\\(rep\\)?\\)\\>" . |
52a244eb S |
2994 | "[ \t]*until") |
2995 | ("\\<case\\>" . "[ \t]*of"))) | |
2996 | match cont-re) | |
2997 | (goto-char end-reg) | |
4b1aaa8b | 2998 | (and |
52a244eb S |
2999 | (setq cont-re |
3000 | (catch 'exit | |
3001 | (while (setq match (car matchers)) | |
3002 | (if (looking-at (cdr match)) | |
3003 | (throw 'exit (car match))) | |
3004 | (setq matchers (cdr matchers))))) | |
3005 | (idlwave-find-key cont-re -1 'nomark beg-last-statement))) | |
3006 | (if (looking-at "end") ;; that one's special | |
4b1aaa8b | 3007 | (- (idlwave-current-indent) |
52a244eb S |
3008 | (+ idlwave-block-indent idlwave-end-offset)) |
3009 | (idlwave-current-indent))) | |
3010 | ||
3011 | ;; Indent in from the previous line for continuing statements | |
3012 | ((let ((matchers '("\\<then\\>" | |
3013 | "\\<do\\>" | |
3014 | "\\<repeat\\>" | |
3015 | "\\<else\\>")) | |
3016 | match) | |
3017 | (catch 'exit | |
3018 | (goto-char end-reg) | |
3019 | (if (/= (forward-line -1) 0) | |
3020 | (throw 'exit nil)) | |
3021 | (while (setq match (car matchers)) | |
3022 | (if (looking-at (concat ".*" match "[ \t]*\\$[ \t]*" | |
3023 | "\\(;.*\\)?$")) | |
3024 | (throw 'exit t)) | |
3025 | (setq matchers (cdr matchers))))) | |
3026 | (+ idlwave-continuation-indent (idlwave-current-indent))) | |
3027 | ||
3028 | ;; Parenthetical indent, either traditional or Kernighan style | |
3029 | ((setq fancy-paren-indent | |
3030 | (let* ((end-reg end-reg) | |
3031 | (close-exp (progn | |
3032 | (goto-char end-reg) | |
4b1aaa8b | 3033 | (skip-chars-forward " \t") |
52a244eb S |
3034 | (looking-at "\\s)"))) |
3035 | indent-cons) | |
3036 | (catch 'loop | |
3037 | (while (setq indent-cons (idlwave-calculate-paren-indent | |
3038 | beg-reg end-reg close-exp)) | |
3039 | ;; First permitted containing paren | |
3040 | (if (or | |
3041 | idlwave-indent-to-open-paren | |
3042 | idlwave-indent-parens-nested | |
3043 | (null (cdr indent-cons)) | |
3044 | (< (- (cdr indent-cons) basic-indent) | |
3045 | idlwave-max-extra-continuation-indent)) | |
3046 | (throw 'loop (cdr indent-cons))) | |
3047 | (setq end-reg (car indent-cons)))))) | |
5e72c6b2 S |
3048 | fancy-paren-indent) |
3049 | ||
52a244eb S |
3050 | ;; A continued assignment, or procedure call/definition |
3051 | ((and | |
3052 | (> idlwave-max-extra-continuation-indent 0) | |
3053 | (setq fancy-nonparen-indent | |
3054 | (progn | |
3055 | (goto-char beg-reg) | |
3056 | (while (idlwave-look-at "&")) ; skip continued statements | |
3057 | (cond | |
3058 | ;; A continued Procedure call or definition | |
3059 | ((progn | |
3060 | (idlwave-look-at "^[ \t]*\\(pro\\|function\\)") ;skip over | |
3061 | (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*")) | |
3062 | (goto-char (match-end 0)) | |
3063 | ;; Comment only, or blank line with "$"? Basic indent. | |
3064 | (if (save-match-data (looking-at "[ \t$]*\\(;.*\\)?$")) | |
3065 | nil | |
3066 | (current-column))) | |
4b1aaa8b | 3067 | |
52a244eb S |
3068 | ;; Continued assignment (with =): |
3069 | ((catch 'assign ; | |
3070 | (while (looking-at "[^=\n\r]*\\(=\\)[ \t]*") | |
3071 | (goto-char (match-end 0)) | |
4b1aaa8b | 3072 | (if (null (idlwave-what-function beg-reg)) |
52a244eb S |
3073 | (throw 'assign t)))) |
3074 | (unless (or | |
3075 | (idlwave-in-quote) | |
3076 | (looking-at "[ \t$]*\\(;.*\\)?$") ; use basic | |
3077 | (save-excursion | |
3078 | (goto-char beg-last-statement) | |
3079 | (eq (caar (idlwave-statement-type)) 'for))) | |
3080 | (current-column)))))) | |
3081 | (< (- fancy-nonparen-indent basic-indent) | |
3082 | idlwave-max-extra-continuation-indent)) | |
3083 | (if fancy-paren-indent ;calculated but disallowed paren indent | |
3084 | (+ fancy-nonparen-indent idlwave-continuation-indent) | |
3085 | fancy-nonparen-indent)) | |
3086 | ||
3087 | ;; Basic indent, by default | |
3088 | (t basic-indent))))) | |
3089 | ||
3090 | ||
f32b3b91 | 3091 | |
15e42531 CD |
3092 | (defun idlwave-find-key (key-re &optional dir nomark limit) |
3093 | "Move to next match of the regular expression KEY-RE. | |
3094 | Matches inside comments or string constants will be ignored. | |
3095 | If DIR is negative, the search will be backwards. | |
3096 | At a successful match, the mark is pushed unless NOMARK is non-nil. | |
3097 | Searches are limited to LIMIT. | |
3098 | Searches are case-insensitive and use a special syntax table which | |
3099 | treats `$' and `_' as word characters. | |
3100 | Return value is the beginning of the match or (in case of failure) nil." | |
3101 | (setq dir (or dir 0)) | |
3102 | (let ((case-fold-search t) | |
3103 | (search-func (if (> dir 0) 're-search-forward 're-search-backward)) | |
3104 | found) | |
3105 | (idlwave-with-special-syntax | |
3106 | (save-excursion | |
3107 | (catch 'exit | |
3108 | (while (funcall search-func key-re limit t) | |
3109 | (if (not (idlwave-quoted)) | |
52a244eb S |
3110 | (throw 'exit (setq found (match-beginning 0))) |
3111 | (if (or (and (> dir 0) (eobp)) | |
3112 | (and (< dir 0) (bobp))) | |
3113 | (throw 'exit nil))))))) | |
15e42531 CD |
3114 | (if found |
3115 | (progn | |
3116 | (if (not nomark) (push-mark)) | |
3117 | (goto-char found) | |
3118 | found) | |
3119 | nil))) | |
3120 | ||
f32b3b91 CD |
3121 | (defun idlwave-block-jump-out (&optional dir nomark) |
3122 | "When optional argument DIR is non-negative, move forward to end of | |
3123 | current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg' | |
5a0c3f56 JB |
3124 | regular expressions. When DIR is negative, move backwards to block beginning. |
3125 | Recursively calls itself to skip over nested blocks. DIR defaults to | |
3126 | forward. Calls `push-mark' unless the optional argument NOMARK is | |
3127 | non-nil. Movement is limited by the start of program units because of | |
f32b3b91 CD |
3128 | possibility of unbalanced blocks." |
3129 | (interactive "P") | |
3130 | (or dir (setq dir 0)) | |
3131 | (let* ((here (point)) | |
3132 | (case-fold-search t) | |
3133 | (limit (if (>= dir 0) (point-max) (point-min))) | |
4b1aaa8b | 3134 | (block-limit (if (>= dir 0) |
f32b3b91 CD |
3135 | idlwave-begin-block-reg |
3136 | idlwave-end-block-reg)) | |
3137 | found | |
3138 | (block-reg (concat idlwave-begin-block-reg "\\|" | |
3139 | idlwave-end-block-reg)) | |
3140 | (unit-limit (or (save-excursion | |
3141 | (if (< dir 0) | |
3142 | (idlwave-find-key | |
3143 | idlwave-begin-unit-reg dir t limit) | |
3144 | (end-of-line) | |
4b1aaa8b | 3145 | (idlwave-find-key |
f32b3b91 CD |
3146 | idlwave-end-unit-reg dir t limit))) |
3147 | limit))) | |
3148 | (if (>= dir 0) (end-of-line)) ;Make sure we are in current block | |
3149 | (if (setq found (idlwave-find-key block-reg dir t unit-limit)) | |
3150 | (while (and found (looking-at block-limit)) | |
3151 | (if (>= dir 0) (forward-word 1)) | |
3152 | (idlwave-block-jump-out dir t) | |
3153 | (setq found (idlwave-find-key block-reg dir t unit-limit)))) | |
3154 | (if (not nomark) (push-mark here)) | |
3155 | (if (not found) (goto-char unit-limit) | |
3156 | (if (>= dir 0) (forward-word 1))))) | |
3157 | ||
52a244eb S |
3158 | (defun idlwave-min-current-statement-indent (&optional end-reg) |
3159 | "The minimum indent in the current statement." | |
3160 | (idlwave-beginning-of-statement) | |
3161 | (if (not (idlwave-is-continuation-line)) | |
3162 | (idlwave-current-indent) | |
3163 | (let ((min (idlwave-current-indent)) comm-or-empty) | |
3164 | (while (and (= (forward-line 1) 0) | |
3165 | (or (setq comm-or-empty (idlwave-is-comment-or-empty-line)) | |
3166 | (idlwave-is-continuation-line)) | |
3167 | (or (null end-reg) (< (point) end-reg))) | |
3168 | (unless comm-or-empty (setq min (min min (idlwave-current-indent))))) | |
3169 | (if (or comm-or-empty (and end-reg (>= (point) end-reg))) | |
4b1aaa8b | 3170 | min |
52a244eb S |
3171 | (min min (idlwave-current-indent)))))) |
3172 | ||
3173 | (defun idlwave-current-statement-indent (&optional last-line) | |
f32b3b91 CD |
3174 | "Return indentation of the current statement. |
3175 | If in a statement, moves to beginning of statement before finding indent." | |
52a244eb S |
3176 | (if last-line |
3177 | (idlwave-end-of-statement) | |
3178 | (idlwave-beginning-of-statement)) | |
f32b3b91 CD |
3179 | (idlwave-current-indent)) |
3180 | ||
3181 | (defun idlwave-current-indent () | |
3182 | "Return the column of the indentation of the current line. | |
5a0c3f56 | 3183 | Skips any whitespace. Returns 0 if the end-of-line follows the whitespace." |
f32b3b91 CD |
3184 | (save-excursion |
3185 | (beginning-of-line) | |
3186 | (skip-chars-forward " \t") | |
3187 | ;; if we are at the end of blank line return 0 | |
3188 | (cond ((eolp) 0) | |
3189 | ((current-column))))) | |
3190 | ||
3191 | (defun idlwave-is-continuation-line () | |
5a0c3f56 | 3192 | "Test if current line is continuation line. |
5e72c6b2 S |
3193 | Blank or comment-only lines following regular continuation lines (with |
3194 | `$') count as continuations too." | |
0dc2be2f S |
3195 | (let (p) |
3196 | (save-excursion | |
4b1aaa8b | 3197 | (or |
0dc2be2f S |
3198 | (idlwave-look-at "\\<\\$") |
3199 | (catch 'loop | |
4b1aaa8b | 3200 | (while (and (looking-at "^[ \t]*\\(;.*\\)?$") |
0dc2be2f S |
3201 | (eq (forward-line -1) 0)) |
3202 | (if (setq p (idlwave-look-at "\\<\\$")) (throw 'loop p)))))))) | |
f32b3b91 CD |
3203 | |
3204 | (defun idlwave-is-comment-line () | |
5a0c3f56 | 3205 | "Test if the current line is a comment line." |
f32b3b91 CD |
3206 | (save-excursion |
3207 | (beginning-of-line 1) | |
3208 | (looking-at "[ \t]*;"))) | |
3209 | ||
05a1abfc | 3210 | (defun idlwave-is-comment-or-empty-line () |
5a0c3f56 | 3211 | "Test if the current line is a comment line." |
05a1abfc CD |
3212 | (save-excursion |
3213 | (beginning-of-line 1) | |
3214 | (looking-at "[ \t]*[;\n]"))) | |
3215 | ||
f32b3b91 | 3216 | (defun idlwave-look-at (regexp &optional cont beg) |
5a0c3f56 | 3217 | "Search current line from current point for REGEXP. |
15e42531 CD |
3218 | If optional argument CONT is non-nil, searches to the end of |
3219 | the current statement. | |
3220 | If optional arg BEG is non-nil, search starts from the beginning of the | |
3221 | current statement. | |
3222 | Ignores matches that end in a comment or inside a string expression. | |
3223 | Returns point if successful, nil otherwise. | |
3224 | This function produces unexpected results if REGEXP contains quotes or | |
5a0c3f56 | 3225 | a comment delimiter. The search is case insensitive. |
15e42531 | 3226 | If successful leaves point after the match, otherwise, does not move point." |
f32b3b91 | 3227 | (let ((here (point)) |
f32b3b91 | 3228 | (case-fold-search t) |
15e42531 CD |
3229 | (eos (save-excursion |
3230 | (if cont (idlwave-end-of-statement) (end-of-line)) | |
3231 | (point))) | |
f32b3b91 | 3232 | found) |
15e42531 CD |
3233 | (idlwave-with-special-syntax |
3234 | (if beg (idlwave-beginning-of-statement)) | |
3235 | (while (and (setq found (re-search-forward regexp eos t)) | |
3236 | (idlwave-quoted)))) | |
f32b3b91 CD |
3237 | (if (not found) (goto-char here)) |
3238 | found)) | |
3239 | ||
3240 | (defun idlwave-fill-paragraph (&optional nohang) | |
5a0c3f56 | 3241 | "Fill paragraphs in comments. |
f32b3b91 CD |
3242 | A paragraph is made up of all contiguous lines having the same comment |
3243 | leader (the leading whitespace before the comment delimiter and the | |
3244 | comment delimiter). In addition, paragraphs are separated by blank | |
5a0c3f56 | 3245 | line comments. The indentation is given by the hanging indent of the |
f32b3b91 | 3246 | first line, otherwise by the minimum indentation of the lines after |
5a0c3f56 JB |
3247 | the first line. The indentation of the first line does not change. |
3248 | Does not effect code lines. Does not fill comments on the same line | |
f32b3b91 | 3249 | with code. The hanging indent is given by the end of the first match |
5a0c3f56 JB |
3250 | matching `idlwave-hang-indent-regexp' on the paragraph's first line. |
3251 | If the optional argument NOHANG is non-nil then the hanging indent is | |
f32b3b91 CD |
3252 | ignored." |
3253 | (interactive "P") | |
3254 | ;; check if this is a line comment | |
3255 | (if (save-excursion | |
3256 | (beginning-of-line) | |
3257 | (skip-chars-forward " \t") | |
3258 | (looking-at comment-start)) | |
3259 | (let | |
3260 | ((indent 999) | |
3261 | pre here diff fill-prefix-reg bcl first-indent | |
3262 | hang start end) | |
3263 | ;; Change tabs to spaces in the surrounding paragraph. | |
3264 | ;; The surrounding paragraph will be the largest containing block of | |
3265 | ;; contiguous line comments. Thus, we may be changing tabs in | |
3266 | ;; a much larger area than is needed, but this is the easiest | |
3267 | ;; brute force way to do it. | |
3268 | ;; | |
3269 | ;; This has the undesirable side effect of replacing the tabs | |
3270 | ;; permanently without the user's request or knowledge. | |
3271 | (save-excursion | |
3272 | (backward-paragraph) | |
3273 | (setq start (point))) | |
3274 | (save-excursion | |
3275 | (forward-paragraph) | |
3276 | (setq end (point))) | |
3277 | (untabify start end) | |
3278 | ;; | |
3279 | (setq here (point)) | |
3280 | (beginning-of-line) | |
3281 | (setq bcl (point)) | |
e180ab9f GM |
3282 | (re-search-forward (concat "^[ \t]*" comment-start "+") |
3283 | (point-at-eol) t) | |
f32b3b91 CD |
3284 | ;; Get the comment leader on the line and its length |
3285 | (setq pre (current-column)) | |
3286 | ;; the comment leader is the indentation plus exactly the | |
3287 | ;; number of consecutive ";". | |
3288 | (setq fill-prefix-reg | |
3289 | (concat | |
3290 | (setq fill-prefix | |
9b026d9f | 3291 | (regexp-quote (buffer-substring (point-at-bol) (point)))) |
f32b3b91 | 3292 | "[^;]")) |
4b1aaa8b | 3293 | |
f32b3b91 CD |
3294 | ;; Mark the beginning and end of the paragraph |
3295 | (goto-char bcl) | |
3296 | (while (and (looking-at fill-prefix-reg) | |
3297 | (not (looking-at paragraph-separate)) | |
3298 | (not (bobp))) | |
3299 | (forward-line -1)) | |
3300 | ;; Move to first line of paragraph | |
3301 | (if (/= (point) bcl) | |
3302 | (forward-line 1)) | |
3303 | (setq start (point)) | |
3304 | (goto-char bcl) | |
3305 | (while (and (looking-at fill-prefix-reg) | |
3306 | (not (looking-at paragraph-separate)) | |
3307 | (not (eobp))) | |
3308 | (forward-line 1)) | |
3309 | (beginning-of-line) | |
3310 | (if (or (not (looking-at fill-prefix-reg)) | |
3311 | (looking-at paragraph-separate)) | |
3312 | (forward-line -1)) | |
3313 | (end-of-line) | |
3314 | ;; if at end of buffer add a newline (need this because | |
3315 | ;; fill-region needs END to be at the beginning of line after | |
3316 | ;; the paragraph or it will add a line). | |
3317 | (if (eobp) | |
3318 | (progn (insert ?\n) (backward-char 1))) | |
3319 | ;; Set END to the beginning of line after the paragraph | |
3320 | ;; END is calculated as distance from end of buffer | |
3321 | (setq end (- (point-max) (point) 1)) | |
3322 | ;; | |
3323 | ;; Calculate the indentation for the paragraph. | |
3324 | ;; | |
3325 | ;; In the following while statements, after one iteration | |
3326 | ;; point will be at the beginning of a line in which case | |
3327 | ;; the while will not be executed for the | |
3328 | ;; the first paragraph line and thus will not affect the | |
3329 | ;; indentation. | |
3330 | ;; | |
3331 | ;; First check to see if indentation is based on hanging indent. | |
3332 | (if (and (not nohang) idlwave-hanging-indent | |
3333 | (setq hang | |
3334 | (save-excursion | |
3335 | (goto-char start) | |
3336 | (idlwave-calc-hanging-indent)))) | |
3337 | ;; Adjust lines of paragraph by inserting spaces so that | |
3338 | ;; each line's indent is at least as great as the hanging | |
3339 | ;; indent. This is needed for fill-paragraph to work with | |
3340 | ;; a fill-prefix. | |
3341 | (progn | |
3342 | (setq indent hang) | |
3343 | (beginning-of-line) | |
3344 | (while (> (point) start) | |
e180ab9f | 3345 | (re-search-forward comment-start-skip (point-at-eol) t) |
f32b3b91 CD |
3346 | (if (> (setq diff (- indent (current-column))) 0) |
3347 | (progn | |
3348 | (if (>= here (point)) | |
3349 | ;; adjust the original location for the | |
3350 | ;; inserted text. | |
3351 | (setq here (+ here diff))) | |
15e42531 | 3352 | (insert (make-string diff ?\ )))) |
f32b3b91 CD |
3353 | (forward-line -1)) |
3354 | ) | |
4b1aaa8b | 3355 | |
f32b3b91 CD |
3356 | ;; No hang. Instead find minimum indentation of paragraph |
3357 | ;; after first line. | |
3358 | ;; For the following while statement, since START is at the | |
aa87aafc | 3359 | ;; beginning of line and END is at the end of line |
f32b3b91 CD |
3360 | ;; point is greater than START at least once (which would |
3361 | ;; be the case for a single line paragraph). | |
3362 | (while (> (point) start) | |
3363 | (beginning-of-line) | |
3364 | (setq indent | |
3365 | (min indent | |
3366 | (progn | |
e180ab9f | 3367 | (re-search-forward comment-start-skip (point-at-eol) t) |
f32b3b91 | 3368 | (current-column)))) |
e180ab9f | 3369 | (forward-line -1))) |
f32b3b91 CD |
3370 | (setq fill-prefix (concat fill-prefix |
3371 | (make-string (- indent pre) | |
15e42531 | 3372 | ?\ ))) |
f32b3b91 CD |
3373 | ;; first-line indent |
3374 | (setq first-indent | |
3375 | (max | |
3376 | (progn | |
e180ab9f | 3377 | (re-search-forward comment-start-skip (point-at-eol) t) |
f32b3b91 CD |
3378 | (current-column)) |
3379 | indent)) | |
4b1aaa8b | 3380 | |
f32b3b91 CD |
3381 | ;; try to keep point at its original place |
3382 | (goto-char here) | |
3383 | ||
3384 | ;; In place of the more modern fill-region-as-paragraph, a hack | |
3385 | ;; to keep whitespace untouched on the first line within the | |
3386 | ;; indent length and to preserve any indent on the first line | |
3387 | ;; (first indent). | |
3388 | (save-excursion | |
3389 | (setq diff | |
3390 | (buffer-substring start (+ start first-indent -1))) | |
15e42531 | 3391 | (subst-char-in-region start (+ start first-indent -1) ?\ ?~ nil) |
f32b3b91 CD |
3392 | (fill-region-as-paragraph |
3393 | start | |
3394 | (- (point-max) end) | |
3395 | (current-justification) | |
3396 | nil) | |
3397 | (delete-region start (+ start first-indent -1)) | |
3398 | (goto-char start) | |
3399 | (insert diff)) | |
3400 | ;; When we want the point at the beginning of the comment | |
3401 | ;; body fill-region will put it at the beginning of the line. | |
3402 | (if (bolp) (skip-chars-forward (concat " \t" comment-start))) | |
3403 | (setq fill-prefix nil)))) | |
3404 | ||
3405 | (defun idlwave-calc-hanging-indent () | |
5a0c3f56 JB |
3406 | "Calculate the position of the hanging indent for the comment paragraph. |
3407 | The hanging indent position is given by the first match with the | |
3408 | `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is | |
3409 | non-nil then use last occurrence matching `idlwave-hang-indent-regexp' | |
3410 | on the line. | |
f32b3b91 CD |
3411 | If not found returns nil." |
3412 | (if idlwave-use-last-hang-indent | |
3413 | (save-excursion | |
3414 | (end-of-line) | |
e180ab9f | 3415 | (if (re-search-backward idlwave-hang-indent-regexp (point-at-bol) t) |
f32b3b91 CD |
3416 | (+ (current-column) (length idlwave-hang-indent-regexp)))) |
3417 | (save-excursion | |
3418 | (beginning-of-line) | |
e180ab9f | 3419 | (if (re-search-forward idlwave-hang-indent-regexp (point-at-eol) t) |
f32b3b91 CD |
3420 | (current-column))))) |
3421 | ||
3422 | (defun idlwave-auto-fill () | |
4b1aaa8b | 3423 | "Called to break lines in auto fill mode. |
52a244eb S |
3424 | Only fills non-comment lines if `idlwave-fill-comment-line-only' is |
3425 | non-nil. Places a continuation character at the end of the line if | |
3426 | not in a comment. Splits strings with IDL concatenation operator `+' | |
3427 | if `idlwave-auto-fill-split-string' is non-nil." | |
f32b3b91 CD |
3428 | (if (<= (current-column) fill-column) |
3429 | nil ; do not to fill | |
3430 | (if (or (not idlwave-fill-comment-line-only) | |
3431 | (save-excursion | |
3432 | ;; Check for comment line | |
3433 | (beginning-of-line) | |
3434 | (looking-at idlwave-comment-line-start-skip))) | |
3435 | (let (beg) | |
3436 | (idlwave-indent-line) | |
3437 | ;; Prevent actions do-auto-fill which calls indent-line-function. | |
3438 | (let (idlwave-do-actions | |
d6aac72d | 3439 | (paragraph-separate ".") |
52a244eb S |
3440 | (fill-nobreak-predicate |
3441 | (if (and (idlwave-in-quote) | |
3442 | idlwave-auto-fill-split-string) | |
3443 | (lambda () ;; We'll need 5 spaces for " ' + $" | |
3444 | (<= (- fill-column (current-column)) 5) | |
3445 | )))) | |
f32b3b91 CD |
3446 | (do-auto-fill)) |
3447 | (save-excursion | |
3448 | (end-of-line 0) | |
3449 | ;; Indent the split line | |
a86bd650 | 3450 | (idlwave-indent-line)) |
f32b3b91 CD |
3451 | (if (save-excursion |
3452 | (beginning-of-line) | |
3453 | (looking-at idlwave-comment-line-start-skip)) | |
3454 | ;; A continued line comment | |
3455 | ;; We treat continued line comments as part of a comment | |
3456 | ;; paragraph. So we check for a hanging indent. | |
3457 | (if idlwave-hanging-indent | |
3458 | (let ((here (- (point-max) (point))) | |
3459 | (indent | |
3460 | (save-excursion | |
3461 | (forward-line -1) | |
3462 | (idlwave-calc-hanging-indent)))) | |
e180ab9f GM |
3463 | (when indent |
3464 | ;; Remove whitespace between comment delimiter and | |
3465 | ;; text, insert spaces for appropriate indentation. | |
3466 | (beginning-of-line) | |
3467 | (re-search-forward comment-start-skip (point-at-eol) t) | |
3468 | (delete-horizontal-space) | |
3469 | (idlwave-indent-to indent) | |
3470 | (goto-char (- (point-max) here))))) | |
f32b3b91 CD |
3471 | ;; Split code or comment? |
3472 | (if (save-excursion | |
3473 | (end-of-line 0) | |
3474 | (idlwave-in-comment)) | |
52a244eb | 3475 | ;; Splitting a non-full-line comment. |
f32b3b91 CD |
3476 | ;; Insert the comment delimiter from split line |
3477 | (progn | |
3478 | (save-excursion | |
3479 | (beginning-of-line) | |
3480 | (skip-chars-forward " \t") | |
3481 | ;; Insert blank to keep off beginning of line | |
3482 | (insert " " | |
3483 | (save-excursion | |
3484 | (forward-line -1) | |
3485 | (buffer-substring (idlwave-goto-comment) | |
3486 | (progn | |
3487 | (skip-chars-forward "; ") | |
3488 | (point)))))) | |
3489 | (idlwave-indent-line)) | |
3490 | ;; Split code line - add continuation character | |
3491 | (save-excursion | |
3492 | (end-of-line 0) | |
3493 | ;; Check to see if we split a string | |
3494 | (if (and (setq beg (idlwave-in-quote)) | |
3495 | idlwave-auto-fill-split-string) | |
3496 | ;; Split the string and concatenate. | |
3497 | ;; The first extra space is for the space | |
3498 | ;; the line was split. That space was removed. | |
3499 | (insert " " (char-after beg) " +")) | |
3500 | (insert " $")) | |
3501 | (if beg | |
3502 | (if idlwave-auto-fill-split-string | |
3503 | ;; Make the second part of continued string | |
3504 | (save-excursion | |
3505 | (beginning-of-line) | |
3506 | (skip-chars-forward " \t") | |
3507 | (insert (char-after beg))) | |
3508 | ;; Warning | |
3509 | (beep) | |
3510 | (message "Warning: continuation inside a string."))) | |
3511 | ;; Although do-auto-fill (via indent-new-comment-line) calls | |
3512 | ;; idlwave-indent-line for the new line, re-indent again | |
3513 | ;; because of the addition of the continuation character. | |
3514 | (idlwave-indent-line)) | |
3515 | ))))) | |
3516 | ||
3517 | (defun idlwave-auto-fill-mode (arg) | |
3518 | "Toggle auto-fill mode for IDL mode. | |
3519 | With arg, turn auto-fill mode on if arg is positive. | |
3520 | In auto-fill mode, inserting a space at a column beyond `fill-column' | |
3521 | automatically breaks the line at a previous space." | |
3522 | (interactive "P") | |
3523 | (prog1 (set idlwave-fill-function | |
3524 | (if (if (null arg) | |
3525 | (not (symbol-value idlwave-fill-function)) | |
3526 | (> (prefix-numeric-value arg) 0)) | |
3527 | 'idlwave-auto-fill | |
3528 | nil)) | |
3529 | ;; update mode-line | |
3530 | (set-buffer-modified-p (buffer-modified-p)))) | |
3531 | ||
52a244eb S |
3532 | ;(defun idlwave-fill-routine-call () |
3533 | ; "Fill a routine definition or statement, indenting appropriately." | |
3534 | ; (let ((where (idlwave-where))))) | |
3535 | ||
3536 | ||
5a0c3f56 | 3537 | (defun idlwave-doc-header (&optional nomark) |
f32b3b91 | 3538 | "Insert a documentation header at the beginning of the unit. |
5a0c3f56 JB |
3539 | Inserts the value of the variable `idlwave-file-header'. Sets mark |
3540 | before moving to do insertion unless the optional prefix argument | |
3541 | NOMARK is non-nil." | |
f32b3b91 CD |
3542 | (interactive "P") |
3543 | (or nomark (push-mark)) | |
3544 | ;; make sure we catch the current line if it begins the unit | |
5e72c6b2 S |
3545 | (if idlwave-header-to-beginning-of-file |
3546 | (goto-char (point-min)) | |
3547 | (end-of-line) | |
3548 | (idlwave-beginning-of-subprogram) | |
3549 | (beginning-of-line) | |
3550 | ;; skip function or procedure line | |
3551 | (if (idlwave-look-at "\\<\\(pro\\|function\\)\\>") | |
3552 | (progn | |
3553 | (idlwave-end-of-statement) | |
3554 | (if (> (forward-line 1) 0) (insert "\n"))))) | |
3555 | (let ((pos (point))) | |
3556 | (if idlwave-file-header | |
3557 | (cond ((car idlwave-file-header) | |
a527b753 | 3558 | (insert-file-contents (car idlwave-file-header))) |
5e72c6b2 S |
3559 | ((stringp (car (cdr idlwave-file-header))) |
3560 | (insert (car (cdr idlwave-file-header)))))) | |
3561 | (goto-char pos))) | |
f32b3b91 CD |
3562 | |
3563 | (defun idlwave-default-insert-timestamp () | |
5a0c3f56 | 3564 | "Default timestamp insertion function." |
f32b3b91 CD |
3565 | (insert (current-time-string)) |
3566 | (insert ", " (user-full-name)) | |
5e72c6b2 | 3567 | (if (boundp 'user-mail-address) |
4b1aaa8b | 3568 | (insert " <" user-mail-address ">") |
5e72c6b2 | 3569 | (insert " <" (user-login-name) "@" (system-name) ">")) |
f32b3b91 CD |
3570 | ;; Remove extra spaces from line |
3571 | (idlwave-fill-paragraph) | |
3572 | ;; Insert a blank line comment to separate from the date entry - | |
3573 | ;; will keep the entry from flowing onto date line if re-filled. | |
5e72c6b2 | 3574 | (insert "\n;\n;\t\t")) |
f32b3b91 CD |
3575 | |
3576 | (defun idlwave-doc-modification () | |
3577 | "Insert a brief modification log at the beginning of the current program. | |
3578 | Looks for an occurrence of the value of user variable | |
5a0c3f56 JB |
3579 | `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user |
3580 | name and places the point for the user to add a log. Before moving, saves | |
f32b3b91 CD |
3581 | location on mark ring so that the user can return to previous point." |
3582 | (interactive) | |
3583 | (push-mark) | |
05a1abfc CD |
3584 | (let* (beg end) |
3585 | (if (and (or (re-search-backward idlwave-doclib-start nil t) | |
3586 | (progn | |
3587 | (goto-char (point-min)) | |
3588 | (re-search-forward idlwave-doclib-start nil t))) | |
3589 | (setq beg (match-beginning 0)) | |
3590 | (re-search-forward idlwave-doclib-end nil t) | |
3591 | (setq end (match-end 0))) | |
3592 | (progn | |
3593 | (goto-char beg) | |
4b1aaa8b | 3594 | (if (re-search-forward |
05a1abfc CD |
3595 | (concat idlwave-doc-modifications-keyword ":") |
3596 | end t) | |
3597 | (end-of-line) | |
3598 | (goto-char end) | |
3599 | (end-of-line -1) | |
3600 | (insert "\n" comment-start "\n") | |
3601 | (insert comment-start " " idlwave-doc-modifications-keyword ":")) | |
3602 | (insert "\n;\n;\t") | |
3603 | (run-hooks 'idlwave-timestamp-hook)) | |
3604 | (error "No valid DOCLIB header")))) | |
f32b3b91 | 3605 | |
e08734e2 | 3606 | |
8d222148 SM |
3607 | ;; CJC 3/16/93 |
3608 | ;; Interface to expand-region-abbrevs which did not work when the | |
3609 | ;; abbrev hook associated with an abbrev moves point backwards | |
3610 | ;; after abbrev expansion, e.g., as with the abbrev '.n'. | |
3611 | ;; The original would enter an infinite loop in attempting to expand | |
3612 | ;; .n (it would continually expand and unexpand the abbrev without expanding | |
3613 | ;; because the point would keep going back to the beginning of the | |
3614 | ;; abbrev instead of to the end of the abbrev). We now keep the | |
3615 | ;; abbrev hook from moving backwards. | |
f32b3b91 CD |
3616 | ;;; |
3617 | (defun idlwave-expand-region-abbrevs (start end) | |
3618 | "Expand each abbrev occurrence in the region. | |
3619 | Calling from a program, arguments are START END." | |
3620 | (interactive "r") | |
3621 | (save-excursion | |
3622 | (goto-char (min start end)) | |
3623 | (let ((idlwave-show-block nil) ;Do not blink | |
3624 | (idlwave-abbrev-move nil)) ;Do not move | |
3625 | (expand-region-abbrevs start end 'noquery)))) | |
3626 | ||
3627 | (defun idlwave-quoted () | |
5a0c3f56 JB |
3628 | "Return t if point is in a comment or quoted string. |
3629 | Returns nil otherwise." | |
f32b3b91 CD |
3630 | (or (idlwave-in-comment) (idlwave-in-quote))) |
3631 | ||
3632 | (defun idlwave-in-quote () | |
5a0c3f56 | 3633 | "Return location of the opening quote |
f32b3b91 CD |
3634 | if point is in a IDL string constant, nil otherwise. |
3635 | Ignores comment delimiters on the current line. | |
3636 | Properly handles nested quotation marks and octal | |
3637 | constants - a double quote followed by an octal digit." | |
8d222148 SM |
3638 | ;; Treat an octal inside an apostrophe to be a normal string. Treat a |
3639 | ;; double quote followed by an octal digit to be an octal constant | |
3640 | ;; rather than a string. Therefore, there is no terminating double | |
3641 | ;; quote. | |
f32b3b91 CD |
3642 | (save-excursion |
3643 | ;; Because single and double quotes can quote each other we must | |
3644 | ;; search for the string start from the beginning of line. | |
3645 | (let* ((start (point)) | |
9b026d9f | 3646 | (eol (point-at-eol)) |
f32b3b91 CD |
3647 | (bq (progn (beginning-of-line) (point))) |
3648 | (endq (point)) | |
3649 | (data (match-data)) | |
3650 | delim | |
3651 | found) | |
3652 | (while (< endq start) | |
3653 | ;; Find string start | |
3654 | ;; Don't find an octal constant beginning with a double quote | |
52a244eb | 3655 | (if (re-search-forward "[\"']" eol 'lim) |
f32b3b91 CD |
3656 | ;; Find the string end. |
3657 | ;; In IDL, two consecutive delimiters after the start of a | |
3658 | ;; string act as an | |
3659 | ;; escape for the delimiter in the string. | |
3660 | ;; Two consecutive delimiters alone (i.e., not after the | |
aa87aafc | 3661 | ;; start of a string) is the null string. |
f32b3b91 CD |
3662 | (progn |
3663 | ;; Move to position after quote | |
3664 | (goto-char (1+ (match-beginning 0))) | |
3665 | (setq bq (1- (point))) | |
3666 | ;; Get the string delimiter | |
3667 | (setq delim (char-to-string (preceding-char))) | |
3668 | ;; Check for null string | |
3669 | (if (looking-at delim) | |
3670 | (progn (setq endq (point)) (forward-char 1)) | |
3671 | ;; Look for next unpaired delimiter | |
3672 | (setq found (search-forward delim eol 'lim)) | |
3673 | (while (looking-at delim) | |
3674 | (forward-char 1) | |
3675 | (setq found (search-forward delim eol 'lim))) | |
8d222148 | 3676 | (setq endq (if found (1- (point)) (point))) |
f32b3b91 CD |
3677 | )) |
3678 | (progn (setq bq (point)) (setq endq (point))))) | |
3679 | (store-match-data data) | |
3680 | ;; return string beginning position or nil | |
3681 | (if (> start bq) bq)))) | |
3682 | ||
76959b77 | 3683 | (defun idlwave-is-pointer-dereference (&optional limit) |
5a0c3f56 | 3684 | "Determine if the character after point is a pointer dereference *." |
8d222148 SM |
3685 | (and |
3686 | (eq (char-after) ?\*) | |
3687 | (not (idlwave-in-quote)) | |
3688 | (save-excursion | |
3689 | (forward-char) | |
3690 | (re-search-backward (concat "\\(" idlwave-idl-keywords | |
3691 | "\\|[[(*+-/=,^><]\\)\\s-*\\*") limit t)))) | |
76959b77 S |
3692 | |
3693 | ||
f32b3b91 CD |
3694 | ;; Statement templates |
3695 | ||
3696 | ;; Replace these with a general template function, something like | |
3697 | ;; expand.el (I think there was also something with a name similar to | |
3698 | ;; dmacro.el) | |
3699 | ||
3700 | (defun idlwave-template (s1 s2 &optional prompt noindent) | |
3701 | "Build a template with optional prompt expression. | |
3702 | ||
3703 | Opens a line if point is not followed by a newline modulo intervening | |
3704 | whitespace. S1 and S2 are strings. S1 is inserted at point followed | |
595ab50b | 3705 | by S2. Point is inserted between S1 and S2. The case of S1 and S2 is |
5a0c3f56 JB |
3706 | adjusted according to `idlwave-abbrev-change-case'. If optional |
3707 | argument PROMPT is a string then it is displayed as a message in the | |
f32b3b91 CD |
3708 | minibuffer. The PROMPT serves as a reminder to the user of an |
3709 | expression to enter. | |
3710 | ||
3711 | The lines containing S1 and S2 are reindented using `indent-region' | |
3712 | unless the optional second argument NOINDENT is non-nil." | |
175069ef | 3713 | (if (derived-mode-p 'idlwave-shell-mode) |
05a1abfc | 3714 | ;; This is a gross hack to avoit template abbrev expansion |
15e42531 CD |
3715 | ;; in the shell. FIXME: This is a dirty hack. |
3716 | (if (and (eq this-command 'self-insert-command) | |
3717 | (equal last-abbrev-location (point))) | |
3718 | (insert last-abbrev-text) | |
3719 | (error "No templates in idlwave-shell")) | |
3720 | (cond ((eq idlwave-abbrev-change-case 'down) | |
3721 | (setq s1 (downcase s1) s2 (downcase s2))) | |
3722 | (idlwave-abbrev-change-case | |
3723 | (setq s1 (upcase s1) s2 (upcase s2)))) | |
e180ab9f | 3724 | (let ((beg (point-at-bol)) |
15e42531 CD |
3725 | end) |
3726 | (if (not (looking-at "\\s-*\n")) | |
3727 | (open-line 1)) | |
3728 | (insert s1) | |
3729 | (save-excursion | |
3730 | (insert s2) | |
3731 | (setq end (point))) | |
3732 | (if (not noindent) | |
3733 | (indent-region beg end nil)) | |
3734 | (if (stringp prompt) | |
274f1353 | 3735 | (message "%s" prompt))))) |
4b1aaa8b | 3736 | |
595ab50b CD |
3737 | (defun idlwave-rw-case (string) |
3738 | "Make STRING have the case required by `idlwave-reserved-word-upcase'." | |
3739 | (if idlwave-reserved-word-upcase | |
3740 | (upcase string) | |
3741 | string)) | |
3742 | ||
f32b3b91 CD |
3743 | (defun idlwave-elif () |
3744 | "Build skeleton IDL if-else block." | |
3745 | (interactive) | |
595ab50b CD |
3746 | (idlwave-template |
3747 | (idlwave-rw-case "if") | |
3748 | (idlwave-rw-case " then begin\n\nendif else begin\n\nendelse") | |
3749 | "Condition expression")) | |
f32b3b91 CD |
3750 | |
3751 | (defun idlwave-case () | |
3752 | "Build skeleton IDL case statement." | |
3753 | (interactive) | |
4b1aaa8b | 3754 | (idlwave-template |
595ab50b CD |
3755 | (idlwave-rw-case "case") |
3756 | (idlwave-rw-case " of\n\nendcase") | |
3757 | "Selector expression")) | |
f32b3b91 | 3758 | |
05a1abfc CD |
3759 | (defun idlwave-switch () |
3760 | "Build skeleton IDL switch statement." | |
3761 | (interactive) | |
4b1aaa8b | 3762 | (idlwave-template |
05a1abfc CD |
3763 | (idlwave-rw-case "switch") |
3764 | (idlwave-rw-case " of\n\nendswitch") | |
3765 | "Selector expression")) | |
3766 | ||
f32b3b91 | 3767 | (defun idlwave-for () |
5a0c3f56 | 3768 | "Build skeleton IDL loop statement." |
f32b3b91 | 3769 | (interactive) |
4b1aaa8b | 3770 | (idlwave-template |
595ab50b CD |
3771 | (idlwave-rw-case "for") |
3772 | (idlwave-rw-case " do begin\n\nendfor") | |
3773 | "Loop expression")) | |
f32b3b91 CD |
3774 | |
3775 | (defun idlwave-if () | |
5a0c3f56 | 3776 | "Build skeleton IDL if statement." |
f32b3b91 | 3777 | (interactive) |
595ab50b CD |
3778 | (idlwave-template |
3779 | (idlwave-rw-case "if") | |
3780 | (idlwave-rw-case " then begin\n\nendif") | |
3781 | "Scalar logical expression")) | |
f32b3b91 CD |
3782 | |
3783 | (defun idlwave-procedure () | |
3784 | (interactive) | |
4b1aaa8b | 3785 | (idlwave-template |
595ab50b CD |
3786 | (idlwave-rw-case "pro") |
3787 | (idlwave-rw-case "\n\nreturn\nend") | |
3788 | "Procedure name")) | |
f32b3b91 CD |
3789 | |
3790 | (defun idlwave-function () | |
3791 | (interactive) | |
4b1aaa8b | 3792 | (idlwave-template |
595ab50b CD |
3793 | (idlwave-rw-case "function") |
3794 | (idlwave-rw-case "\n\nreturn\nend") | |
3795 | "Function name")) | |
f32b3b91 CD |
3796 | |
3797 | (defun idlwave-repeat () | |
3798 | (interactive) | |
595ab50b CD |
3799 | (idlwave-template |
3800 | (idlwave-rw-case "repeat begin\n\nendrep until") | |
3801 | (idlwave-rw-case "") | |
3802 | "Exit condition")) | |
f32b3b91 CD |
3803 | |
3804 | (defun idlwave-while () | |
3805 | (interactive) | |
4b1aaa8b | 3806 | (idlwave-template |
595ab50b CD |
3807 | (idlwave-rw-case "while") |
3808 | (idlwave-rw-case " do begin\n\nendwhile") | |
3809 | "Entry condition")) | |
f32b3b91 CD |
3810 | |
3811 | (defun idlwave-split-string (string &optional pattern) | |
3812 | "Return a list of substrings of STRING which are separated by PATTERN. | |
3813 | If PATTERN is omitted, it defaults to \"[ \\f\\t\\n\\r\\v]+\"." | |
3814 | (or pattern | |
3815 | (setq pattern "[ \f\t\n\r\v]+")) | |
3816 | (let (parts (start 0)) | |
3817 | (while (string-match pattern string start) | |
3818 | (setq parts (cons (substring string start (match-beginning 0)) parts) | |
3819 | start (match-end 0))) | |
3820 | (nreverse (cons (substring string start) parts)))) | |
3821 | ||
3822 | (defun idlwave-replace-string (string replace_string replace_with) | |
3823 | (let* ((start 0) | |
3824 | (last (length string)) | |
3825 | (ret_string "") | |
3826 | end) | |
3827 | (while (setq end (string-match replace_string string start)) | |
3828 | (setq ret_string | |
3829 | (concat ret_string (substring string start end) replace_with)) | |
3830 | (setq start (match-end 0))) | |
3831 | (setq ret_string (concat ret_string (substring string start last))))) | |
3832 | ||
3833 | (defun idlwave-get-buffer-visiting (file) | |
3834 | ;; Return the buffer currently visiting FILE | |
3835 | (cond | |
3836 | ((boundp 'find-file-compare-truenames) ; XEmacs | |
3837 | (let ((find-file-compare-truenames t)) | |
3838 | (get-file-buffer file))) | |
3839 | ((fboundp 'find-buffer-visiting) ; Emacs | |
3840 | (find-buffer-visiting file)) | |
3841 | (t (error "This should not happen (idlwave-get-buffer-visiting)")))) | |
3842 | ||
15e42531 | 3843 | (defvar idlwave-outlawed-buffers nil |
5a0c3f56 | 3844 | "List of buffers pulled up by IDLWAVE for special reasons. |
15e42531 CD |
3845 | Buffers in this list may be killed by `idlwave-kill-autoloaded-buffers'.") |
3846 | ||
3847 | (defun idlwave-find-file-noselect (file &optional why) | |
f32b3b91 CD |
3848 | ;; Return a buffer visiting file. |
3849 | (or (idlwave-get-buffer-visiting file) | |
15e42531 CD |
3850 | (let ((buf (find-file-noselect file))) |
3851 | (if why (add-to-list 'idlwave-outlawed-buffers (cons buf why))) | |
3852 | buf))) | |
3853 | ||
3854 | (defun idlwave-kill-autoloaded-buffers () | |
52a244eb | 3855 | "Kill buffers created automatically by IDLWAVE. |
15e42531 CD |
3856 | Function prompts for a letter to identify the buffers to kill. |
3857 | Possible letters are: | |
3858 | ||
3859 | f Buffers created by the command \\[idlwave-find-module] or mouse | |
3860 | clicks in the routine info window. | |
3861 | s Buffers created by the IDLWAVE Shell to display where execution | |
3862 | stopped or an error was found. | |
3863 | a Both of the above. | |
3864 | ||
5a0c3f56 | 3865 | Buffers containing unsaved changes require confirmation before they are killed." |
15e42531 CD |
3866 | (interactive) |
3867 | (if (null idlwave-outlawed-buffers) | |
3868 | (error "No IDLWAVE-created buffers available") | |
3869 | (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? " | |
3870 | (idlwave-count-outlawed-buffers 'find) | |
3871 | (idlwave-count-outlawed-buffers 'shell))) | |
3872 | (let ((c (read-char))) | |
3873 | (cond | |
3874 | ((member c '(?f ?\C-f)) | |
3875 | (idlwave-do-kill-autoloaded-buffers 'find)) | |
3876 | ((member c '(?s ?\C-s)) | |
3877 | (idlwave-do-kill-autoloaded-buffers 'shell)) | |
3878 | ((member c '(?a ?\C-a)) | |
3879 | (idlwave-do-kill-autoloaded-buffers t)) | |
3880 | (t (error "Abort")))))) | |
3881 | ||
3882 | (defun idlwave-count-outlawed-buffers (tag) | |
3883 | "How many outlawed buffers have tag TAG?" | |
3884 | (length (delq nil | |
4b1aaa8b PE |
3885 | (mapcar |
3886 | (lambda (x) (eq (cdr x) tag)) | |
15e42531 CD |
3887 | idlwave-outlawed-buffers)))) |
3888 | ||
3889 | (defun idlwave-do-kill-autoloaded-buffers (&rest reasons) | |
3890 | "Kill all buffers pulled up by IDLWAVE matching REASONS." | |
3891 | (let* ((list (copy-sequence idlwave-outlawed-buffers)) | |
3892 | (cnt 0) | |
3893 | entry) | |
3894 | (while (setq entry (pop list)) | |
3895 | (if (buffer-live-p (car entry)) | |
3896 | (and (or (memq t reasons) | |
3897 | (memq (cdr entry) reasons)) | |
3898 | (kill-buffer (car entry)) | |
3899 | (incf cnt) | |
4b1aaa8b | 3900 | (setq idlwave-outlawed-buffers |
15e42531 | 3901 | (delq entry idlwave-outlawed-buffers))) |
4b1aaa8b | 3902 | (setq idlwave-outlawed-buffers |
15e42531 CD |
3903 | (delq entry idlwave-outlawed-buffers)))) |
3904 | (message "%d buffer%s killed" cnt (if (= cnt 1) "" "s")))) | |
3905 | ||
3906 | (defun idlwave-revoke-license-to-kill () | |
3907 | "Remove BUFFER from the buffers which may be killed. | |
3908 | Killing would be done by `idlwave-do-kill-autoloaded-buffers'. | |
3909 | Intended for `after-save-hook'." | |
3910 | (let* ((buf (current-buffer)) | |
3911 | (entry (assq buf idlwave-outlawed-buffers))) | |
3912 | ;; Revoke license | |
3913 | (if entry | |
4b1aaa8b | 3914 | (setq idlwave-outlawed-buffers |
15e42531 CD |
3915 | (delq entry idlwave-outlawed-buffers))) |
3916 | ;; Remove this function from the hook. | |
3917 | (remove-hook 'after-save-hook 'idlwave-revoke-license-to-kill 'local))) | |
3918 | ||
3919 | (defvar idlwave-path-alist) | |
3920 | (defun idlwave-locate-lib-file (file) | |
f32b3b91 | 3921 | ;; Find FILE on the scanned lib path and return a buffer visiting it |
15e42531 | 3922 | (let* ((dirs idlwave-path-alist) |
f32b3b91 CD |
3923 | dir efile) |
3924 | (catch 'exit | |
15e42531 | 3925 | (while (setq dir (car (pop dirs))) |
f32b3b91 CD |
3926 | (if (file-regular-p |
3927 | (setq efile (expand-file-name file dir))) | |
15e42531 | 3928 | (throw 'exit efile)))))) |
52a244eb | 3929 | |
15e42531 CD |
3930 | (defun idlwave-expand-lib-file-name (file) |
3931 | ;; Find FILE on the scanned lib path and return a buffer visiting it | |
52a244eb | 3932 | ;; This is for, e.g., finding source with no user catalog |
4b1aaa8b | 3933 | (cond |
15e42531 | 3934 | ((null file) nil) |
15e42531 CD |
3935 | ((file-name-absolute-p file) file) |
3936 | (t (idlwave-locate-lib-file file)))) | |
f32b3b91 CD |
3937 | |
3938 | (defun idlwave-make-tags () | |
5a0c3f56 JB |
3939 | "Create the IDL tags file IDLTAGS in the current directory from |
3940 | the list of directories specified in the minibuffer. Directories may be | |
3941 | for example: . /usr/local/rsi/idl/lib. All the subdirectories of the | |
f32b3b91 | 3942 | specified top directories are searched if the directory name is prefixed |
5a0c3f56 | 3943 | by @. Specify @ directories with care, it may take a long, long time if |
f32b3b91 CD |
3944 | you specify /." |
3945 | (interactive) | |
3946 | (let (directory directories cmd append status numdirs dir getsubdirs | |
3947 | buffer save_buffer files numfiles item errbuf) | |
4b1aaa8b | 3948 | |
f32b3b91 CD |
3949 | ;; |
3950 | ;; Read list of directories | |
3951 | (setq directory (read-string "Tag Directories: " ".")) | |
3952 | (setq directories (idlwave-split-string directory "[ \t]+")) | |
3953 | ;; | |
3954 | ;; Set etags command, vars | |
3955 | (setq cmd "etags --output=IDLTAGS --language=none --regex='/[ | |
3956 | \\t]*[pP][Rr][Oo][ \\t]+\\([^ \\t,]+\\)/' --regex='/[ | |
3957 | \\t]*[Ff][Uu][Nn][Cc][Tt][Ii][Oo][Nn][ \\t]+\\([^ \\t,]+\\)/' ") | |
3958 | (setq append " ") | |
3959 | (setq status 0) | |
3960 | ;; | |
3961 | ;; For each directory | |
3962 | (setq numdirs 0) | |
3963 | (setq dir (nth numdirs directories)) | |
3964 | (while (and dir) | |
3965 | ;; | |
3966 | ;; Find the subdirectories | |
3967 | (if (string-match "^[@]\\(.+\\)$" dir) | |
3968 | (setq getsubdirs t) (setq getsubdirs nil)) | |
3969 | (if (and getsubdirs) (setq dir (substring dir 1 (length dir)))) | |
3970 | (setq dir (expand-file-name dir)) | |
3971 | (if (file-directory-p dir) | |
3972 | (progn | |
3973 | (if (and getsubdirs) | |
3974 | (progn | |
3975 | (setq buffer (get-buffer-create "*idltags*")) | |
3976 | (call-process "sh" nil buffer nil "-c" | |
3977 | (concat "find " dir " -type d -print")) | |
3978 | (setq save_buffer (current-buffer)) | |
3979 | (set-buffer buffer) | |
3980 | (setq files (idlwave-split-string | |
3981 | (idlwave-replace-string | |
3982 | (buffer-substring 1 (point-max)) | |
3983 | "\n" "/*.pro ") | |
3984 | "[ \t]+")) | |
3985 | (set-buffer save_buffer) | |
3986 | (kill-buffer buffer)) | |
3987 | (setq files (list (concat dir "/*.pro")))) | |
3988 | ;; | |
3989 | ;; For each subdirectory | |
3990 | (setq numfiles 0) | |
3991 | (setq item (nth numfiles files)) | |
3992 | (while (and item) | |
3993 | ;; | |
3994 | ;; Call etags | |
3995 | (if (not (string-match "^[ \\t]*$" item)) | |
3996 | (progn | |
29a4e67d | 3997 | (message "%s" (concat "Tagging " item "...")) |
f32b3b91 | 3998 | (setq errbuf (get-buffer-create "*idltags-error*")) |
52a244eb | 3999 | (setq status (+ status |
4b1aaa8b | 4000 | (if (eq 0 (call-process |
52a244eb S |
4001 | "sh" nil errbuf nil "-c" |
4002 | (concat cmd append item))) | |
4003 | 0 | |
4004 | 1))) | |
f32b3b91 CD |
4005 | ;; |
4006 | ;; Append additional tags | |
4007 | (setq append " --append ") | |
4008 | (setq numfiles (1+ numfiles)) | |
4009 | (setq item (nth numfiles files))) | |
4010 | (progn | |
4011 | (setq numfiles (1+ numfiles)) | |
4012 | (setq item (nth numfiles files)) | |
4013 | ))) | |
4b1aaa8b | 4014 | |
f32b3b91 CD |
4015 | (setq numdirs (1+ numdirs)) |
4016 | (setq dir (nth numdirs directories))) | |
4017 | (progn | |
4018 | (setq numdirs (1+ numdirs)) | |
4019 | (setq dir (nth numdirs directories))))) | |
4b1aaa8b | 4020 | |
f32b3b91 CD |
4021 | (setq errbuf (get-buffer-create "*idltags-error*")) |
4022 | (if (= status 0) | |
4023 | (kill-buffer errbuf)) | |
4024 | (message "") | |
4025 | )) | |
4026 | ||
4027 | (defun idlwave-toggle-comment-region (beg end &optional n) | |
4028 | "Comment the lines in the region if the first non-blank line is | |
5a0c3f56 | 4029 | commented, and conversely, uncomment region. If optional prefix arg |
f32b3b91 CD |
4030 | N is non-nil, then for N positive, add N comment delimiters or for N |
4031 | negative, remove N comment delimiters. | |
4032 | Uses `comment-region' which does not place comment delimiters on | |
4033 | blank lines." | |
4034 | (interactive "r\nP") | |
4035 | (if n | |
4036 | (comment-region beg end (prefix-numeric-value n)) | |
4037 | (save-excursion | |
4038 | (goto-char beg) | |
4039 | (beginning-of-line) | |
4040 | ;; skip blank lines | |
4041 | (skip-chars-forward " \t\n") | |
4042 | (if (looking-at (concat "[ \t]*\\(" comment-start "+\\)")) | |
52a244eb S |
4043 | (if (fboundp 'uncomment-region) |
4044 | (uncomment-region beg end) | |
4045 | (comment-region beg end | |
4046 | (- (length (buffer-substring | |
4047 | (match-beginning 1) | |
4048 | (match-end 1)))))) | |
4049 | (comment-region beg end))))) | |
f32b3b91 CD |
4050 | |
4051 | ||
4052 | ;; ---------------------------------------------------------------------------- | |
4053 | ;; ---------------------------------------------------------------------------- | |
4054 | ;; ---------------------------------------------------------------------------- | |
4055 | ;; ---------------------------------------------------------------------------- | |
4056 | ;; | |
4057 | ;; Completion and Routine Info | |
4058 | ;; | |
4059 | ||
4060 | ;; String "intern" functions | |
4061 | ||
4062 | ;; For the completion and routine info function, we want to normalize | |
4063 | ;; the case of procedure names etc. We do this by "interning" these | |
4064 | ;; string is a hand-crafted way. Hashes are used to map the downcase | |
52a244eb S |
4065 | ;; version of the strings to the cased versions. Most *-sint-* |
4066 | ;; variables consist of *two* hashes, a buffer+shell, followed by a | |
4067 | ;; system hash. The former is re-scanned, and the latter takes case | |
4068 | ;; precedence. | |
4069 | ;; | |
4070 | ;; Since these cased versions are really lisp objects, we can use `eq' | |
4071 | ;; to search, which is a large performance boost. All new strings | |
4072 | ;; need to be "sinterned". We do this as early as possible after | |
4073 | ;; getting these strings from completion or buffer substrings. So | |
4074 | ;; most of the code can simply assume to deal with "sinterned" | |
4075 | ;; strings. The only exception is that the functions which scan whole | |
4076 | ;; buffers for routine information do not intern the grabbed strings. | |
4077 | ;; This is only done afterwards. Therefore in these functions it is | |
4078 | ;; *not* safe to assume the strings can be compared with `eq' and be | |
4079 | ;; fed into the routine assq functions. | |
f32b3b91 CD |
4080 | |
4081 | ;; Here we define the hashing functions. | |
4082 | ||
4083 | ;; The variables which hold the hashes. | |
4084 | (defvar idlwave-sint-routines '(nil)) | |
4085 | (defvar idlwave-sint-keywords '(nil)) | |
4086 | (defvar idlwave-sint-methods '(nil)) | |
4087 | (defvar idlwave-sint-classes '(nil)) | |
52a244eb S |
4088 | (defvar idlwave-sint-dirs '(nil)) |
4089 | (defvar idlwave-sint-libnames '(nil)) | |
f32b3b91 CD |
4090 | |
4091 | (defun idlwave-reset-sintern (&optional what) | |
4092 | "Reset all sintern hashes." | |
4093 | ;; Make sure the hash functions are accessible. | |
8d222148 SM |
4094 | (unless (and (fboundp 'gethash) |
4095 | (fboundp 'puthash)) | |
4096 | (require 'cl) | |
4097 | (or (fboundp 'puthash) | |
4098 | (defalias 'puthash 'cl-puthash))) | |
f32b3b91 CD |
4099 | (let ((entries '((idlwave-sint-routines 1000 10) |
4100 | (idlwave-sint-keywords 1000 10) | |
4101 | (idlwave-sint-methods 100 10) | |
4102 | (idlwave-sint-classes 10 10)))) | |
4103 | ||
4104 | ;; Make sure these are lists | |
4105 | (loop for entry in entries | |
4106 | for var = (car entry) | |
4107 | do (if (not (consp (symbol-value var))) (set var (list nil)))) | |
4108 | ||
f66f03de | 4109 | ;; Reset the system & library hash |
f32b3b91 CD |
4110 | (when (or (eq what t) (eq what 'syslib) |
4111 | (null (cdr idlwave-sint-routines))) | |
f32b3b91 CD |
4112 | (loop for entry in entries |
4113 | for var = (car entry) for size = (nth 1 entry) | |
4b1aaa8b | 4114 | do (setcdr (symbol-value var) |
f32b3b91 | 4115 | (make-hash-table ':size size ':test 'equal))) |
52a244eb S |
4116 | (setq idlwave-sint-dirs nil |
4117 | idlwave-sint-libnames nil)) | |
f32b3b91 | 4118 | |
f66f03de | 4119 | ;; Reset the buffer & shell hash |
f32b3b91 CD |
4120 | (when (or (eq what t) (eq what 'bufsh) |
4121 | (null (car idlwave-sint-routines))) | |
f32b3b91 CD |
4122 | (loop for entry in entries |
4123 | for var = (car entry) for size = (nth 1 entry) | |
4b1aaa8b | 4124 | do (setcar (symbol-value var) |
f32b3b91 CD |
4125 | (make-hash-table ':size size ':test 'equal)))))) |
4126 | ||
4127 | (defun idlwave-sintern-routine-or-method (name &optional class set) | |
4128 | (if class | |
4129 | (idlwave-sintern-method name set) | |
4130 | (idlwave-sintern-routine name set))) | |
4131 | ||
4132 | (defun idlwave-sintern (stype &rest args) | |
4133 | (apply (intern (concat "idlwave-sintern-" (symbol-name stype))) args)) | |
4134 | ||
4135 | ;;(defmacro idlwave-sintern (type var) | |
4136 | ;; `(cond ((not (stringp name)) name) | |
4137 | ;; ((gethash (downcase name) (cdr ,var))) | |
4138 | ;; ((gethash (downcase name) (car ,var))) | |
4139 | ;; (set (idlwave-sintern-set name ,type ,var set)) | |
4140 | ;; (name))) | |
4141 | ||
4142 | (defun idlwave-sintern-routine (name &optional set) | |
4143 | (cond ((not (stringp name)) name) | |
4144 | ((gethash (downcase name) (cdr idlwave-sint-routines))) | |
4145 | ((gethash (downcase name) (car idlwave-sint-routines))) | |
4146 | (set (idlwave-sintern-set name 'routine idlwave-sint-routines set)) | |
4147 | (name))) | |
4148 | (defun idlwave-sintern-keyword (name &optional set) | |
4149 | (cond ((not (stringp name)) name) | |
4150 | ((gethash (downcase name) (cdr idlwave-sint-keywords))) | |
4151 | ((gethash (downcase name) (car idlwave-sint-keywords))) | |
4152 | (set (idlwave-sintern-set name 'keyword idlwave-sint-keywords set)) | |
4153 | (name))) | |
4154 | (defun idlwave-sintern-method (name &optional set) | |
4155 | (cond ((not (stringp name)) name) | |
4156 | ((gethash (downcase name) (cdr idlwave-sint-methods))) | |
4157 | ((gethash (downcase name) (car idlwave-sint-methods))) | |
4158 | (set (idlwave-sintern-set name 'method idlwave-sint-methods set)) | |
4159 | (name))) | |
4160 | (defun idlwave-sintern-class (name &optional set) | |
4161 | (cond ((not (stringp name)) name) | |
4162 | ((gethash (downcase name) (cdr idlwave-sint-classes))) | |
4163 | ((gethash (downcase name) (car idlwave-sint-classes))) | |
4164 | (set (idlwave-sintern-set name 'class idlwave-sint-classes set)) | |
4165 | (name))) | |
4166 | ||
52a244eb S |
4167 | (defun idlwave-sintern-dir (dir &optional set) |
4168 | (car (or (member dir idlwave-sint-dirs) | |
4169 | (setq idlwave-sint-dirs (cons dir idlwave-sint-dirs))))) | |
4170 | (defun idlwave-sintern-libname (name &optional set) | |
4171 | (car (or (member name idlwave-sint-libnames) | |
4172 | (setq idlwave-sint-libnames (cons name idlwave-sint-libnames))))) | |
f32b3b91 CD |
4173 | |
4174 | (defun idlwave-sintern-set (name type tables set) | |
4175 | (let* ((func (or (cdr (assq type idlwave-completion-case)) | |
4176 | 'identity)) | |
4177 | (iname (funcall (if (eq func 'preserve) 'identity func) name)) | |
4178 | (table (if (eq set 'sys) (cdr tables) (car tables)))) | |
4179 | (puthash (downcase name) iname table) | |
4180 | iname)) | |
4181 | ||
52a244eb S |
4182 | (defun idlwave-sintern-keyword-list (kwd-list &optional set) |
4183 | "Sintern a set of keywords (file (key . link) (key2 . link2) ...)" | |
8ffcfb27 GM |
4184 | (mapc (lambda(x) |
4185 | (setcar x (idlwave-sintern-keyword (car x) set))) | |
4186 | (cdr kwd-list)) | |
52a244eb S |
4187 | kwd-list) |
4188 | ||
4189 | (defun idlwave-sintern-rinfo-list (list &optional set default-dir) | |
5a0c3f56 JB |
4190 | "Sintern all strings in the rinfo LIST. |
4191 | With optional parameter SET: also set new patterns. Probably this | |
4192 | will always have to be t. If DEFAULT-DIR is passed, it is used as | |
4193 | the base of the directory." | |
52a244eb | 4194 | (let (entry name type class kwds res source call new) |
f32b3b91 CD |
4195 | (while list |
4196 | (setq entry (car list) | |
4197 | list (cdr list) | |
4198 | name (car entry) | |
4199 | type (nth 1 entry) | |
4200 | class (nth 2 entry) | |
4201 | source (nth 3 entry) | |
4202 | call (nth 4 entry) | |
52a244eb S |
4203 | kwds (nthcdr 5 entry)) |
4204 | ||
4205 | ;; The class and name | |
f32b3b91 CD |
4206 | (if class |
4207 | (progn | |
4208 | (if (symbolp class) (setq class (symbol-name class))) | |
4209 | (setq class (idlwave-sintern-class class set)) | |
4210 | (setq name (idlwave-sintern-method name set))) | |
4211 | (setq name (idlwave-sintern-routine name set))) | |
4b1aaa8b | 4212 | |
52a244eb S |
4213 | ;; The source |
4214 | (let ((source-type (car source)) | |
4215 | (source-file (nth 1 source)) | |
4b1aaa8b | 4216 | (source-dir (if default-dir |
52a244eb S |
4217 | (file-name-as-directory default-dir) |
4218 | (nth 2 source))) | |
4219 | (source-lib (nth 3 source))) | |
4220 | (if (stringp source-dir) | |
4221 | (setq source-dir (idlwave-sintern-dir source-dir set))) | |
4222 | (if (stringp source-lib) | |
4223 | (setq source-lib (idlwave-sintern-libname source-lib set))) | |
4224 | (setq source (list source-type source-file source-dir source-lib))) | |
4b1aaa8b | 4225 | |
52a244eb S |
4226 | ;; The keywords |
4227 | (setq kwds (mapcar (lambda (x) | |
4228 | (idlwave-sintern-keyword-list x set)) | |
4229 | kwds)) | |
4230 | ||
4231 | ;; Build a canonicalized list | |
4232 | (setq new (nconc (list name type class source call) kwds) | |
4233 | res (cons new res))) | |
f32b3b91 CD |
4234 | (nreverse res))) |
4235 | ||
05a1abfc CD |
4236 | ;; Creating new sintern tables |
4237 | ||
4238 | (defun idlwave-new-sintern-type (tag) | |
4239 | "Define a variable and a function to sintern the new type TAG. | |
4240 | This defines the function `idlwave-sintern-TAG' and the variable | |
4241 | `idlwave-sint-TAGs'." | |
4242 | (let* ((name (symbol-name tag)) | |
4243 | (names (concat name "s")) | |
4244 | (var (intern (concat "idlwave-sint-" names))) | |
4245 | (func (intern (concat "idlwave-sintern-" name)))) | |
4246 | (set var nil) ; initial value of the association list | |
4247 | (fset func ; set the function | |
4248 | `(lambda (name &optional set) | |
4249 | (cond ((not (stringp name)) name) | |
4250 | ((cdr (assoc (downcase name) ,var))) | |
4251 | (set | |
4252 | (setq ,var (cons (cons (downcase name) name) ,var)) | |
4253 | name) | |
4254 | (name)))))) | |
4255 | ||
4256 | (defun idlwave-reset-sintern-type (tag) | |
4257 | "Reset the sintern variable associated with TAG." | |
4258 | (set (intern (concat "idlwave-sint-" (symbol-name tag) "s")) nil)) | |
4259 | ||
f32b3b91 CD |
4260 | ;;--------------------------------------------------------------------------- |
4261 | ||
4262 | ||
4263 | ;; The variables which hold the information | |
15e42531 | 4264 | (defvar idlwave-system-routines nil |
f32b3b91 CD |
4265 | "Holds the routine-info obtained by scanning buffers.") |
4266 | (defvar idlwave-buffer-routines nil | |
4267 | "Holds the routine-info obtained by scanning buffers.") | |
4268 | (defvar idlwave-compiled-routines nil | |
15e42531 CD |
4269 | "Holds the routine-info obtained by asking the shell.") |
4270 | (defvar idlwave-unresolved-routines nil | |
4271 | "Holds the unresolved routine-info obtained by asking the shell.") | |
52a244eb S |
4272 | (defvar idlwave-user-catalog-routines nil |
4273 | "Holds the procedure routine-info from the user scan.") | |
4274 | (defvar idlwave-library-catalog-routines nil | |
3938cb82 S |
4275 | "Holds the procedure routine-info from the .idlwave_catalog library files.") |
4276 | (defvar idlwave-library-catalog-libname nil | |
4277 | "Name of library catalog loaded from .idlwave_catalog files.") | |
15e42531 | 4278 | (defvar idlwave-path-alist nil |
52a244eb S |
4279 | "Alist with !PATH directories and zero or more flags if the dir has |
4280 | been scanned in a user catalog ('user) or discovered in a library | |
4281 | catalog \('lib).") | |
15e42531 CD |
4282 | (defvar idlwave-true-path-alist nil |
4283 | "Like `idlwave-path-alist', but with true filenames.") | |
f32b3b91 | 4284 | (defvar idlwave-routines nil |
b9e4fbd3 | 4285 | "Holds the combined procedure/function/method routine-info.") |
f32b3b91 CD |
4286 | (defvar idlwave-class-alist nil |
4287 | "Holds the class names known to IDLWAVE.") | |
4288 | (defvar idlwave-class-history nil | |
4289 | "The history of classes selected with the minibuffer.") | |
4290 | (defvar idlwave-force-class-query nil) | |
4291 | (defvar idlwave-before-completion-wconf nil | |
4292 | "The window configuration just before the completion buffer was displayed.") | |
15e42531 CD |
4293 | (defvar idlwave-last-system-routine-info-cons-cell nil |
4294 | "The last cons cell in the system routine info.") | |
f32b3b91 CD |
4295 | |
4296 | ;; | |
4297 | ;; The code to get routine info from different sources. | |
4298 | ||
15e42531 | 4299 | (defvar idlwave-system-routines) |
5e72c6b2 S |
4300 | (defvar idlwave-catalog-process nil |
4301 | "The background process currently updating the catalog.") | |
4302 | ||
f32b3b91 CD |
4303 | (defun idlwave-routines () |
4304 | "Provide a list of IDL routines. | |
5a0c3f56 JB |
4305 | This routine loads the builtin routines on the first call. |
4306 | Later it only returns the value of the variable." | |
5e72c6b2 S |
4307 | (if (and idlwave-catalog-process |
4308 | (processp idlwave-catalog-process)) | |
4309 | (progn | |
4310 | (cond | |
4311 | ((equal (process-status idlwave-catalog-process) 'exit) | |
4312 | (message "updating........") | |
4313 | (setq idlwave-catalog-process nil) | |
4314 | (idlwave-update-routine-info '(4))) | |
4315 | ((equal (process-status idlwave-catalog-process) 'run) | |
4316 | ;; Keep it running... | |
4317 | ) | |
4318 | (t | |
4319 | ;; Something is wrong, get rid of the process | |
4320 | (message "Problem with catalog process") (beep) | |
4321 | (condition-case nil | |
4322 | (kill-process idlwave-catalog-process) | |
4323 | (error nil)) | |
4324 | (setq idlwave-catalog-process nil))))) | |
f32b3b91 CD |
4325 | (or idlwave-routines |
4326 | (progn | |
4327 | (idlwave-update-routine-info) | |
4328 | ;; return the current value | |
4329 | idlwave-routines))) | |
4330 | ||
05a1abfc CD |
4331 | (defvar idlwave-update-rinfo-hook nil |
4332 | "List of functions which should run after a global rinfo update. | |
4333 | Does not run after automatic updates of buffer or the shell.") | |
4334 | ||
5e72c6b2 | 4335 | (defun idlwave-rescan-catalog-directories () |
5a0c3f56 | 4336 | "Rescan the previously selected directories. For batch processing." |
5e72c6b2 S |
4337 | (idlwave-update-routine-info '(16))) |
4338 | ||
4339 | (defun idlwave-rescan-asynchronously () | |
8a6a28ac | 4340 | "Dispatch another Emacs instance to update the idlwave catalog. |
5e72c6b2 S |
4341 | After the process finishes normally, the first access to routine info |
4342 | will re-read the catalog." | |
4343 | (interactive) | |
4344 | (if (processp idlwave-catalog-process) | |
4345 | (if (eq (process-status idlwave-catalog-process) 'run) | |
4346 | (if (yes-or-no-p "A catalog-updating process is running. Kill it? ") | |
4347 | (progn | |
4348 | (condition-case nil | |
4349 | (kill-process idlwave-catalog-process) | |
4350 | (error nil)) | |
4351 | (error "Process killed, no new process started")) | |
4352 | (error "Quit")) | |
4353 | (condition-case nil | |
4354 | (kill-process idlwave-catalog-process) | |
4355 | (error nil)))) | |
52a244eb S |
4356 | (if (or (not idlwave-user-catalog-file) |
4357 | (not (stringp idlwave-user-catalog-file)) | |
4358 | (not (file-regular-p idlwave-user-catalog-file))) | |
5e72c6b2 | 4359 | (error "No catalog has been produced yet")) |
4b1aaa8b | 4360 | (let* ((emacs (concat invocation-directory invocation-name)) |
5e72c6b2 S |
4361 | (args (list "-batch" |
4362 | "-l" (expand-file-name "~/.emacs") | |
4363 | "-l" "idlwave" | |
4364 | "-f" "idlwave-rescan-catalog-directories")) | |
4b1aaa8b | 4365 | (process (apply 'start-process "idlcat" |
5e72c6b2 S |
4366 | nil emacs args))) |
4367 | (setq idlwave-catalog-process process) | |
4b1aaa8b | 4368 | (set-process-sentinel |
5e72c6b2 S |
4369 | process |
4370 | (lambda (pro why) | |
4371 | (when (string-match "finished" why) | |
4372 | (setq idlwave-routines nil | |
4373 | idlwave-system-routines nil | |
4374 | idlwave-catalog-process nil) | |
4375 | (or (idlwave-start-load-rinfo-timer) | |
4376 | (idlwave-update-routine-info '(4)))))) | |
4377 | (message "Background job started to update catalog file"))) | |
4378 | ||
4379 | ||
52a244eb S |
4380 | ;; Format for all routine info user catalog, library catalogs, etc.: |
4381 | ;; | |
4382 | ;; ("ROUTINE" type class | |
4383 | ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") | | |
4384 | ;; (buffer pro_file dir) | (compiled pro_file dir) | |
4b1aaa8b | 4385 | ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...)) |
f66f03de | 4386 | ;; ("HELPFILE2" (("KWD2" . link) ...)) ...) |
52a244eb S |
4387 | ;; |
4388 | ;; DIR will be supplied dynamically while loading library catalogs, | |
4389 | ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a | |
4390 | ;; complete filepath, in which case DIR is unnecessary. HELPFILE can | |
4391 | ;; be nil, as can LINK1, etc., if no HTML help is available. | |
4392 | ||
4393 | ||
5e72c6b2 | 4394 | (defvar idlwave-load-rinfo-idle-timer) |
3938cb82 S |
4395 | (defvar idlwave-shell-path-query) |
4396 | ||
52a244eb | 4397 | (defun idlwave-update-routine-info (&optional arg no-concatenate) |
f32b3b91 CD |
4398 | "Update the internal routine-info lists. |
4399 | These lists are used by `idlwave-routine-info' (\\[idlwave-routine-info]) | |
4400 | and by `idlwave-complete' (\\[idlwave-complete]) to provide information | |
4401 | about individual routines. | |
4402 | ||
4403 | The information can come from 4 sources: | |
4404 | 1. IDL programs in the current editing session | |
4405 | 2. Compiled modules in an IDL shell running as Emacs subprocess | |
4406 | 3. A list which covers the IDL system routines. | |
4407 | 4. A list which covers the prescanned library files. | |
4408 | ||
4409 | Scans all IDLWAVE-mode buffers of the current editing session (see | |
4410 | `idlwave-scan-all-buffers-for-routine-info'). | |
4411 | When an IDL shell is running, this command also queries the IDL program | |
4412 | for currently compiled routines. | |
4413 | ||
4414 | With prefix ARG, also reload the system and library lists. | |
52a244eb S |
4415 | With two prefix ARG's, also rescans the chosen user catalog tree. |
4416 | With three prefix args, dispatch asynchronous process to do the update. | |
4417 | ||
4418 | If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info | |
4419 | lists, but instead wait for the shell query to complete and | |
4420 | asynchronously finish updating routine info. This is set | |
4421 | automatically when called interactively. When you need routine | |
4422 | information updated immediately, leave NO-CONCATENATE nil." | |
751adbde | 4423 | (interactive "P\np") |
5e72c6b2 S |
4424 | ;; Stop any idle processing |
4425 | (if (or (and (fboundp 'itimerp) | |
4426 | (itimerp idlwave-load-rinfo-idle-timer)) | |
4427 | (and (fboundp 'timerp) | |
4428 | (timerp idlwave-load-rinfo-idle-timer))) | |
4429 | (cancel-timer idlwave-load-rinfo-idle-timer)) | |
4430 | (cond | |
4431 | ((equal arg '(64)) | |
4432 | ;; Start a background process which updates the catalog. | |
4433 | (idlwave-rescan-asynchronously)) | |
4434 | ((equal arg '(16)) | |
52a244eb S |
4435 | ;; Update the user catalog now, and wait for them. |
4436 | (idlwave-create-user-catalog-file t)) | |
5e72c6b2 S |
4437 | (t |
4438 | (let* ((load (or arg | |
4439 | idlwave-buffer-case-takes-precedence | |
4440 | (null idlwave-routines))) | |
4441 | ;; The override-idle means, even if the idle timer has done some | |
4442 | ;; preparing work, load and renormalize everything anyway. | |
4443 | (override-idle (or arg idlwave-buffer-case-takes-precedence))) | |
4b1aaa8b | 4444 | |
f32b3b91 | 4445 | (setq idlwave-buffer-routines nil |
15e42531 CD |
4446 | idlwave-compiled-routines nil |
4447 | idlwave-unresolved-routines nil) | |
f32b3b91 | 4448 | ;; Reset the appropriate hashes |
5e72c6b2 S |
4449 | (if (get 'idlwave-reset-sintern 'done-by-idle) |
4450 | ;; reset was already done in idle time, so skip this step now once | |
4451 | (put 'idlwave-reset-sintern 'done-by-idle nil) | |
4452 | (idlwave-reset-sintern (cond (load t) | |
4453 | ((null idlwave-system-routines) t) | |
4454 | (t 'bufsh)))) | |
4b1aaa8b | 4455 | |
f32b3b91 CD |
4456 | (if idlwave-buffer-case-takes-precedence |
4457 | ;; We can safely scan the buffer stuff first | |
4458 | (progn | |
4459 | (idlwave-update-buffer-routine-info) | |
f66f03de | 4460 | (and load (idlwave-load-all-rinfo override-idle))) |
f32b3b91 | 4461 | ;; We first do the system info, and then the buffers |
f66f03de | 4462 | (and load (idlwave-load-all-rinfo override-idle)) |
f32b3b91 CD |
4463 | (idlwave-update-buffer-routine-info)) |
4464 | ||
4465 | ;; Let's see if there is a shell | |
4466 | (let* ((shell-is-running (and (fboundp 'idlwave-shell-is-running) | |
4467 | (idlwave-shell-is-running))) | |
4468 | (ask-shell (and shell-is-running | |
4469 | idlwave-query-shell-for-routine-info))) | |
4b1aaa8b | 4470 | |
52a244eb | 4471 | ;; Load the library catalogs again, first re-scanning the path |
4b1aaa8b | 4472 | (when arg |
52a244eb S |
4473 | (if shell-is-running |
4474 | (idlwave-shell-send-command idlwave-shell-path-query | |
4475 | '(progn | |
4476 | (idlwave-shell-get-path-info) | |
4477 | (idlwave-scan-library-catalogs)) | |
4478 | 'hide) | |
4479 | (idlwave-scan-library-catalogs))) | |
775591f7 | 4480 | |
f32b3b91 | 4481 | (if (or (not ask-shell) |
52a244eb | 4482 | (not no-concatenate)) |
f32b3b91 CD |
4483 | ;; 1. If we are not going to ask the shell, we need to do the |
4484 | ;; concatenation now. | |
52a244eb S |
4485 | ;; 2. When this function is called non-interactively, it |
4486 | ;; means that someone needs routine info *now*. The | |
4487 | ;; shell update causes the concatenation to be | |
4488 | ;; *delayed*, so not in time for the current command. | |
4489 | ;; Therefore, we do a concatenation now, even though | |
4490 | ;; the shell might do it again. | |
4491 | (idlwave-concatenate-rinfo-lists nil 'run-hooks)) | |
4b1aaa8b | 4492 | |
f32b3b91 | 4493 | (when ask-shell |
52a244eb | 4494 | ;; Ask the shell about the routines it knows of. |
f32b3b91 | 4495 | (message "Querying the shell") |
5e72c6b2 S |
4496 | (idlwave-shell-update-routine-info nil t))))))) |
4497 | ||
52a244eb S |
4498 | |
4499 | (defvar idlwave-load-rinfo-steps-done (make-vector 6 nil)) | |
5e72c6b2 S |
4500 | (defvar idlwave-load-rinfo-idle-timer nil) |
4501 | (defun idlwave-start-load-rinfo-timer () | |
4502 | (if (or (and (fboundp 'itimerp) | |
4503 | (itimerp idlwave-load-rinfo-idle-timer)) | |
4504 | (and (fboundp 'timerp) | |
4505 | (timerp idlwave-load-rinfo-idle-timer))) | |
4506 | (cancel-timer idlwave-load-rinfo-idle-timer)) | |
52a244eb | 4507 | (setq idlwave-load-rinfo-steps-done (make-vector 6 nil)) |
5e72c6b2 S |
4508 | (setq idlwave-load-rinfo-idle-timer nil) |
4509 | (if (and idlwave-init-rinfo-when-idle-after | |
4510 | (numberp idlwave-init-rinfo-when-idle-after) | |
4511 | (not (equal 0 idlwave-init-rinfo-when-idle-after)) | |
4512 | (not idlwave-routines)) | |
4513 | (condition-case nil | |
4514 | (progn | |
4515 | (setq idlwave-load-rinfo-idle-timer | |
4516 | (run-with-idle-timer | |
4517 | idlwave-init-rinfo-when-idle-after | |
4518 | nil 'idlwave-load-rinfo-next-step))) | |
4519 | (error nil)))) | |
4520 | ||
f66f03de S |
4521 | ;;------ XML Help routine info system |
4522 | (defun idlwave-load-system-routine-info () | |
4523 | ;; Load the system routine info from the cached routine info file, | |
4524 | ;; which, if necessary, will be re-created from the XML file on | |
4525 | ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo | |
4526 | ;; file distributed with older IDLWAVE versions (<6.0) | |
4b1aaa8b | 4527 | (unless (and (load idlwave-xml-system-rinfo-converted-file |
f66f03de S |
4528 | 'noerror 'nomessage) |
4529 | (idlwave-xml-system-routine-info-up-to-date)) | |
4530 | ;; See if we can create it from XML source | |
4531 | (condition-case nil | |
4532 | (idlwave-convert-xml-system-routine-info) | |
4b1aaa8b PE |
4533 | (error |
4534 | (unless (load idlwave-xml-system-rinfo-converted-file | |
f66f03de S |
4535 | 'noerror 'nomessage) |
4536 | (if idlwave-system-routines | |
4b1aaa8b | 4537 | (message |
f66f03de | 4538 | "Failed to load converted routine info, using old conversion.") |
4b1aaa8b | 4539 | (message |
f66f03de S |
4540 | "Failed to convert XML routine info, falling back on idlw-rinfo.") |
4541 | (if (not (load "idlw-rinfo" 'noerror 'nomessage)) | |
4b1aaa8b | 4542 | (message |
f66f03de S |
4543 | "Could not locate any system routine information.")))))))) |
4544 | ||
4545 | (defun idlwave-xml-system-routine-info-up-to-date() | |
4b1aaa8b | 4546 | (let* ((dir (file-name-as-directory |
f66f03de S |
4547 | (expand-file-name "help/online_help" (idlwave-sys-dir)))) |
4548 | (catalog-file (expand-file-name "idl_catalog.xml" dir))) | |
4549 | (file-newer-than-file-p ;converted file is newer than catalog | |
4550 | idlwave-xml-system-rinfo-converted-file | |
4551 | catalog-file))) | |
4552 | ||
4553 | (defvar idlwave-system-class-info nil) ; Gathered from idlw-rinfo | |
4554 | (defvar idlwave-system-variables-alist nil | |
4555 | "Alist of system variables and the associated structure tags. | |
4556 | Gets set in cached XML rinfo, or `idlw-rinfo.el'.") | |
4557 | (defvar idlwave-executive-commands-alist nil | |
4558 | "Alist of system variables and their help files.") | |
4559 | (defvar idlwave-help-special-topic-words nil) | |
4560 | ||
4b1aaa8b | 4561 | |
f66f03de | 4562 | (defun idlwave-shorten-syntax (syntax name &optional class) |
5a89f0a7 | 4563 | ;; From a list of syntax statements, shorten with %s and group with "or" |
f66f03de | 4564 | (let ((case-fold-search t)) |
4b1aaa8b | 4565 | (mapconcat |
f66f03de S |
4566 | (lambda (x) |
4567 | (while (string-match name x) | |
4568 | (setq x (replace-match "%s" t t x))) | |
4b1aaa8b | 4569 | (if class |
f66f03de S |
4570 | (while (string-match class x) |
4571 | (setq x (replace-match "%s" t t x)))) | |
4572 | x) | |
4573 | (nreverse syntax) | |
4574 | " or "))) | |
4575 | ||
4576 | (defun idlwave-xml-create-class-method-lists (xml-entry) | |
4577 | ;; Create a class list entry from the xml parsed list., returning a | |
4578 | ;; cons of form (class-entry method-entries). | |
4579 | (let* ((nameblock (nth 1 xml-entry)) | |
4580 | (class (cdr (assq 'name nameblock))) | |
4581 | (link (cdr (assq 'link nameblock))) | |
4582 | (params (cddr xml-entry)) | |
4583 | (case-fold-search t) | |
4584 | class-entry | |
4585 | method methods-entry extra-kwds | |
4586 | props get-props set-props init-props inherits | |
4587 | pelem ptype) | |
4588 | (while params | |
4589 | (setq pelem (car params)) | |
4590 | (when (listp pelem) | |
4591 | (setq ptype (car pelem) | |
4592 | props (car (cdr pelem))) | |
4593 | (cond | |
4594 | ((eq ptype 'SUPERCLASS) | |
58c8f915 S |
4595 | (let ((pname (cdr (assq 'name props))) |
4596 | (plink (cdr (assq 'link props)))) | |
4597 | (unless (and (string= pname "None") | |
4598 | (string= plink "None")) | |
4599 | (push pname inherits)))) | |
f66f03de S |
4600 | |
4601 | ((eq ptype 'PROPERTY) | |
4602 | (let ((pname (cdr (assq 'name props))) | |
4603 | (plink (cdr (assq 'link props))) | |
4604 | (get (string= (cdr (assq 'get props)) "Yes")) | |
4605 | (set (string= (cdr (assq 'set props)) "Yes")) | |
4606 | (init (string= (cdr (assq 'init props)) "Yes"))) | |
4607 | (if get (push (list pname plink) get-props)) | |
4608 | (if set (push (list pname plink) set-props)) | |
4609 | (if init (push (list pname plink) init-props)))) | |
4610 | ||
4611 | ((eq ptype 'METHOD) | |
4612 | (setq method (cdr (assq 'name props))) | |
4613 | (setq extra-kwds ;;Assume all property keywords are gathered already | |
4614 | (cond | |
4615 | ((string-match (concat class "::Init") method) | |
4616 | (put 'init-props 'matched t) | |
4617 | init-props) | |
4618 | ((string-match (concat class "::GetProperty") method) | |
4619 | (put 'get-props 'matched t) | |
4620 | get-props) | |
4621 | ((string-match (concat class "::SetProperty") method) | |
4622 | (put 'set-props 'matched t) | |
4623 | set-props) | |
4624 | (t nil))) | |
4b1aaa8b PE |
4625 | (setq methods-entry |
4626 | (nconc (idlwave-xml-create-rinfo-list pelem class extra-kwds) | |
f66f03de S |
4627 | methods-entry))) |
4628 | (t))) | |
4629 | (setq params (cdr params))) | |
8d222148 SM |
4630 | ;;(unless (get 'init-props 'matched) |
4631 | ;; (message "Failed to match Init in class %s" class)) | |
4632 | ;;(unless (get 'get-props 'matched) | |
4633 | ;; (message "Failed to match GetProperty in class %s" class)) | |
4634 | ;;(unless (get 'set-props 'matched) | |
4635 | ;; (message "Failed to match SetProperty in class %s" class)) | |
4b1aaa8b PE |
4636 | (setq class-entry |
4637 | (if inherits | |
f66f03de S |
4638 | (list class (append '(inherits) inherits) (list 'link link)) |
4639 | (list class (list 'link link)))) | |
4640 | (cons class-entry methods-entry))) | |
4b1aaa8b | 4641 | |
f66f03de S |
4642 | (defun idlwave-xml-create-rinfo-list (xml-entry &optional class extra-kws) |
4643 | ;; Create correctly structured list elements from ROUTINE or METHOD | |
4644 | ;; XML list structures. Return a list of list elements, with more | |
4645 | ;; than one sub-list possible if a routine can serve as both | |
4646 | ;; procedure and function (e.g. call_method). | |
4647 | (let* ((nameblock (nth 1 xml-entry)) | |
4648 | (name (cdr (assq 'name nameblock))) | |
4649 | (link (cdr (assq 'link nameblock))) | |
4650 | (params (cddr xml-entry)) | |
4651 | (syntax-vec (make-vector 3 nil)) ; procedure, function, exec command | |
4652 | (case-fold-search t) | |
8d222148 | 4653 | syntax kwd klink pref-list kwds pelem ptype props result type) |
f66f03de S |
4654 | (if class ;; strip out class name from class method name string |
4655 | (if (string-match (concat class "::") name) | |
4656 | (setq name (substring name (match-end 0))))) | |
4657 | (while params | |
4658 | (setq pelem (car params)) | |
4659 | (when (listp pelem) | |
4660 | (setq ptype (car pelem) | |
4661 | props (car (cdr pelem))) | |
4662 | (cond | |
4663 | ((eq ptype 'SYNTAX) | |
4664 | (setq syntax (cdr (assq 'name props))) | |
4665 | (if (string-match "->" syntax) | |
4666 | (setq syntax (replace-match "->" t nil syntax))) | |
4667 | (setq type (cdr (assq 'type props))) | |
4668 | (push syntax | |
4669 | (aref syntax-vec (cond | |
4670 | ((string-match "^pro" type) 0) | |
4671 | ((string-match "^fun" type) 1) | |
4672 | ((string-match "^exec" type) 2))))) | |
4673 | ((eq ptype 'KEYWORD) | |
4674 | (setq kwd (cdr (assq 'name props)) | |
4675 | klink (cdr (assq 'link props))) | |
4676 | (if (string-match "^\\[XY\\(Z?\\)\\]" kwd) | |
4b1aaa8b PE |
4677 | (progn |
4678 | (setq pref-list | |
f66f03de S |
4679 | (if (match-string 1 kwd) '("X" "Y" "Z") '("X" "Y")) |
4680 | kwd (substring kwd (match-end 0))) | |
4681 | (loop for x in pref-list do | |
4682 | (push (list (concat x kwd) klink) kwds))) | |
4683 | (push (list kwd klink) kwds))) | |
4684 | ||
4685 | (t))); Do nothing for the others | |
4686 | (setq params (cdr params))) | |
4b1aaa8b | 4687 | |
f66f03de | 4688 | ;; Debug |
8d222148 SM |
4689 | ;; (if (and (null (aref syntax-vec 0)) |
4690 | ;; (null (aref syntax-vec 1)) | |
4691 | ;; (null (aref syntax-vec 2))) | |
4692 | ;; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints") | |
4693 | ;; (if class | |
4694 | ;; (insert (format "Missing SYNTAX entry for %s::%s\n" class name)) | |
4695 | ;; (insert (message "Missing SYNTAX entry for %s\n" name))))) | |
f66f03de S |
4696 | |
4697 | ;; Executive commands are treated specially | |
4698 | (if (aref syntax-vec 2) | |
4699 | (cons (substring name 1) link) | |
4700 | (if extra-kws (setq kwds (nconc kwds extra-kws))) | |
4701 | (setq kwds (idlwave-rinfo-group-keywords kwds link)) | |
4702 | (loop for idx from 0 to 1 do | |
4703 | (if (aref syntax-vec idx) | |
4b1aaa8b | 4704 | (push (append (list name (if (eq idx 0) 'pro 'fun) |
f66f03de | 4705 | class '(system) |
4b1aaa8b | 4706 | (idlwave-shorten-syntax |
f66f03de S |
4707 | (aref syntax-vec idx) name class)) |
4708 | kwds) result))) | |
4709 | result))) | |
4710 | ||
4711 | ||
4712 | (defun idlwave-rinfo-group-keywords (kwds master-link) | |
4b1aaa8b | 4713 | ;; Group keywords by link file, as a list with elements |
f66f03de S |
4714 | ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2)) |
4715 | (let (kwd link anchor linkfiles block master-elt) | |
4716 | (while kwds | |
4717 | (setq kwd (car kwds) | |
4718 | link (idlwave-split-link-target (nth 1 kwd)) | |
4719 | anchor (cdr link) | |
4720 | link (car link) | |
4721 | kwd (car kwd)) | |
4722 | (if (setq block (assoc link linkfiles)) | |
4723 | (push (cons kwd anchor) (cdr block)) | |
4724 | (push (list link (cons kwd anchor)) linkfiles)) | |
4725 | (setq kwds (cdr kwds))) | |
4726 | ;; Ensure the master link is there | |
4727 | (if (setq master-elt (assoc master-link linkfiles)) | |
4728 | (if (eq (car linkfiles) master-elt) | |
4729 | linkfiles | |
4730 | (cons master-elt (delq master-elt linkfiles))) | |
4731 | (push (list master-link) linkfiles)))) | |
4b1aaa8b | 4732 | |
f66f03de S |
4733 | (defun idlwave-convert-xml-clean-statement-aliases (aliases) |
4734 | ;; Clean up the syntax of routines which are actually aliases by | |
4735 | ;; removing the "OR" from the statements | |
4736 | (let (syntax entry) | |
4737 | (loop for x in aliases do | |
4738 | (setq entry (assoc x idlwave-system-routines)) | |
4739 | (when entry | |
4740 | (while (string-match " +or +" (setq syntax (nth 4 entry))) | |
4741 | (setf (nth 4 entry) (replace-match ", " t t syntax))))))) | |
4742 | ||
4743 | (defun idlwave-convert-xml-clean-routine-aliases (aliases) | |
4744 | ;; Duplicate and trim original routine aliases from rinfo list | |
4b1aaa8b | 4745 | ;; This if for, e.g. OPENR/OPENW/OPENU |
f66f03de S |
4746 | (let (alias remove-list new parts all-parts) |
4747 | (loop for x in aliases do | |
4748 | (when (setq parts (split-string (cdr x) "/")) | |
4749 | (setq new (assoc (cdr x) all-parts)) | |
4750 | (unless new | |
4751 | (setq new (cons (cdr x) parts)) | |
4752 | (push new all-parts)) | |
4753 | (setcdr new (delete (car x) (cdr new))))) | |
4b1aaa8b | 4754 | |
f66f03de S |
4755 | ;; Add any missing aliases (separate by slashes) |
4756 | (loop for x in all-parts do | |
4757 | (if (cdr x) | |
4758 | (push (cons (nth 1 x) (car x)) aliases))) | |
4759 | ||
4760 | (loop for x in aliases do | |
4761 | (when (setq alias (assoc (cdr x) idlwave-system-routines)) | |
4762 | (unless (memq alias remove-list) (push alias remove-list)) | |
4763 | (setq alias (copy-sequence alias)) | |
4764 | (setcar alias (car x)) | |
4765 | (push alias idlwave-system-routines))) | |
4766 | (loop for x in remove-list do | |
4767 | (delq x idlwave-system-routines)))) | |
4768 | ||
4769 | (defun idlwave-convert-xml-clean-sysvar-aliases (aliases) | |
4770 | ;; Duplicate and trim original routine aliases from rinfo list | |
4771 | ;; This if for, e.g. !X, !Y, !Z. | |
8d222148 | 4772 | (let (alias remove-list) |
f66f03de S |
4773 | (loop for x in aliases do |
4774 | (when (setq alias (assoc (cdr x) idlwave-system-variables-alist)) | |
4775 | (unless (memq alias remove-list) (push alias remove-list)) | |
4776 | (setq alias (copy-sequence alias)) | |
4777 | (setcar alias (car x)) | |
4778 | (push alias idlwave-system-variables-alist))) | |
4779 | (loop for x in remove-list do | |
4780 | (delq x idlwave-system-variables-alist)))) | |
4781 | ||
4782 | ||
4783 | (defun idlwave-xml-create-sysvar-alist (xml-entry) | |
4784 | ;; Create a sysvar list entry from the xml parsed list. | |
4785 | (let* ((nameblock (nth 1 xml-entry)) | |
a86bd650 | 4786 | (name (cdr (assq 'name nameblock))) |
b9e4fbd3 | 4787 | (sysvar (substring name (progn (string-match "^ *!" name) |
a86bd650 | 4788 | (match-end 0)))) |
f66f03de S |
4789 | (link (cdr (assq 'link nameblock))) |
4790 | (params (cddr xml-entry)) | |
4791 | (case-fold-search t) | |
8d222148 | 4792 | pelem ptype props tags) |
f66f03de S |
4793 | (while params |
4794 | (setq pelem (car params)) | |
4795 | (when (listp pelem) | |
4796 | (setq ptype (car pelem) | |
4797 | props (car (cdr pelem))) | |
4798 | (cond | |
4799 | ((eq ptype 'FIELD) | |
4b1aaa8b | 4800 | (push (cons (cdr (assq 'name props)) |
f66f03de S |
4801 | (cdr |
4802 | (idlwave-split-link-target (cdr (assq 'link props))))) | |
4803 | tags)))) | |
4804 | (setq params (cdr params))) | |
4805 | (delq nil | |
4806 | (list sysvar (if tags (cons 'tags tags)) (list 'link link))))) | |
4807 | ||
4808 | ||
4809 | (defvar idlwave-xml-routine-info-file nil) | |
4810 | ||
4811 | (defun idlwave-save-routine-info () | |
4812 | (if idlwave-xml-routine-info-file | |
4813 | (with-temp-file idlwave-xml-system-rinfo-converted-file | |
4b1aaa8b | 4814 | (insert |
f66f03de | 4815 | (concat ";; *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-* |
4b1aaa8b PE |
4816 | ;; IDLWAVE Routine Information File (IDLWAVE version " idlwave-mode-version ") |
4817 | ;; Automatically generated from source file: | |
f66f03de S |
4818 | ;; " idlwave-xml-routine-info-file " |
4819 | ;; on " (current-time-string) " | |
4820 | ;; Do not edit.")) | |
4821 | (insert (format "\n(setq idlwave-xml-routine-info-file \n \"%s\")" | |
4822 | idlwave-xml-routine-info-file)) | |
4823 | (insert "\n(setq idlwave-system-routines\n '") | |
4824 | (prin1 idlwave-system-routines (current-buffer)) | |
4825 | (insert ")") | |
4826 | (insert "\n(setq idlwave-system-variables-alist\n '") | |
4827 | (prin1 idlwave-system-variables-alist (current-buffer)) | |
4828 | (insert ")") | |
4829 | (insert "\n(setq idlwave-system-class-info\n '") | |
4830 | (prin1 idlwave-system-class-info (current-buffer)) | |
4831 | (insert ")") | |
4832 | (insert "\n(setq idlwave-executive-commands-alist\n '") | |
4833 | (prin1 idlwave-executive-commands-alist (current-buffer)) | |
4834 | (insert ")") | |
4835 | (insert "\n(setq idlwave-help-special-topic-words\n '") | |
4836 | (prin1 idlwave-help-special-topic-words (current-buffer)) | |
4837 | (insert ")")))) | |
4838 | ||
4839 | (defun idlwave-convert-xml-system-routine-info () | |
4840 | "Convert XML supplied IDL routine info into internal form. | |
4841 | Cache to disk for quick recovery." | |
4842 | (interactive) | |
4b1aaa8b | 4843 | (let* ((dir (file-name-as-directory |
f66f03de S |
4844 | (expand-file-name "help/online_help" (idlwave-sys-dir)))) |
4845 | (catalog-file (expand-file-name "idl_catalog.xml" dir)) | |
4846 | (elem-cnt 0) | |
4b1aaa8b | 4847 | props rinfo msg-cnt elem type nelem class-result alias |
8d222148 | 4848 | routines routine-aliases statement-aliases sysvar-aliases) |
f66f03de S |
4849 | (if (not (file-exists-p catalog-file)) |
4850 | (error "No such XML routine info file: %s" catalog-file) | |
4851 | (if (not (file-readable-p catalog-file)) | |
4852 | (error "Cannot read XML routine info file: %s" catalog-file))) | |
4b1aaa8b | 4853 | (message "Reading XML routine info...") |
e08734e2 | 4854 | (setq rinfo (xml-parse-file catalog-file)) |
f66f03de S |
4855 | (message "Reading XML routine info...done") |
4856 | (setq rinfo (assq 'CATALOG rinfo)) | |
4857 | (unless rinfo (error "Failed to parse XML routine info")) | |
4858 | ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff. | |
4b1aaa8b | 4859 | |
8d222148 | 4860 | (setq rinfo (cddr rinfo)) |
f66f03de S |
4861 | |
4862 | (setq nelem (length rinfo) | |
4863 | msg-cnt (/ nelem 20)) | |
4b1aaa8b | 4864 | |
f66f03de S |
4865 | (setq idlwave-xml-routine-info-file nil) |
4866 | (message "Converting XML routine info...") | |
4867 | (setq idlwave-system-routines nil | |
4868 | idlwave-system-variables-alist nil | |
4869 | idlwave-system-class-info nil | |
4870 | idlwave-executive-commands-alist nil | |
4871 | idlwave-help-special-topic-words nil) | |
4872 | ||
4873 | (while rinfo | |
4874 | (setq elem (car rinfo) | |
4875 | rinfo (cdr rinfo)) | |
4876 | (incf elem-cnt) | |
4877 | (when (listp elem) | |
4878 | (setq type (car elem) | |
4879 | props (car (cdr elem))) | |
4880 | (if (= (mod elem-cnt msg-cnt) 0) | |
4b1aaa8b | 4881 | (message "Converting XML routine info...%2d%%" |
f66f03de | 4882 | (/ (* elem-cnt 100) nelem))) |
4b1aaa8b | 4883 | (cond |
f66f03de S |
4884 | ((eq type 'ROUTINE) |
4885 | (if (setq alias (assq 'alias_to props)) | |
4b1aaa8b | 4886 | (push (cons (cdr (assq 'name props)) (cdr alias)) |
f66f03de S |
4887 | routine-aliases) |
4888 | (setq routines (idlwave-xml-create-rinfo-list elem)) | |
4889 | (if (listp (cdr routines)) | |
4890 | (setq idlwave-system-routines | |
4891 | (nconc idlwave-system-routines routines)) | |
4892 | ;; a cons cell is an executive commands | |
4893 | (push routines idlwave-executive-commands-alist)))) | |
4b1aaa8b | 4894 | |
f66f03de S |
4895 | ((eq type 'CLASS) |
4896 | (setq class-result (idlwave-xml-create-class-method-lists elem)) | |
4897 | (push (car class-result) idlwave-system-class-info) | |
4898 | (setq idlwave-system-routines | |
4899 | (nconc idlwave-system-routines (cdr class-result)))) | |
4900 | ||
4901 | ((eq type 'STATEMENT) | |
4902 | (push (cons (cdr (assq 'name props)) | |
4903 | (cdr (assq 'link props))) | |
4904 | idlwave-help-special-topic-words) | |
4905 | ;; Save the links to those which are statement aliases (not routines) | |
4906 | (if (setq alias (assq 'alias_to props)) | |
4907 | (unless (member (cdr alias) statement-aliases) | |
4908 | (push (cdr alias) statement-aliases)))) | |
4909 | ||
4910 | ((eq type 'SYSVAR) | |
4911 | (if (setq alias (cdr (assq 'alias_to props))) | |
4b1aaa8b | 4912 | (push (cons (substring (cdr (assq 'name props)) 1) |
f66f03de S |
4913 | (substring alias 1)) |
4914 | sysvar-aliases) | |
4b1aaa8b | 4915 | (push (idlwave-xml-create-sysvar-alist elem) |
f66f03de S |
4916 | idlwave-system-variables-alist))) |
4917 | (t)))) | |
4918 | (idlwave-convert-xml-clean-routine-aliases routine-aliases) | |
4919 | (idlwave-convert-xml-clean-statement-aliases statement-aliases) | |
4920 | (idlwave-convert-xml-clean-sysvar-aliases sysvar-aliases) | |
4921 | ||
4922 | (setq idlwave-xml-routine-info-file catalog-file) | |
4923 | (idlwave-save-routine-info) | |
4924 | (message "Converting XML routine info...done"))) | |
4b1aaa8b PE |
4925 | |
4926 | ||
f66f03de S |
4927 | ;; ("ROUTINE" type class |
4928 | ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") | | |
4929 | ;; (buffer pro_file dir) | (compiled pro_file dir) | |
4b1aaa8b | 4930 | ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...)) |
f66f03de S |
4931 | ;; ("HELPFILE2" (("KWD2" . link) ...)) ...) |
4932 | ||
4933 | ||
5e72c6b2 S |
4934 | (defun idlwave-load-rinfo-next-step () |
4935 | (let ((inhibit-quit t) | |
4936 | (arr idlwave-load-rinfo-steps-done)) | |
f66f03de | 4937 | (if (catch 'exit |
5e72c6b2 | 4938 | (when (not (aref arr 0)) |
f66f03de S |
4939 | (message "Loading system routine info in idle time...") |
4940 | (idlwave-load-system-routine-info) | |
4941 | ;;(load "idlw-rinfo" 'noerror 'nomessage) | |
4942 | (message "Loading system routine info in idle time...done") | |
5e72c6b2 S |
4943 | (aset arr 0 t) |
4944 | (throw 'exit t)) | |
4b1aaa8b | 4945 | |
5e72c6b2 S |
4946 | (when (not (aref arr 1)) |
4947 | (message "Normalizing idlwave-system-routines in idle time...") | |
4948 | (idlwave-reset-sintern t) | |
4949 | (put 'idlwave-reset-sintern 'done-by-idle t) | |
4950 | (setq idlwave-system-routines | |
4951 | (idlwave-sintern-rinfo-list idlwave-system-routines 'sys)) | |
4952 | (message "Normalizing idlwave-system-routines in idle time...done") | |
4953 | (aset arr 1 t) | |
4954 | (throw 'exit t)) | |
f66f03de | 4955 | |
5e72c6b2 | 4956 | (when (not (aref arr 2)) |
52a244eb S |
4957 | (when (and (stringp idlwave-user-catalog-file) |
4958 | (file-regular-p idlwave-user-catalog-file)) | |
4959 | (message "Loading user catalog in idle time...") | |
5e72c6b2 | 4960 | (condition-case nil |
52a244eb S |
4961 | (load-file idlwave-user-catalog-file) |
4962 | (error (throw 'exit nil))) | |
4963 | ;; Check for the old style catalog and warn | |
4964 | (if (and | |
4965 | (boundp 'idlwave-library-routines) | |
4966 | idlwave-library-routines) | |
775591f7 | 4967 | (progn |
52a244eb S |
4968 | (setq idlwave-library-routines nil) |
4969 | (ding) | |
4b1aaa8b | 4970 | (message "Outdated user catalog: %s... recreate" |
52a244eb | 4971 | idlwave-user-catalog-file)) |
f66f03de S |
4972 | (message "Loading user catalog in idle time...done"))) |
4973 | (aset arr 2 t) | |
4974 | (throw 'exit t)) | |
4975 | ||
5e72c6b2 | 4976 | (when (not (aref arr 3)) |
52a244eb S |
4977 | (when idlwave-user-catalog-routines |
4978 | (message "Normalizing user catalog routines in idle time...") | |
4b1aaa8b | 4979 | (setq idlwave-user-catalog-routines |
52a244eb S |
4980 | (idlwave-sintern-rinfo-list |
4981 | idlwave-user-catalog-routines 'sys)) | |
4b1aaa8b | 4982 | (message |
52a244eb | 4983 | "Normalizing user catalog routines in idle time...done")) |
5e72c6b2 S |
4984 | (aset arr 3 t) |
4985 | (throw 'exit t)) | |
f66f03de | 4986 | |
5e72c6b2 | 4987 | (when (not (aref arr 4)) |
4b1aaa8b | 4988 | (idlwave-scan-library-catalogs |
52a244eb S |
4989 | "Loading and normalizing library catalogs in idle time...") |
4990 | (aset arr 4 t) | |
4991 | (throw 'exit t)) | |
4992 | (when (not (aref arr 5)) | |
5e72c6b2 S |
4993 | (message "Finishing initialization in idle time...") |
4994 | (idlwave-routines) | |
4995 | (message "Finishing initialization in idle time...done") | |
4b1aaa8b | 4996 | (aset arr 5 t) |
5e72c6b2 | 4997 | (throw 'exit nil))) |
52a244eb S |
4998 | ;; restart the timer |
4999 | (if (sit-for 1) | |
5000 | (idlwave-load-rinfo-next-step) | |
5001 | (setq idlwave-load-rinfo-idle-timer | |
5002 | (run-with-idle-timer | |
5003 | idlwave-init-rinfo-when-idle-after | |
5004 | nil 'idlwave-load-rinfo-next-step)))))) | |
5e72c6b2 | 5005 | |
8d222148 SM |
5006 | (defvar idlwave-after-load-rinfo-hook nil) |
5007 | ||
f66f03de S |
5008 | (defun idlwave-load-all-rinfo (&optional force) |
5009 | ;; Load and case-treat the system, user catalog, and library routine | |
5010 | ;; info files. | |
5011 | ||
5012 | ;; System | |
5e72c6b2 | 5013 | (when (or force (not (aref idlwave-load-rinfo-steps-done 0))) |
f66f03de S |
5014 | ;;(load "idlw-rinfo" 'noerror 'nomessage)) |
5015 | (idlwave-load-system-routine-info)) | |
5e72c6b2 S |
5016 | (when (or force (not (aref idlwave-load-rinfo-steps-done 1))) |
5017 | (message "Normalizing idlwave-system-routines...") | |
5018 | (setq idlwave-system-routines | |
5019 | (idlwave-sintern-rinfo-list idlwave-system-routines 'sys)) | |
5020 | (message "Normalizing idlwave-system-routines...done")) | |
f66f03de S |
5021 | (when idlwave-system-routines |
5022 | (setq idlwave-routines (copy-sequence idlwave-system-routines)) | |
5023 | (setq idlwave-last-system-routine-info-cons-cell | |
5024 | (nthcdr (1- (length idlwave-routines)) idlwave-routines))) | |
5025 | ||
5026 | ;; User catalog | |
52a244eb S |
5027 | (when (and (stringp idlwave-user-catalog-file) |
5028 | (file-regular-p idlwave-user-catalog-file)) | |
f32b3b91 | 5029 | (condition-case nil |
52a244eb S |
5030 | (when (or force (not (aref idlwave-load-rinfo-steps-done 2))) |
5031 | (load-file idlwave-user-catalog-file)) | |
5032 | (error nil)) | |
4b1aaa8b | 5033 | (when (and |
f66f03de S |
5034 | (boundp 'idlwave-library-routines) |
5035 | idlwave-library-routines) | |
52a244eb | 5036 | (setq idlwave-library-routines nil) |
4b1aaa8b | 5037 | (error "Outdated user catalog: %s... recreate" |
f66f03de | 5038 | idlwave-user-catalog-file)) |
52a244eb S |
5039 | (setq idlwave-true-path-alist nil) |
5040 | (when (or force (not (aref idlwave-load-rinfo-steps-done 3))) | |
5041 | (message "Normalizing user catalog routines...") | |
4b1aaa8b PE |
5042 | (setq idlwave-user-catalog-routines |
5043 | (idlwave-sintern-rinfo-list | |
52a244eb S |
5044 | idlwave-user-catalog-routines 'sys)) |
5045 | (message "Normalizing user catalog routines...done"))) | |
f66f03de S |
5046 | |
5047 | ;; Library catalog | |
52a244eb S |
5048 | (when (or force (not (aref idlwave-load-rinfo-steps-done 4))) |
5049 | (idlwave-scan-library-catalogs | |
5050 | "Loading and normalizing library catalogs...")) | |
05a1abfc CD |
5051 | (run-hooks 'idlwave-after-load-rinfo-hook)) |
5052 | ||
f32b3b91 CD |
5053 | |
5054 | (defun idlwave-update-buffer-routine-info () | |
5055 | (let (res) | |
4b1aaa8b | 5056 | (cond |
15e42531 CD |
5057 | ((eq idlwave-scan-all-buffers-for-routine-info t) |
5058 | ;; Scan all buffers, current buffer last | |
5059 | (message "Scanning all buffers...") | |
4b1aaa8b | 5060 | (setq res (idlwave-get-routine-info-from-buffers |
15e42531 CD |
5061 | (reverse (buffer-list))))) |
5062 | ((null idlwave-scan-all-buffers-for-routine-info) | |
5063 | ;; Don't scan any buffers | |
5064 | (setq res nil)) | |
5065 | (t | |
f32b3b91 | 5066 | ;; Just scan this buffer |
175069ef | 5067 | (if (derived-mode-p 'idlwave-mode) |
f32b3b91 CD |
5068 | (progn |
5069 | (message "Scanning current buffer...") | |
5070 | (setq res (idlwave-get-routine-info-from-buffers | |
15e42531 | 5071 | (list (current-buffer)))))))) |
f32b3b91 | 5072 | ;; Put the result into the correct variable |
4b1aaa8b | 5073 | (setq idlwave-buffer-routines |
52a244eb | 5074 | (idlwave-sintern-rinfo-list res 'set)))) |
f32b3b91 | 5075 | |
05a1abfc | 5076 | (defun idlwave-concatenate-rinfo-lists (&optional quiet run-hook) |
f32b3b91 | 5077 | "Put the different sources for routine information together." |
4b1aaa8b | 5078 | ;; The sequence here is important because earlier definitions shadow |
f32b3b91 | 5079 | ;; later ones. We assume that if things in the buffers are newer |
52a244eb | 5080 | ;; then in the shell of the system, they are meant to be different. |
03983bdc GM |
5081 | (let ((temp (append idlwave-buffer-routines |
5082 | idlwave-compiled-routines | |
5083 | idlwave-library-catalog-routines | |
5084 | idlwave-user-catalog-routines))) | |
5085 | ;; Not actually used for anything? | |
5086 | (if idlwave-last-system-routine-info-cons-cell | |
5087 | (setcdr idlwave-last-system-routine-info-cons-cell temp) | |
5088 | (setq idlwave-last-system-routine-info-cons-cell (cons temp nil)))) | |
f32b3b91 | 5089 | (setq idlwave-class-alist nil) |
15e42531 | 5090 | |
f32b3b91 | 5091 | ;; Give a message with information about the number of routines we have. |
15e42531 | 5092 | (unless quiet |
4b1aaa8b | 5093 | (message |
52a244eb | 5094 | "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)" |
15e42531 CD |
5095 | (length idlwave-buffer-routines) |
5096 | (length idlwave-compiled-routines) | |
52a244eb S |
5097 | (length idlwave-library-catalog-routines) |
5098 | (length idlwave-user-catalog-routines) | |
05a1abfc CD |
5099 | (length idlwave-system-routines))) |
5100 | (if run-hook | |
5101 | (run-hooks 'idlwave-update-rinfo-hook))) | |
15e42531 CD |
5102 | |
5103 | (defun idlwave-class-alist () | |
5104 | "Return the class alist - make it if necessary." | |
5105 | (or idlwave-class-alist | |
5106 | (let (class) | |
5107 | (loop for x in idlwave-routines do | |
5108 | (when (and (setq class (nth 2 x)) | |
5109 | (not (assq class idlwave-class-alist))) | |
5110 | (push (list class) idlwave-class-alist))) | |
4b1aaa8b | 5111 | idlwave-class-alist))) |
15e42531 CD |
5112 | |
5113 | ;; Three functions for the hooks | |
5114 | (defun idlwave-save-buffer-update () | |
5115 | (idlwave-update-current-buffer-info 'save-buffer)) | |
5116 | (defun idlwave-kill-buffer-update () | |
5117 | (idlwave-update-current-buffer-info 'kill-buffer)) | |
5118 | (defun idlwave-new-buffer-update () | |
5119 | (idlwave-update-current-buffer-info 'find-file)) | |
5120 | ||
5121 | (defun idlwave-update-current-buffer-info (why) | |
5a0c3f56 JB |
5122 | "Update `idlwave-routines' for current buffer. |
5123 | Can run from `after-save-hook'." | |
175069ef | 5124 | (when (and (derived-mode-p 'idlwave-mode) |
15e42531 CD |
5125 | (or (eq t idlwave-auto-routine-info-updates) |
5126 | (memq why idlwave-auto-routine-info-updates)) | |
5127 | idlwave-scan-all-buffers-for-routine-info | |
5128 | idlwave-routines) | |
5129 | (condition-case nil | |
5130 | (let (routines) | |
5131 | (idlwave-replace-buffer-routine-info | |
5132 | (buffer-file-name) | |
5133 | (if (eq why 'kill-buffer) | |
5134 | nil | |
5135 | (setq routines | |
5136 | (idlwave-sintern-rinfo-list | |
5137 | (idlwave-get-routine-info-from-buffers | |
5138 | (list (current-buffer))) 'set)))) | |
5139 | (idlwave-concatenate-rinfo-lists 'quiet) | |
5140 | routines) | |
5141 | (error nil)))) | |
5142 | ||
5143 | (defun idlwave-replace-buffer-routine-info (file new) | |
5144 | "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW." | |
4b1aaa8b | 5145 | (let ((list idlwave-buffer-routines) |
15e42531 CD |
5146 | found) |
5147 | (while list | |
5148 | ;; The following test uses eq to make sure it works correctly | |
5149 | ;; when two buffers visit the same file. Then the file names | |
5150 | ;; will be equal, but not eq. | |
52a244eb | 5151 | (if (eq (idlwave-routine-source-file (nth 3 (car list))) file) |
15e42531 CD |
5152 | (progn |
5153 | (setcar list nil) | |
5154 | (setq found t)) | |
5155 | (if found | |
4b1aaa8b | 5156 | ;; End of that section reached. Jump. |
15e42531 CD |
5157 | (setq list nil))) |
5158 | (setq list (cdr list))) | |
5159 | (setq idlwave-buffer-routines | |
5160 | (append new (delq nil idlwave-buffer-routines))))) | |
f32b3b91 CD |
5161 | |
5162 | ;;----- Scanning buffers ------------------- | |
5163 | ||
5164 | (defun idlwave-get-routine-info-from-buffers (buffers) | |
5165 | "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS." | |
5166 | (let (buf routine-lists res) | |
5167 | (save-excursion | |
5168 | (while (setq buf (pop buffers)) | |
5169 | (set-buffer buf) | |
175069ef | 5170 | (if (and (derived-mode-p 'idlwave-mode) |
05a1abfc | 5171 | buffer-file-name) |
f32b3b91 CD |
5172 | ;; yes, this buffer has the right mode. |
5173 | (progn (setq res (condition-case nil | |
5174 | (idlwave-get-buffer-routine-info) | |
5175 | (error nil))) | |
5176 | (push res routine-lists))))) | |
5177 | ;; Concatenate the individual lists and return the result | |
5178 | (apply 'nconc routine-lists))) | |
5179 | ||
5180 | (defun idlwave-get-buffer-routine-info () | |
5181 | "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)." | |
5182 | (let* ((case-fold-search t) | |
5183 | routine-list string entry) | |
5184 | (save-excursion | |
5185 | (save-restriction | |
5186 | (widen) | |
5187 | (goto-char (point-min)) | |
4b1aaa8b | 5188 | (while (re-search-forward |
15e42531 | 5189 | "^[ \t]*\\(pro\\|function\\)[ \t]" nil t) |
76959b77 | 5190 | (setq string (buffer-substring-no-properties |
f32b3b91 | 5191 | (match-beginning 0) |
4b1aaa8b | 5192 | (progn |
f32b3b91 CD |
5193 | (idlwave-end-of-statement) |
5194 | (point)))) | |
5195 | (setq entry (idlwave-parse-definition string)) | |
5196 | (push entry routine-list)))) | |
5197 | routine-list)) | |
5198 | ||
15e42531 | 5199 | (defvar idlwave-scanning-lib-dir) |
8d222148 | 5200 | (defvar idlwave-scanning-lib) |
f32b3b91 CD |
5201 | (defun idlwave-parse-definition (string) |
5202 | "Parse a module definition." | |
5203 | (let ((case-fold-search t) | |
5204 | start name args type keywords class) | |
5205 | ;; Remove comments | |
5206 | (while (string-match ";.*" string) | |
5207 | (setq string (replace-match "" t t string))) | |
5208 | ;; Remove the continuation line stuff | |
5209 | (while (string-match "\\([^a-zA-Z0-9$_]\\)\\$[ \t]*\n" string) | |
5210 | (setq string (replace-match "\\1 " t nil string))) | |
05a1abfc CD |
5211 | (while (string-match "\n" string) |
5212 | (setq string (replace-match " " t nil string))) | |
f32b3b91 CD |
5213 | ;; Match the name and type. |
5214 | (when (string-match | |
5215 | "\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)" string) | |
5216 | (setq start (match-end 0)) | |
5217 | (setq type (downcase (match-string 1 string))) | |
5218 | (if (match-beginning 3) | |
5219 | (setq class (match-string 3 string))) | |
5220 | (setq name (match-string 4 string))) | |
5221 | ;; Match normal args and keyword args | |
5222 | (while (string-match | |
15e42531 | 5223 | ",\\s-*\\([a-zA-Z][a-zA-Z0-9$_]*\\|\\(_ref\\)?_extra\\)\\s-*\\(=\\)?" |
f32b3b91 CD |
5224 | string start) |
5225 | (setq start (match-end 0)) | |
15e42531 | 5226 | (if (match-beginning 3) |
f32b3b91 CD |
5227 | (push (match-string 1 string) keywords) |
5228 | (push (match-string 1 string) args))) | |
5229 | ;; Normalize and sort. | |
5230 | (setq args (nreverse args)) | |
4b1aaa8b | 5231 | (setq keywords (sort keywords (lambda (a b) |
f32b3b91 CD |
5232 | (string< (downcase a) (downcase b))))) |
5233 | ;; Make and return the entry | |
5234 | ;; We don't know which argument are optional, so this information | |
5235 | ;; will not be contained in the calling sequence. | |
5236 | (list name | |
5237 | (if (equal type "pro") 'pro 'fun) | |
5238 | class | |
5239 | (cond ((not (boundp 'idlwave-scanning-lib)) | |
52a244eb | 5240 | (list 'buffer (buffer-file-name))) |
d2c32364 | 5241 | ; ((string= (downcase (file-name-base)) |
15e42531 CD |
5242 | ; (downcase name)) |
5243 | ; (list 'lib)) | |
5244 | ; (t (cons 'lib (file-name-nondirectory (buffer-file-name)))) | |
52a244eb S |
5245 | (t (list 'user (file-name-nondirectory (buffer-file-name)) |
5246 | idlwave-scanning-lib-dir "UserLib"))) | |
4b1aaa8b | 5247 | (concat |
f32b3b91 CD |
5248 | (if (string= type "function") "Result = " "") |
5249 | (if class "Obj ->[%s::]" "") | |
5250 | "%s" | |
5251 | (if args | |
5252 | (concat | |
5253 | (if (string= type "function") "(" ", ") | |
5254 | (mapconcat 'identity args ", ") | |
5255 | (if (string= type "function") ")" "")))) | |
5256 | (if keywords | |
52a244eb | 5257 | (cons nil (mapcar 'list keywords)) ;No help file |
f32b3b91 CD |
5258 | nil)))) |
5259 | ||
f32b3b91 | 5260 | |
52a244eb | 5261 | ;;----- Scanning the user catalog ------------------- |
15e42531 CD |
5262 | |
5263 | (defun idlwave-sys-dir () | |
5264 | "Return the syslib directory, or a dummy that never matches." | |
3938cb82 S |
5265 | (cond |
5266 | ((and idlwave-system-directory | |
5267 | (not (string= idlwave-system-directory ""))) | |
5268 | idlwave-system-directory) | |
5269 | ((getenv "IDL_DIR")) | |
5270 | (t "@@@@@@@@"))) | |
5271 | ||
52a244eb | 5272 | |
52a244eb | 5273 | (defun idlwave-create-user-catalog-file (&optional arg) |
f32b3b91 | 5274 | "Scan all files on selected dirs of IDL search path for routine information. |
52a244eb S |
5275 | |
5276 | A widget checklist will allow you to choose the directories. Write | |
5277 | the result as a file `idlwave-user-catalog-file'. When this file | |
5a0c3f56 JB |
5278 | exists, it will be automatically loaded to give routine information |
5279 | about library routines. With ARG, just rescan the same directories | |
5280 | as last time - so no widget will pop up." | |
f32b3b91 CD |
5281 | (interactive "P") |
5282 | ;; Make sure the file is loaded if it exists. | |
52a244eb S |
5283 | (if (and (stringp idlwave-user-catalog-file) |
5284 | (file-regular-p idlwave-user-catalog-file)) | |
f32b3b91 | 5285 | (condition-case nil |
52a244eb | 5286 | (load-file idlwave-user-catalog-file) |
f32b3b91 CD |
5287 | (error nil))) |
5288 | ;; Make sure the file name makes sense | |
52a244eb S |
5289 | (unless (and (stringp idlwave-user-catalog-file) |
5290 | (> (length idlwave-user-catalog-file) 0) | |
f32b3b91 | 5291 | (file-accessible-directory-p |
52a244eb | 5292 | (file-name-directory idlwave-user-catalog-file)) |
4b1aaa8b | 5293 | (not (string= "" (file-name-nondirectory |
52a244eb S |
5294 | idlwave-user-catalog-file)))) |
5295 | (error "`idlwave-user-catalog-file' does not point to a file in an accessible directory")) | |
4b1aaa8b | 5296 | |
f32b3b91 | 5297 | (cond |
f32b3b91 | 5298 | ;; Rescan the known directories |
52a244eb S |
5299 | ((and arg idlwave-path-alist |
5300 | (consp (car idlwave-path-alist))) | |
5301 | (idlwave-scan-user-lib-files idlwave-path-alist)) | |
5302 | ||
5303 | ;; Expand the directories from library-path and run the widget | |
f32b3b91 | 5304 | (idlwave-library-path |
52a244eb | 5305 | (idlwave-display-user-catalog-widget |
4b1aaa8b | 5306 | (if idlwave-true-path-alist |
52a244eb S |
5307 | ;; Propagate any flags on the existing path-alist |
5308 | (mapcar (lambda (x) | |
5309 | (let ((path-entry (assoc (file-truename x) | |
5310 | idlwave-true-path-alist))) | |
5311 | (if path-entry | |
4b1aaa8b | 5312 | (cons x (cdr path-entry)) |
52a244eb S |
5313 | (list x)))) |
5314 | (idlwave-expand-path idlwave-library-path)) | |
5315 | (mapcar 'list (idlwave-expand-path idlwave-library-path))))) | |
5316 | ||
5317 | ;; Ask the shell for the path and then run the widget | |
f32b3b91 | 5318 | (t |
f32b3b91 | 5319 | (message "Asking the shell for IDL path...") |
15e42531 CD |
5320 | (require 'idlw-shell) |
5321 | (idlwave-shell-send-command idlwave-shell-path-query | |
52a244eb | 5322 | '(idlwave-user-catalog-command-hook nil) |
15e42531 | 5323 | 'hide)))) |
f32b3b91 | 5324 | |
52a244eb S |
5325 | |
5326 | ;; Parse shell path information and select among it. | |
5327 | (defun idlwave-user-catalog-command-hook (&optional arg) | |
5328 | ;; Command hook used by `idlwave-create-user-catalog-file'. | |
f32b3b91 CD |
5329 | (if arg |
5330 | ;; Scan immediately | |
52a244eb S |
5331 | (idlwave-scan-user-lib-files idlwave-path-alist) |
5332 | ;; Set the path and display the widget | |
5333 | (idlwave-shell-get-path-info 'no-write) ; set to something path-alist | |
5334 | (idlwave-scan-library-catalogs "Locating library catalogs..." 'no-load) | |
5335 | (idlwave-display-user-catalog-widget idlwave-path-alist))) | |
5336 | ||
4b1aaa8b | 5337 | (defconst idlwave-user-catalog-widget-help-string |
52a244eb S |
5338 | "This is the front-end to the creation of the IDLWAVE user catalog. |
5339 | Please select the directories on IDL's search path from which you | |
5340 | would like to extract routine information, to be stored in the file: | |
f32b3b91 CD |
5341 | |
5342 | %s | |
5343 | ||
52a244eb S |
5344 | If this is not the correct file, first set variable |
5345 | `idlwave-user-catalog-file', and call this command again. | |
15e42531 | 5346 | |
52a244eb S |
5347 | N.B. Many libraries include pre-scanned catalog files |
5348 | \(\".idlwave_catalog\"). These are marked with \"[LIB]\", and need | |
5349 | not be scanned. You can scan your own libraries off-line using the | |
5350 | perl script `idlwave_catalog'. | |
15e42531 | 5351 | |
f32b3b91 CD |
5352 | After selecting the directories, choose [Scan & Save] to scan the library |
5353 | directories and save the routine info. | |
5354 | \n") | |
5355 | ||
5356 | (defvar idlwave-widget) | |
5357 | (defvar widget-keymap) | |
52a244eb | 5358 | (defun idlwave-display-user-catalog-widget (dirs-list) |
f32b3b91 CD |
5359 | "Create the widget to select IDL search path directories for scanning." |
5360 | (interactive) | |
5361 | (require 'widget) | |
5362 | (require 'wid-edit) | |
52a244eb | 5363 | (unless dirs-list |
f32b3b91 CD |
5364 | (error "Don't know IDL's search path")) |
5365 | ||
f32b3b91 CD |
5366 | (kill-buffer (get-buffer-create "*IDLWAVE Widget*")) |
5367 | (switch-to-buffer (get-buffer-create "*IDLWAVE Widget*")) | |
5368 | (kill-all-local-variables) | |
5369 | (make-local-variable 'idlwave-widget) | |
52a244eb S |
5370 | (widget-insert (format idlwave-user-catalog-widget-help-string |
5371 | idlwave-user-catalog-file)) | |
4b1aaa8b | 5372 | |
f32b3b91 | 5373 | (widget-create 'push-button |
52a244eb | 5374 | :notify 'idlwave-widget-scan-user-lib-files |
f32b3b91 CD |
5375 | "Scan & Save") |
5376 | (widget-insert " ") | |
5377 | (widget-create 'push-button | |
52a244eb | 5378 | :notify 'idlwave-delete-user-catalog-file |
f32b3b91 CD |
5379 | "Delete File") |
5380 | (widget-insert " ") | |
5381 | (widget-create 'push-button | |
4b1aaa8b | 5382 | :notify |
8d222148 SM |
5383 | (lambda (&rest ignore) |
5384 | (let ((path-list (widget-get idlwave-widget :path-dirs))) | |
5385 | (dolist (x path-list) | |
5386 | (unless (memq 'lib (cdr x)) | |
5387 | (idlwave-path-alist-add-flag x 'user))) | |
5388 | (idlwave-display-user-catalog-widget path-list))) | |
52a244eb | 5389 | "Select All Non-Lib") |
f32b3b91 CD |
5390 | (widget-insert " ") |
5391 | (widget-create 'push-button | |
4b1aaa8b | 5392 | :notify |
8d222148 SM |
5393 | (lambda (&rest ignore) |
5394 | (let ((path-list (widget-get idlwave-widget :path-dirs))) | |
5395 | (dolist (x path-list) | |
5396 | (idlwave-path-alist-remove-flag x 'user)) | |
5397 | (idlwave-display-user-catalog-widget path-list))) | |
f32b3b91 | 5398 | "Deselect All") |
52a244eb S |
5399 | (widget-insert " ") |
5400 | (widget-create 'push-button | |
5401 | :notify (lambda (&rest ignore) | |
5402 | (kill-buffer (current-buffer))) | |
5403 | "Quit") | |
f32b3b91 CD |
5404 | (widget-insert "\n\n") |
5405 | ||
52a244eb | 5406 | (widget-insert "Select Directories: \n") |
4b1aaa8b | 5407 | |
f32b3b91 CD |
5408 | (setq idlwave-widget |
5409 | (apply 'widget-create | |
5410 | 'checklist | |
4b1aaa8b PE |
5411 | :value (delq nil (mapcar (lambda (x) |
5412 | (if (memq 'user (cdr x)) | |
52a244eb S |
5413 | (car x))) |
5414 | dirs-list)) | |
f32b3b91 CD |
5415 | :greedy t |
5416 | :tag "List of directories" | |
4b1aaa8b PE |
5417 | (mapcar (lambda (x) |
5418 | (list 'item | |
52a244eb S |
5419 | (if (memq 'lib (cdr x)) |
5420 | (concat "[LIB] " (car x) ) | |
5421 | (car x)))) dirs-list))) | |
5422 | (widget-put idlwave-widget :path-dirs dirs-list) | |
f32b3b91 CD |
5423 | (widget-insert "\n") |
5424 | (use-local-map widget-keymap) | |
5425 | (widget-setup) | |
5426 | (goto-char (point-min)) | |
5427 | (delete-other-windows)) | |
4b1aaa8b | 5428 | |
52a244eb | 5429 | (defun idlwave-delete-user-catalog-file (&rest ignore) |
f32b3b91 | 5430 | (if (yes-or-no-p |
52a244eb | 5431 | (format "Delete file %s " idlwave-user-catalog-file)) |
f32b3b91 | 5432 | (progn |
52a244eb S |
5433 | (delete-file idlwave-user-catalog-file) |
5434 | (message "%s has been deleted" idlwave-user-catalog-file)))) | |
f32b3b91 | 5435 | |
52a244eb S |
5436 | (defun idlwave-widget-scan-user-lib-files (&rest ignore) |
5437 | ;; Call `idlwave-scan-user-lib-files' with data taken from the widget. | |
f32b3b91 | 5438 | (let* ((widget idlwave-widget) |
15e42531 | 5439 | (selected-dirs (widget-value widget)) |
52a244eb S |
5440 | (path-alist (widget-get widget :path-dirs)) |
5441 | (this-path-alist path-alist) | |
5442 | dir-entry) | |
5443 | (while (setq dir-entry (pop this-path-alist)) | |
4b1aaa8b | 5444 | (if (member |
52a244eb S |
5445 | (if (memq 'lib (cdr dir-entry)) |
5446 | (concat "[LIB] " (car dir-entry)) | |
5447 | (car dir-entry)) | |
5448 | selected-dirs) | |
5449 | (idlwave-path-alist-add-flag dir-entry 'user) | |
5450 | (idlwave-path-alist-remove-flag dir-entry 'user))) | |
5451 | (idlwave-scan-user-lib-files path-alist))) | |
f32b3b91 CD |
5452 | |
5453 | (defvar font-lock-mode) | |
52a244eb S |
5454 | (defun idlwave-scan-user-lib-files (path-alist) |
5455 | ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog | |
f32b3b91 | 5456 | (let* ((idlwave-scanning-lib t) |
15e42531 | 5457 | (idlwave-scanning-lib-dir "") |
f32b3b91 | 5458 | (idlwave-completion-case nil) |
15e42531 | 5459 | dirs-alist dir files file) |
52a244eb S |
5460 | (setq idlwave-user-catalog-routines nil |
5461 | idlwave-path-alist path-alist ; for library-path instead | |
5462 | idlwave-true-path-alist nil) | |
5463 | (if idlwave-auto-write-paths (idlwave-write-paths)) | |
9a529312 | 5464 | (with-current-buffer (get-buffer-create "*idlwave-scan.pro*") |
f32b3b91 | 5465 | (idlwave-mode) |
15e42531 CD |
5466 | (setq dirs-alist (reverse path-alist)) |
5467 | (while (setq dir (pop dirs-alist)) | |
52a244eb | 5468 | (when (memq 'user (cdr dir)) ; Has it marked for scan? |
15e42531 | 5469 | (setq dir (car dir)) |
52a244eb | 5470 | (setq idlwave-scanning-lib-dir dir) |
15e42531 CD |
5471 | (when (file-directory-p dir) |
5472 | (setq files (directory-files dir 'full "\\.[pP][rR][oO]\\'")) | |
5473 | (while (setq file (pop files)) | |
5474 | (when (file-regular-p file) | |
5475 | (if (not (file-readable-p file)) | |
5476 | (message "Skipping %s (no read permission)" file) | |
5477 | (message "Scanning %s..." file) | |
5478 | (erase-buffer) | |
5479 | (insert-file-contents file 'visit) | |
52a244eb | 5480 | (setq idlwave-user-catalog-routines |
15e42531 CD |
5481 | (append (idlwave-get-routine-info-from-buffers |
5482 | (list (current-buffer))) | |
52a244eb S |
5483 | idlwave-user-catalog-routines))))))))) |
5484 | (message "Creating user catalog file...") | |
f32b3b91 CD |
5485 | (kill-buffer "*idlwave-scan.pro*") |
5486 | (kill-buffer (get-buffer-create "*IDLWAVE Widget*")) | |
bc74a74a GM |
5487 | (with-temp-buffer |
5488 | (insert ";; IDLWAVE user catalog file\n") | |
5489 | (insert (format ";; Created %s\n\n" (current-time-string))) | |
5490 | ||
5491 | ;; Define the routine info list | |
5492 | (insert "\n(setq idlwave-user-catalog-routines\n '(") | |
5493 | (let ((standard-output (current-buffer))) | |
5494 | (mapc (lambda (x) | |
5495 | (insert "\n ") | |
5496 | (prin1 x) | |
5497 | (goto-char (point-max))) | |
5498 | idlwave-user-catalog-routines)) | |
5499 | (insert (format "))\n\n;;; %s ends here\n" | |
5500 | (file-name-nondirectory idlwave-user-catalog-file))) | |
5501 | (write-region nil nil idlwave-user-catalog-file))) | |
52a244eb | 5502 | (message "Creating user catalog file...done") |
f32b3b91 | 5503 | (message "Info for %d routines saved in %s" |
52a244eb S |
5504 | (length idlwave-user-catalog-routines) |
5505 | idlwave-user-catalog-file) | |
f32b3b91 CD |
5506 | (sit-for 2) |
5507 | (idlwave-update-routine-info t)) | |
5508 | ||
52a244eb S |
5509 | (defun idlwave-read-paths () |
5510 | (if (and (stringp idlwave-path-file) | |
5511 | (file-regular-p idlwave-path-file)) | |
5512 | (condition-case nil | |
5513 | (load idlwave-path-file t t t) | |
5514 | (error nil)))) | |
5515 | ||
5516 | (defun idlwave-write-paths () | |
5517 | (interactive) | |
5518 | (when (and idlwave-path-alist idlwave-system-directory) | |
bc74a74a GM |
5519 | (with-temp-buffer |
5520 | (insert ";; IDLWAVE paths\n") | |
5521 | (insert (format ";; Created %s\n\n" (current-time-string))) | |
52a244eb | 5522 | ;; Define the variable which knows the value of "!DIR" |
bc74a74a GM |
5523 | (insert (format "\n(setq idlwave-system-directory \"%s\")\n" |
5524 | idlwave-system-directory)) | |
5525 | ||
5526 | ;; Define the variable which contains a list of all scanned directories | |
5527 | (insert "\n(setq idlwave-path-alist\n '(") | |
5528 | (let ((standard-output (current-buffer))) | |
5529 | (mapc (lambda (x) | |
5530 | (insert "\n ") | |
5531 | (prin1 x) | |
5532 | (goto-char (point-max))) | |
5533 | idlwave-path-alist)) | |
5534 | (insert "))\n") | |
5535 | (write-region nil nil idlwave-path-file)))) | |
52a244eb | 5536 | |
f32b3b91 CD |
5537 | (defun idlwave-expand-path (path &optional default-dir) |
5538 | ;; Expand parts of path starting with '+' recursively into directory list. | |
5539 | ;; Relative recursive path elements are expanded relative to DEFAULT-DIR. | |
5540 | (message "Expanding path...") | |
5541 | (let (path1 dir recursive) | |
5542 | (while (setq dir (pop path)) | |
5543 | (if (setq recursive (string= (substring dir 0 1) "+")) | |
5544 | (setq dir (substring dir 1))) | |
5545 | (if (and recursive | |
5546 | (not (file-name-absolute-p dir))) | |
5547 | (setq dir (expand-file-name dir default-dir))) | |
5548 | (if recursive | |
5549 | ;; Expand recursively | |
5550 | (setq path1 (append (idlwave-recursive-directory-list dir) path1)) | |
5551 | ;; Keep unchanged | |
5552 | (push dir path1))) | |
5553 | (message "Expanding path...done") | |
5554 | (nreverse path1))) | |
5555 | ||
5556 | (defun idlwave-recursive-directory-list (dir) | |
5557 | ;; Return a list of all directories below DIR, including DIR itself | |
5558 | (let ((path (list dir)) path1 file files) | |
5559 | (while (setq dir (pop path)) | |
5560 | (when (file-directory-p dir) | |
5561 | (setq files (nreverse (directory-files dir t "[^.]"))) | |
5562 | (while (setq file (pop files)) | |
4b1aaa8b | 5563 | (if (file-directory-p file) |
f32b3b91 CD |
5564 | (push (file-name-as-directory file) path))) |
5565 | (push dir path1))) | |
5566 | path1)) | |
5567 | ||
52a244eb S |
5568 | |
5569 | ;;----- Scanning the library catalogs ------------------ | |
5570 | ||
3938cb82 S |
5571 | |
5572 | ||
5573 | ||
52a244eb | 5574 | (defun idlwave-scan-library-catalogs (&optional message-base no-load) |
4b1aaa8b | 5575 | "Scan for library catalog files (.idlwave_catalog) and ingest. |
52a244eb S |
5576 | |
5577 | All directories on `idlwave-path-alist' (or `idlwave-library-path' | |
5578 | instead, if present) are searched. Print MESSAGE-BASE along with the | |
5579 | libraries being loaded, if passed, and skip loading/normalizing if | |
5580 | NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can | |
5581 | be set to nil to disable library catalog scanning." | |
5582 | (when idlwave-use-library-catalogs | |
4b1aaa8b | 5583 | (let ((dirs |
52a244eb S |
5584 | (if idlwave-library-path |
5585 | (idlwave-expand-path idlwave-library-path) | |
5586 | (mapcar 'car idlwave-path-alist))) | |
5587 | (old-libname "") | |
8d222148 | 5588 | dir-entry dir catalog all-routines) |
52a244eb S |
5589 | (if message-base (message message-base)) |
5590 | (while (setq dir (pop dirs)) | |
5591 | (catch 'continue | |
4b1aaa8b | 5592 | (when (file-readable-p |
52a244eb S |
5593 | (setq catalog (expand-file-name ".idlwave_catalog" dir))) |
5594 | (unless no-load | |
5595 | (setq idlwave-library-catalog-routines nil) | |
5596 | ;; Load the catalog file | |
5597 | (condition-case nil | |
5598 | (load catalog t t t) | |
5599 | (error (throw 'continue t))) | |
4b1aaa8b PE |
5600 | (when (and |
5601 | message-base | |
5602 | (not (string= idlwave-library-catalog-libname | |
52a244eb | 5603 | old-libname))) |
4b1aaa8b | 5604 | (message "%s" (concat message-base |
f66f03de | 5605 | idlwave-library-catalog-libname)) |
52a244eb S |
5606 | (setq old-libname idlwave-library-catalog-libname)) |
5607 | (when idlwave-library-catalog-routines | |
5608 | (setq all-routines | |
4b1aaa8b | 5609 | (append |
52a244eb S |
5610 | (idlwave-sintern-rinfo-list |
5611 | idlwave-library-catalog-routines 'sys dir) | |
5612 | all-routines)))) | |
4b1aaa8b | 5613 | |
52a244eb S |
5614 | ;; Add a 'lib flag if on path-alist |
5615 | (when (and idlwave-path-alist | |
5616 | (setq dir-entry (assoc dir idlwave-path-alist))) | |
5617 | (idlwave-path-alist-add-flag dir-entry 'lib))))) | |
5618 | (unless no-load (setq idlwave-library-catalog-routines all-routines)) | |
5619 | (if message-base (message (concat message-base "done")))))) | |
5620 | ||
5621 | ;;----- Communicating with the Shell ------------------- | |
f32b3b91 CD |
5622 | |
5623 | ;; First, here is the idl program which can be used to query IDL for | |
4b1aaa8b | 5624 | ;; defined routines. |
f32b3b91 CD |
5625 | (defconst idlwave-routine-info.pro |
5626 | " | |
05a1abfc | 5627 | ;; START OF IDLWAVE SUPPORT ROUTINES |
f66f03de S |
5628 | pro idlwave_print_safe,item,limit |
5629 | catch,err | |
5630 | if err ne 0 then begin | |
5631 | print,'Could not print item.' | |
5632 | return | |
5633 | endif | |
5634 | if n_elements(item) gt limit then $ | |
5635 | print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $ | |
5636 | else print,item | |
5637 | end | |
5638 | ||
15e42531 | 5639 | pro idlwave_print_info_entry,name,func=func,separator=sep |
f32b3b91 | 5640 | ;; See if it's an object method |
15e42531 | 5641 | if name eq '' then return |
4b1aaa8b | 5642 | func = keyword_set(func) |
f32b3b91 CD |
5643 | methsep = strpos(name,'::') |
5644 | meth = methsep ne -1 | |
4b1aaa8b | 5645 | |
f32b3b91 CD |
5646 | ;; Get routine info |
5647 | pars = routine_info(name,/parameters,functions=func) | |
5648 | source = routine_info(name,/source,functions=func) | |
5649 | nargs = pars.num_args | |
5650 | nkw = pars.num_kw_args | |
5651 | if nargs gt 0 then args = pars.args | |
5652 | if nkw gt 0 then kwargs = pars.kw_args | |
4b1aaa8b | 5653 | |
f32b3b91 | 5654 | ;; Trim the class, and make the name |
4b1aaa8b | 5655 | if meth then begin |
f32b3b91 CD |
5656 | class = strmid(name,0,methsep) |
5657 | name = strmid(name,methsep+2,strlen(name)-1) | |
4b1aaa8b | 5658 | if nargs gt 0 then begin |
f32b3b91 CD |
5659 | ;; remove the self argument |
5660 | wh = where(args ne 'SELF',nargs) | |
52a244eb | 5661 | if nargs gt 0 then args = args[wh] |
f32b3b91 CD |
5662 | endif |
5663 | endif else begin | |
5664 | ;; No class, just a normal routine. | |
5665 | class = \"\" | |
5666 | endelse | |
4b1aaa8b | 5667 | |
f32b3b91 CD |
5668 | ;; Calling sequence |
5669 | cs = \"\" | |
5670 | if func then cs = 'Result = ' | |
5671 | if meth then cs = cs + 'Obj -> [' + '%s' + '::]' | |
5672 | cs = cs + '%s' | |
5673 | if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', ' | |
5674 | if nargs gt 0 then begin | |
5675 | for j=0,nargs-1 do begin | |
52a244eb | 5676 | cs = cs + args[j] |
f32b3b91 CD |
5677 | if j lt nargs-1 then cs = cs + ', ' |
5678 | endfor | |
5679 | end | |
5680 | if func then cs = cs + ')' | |
5681 | ;; Keyword arguments | |
5682 | kwstring = '' | |
5683 | if nkw gt 0 then begin | |
5684 | for j=0,nkw-1 do begin | |
52a244eb | 5685 | kwstring = kwstring + ' ' + kwargs[j] |
f32b3b91 CD |
5686 | endfor |
5687 | endif | |
4b1aaa8b | 5688 | |
52a244eb | 5689 | ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func] |
4b1aaa8b | 5690 | |
52a244eb | 5691 | print,ret + ': ' + name + sep + class + sep + source[0].path $ |
f32b3b91 CD |
5692 | + sep + cs + sep + kwstring |
5693 | end | |
5694 | ||
f66f03de | 5695 | pro idlwave_routine_info,file |
52a244eb | 5696 | on_error,1 |
f32b3b91 CD |
5697 | sep = '<@>' |
5698 | print,'>>>BEGIN OF IDLWAVE ROUTINE INFO (\"' + sep + '\" IS THE SEPARATOR)' | |
5699 | all = routine_info() | |
f66f03de S |
5700 | fileQ=n_elements(file) ne 0 |
5701 | if fileQ then file=strtrim(file,2) | |
4b1aaa8b PE |
5702 | for i=0L,n_elements(all)-1L do begin |
5703 | if fileQ then begin | |
f66f03de S |
5704 | if (routine_info(all[i],/SOURCE)).path eq file then $ |
5705 | idlwave_print_info_entry,all[i],separator=sep | |
5706 | endif else idlwave_print_info_entry,all[i],separator=sep | |
4b1aaa8b | 5707 | endfor |
f32b3b91 | 5708 | all = routine_info(/functions) |
4b1aaa8b PE |
5709 | for i=0L,n_elements(all)-1L do begin |
5710 | if fileQ then begin | |
f66f03de S |
5711 | if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $ |
5712 | idlwave_print_info_entry,all[i],separator=sep,/FUNC | |
5713 | endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC | |
4b1aaa8b | 5714 | endfor |
f32b3b91 CD |
5715 | print,'>>>END OF IDLWAVE ROUTINE INFO' |
5716 | end | |
05a1abfc CD |
5717 | |
5718 | pro idlwave_get_sysvars | |
52a244eb | 5719 | on_error,1 |
05a1abfc CD |
5720 | catch,error_status |
5721 | if error_status ne 0 then begin | |
5722 | print, 'Cannot get info about system variables' | |
5723 | endif else begin | |
5724 | help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT= | |
5725 | s = strtrim(strjoin(s,' ',/single),2) ; make one line | |
5726 | v = strsplit(s,' +',/regex,/extract) ; get variables | |
f66f03de | 5727 | for i=0L,n_elements(v)-1 do begin |
05a1abfc CD |
5728 | t = [''] ; get tag list |
5729 | a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')') | |
5730 | print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single) | |
5731 | endfor | |
5732 | endelse | |
5733 | end | |
5734 | ||
5735 | pro idlwave_get_class_tags, class | |
5736 | res = execute('tags=tag_names({'+class+'})') | |
5e72c6b2 | 5737 | if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single) |
05a1abfc CD |
5738 | end |
5739 | ;; END OF IDLWAVE SUPPORT ROUTINES | |
4b1aaa8b | 5740 | " |
5a0c3f56 | 5741 | "The IDL programs to get info from the shell.") |
f32b3b91 | 5742 | |
15e42531 | 5743 | (defvar idlwave-idlwave_routine_info-compiled nil |
5a0c3f56 | 5744 | "Remember if the routine info procedure is already compiled.") |
f32b3b91 CD |
5745 | |
5746 | (defvar idlwave-shell-temp-pro-file) | |
15e42531 | 5747 | (defvar idlwave-shell-temp-rinfo-save-file) |
f66f03de S |
5748 | |
5749 | (defun idlwave-shell-compile-helper-routines (&optional wait) | |
15e42531 | 5750 | (unless (and idlwave-idlwave_routine_info-compiled |
5e72c6b2 | 5751 | (file-readable-p (idlwave-shell-temp-file 'rinfo))) |
9a529312 SM |
5752 | (with-current-buffer (idlwave-find-file-noselect |
5753 | (idlwave-shell-temp-file 'pro)) | |
15e42531 CD |
5754 | (erase-buffer) |
5755 | (insert idlwave-routine-info.pro) | |
5756 | (save-buffer 0)) | |
4b1aaa8b | 5757 | (idlwave-shell-send-command |
f66f03de | 5758 | (concat ".run \"" idlwave-shell-temp-pro-file "\"") |
52a244eb | 5759 | nil 'hide wait) |
15e42531 | 5760 | (idlwave-shell-send-command |
4b1aaa8b | 5761 | (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES" |
5e72c6b2 | 5762 | (idlwave-shell-temp-file 'rinfo)) |
f66f03de S |
5763 | nil 'hide) |
5764 | (setq idlwave-idlwave_routine_info-compiled t)) | |
15e42531 | 5765 | |
f66f03de | 5766 | ;; Restore if necessary. Must use execute to hide lame routine_info |
cd1181db | 5767 | ;; errors on undefined routine |
15e42531 | 5768 | (idlwave-shell-send-command |
f66f03de S |
5769 | (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'" |
5770 | idlwave-shell-temp-rinfo-save-file | |
15e42531 | 5771 | idlwave-shell-temp-rinfo-save-file) |
f66f03de S |
5772 | nil 'hide)) |
5773 | ||
5774 | ||
5775 | (defun idlwave-shell-update-routine-info (&optional quiet run-hooks wait file) | |
5776 | "Query the shell for routine_info of compiled modules and update the lists." | |
5777 | ;; Save and compile the procedure. The compiled procedure is then | |
5778 | ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may | |
5779 | ;; need to test for and possibly RESTORE the procedure each time we | |
5780 | ;; use it, since the user may have killed or redefined it. In | |
5781 | ;; particular, .RESET_SESSION will kill all user procedures. If | |
5782 | ;; FILE is set, only update routine info for routines in that file. | |
5783 | ||
5784 | (idlwave-shell-compile-helper-routines wait) | |
5785 | ; execute the routine_info procedure, and analyze the output | |
5786 | (idlwave-shell-send-command | |
5787 | (format "idlwave_routine_info%s" (if file (concat ",'" file "'") "")) | |
15e42531 CD |
5788 | `(progn |
5789 | (idlwave-shell-routine-info-filter) | |
05a1abfc | 5790 | (idlwave-concatenate-rinfo-lists ,quiet ,run-hooks)) |
52a244eb | 5791 | 'hide wait)) |
f32b3b91 CD |
5792 | |
5793 | ;; --------------------------------------------------------------------------- | |
5794 | ;; | |
5795 | ;; Completion and displaying routine calling sequences | |
5796 | ||
15e42531 | 5797 | (defvar idlwave-completion-help-info nil) |
52a244eb | 5798 | (defvar idlwave-completion-help-links nil) |
15e42531 | 5799 | (defvar idlwave-current-obj_new-class nil) |
05a1abfc | 5800 | (defvar idlwave-complete-special nil) |
8d222148 SM |
5801 | (defvar method-selector) |
5802 | (defvar class-selector) | |
5803 | (defvar type-selector) | |
5804 | (defvar super-classes) | |
15e42531 | 5805 | |
f32b3b91 CD |
5806 | (defun idlwave-complete (&optional arg module class) |
5807 | "Complete a function, procedure or keyword name at point. | |
2e8b9c7d | 5808 | This function is smart and figures out what can be completed |
f32b3b91 CD |
5809 | at this point. |
5810 | - At the beginning of a statement it completes procedure names. | |
5811 | - In the middle of a statement it completes function names. | |
5a0c3f56 | 5812 | - After a `(' or `,' in the argument list of a function or procedure, |
f32b3b91 CD |
5813 | it completes a keyword of the relevant function or procedure. |
5814 | - In the first arg of `OBJ_NEW', it completes a class name. | |
5815 | ||
5a0c3f56 JB |
5816 | When several completions are possible, a list will be displayed in |
5817 | the *Completions* buffer. If this list is too long to fit into the | |
5e72c6b2 S |
5818 | window, scrolling can be achieved by repeatedly pressing |
5819 | \\[idlwave-complete]. | |
f32b3b91 CD |
5820 | |
5821 | The function also knows about object methods. When it needs a class | |
5822 | name, the action depends upon `idlwave-query-class', which see. You | |
5e72c6b2 S |
5823 | can force IDLWAVE to ask you for a class name with a |
5824 | \\[universal-argument] prefix argument to this command. | |
f32b3b91 CD |
5825 | |
5826 | See also the variables `idlwave-keyword-completion-adds-equal' and | |
5827 | `idlwave-function-completion-adds-paren'. | |
5828 | ||
5829 | The optional ARG can be used to specify the completion type in order | |
5830 | to override IDLWAVE's idea of what should be completed at point. | |
5831 | Possible values are: | |
5832 | ||
5833 | 0 <=> query for the completion type | |
5834 | 1 <=> 'procedure | |
5835 | 2 <=> 'procedure-keyword | |
5836 | 3 <=> 'function | |
5837 | 4 <=> 'function-keyword | |
5838 | 5 <=> 'procedure-method | |
5839 | 6 <=> 'procedure-method-keyword | |
5840 | 7 <=> 'function-method | |
5841 | 8 <=> 'function-method-keyword | |
5842 | 9 <=> 'class | |
5843 | ||
5e72c6b2 S |
5844 | As a special case, the universal argument C-u forces completion of |
5845 | function names in places where the default would be a keyword. | |
5846 | ||
52a244eb S |
5847 | Two prefix argument, C-u C-u, prompts for a regexp by which to limit |
5848 | completion. | |
5849 | ||
f32b3b91 CD |
5850 | For Lisp programmers only: |
5851 | When we force a keyword, optional argument MODULE can contain the module name. | |
5852 | When we force a method or a method keyword, CLASS can specify the class." | |
5853 | (interactive "P") | |
5854 | (idlwave-routines) | |
5855 | (let* ((where-list | |
5856 | (if (and arg | |
52a244eb | 5857 | (or (and (integerp arg) (not (equal arg '(16)))) |
f32b3b91 CD |
5858 | (symbolp arg))) |
5859 | (idlwave-make-force-complete-where-list arg module class) | |
5860 | (idlwave-where))) | |
5861 | (what (nth 2 where-list)) | |
52a244eb S |
5862 | (idlwave-force-class-query (equal arg '(4))) |
5863 | (completion-regexp-list | |
5864 | (if (equal arg '(16)) | |
5865 | (list (read-string (concat "Completion Regexp: ")))))) | |
4b1aaa8b | 5866 | |
f32b3b91 CD |
5867 | (if (and module (string-match "::" module)) |
5868 | (setq class (substring module 0 (match-beginning 0)) | |
5869 | module (substring module (match-end 0)))) | |
5870 | ||
5871 | (cond | |
5872 | ||
5873 | ((and (null arg) | |
5874 | (eq (car-safe last-command) 'idlwave-display-completion-list) | |
595ab50b | 5875 | (get-buffer-window "*Completions*")) |
f32b3b91 CD |
5876 | (setq this-command last-command) |
5877 | (idlwave-scroll-completions)) | |
5878 | ||
52a244eb | 5879 | ;; Complete a filename in quotes |
05a1abfc CD |
5880 | ((and (idlwave-in-quote) |
5881 | (not (eq what 'class))) | |
5882 | (idlwave-complete-filename)) | |
5883 | ||
52a244eb S |
5884 | ;; Check for any special completion functions |
5885 | ((and idlwave-complete-special | |
5886 | (idlwave-call-special idlwave-complete-special))) | |
4b1aaa8b | 5887 | |
f32b3b91 CD |
5888 | ((null what) |
5889 | (error "Nothing to complete here")) | |
5890 | ||
52a244eb | 5891 | ;; Complete a class |
f32b3b91 | 5892 | ((eq what 'class) |
15e42531 | 5893 | (setq idlwave-completion-help-info '(class)) |
f32b3b91 CD |
5894 | (idlwave-complete-class)) |
5895 | ||
5896 | ((eq what 'procedure) | |
5897 | ;; Complete a procedure name | |
5e72c6b2 S |
5898 | (let* ((cw-list (nth 3 where-list)) |
5899 | (class-selector (idlwave-determine-class cw-list 'pro)) | |
5900 | (super-classes (unless (idlwave-explicit-class-listed cw-list) | |
5901 | (idlwave-all-class-inherits class-selector))) | |
f32b3b91 CD |
5902 | (isa (concat "procedure" (if class-selector "-method" ""))) |
5903 | (type-selector 'pro)) | |
4b1aaa8b | 5904 | (setq idlwave-completion-help-info |
05a1abfc | 5905 | (list 'routine nil type-selector class-selector nil super-classes)) |
f32b3b91 CD |
5906 | (idlwave-complete-in-buffer |
5907 | 'procedure (if class-selector 'method 'routine) | |
5908 | (idlwave-routines) 'idlwave-selector | |
5909 | (format "Select a %s name%s" | |
5910 | isa | |
5911 | (if class-selector | |
4b1aaa8b PE |
5912 | (format " (class is %s)" |
5913 | (if (eq class-selector t) | |
76959b77 | 5914 | "unknown" class-selector)) |
f32b3b91 CD |
5915 | "")) |
5916 | isa | |
52a244eb | 5917 | 'idlwave-attach-method-classes 'idlwave-add-file-link-selector))) |
f32b3b91 CD |
5918 | |
5919 | ((eq what 'function) | |
5920 | ;; Complete a function name | |
5e72c6b2 S |
5921 | (let* ((cw-list (nth 3 where-list)) |
5922 | (class-selector (idlwave-determine-class cw-list 'fun)) | |
5923 | (super-classes (unless (idlwave-explicit-class-listed cw-list) | |
5924 | (idlwave-all-class-inherits class-selector))) | |
f32b3b91 CD |
5925 | (isa (concat "function" (if class-selector "-method" ""))) |
5926 | (type-selector 'fun)) | |
4b1aaa8b | 5927 | (setq idlwave-completion-help-info |
05a1abfc | 5928 | (list 'routine nil type-selector class-selector nil super-classes)) |
f32b3b91 CD |
5929 | (idlwave-complete-in-buffer |
5930 | 'function (if class-selector 'method 'routine) | |
5931 | (idlwave-routines) 'idlwave-selector | |
5932 | (format "Select a %s name%s" | |
5933 | isa | |
5934 | (if class-selector | |
4b1aaa8b | 5935 | (format " (class is %s)" |
76959b77 S |
5936 | (if (eq class-selector t) |
5937 | "unknown" class-selector)) | |
f32b3b91 CD |
5938 | "")) |
5939 | isa | |
52a244eb | 5940 | 'idlwave-attach-method-classes 'idlwave-add-file-link-selector))) |
f32b3b91 | 5941 | |
52a244eb | 5942 | ((and (memq what '(procedure-keyword function-keyword)) ; Special Case |
5e72c6b2 S |
5943 | (equal arg '(4))) |
5944 | (idlwave-complete 3)) | |
5945 | ||
f32b3b91 CD |
5946 | ((eq what 'procedure-keyword) |
5947 | ;; Complete a procedure keyword | |
5948 | (let* ((where (nth 3 where-list)) | |
5949 | (name (car where)) | |
5950 | (method-selector name) | |
5951 | (type-selector 'pro) | |
5952 | (class (idlwave-determine-class where 'pro)) | |
5953 | (class-selector class) | |
05a1abfc | 5954 | (super-classes (idlwave-all-class-inherits class-selector)) |
f32b3b91 | 5955 | (isa (format "procedure%s-keyword" (if class "-method" ""))) |
15e42531 | 5956 | (entry (idlwave-best-rinfo-assq |
f32b3b91 | 5957 | name 'pro class (idlwave-routines))) |
3938cb82 | 5958 | (system (if entry (eq (car (nth 3 entry)) 'system))) |
52a244eb | 5959 | (list (idlwave-entry-keywords entry 'do-link))) |
f32b3b91 CD |
5960 | (unless (or entry (eq class t)) |
5961 | (error "Nothing known about procedure %s" | |
5962 | (idlwave-make-full-name class name))) | |
4b1aaa8b | 5963 | (setq list (idlwave-fix-keywords name 'pro class list |
3938cb82 | 5964 | super-classes system)) |
b6a97790 | 5965 | (unless list (error "No keywords available for procedure %s" |
3938cb82 | 5966 | (idlwave-make-full-name class name))) |
4b1aaa8b | 5967 | (setq idlwave-completion-help-info |
52a244eb | 5968 | (list 'keyword name type-selector class-selector entry super-classes)) |
f32b3b91 CD |
5969 | (idlwave-complete-in-buffer |
5970 | 'keyword 'keyword list nil | |
5971 | (format "Select keyword for procedure %s%s" | |
5972 | (idlwave-make-full-name class name) | |
15e42531 | 5973 | (if (or (member '("_EXTRA") list) |
4b1aaa8b | 5974 | (member '("_REF_EXTRA") list)) |
15e42531 | 5975 | " (note _EXTRA)" "")) |
f32b3b91 CD |
5976 | isa |
5977 | 'idlwave-attach-keyword-classes))) | |
5978 | ||
5979 | ((eq what 'function-keyword) | |
5980 | ;; Complete a function keyword | |
5981 | (let* ((where (nth 3 where-list)) | |
5982 | (name (car where)) | |
5983 | (method-selector name) | |
5984 | (type-selector 'fun) | |
5985 | (class (idlwave-determine-class where 'fun)) | |
5986 | (class-selector class) | |
05a1abfc | 5987 | (super-classes (idlwave-all-class-inherits class-selector)) |
f32b3b91 | 5988 | (isa (format "function%s-keyword" (if class "-method" ""))) |
15e42531 | 5989 | (entry (idlwave-best-rinfo-assq |
f32b3b91 | 5990 | name 'fun class (idlwave-routines))) |
3938cb82 | 5991 | (system (if entry (eq (car (nth 3 entry)) 'system))) |
52a244eb | 5992 | (list (idlwave-entry-keywords entry 'do-link)) |
15e42531 | 5993 | msg-name) |
f32b3b91 CD |
5994 | (unless (or entry (eq class t)) |
5995 | (error "Nothing known about function %s" | |
5996 | (idlwave-make-full-name class name))) | |
4b1aaa8b | 5997 | (setq list (idlwave-fix-keywords name 'fun class list |
3938cb82 | 5998 | super-classes system)) |
15e42531 CD |
5999 | ;; OBJ_NEW: Messages mention the proper Init method |
6000 | (setq msg-name (if (and (null class) | |
6001 | (string= (upcase name) "OBJ_NEW")) | |
6002 | (concat idlwave-current-obj_new-class | |
6003 | "::Init (via OBJ_NEW)") | |
6004 | (idlwave-make-full-name class name))) | |
b6a97790 | 6005 | (unless list (error "No keywords available for function %s" |
3938cb82 | 6006 | msg-name)) |
4b1aaa8b | 6007 | (setq idlwave-completion-help-info |
05a1abfc | 6008 | (list 'keyword name type-selector class-selector nil super-classes)) |
f32b3b91 CD |
6009 | (idlwave-complete-in-buffer |
6010 | 'keyword 'keyword list nil | |
15e42531 CD |
6011 | (format "Select keyword for function %s%s" msg-name |
6012 | (if (or (member '("_EXTRA") list) | |
4b1aaa8b | 6013 | (member '("_REF_EXTRA") list)) |
15e42531 | 6014 | " (note _EXTRA)" "")) |
f32b3b91 CD |
6015 | isa |
6016 | 'idlwave-attach-keyword-classes))) | |
15e42531 | 6017 | |
f32b3b91 CD |
6018 | (t (error "This should not happen (idlwave-complete)"))))) |
6019 | ||
05a1abfc CD |
6020 | (defvar idlwave-complete-special nil |
6021 | "List of special completion functions. | |
52a244eb S |
6022 | These functions are called for each completion. Each function must |
6023 | check if its own special completion context is present. If yes, it | |
6024 | should use `idlwave-complete-in-buffer' to do some completion and | |
6025 | return t. If such a function returns t, *no further* attempts to | |
6026 | complete other contexts will be done. If the function returns nil, | |
6027 | other completions will be tried.") | |
76959b77 S |
6028 | |
6029 | (defun idlwave-call-special (functions &rest args) | |
6030 | (let ((funcs functions) | |
6031 | fun ret) | |
05a1abfc | 6032 | (catch 'exit |
76959b77 S |
6033 | (while (setq fun (pop funcs)) |
6034 | (if (setq ret (apply fun args)) | |
6035 | (throw 'exit ret))) | |
05a1abfc CD |
6036 | nil))) |
6037 | ||
f32b3b91 CD |
6038 | (defun idlwave-make-force-complete-where-list (what &optional module class) |
6039 | ;; Return an artificial WHERE specification to force the completion | |
6040 | ;; routine to complete a specific item independent of context. | |
6041 | ;; WHAT is the prefix arg of `idlwave-complete', see there for details. | |
6042 | ;; MODULE and CLASS can be used to specify the routine name and class. | |
6043 | ;; The class name will also be found in MODULE if that is like "class::mod". | |
6044 | (let* ((what-list '(("procedure") ("procedure-keyword") | |
6045 | ("function") ("function-keyword") | |
6046 | ("procedure-method") ("procedure-method-keyword") | |
6047 | ("function-method") ("function-method-keyword") | |
6048 | ("class"))) | |
6049 | (module (idlwave-sintern-routine-or-method module class)) | |
6050 | (class (idlwave-sintern-class class)) | |
4b1aaa8b | 6051 | (what (cond |
f32b3b91 CD |
6052 | ((equal what 0) |
6053 | (setq what | |
4b1aaa8b | 6054 | (intern (completing-read |
f32b3b91 CD |
6055 | "Complete what? " what-list nil t)))) |
6056 | ((integerp what) | |
6057 | (setq what (intern (car (nth (1- what) what-list))))) | |
6058 | ((and what | |
6059 | (symbolp what) | |
6060 | (assoc (symbol-name what) what-list)) | |
6061 | what) | |
eac9c0ef | 6062 | (t (error "Invalid WHAT")))) |
f32b3b91 CD |
6063 | (nil-list '(nil nil nil nil)) |
6064 | (class-list (list nil nil (or class t) nil))) | |
6065 | ||
6066 | (cond | |
6067 | ||
6068 | ((eq what 'procedure) | |
6069 | (list nil-list nil-list 'procedure nil-list nil)) | |
6070 | ||
6071 | ((eq what 'procedure-keyword) | |
6072 | (let* ((class-selector nil) | |
05a1abfc | 6073 | (super-classes nil) |
f32b3b91 CD |
6074 | (type-selector 'pro) |
6075 | (pro (or module | |
4b1aaa8b | 6076 | (idlwave-completing-read |
f32b3b91 CD |
6077 | "Procedure: " (idlwave-routines) 'idlwave-selector)))) |
6078 | (setq pro (idlwave-sintern-routine pro)) | |
6079 | (list nil-list nil-list 'procedure-keyword | |
6080 | (list pro nil nil nil) nil))) | |
6081 | ||
6082 | ((eq what 'function) | |
6083 | (list nil-list nil-list 'function nil-list nil)) | |
6084 | ||
6085 | ((eq what 'function-keyword) | |
6086 | (let* ((class-selector nil) | |
05a1abfc | 6087 | (super-classes nil) |
f32b3b91 CD |
6088 | (type-selector 'fun) |
6089 | (func (or module | |
4b1aaa8b | 6090 | (idlwave-completing-read |
f32b3b91 CD |
6091 | "Function: " (idlwave-routines) 'idlwave-selector)))) |
6092 | (setq func (idlwave-sintern-routine func)) | |
6093 | (list nil-list nil-list 'function-keyword | |
6094 | (list func nil nil nil) nil))) | |
6095 | ||
6096 | ((eq what 'procedure-method) | |
6097 | (list nil-list nil-list 'procedure class-list nil)) | |
6098 | ||
6099 | ((eq what 'procedure-method-keyword) | |
6100 | (let* ((class (idlwave-determine-class class-list 'pro)) | |
6101 | (class-selector class) | |
05a1abfc | 6102 | (super-classes (idlwave-all-class-inherits class-selector)) |
f32b3b91 CD |
6103 | (type-selector 'pro) |
6104 | (pro (or module | |
6105 | (idlwave-completing-read | |
6106 | (format "Procedure in %s class: " class-selector) | |
6107 | (idlwave-routines) 'idlwave-selector)))) | |
6108 | (setq pro (idlwave-sintern-method pro)) | |
6109 | (list nil-list nil-list 'procedure-keyword | |
6110 | (list pro nil class nil) nil))) | |
6111 | ||
6112 | ((eq what 'function-method) | |
6113 | (list nil-list nil-list 'function class-list nil)) | |
6114 | ||
6115 | ((eq what 'function-method-keyword) | |
6116 | (let* ((class (idlwave-determine-class class-list 'fun)) | |
6117 | (class-selector class) | |
05a1abfc | 6118 | (super-classes (idlwave-all-class-inherits class-selector)) |
f32b3b91 CD |
6119 | (type-selector 'fun) |
6120 | (func (or module | |
6121 | (idlwave-completing-read | |
6122 | (format "Function in %s class: " class-selector) | |
6123 | (idlwave-routines) 'idlwave-selector)))) | |
6124 | (setq func (idlwave-sintern-method func)) | |
6125 | (list nil-list nil-list 'function-keyword | |
6126 | (list func nil class nil) nil))) | |
6127 | ||
6128 | ((eq what 'class) | |
6129 | (list nil-list nil-list 'class nil-list nil)) | |
4b1aaa8b | 6130 | |
eac9c0ef | 6131 | (t (error "Invalid value for WHAT"))))) |
f32b3b91 CD |
6132 | |
6133 | (defun idlwave-completing-read (&rest args) | |
6134 | ;; Completing read, case insensitive | |
6135 | (let ((old-value (default-value 'completion-ignore-case))) | |
6136 | (unwind-protect | |
6137 | (progn | |
6138 | (setq-default completion-ignore-case t) | |
6139 | (apply 'completing-read args)) | |
6140 | (setq-default completion-ignore-case old-value)))) | |
6141 | ||
05a1abfc CD |
6142 | (defvar idlwave-shell-default-directory) |
6143 | (defun idlwave-complete-filename () | |
6144 | "Use the comint stuff to complete a file name." | |
6145 | (require 'comint) | |
6146 | (let* ((comint-file-name-chars "~/A-Za-z0-9+@:_.$#%={}\\-") | |
6147 | (comint-completion-addsuffix nil) | |
6148 | (default-directory | |
6149 | (if (and (boundp 'idlwave-shell-default-directory) | |
6150 | (stringp idlwave-shell-default-directory) | |
6151 | (file-directory-p idlwave-shell-default-directory)) | |
6152 | idlwave-shell-default-directory | |
4b1aaa8b | 6153 | default-directory))) |
05a1abfc CD |
6154 | (comint-dynamic-complete-filename))) |
6155 | ||
f32b3b91 CD |
6156 | (defun idlwave-make-full-name (class name) |
6157 | ;; Make a fully qualified module name including the class name | |
6158 | (concat (if class (format "%s::" class) "") name)) | |
6159 | ||
15e42531 CD |
6160 | (defun idlwave-rinfo-assoc (name type class list) |
6161 | "Like `idlwave-rinfo-assq', but sintern strings first." | |
4b1aaa8b | 6162 | (idlwave-rinfo-assq |
15e42531 CD |
6163 | (idlwave-sintern-routine-or-method name class) |
6164 | type (idlwave-sintern-class class) list)) | |
6165 | ||
f32b3b91 CD |
6166 | (defun idlwave-rinfo-assq (name type class list) |
6167 | ;; Works like assq, but also checks type and class | |
6168 | (catch 'exit | |
6169 | (let (match) | |
6170 | (while (setq match (assq name list)) | |
6171 | (and (or (eq type t) | |
6172 | (eq (nth 1 match) type)) | |
6173 | (eq (nth 2 match) class) | |
6174 | (throw 'exit match)) | |
6175 | (setq list (cdr (memq match list))))))) | |
6176 | ||
05a1abfc | 6177 | (defun idlwave-rinfo-assq-any-class (name type class list) |
52a244eb | 6178 | ;; Return the first matching method on the inheritance list |
05a1abfc CD |
6179 | (let* ((classes (cons class (idlwave-all-class-inherits class))) |
6180 | class rtn) | |
6181 | (while classes | |
6182 | (if (setq rtn (idlwave-rinfo-assq name type (pop classes) list)) | |
6183 | (setq classes nil))) | |
6184 | rtn)) | |
6185 | ||
4b1aaa8b | 6186 | (defun idlwave-best-rinfo-assq (name type class list &optional with-file |
52a244eb S |
6187 | keep-system) |
6188 | "Like `idlwave-rinfo-assq', but get all twins and sort, then return first. | |
6189 | If WITH-FILE is passed, find the best rinfo entry with a file | |
6190 | included. If KEEP-SYSTEM is set, don't prune system for compiled | |
6191 | syslib files." | |
15e42531 | 6192 | (let ((twins (idlwave-routine-twins |
05a1abfc | 6193 | (idlwave-rinfo-assq-any-class name type class list) |
15e42531 CD |
6194 | list)) |
6195 | syslibp) | |
6196 | (when (> (length twins) 1) | |
6197 | (setq twins (sort twins 'idlwave-routine-entry-compare-twins)) | |
52a244eb S |
6198 | (if (and (null keep-system) |
6199 | (eq 'system (car (nth 3 (car twins)))) | |
15e42531 CD |
6200 | (setq syslibp (idlwave-any-syslib (cdr twins))) |
6201 | (not (equal 1 syslibp))) | |
52a244eb S |
6202 | ;; Its a compiled syslib, so we need to remove the system entry |
6203 | (setq twins (cdr twins))) | |
6204 | (if with-file | |
6205 | (setq twins (delq nil | |
6206 | (mapcar (lambda (x) | |
6207 | (if (nth 1 (nth 3 x)) x)) | |
6208 | twins))))) | |
15e42531 CD |
6209 | (car twins))) |
6210 | ||
4b1aaa8b | 6211 | (defun idlwave-best-rinfo-assoc (name type class list &optional with-file |
52a244eb | 6212 | keep-system) |
15e42531 CD |
6213 | "Like `idlwave-best-rinfo-assq', but sintern strings first." |
6214 | (idlwave-best-rinfo-assq | |
6215 | (idlwave-sintern-routine-or-method name class) | |
52a244eb | 6216 | type (idlwave-sintern-class class) list with-file keep-system)) |
15e42531 CD |
6217 | |
6218 | (defun idlwave-any-syslib (entries) | |
6219 | "Does the entry list ENTRIES contain a syslib entry? | |
6220 | If yes, return the index (>=1)." | |
6221 | (let (file (cnt 0)) | |
6222 | (catch 'exit | |
6223 | (while entries | |
6224 | (incf cnt) | |
52a244eb S |
6225 | (setq file (idlwave-routine-source-file (nth 3 (car entries)))) |
6226 | (if (and file (idlwave-syslib-p file)) | |
15e42531 CD |
6227 | (throw 'exit cnt) |
6228 | (setq entries (cdr entries)))) | |
6229 | nil))) | |
6230 | ||
f32b3b91 CD |
6231 | (defun idlwave-all-assq (key list) |
6232 | "Return a list of all associations of Key in LIST." | |
6233 | (let (rtn elt) | |
6234 | (while (setq elt (assq key list)) | |
6235 | (push elt rtn) | |
6236 | (setq list (cdr (memq elt list)))) | |
6237 | (nreverse rtn))) | |
6238 | ||
6239 | (defun idlwave-all-method-classes (method &optional type) | |
5a0c3f56 JB |
6240 | "Return all classes which have a method METHOD. |
6241 | TYPE is 'fun or 'pro. | |
f32b3b91 CD |
6242 | When TYPE is not specified, both procedures and functions will be considered." |
6243 | (if (null method) | |
15e42531 | 6244 | (mapcar 'car (idlwave-class-alist)) |
f32b3b91 | 6245 | (let (rtn) |
8ffcfb27 GM |
6246 | (mapc (lambda (x) |
6247 | (and (nth 2 x) | |
6248 | (or (not type) | |
6249 | (eq type (nth 1 x))) | |
6250 | (push (nth 2 x) rtn))) | |
6251 | (idlwave-all-assq method (idlwave-routines))) | |
f32b3b91 CD |
6252 | (idlwave-uniquify rtn)))) |
6253 | ||
6254 | (defun idlwave-all-method-keyword-classes (method keyword &optional type) | |
6255 | "Return all classes which have a method METHOD with keyword KEYWORD. | |
6256 | TYPE is 'fun or 'pro. | |
6257 | When TYPE is not specified, both procedures and functions will be considered." | |
6258 | (if (or (null method) | |
6259 | (null keyword)) | |
6260 | nil | |
6261 | (let (rtn) | |
8ffcfb27 GM |
6262 | (mapc (lambda (x) |
6263 | (and (nth 2 x) ; non-nil class | |
6264 | (or (not type) ; correct or unspecified type | |
6265 | (eq type (nth 1 x))) | |
6266 | (assoc keyword (idlwave-entry-keywords x)) | |
6267 | (push (nth 2 x) rtn))) | |
6268 | (idlwave-all-assq method (idlwave-routines))) | |
f32b3b91 CD |
6269 | (idlwave-uniquify rtn)))) |
6270 | ||
05a1abfc CD |
6271 | (defun idlwave-members-only (list club) |
6272 | "Return list of all elements in LIST which are also in CLUB." | |
6273 | (let (rtn) | |
6274 | (while list | |
6275 | (if (member (car list) club) | |
6276 | (setq rtn (cons (car list) rtn))) | |
6277 | (setq list (cdr list))) | |
6278 | (nreverse rtn))) | |
6279 | ||
6280 | (defun idlwave-nonmembers-only (list club) | |
6281 | "Return list of all elements in LIST which are not in CLUB." | |
6282 | (let (rtn) | |
6283 | (while list | |
6284 | (if (member (car list) club) | |
6285 | nil | |
6286 | (setq rtn (cons (car list) rtn))) | |
6287 | (setq list (cdr list))) | |
6288 | (nreverse rtn))) | |
6289 | ||
5e72c6b2 S |
6290 | (defun idlwave-explicit-class-listed (info) |
6291 | "Return whether or not the class is listed explicitly, ala a->b::c. | |
5a0c3f56 | 6292 | INFO is as returned by `idlwave-what-function' or `-procedure'." |
5e72c6b2 S |
6293 | (let ((apos (nth 3 info))) |
6294 | (if apos | |
6295 | (save-excursion (goto-char apos) | |
6296 | (looking-at "->[a-zA-Z][a-zA-Z0-9$_]*::"))))) | |
6297 | ||
76959b77 S |
6298 | (defvar idlwave-determine-class-special nil |
6299 | "List of special functions for determining class. | |
5a0c3f56 | 6300 | Must accept two arguments: `apos' and `info'.") |
76959b77 | 6301 | |
f32b3b91 | 6302 | (defun idlwave-determine-class (info type) |
4b1aaa8b | 6303 | ;; Determine the class of a routine call. |
76959b77 S |
6304 | ;; INFO is the `cw-list' structure as returned by idlwave-where. |
6305 | ;; The second element in this structure is the class. When nil, we | |
6306 | ;; return nil. When t, try to get the class from text properties at | |
6307 | ;; the arrow. When the object is "self", we use the class of the | |
6308 | ;; current routine. otherwise prompt the user for a class name. | |
6309 | ;; Also stores the selected class as a text property at the arrow. | |
f32b3b91 CD |
6310 | ;; TYPE is 'fun or 'pro. |
6311 | (let* ((class (nth 2 info)) | |
6312 | (apos (nth 3 info)) | |
6313 | (nassoc (assoc (if (stringp (car info)) | |
6314 | (upcase (car info)) | |
6315 | (car info)) | |
6316 | idlwave-query-class)) | |
6317 | (dassoc (assq (if (car info) 'keyword-default 'method-default) | |
6318 | idlwave-query-class)) | |
6319 | (query (cond (nassoc (cdr nassoc)) | |
6320 | (dassoc (cdr dassoc)) | |
6321 | (t t))) | |
6322 | (arrow (and apos (string= (buffer-substring apos (+ 2 apos)) "->"))) | |
4b1aaa8b | 6323 | (is-self |
15e42531 CD |
6324 | (and arrow |
6325 | (save-excursion (goto-char apos) | |
6326 | (forward-word -1) | |
6327 | (let ((case-fold-search t)) | |
6328 | (looking-at "self\\>"))))) | |
f32b3b91 | 6329 | (force-query idlwave-force-class-query) |
76959b77 | 6330 | store special-class class-alist) |
f32b3b91 CD |
6331 | (cond |
6332 | ((null class) nil) | |
6333 | ((eq t class) | |
6334 | ;; There is an object which would like to know its class | |
6335 | (if (and arrow (get-text-property apos 'idlwave-class) | |
6336 | idlwave-store-inquired-class | |
6337 | (not force-query)) | |
6338 | (setq class (get-text-property apos 'idlwave-class) | |
6339 | class (idlwave-sintern-class class))) | |
76959b77 S |
6340 | (if (and (eq t class) is-self) |
6341 | (setq class (or (nth 2 (idlwave-current-routine)) class))) | |
6342 | ||
6343 | ;; Before prompting, try any special class determination routines | |
4b1aaa8b | 6344 | (when (and (eq t class) |
76959b77 S |
6345 | idlwave-determine-class-special |
6346 | (not force-query)) | |
4b1aaa8b | 6347 | (setq special-class |
76959b77 | 6348 | (idlwave-call-special idlwave-determine-class-special apos)) |
4b1aaa8b | 6349 | (if special-class |
76959b77 S |
6350 | (setq class (idlwave-sintern-class special-class) |
6351 | store idlwave-store-inquired-class))) | |
4b1aaa8b | 6352 | |
76959b77 | 6353 | ;; Prompt for a class, if we need to |
f32b3b91 CD |
6354 | (when (and (eq class t) |
6355 | (or force-query query)) | |
4b1aaa8b | 6356 | (setq class-alist |
f32b3b91 CD |
6357 | (mapcar 'list (idlwave-all-method-classes (car info) type))) |
6358 | (setq class | |
6359 | (idlwave-sintern-class | |
6360 | (cond | |
6361 | ((and (= (length class-alist) 0) (not force-query)) | |
6362 | (error "No classes available with method %s" (car info))) | |
6363 | ((and (= (length class-alist) 1) (not force-query)) | |
6364 | (car (car class-alist))) | |
4b1aaa8b | 6365 | (t |
f32b3b91 | 6366 | (setq store idlwave-store-inquired-class) |
4b1aaa8b | 6367 | (idlwave-completing-read |
f32b3b91 CD |
6368 | (format "Class%s: " (if (stringp (car info)) |
6369 | (format " for %s method %s" | |
6370 | type (car info)) | |
6371 | "")) | |
6372 | class-alist nil nil nil 'idlwave-class-history)))))) | |
76959b77 S |
6373 | |
6374 | ;; Store it, if requested | |
f32b3b91 CD |
6375 | (when (and class (not (eq t class))) |
6376 | ;; We have a real class here | |
6377 | (when (and store arrow) | |
76959b77 | 6378 | (condition-case () |
4b1aaa8b PE |
6379 | (add-text-properties |
6380 | apos (+ apos 2) | |
6381 | `(idlwave-class ,class face ,idlwave-class-arrow-face | |
76959b77 S |
6382 | rear-nonsticky t)) |
6383 | (error nil))) | |
f32b3b91 CD |
6384 | (setf (nth 2 info) class)) |
6385 | ;; Return the class | |
6386 | class) | |
6387 | ;; Default as fallback | |
6388 | (t class)))) | |
6389 | ||
f32b3b91 CD |
6390 | (defun idlwave-selector (a) |
6391 | (and (eq (nth 1 a) type-selector) | |
6392 | (or (and (nth 2 a) (eq class-selector t)) | |
05a1abfc | 6393 | (eq (nth 2 a) class-selector) |
52a244eb S |
6394 | (memq (nth 2 a) super-classes)))) |
6395 | ||
6396 | (defun idlwave-add-file-link-selector (a) | |
6397 | ;; Record a file link, if any, for the tested names during selection. | |
6398 | (let ((sel (idlwave-selector a)) file) | |
6399 | (if (and sel (setq file (idlwave-entry-has-help a))) | |
6400 | (push (cons (car a) file) idlwave-completion-help-links)) | |
6401 | sel)) | |
6402 | ||
f32b3b91 CD |
6403 | |
6404 | (defun idlwave-where () | |
4b1aaa8b | 6405 | "Find out where we are. |
f32b3b91 | 6406 | The return value is a list with the following stuff: |
5e72c6b2 | 6407 | \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR) |
f32b3b91 CD |
6408 | |
6409 | PRO-LIST (PRO POINT CLASS ARROW) | |
6410 | FUNC-LIST (FUNC POINT CLASS ARROW) | |
6411 | COMPLETE-WHAT a symbol indicating what kind of completion makes sense here | |
4b1aaa8b | 6412 | CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can |
5e72c6b2 | 6413 | be completed here. |
f32b3b91 CD |
6414 | LAST-CHAR last relevant character before point (non-white non-comment, |
6415 | not part of current identifier or leading slash). | |
6416 | ||
6417 | In the lists, we have these meanings: | |
6418 | PRO: Procedure name | |
6419 | FUNC: Function name | |
6420 | POINT: Where is this | |
6421 | CLASS: What class has the routine (nil=no, t=is method, but class unknown) | |
5e72c6b2 | 6422 | ARROW: Location of the arrow" |
f32b3b91 | 6423 | (idlwave-routines) |
4b1aaa8b | 6424 | (let* (;(bos (save-excursion (idlwave-beginning-of-statement) (point))) |
15e42531 | 6425 | (bos (save-excursion (idlwave-start-of-substatement 'pre) (point))) |
f32b3b91 CD |
6426 | (func-entry (idlwave-what-function bos)) |
6427 | (func (car func-entry)) | |
6428 | (func-class (nth 1 func-entry)) | |
6429 | (func-arrow (nth 2 func-entry)) | |
6430 | (func-point (or (nth 3 func-entry) 0)) | |
6431 | (func-level (or (nth 4 func-entry) 0)) | |
6432 | (pro-entry (idlwave-what-procedure bos)) | |
6433 | (pro (car pro-entry)) | |
6434 | (pro-class (nth 1 pro-entry)) | |
6435 | (pro-arrow (nth 2 pro-entry)) | |
6436 | (pro-point (or (nth 3 pro-entry) 0)) | |
6437 | (last-char (idlwave-last-valid-char)) | |
6438 | (case-fold-search t) | |
52a244eb | 6439 | (match-string (buffer-substring bos (point))) |
f32b3b91 CD |
6440 | cw cw-mod cw-arrow cw-class cw-point) |
6441 | (if (< func-point pro-point) (setq func nil)) | |
6442 | (cond | |
15e42531 | 6443 | ((string-match "\\`[ \t]*\\(pro\\|function\\)[ \t]+[a-zA-Z0-9_]*\\'" |
52a244eb | 6444 | match-string) |
15e42531 | 6445 | (setq cw 'class)) |
4b1aaa8b PE |
6446 | ((string-match |
6447 | "\\`[ \t]*\\([a-zA-Z][a-zA-Z0-9$_]*\\)?\\'" | |
52a244eb S |
6448 | (if (> pro-point 0) |
6449 | (buffer-substring pro-point (point)) | |
6450 | match-string)) | |
f32b3b91 CD |
6451 | (setq cw 'procedure cw-class pro-class cw-point pro-point |
6452 | cw-arrow pro-arrow)) | |
6453 | ((string-match "\\`[ \t]*\\(pro\\|function\\)\\>" | |
52a244eb | 6454 | match-string) |
f32b3b91 | 6455 | nil) |
05a1abfc | 6456 | ((string-match "OBJ_NEW([ \t]*['\"]\\([a-zA-Z0-9$_]*\\)?\\'" |
52a244eb | 6457 | match-string) |
4b1aaa8b | 6458 | (setq cw 'class)) |
05a1abfc | 6459 | ((string-match "\\<inherits\\s-+\\([a-zA-Z0-9$_]*\\)?\\'" |
52a244eb | 6460 | match-string) |
4b1aaa8b PE |
6461 | (setq cw 'class)) |
6462 | ((and func | |
f32b3b91 CD |
6463 | (> func-point pro-point) |
6464 | (= func-level 1) | |
6465 | (memq last-char '(?\( ?,))) | |
6466 | (setq cw 'function-keyword cw-mod func cw-point func-point | |
6467 | cw-class func-class cw-arrow func-arrow)) | |
6468 | ((and pro (eq last-char ?,)) | |
6469 | (setq cw 'procedure-keyword cw-mod pro cw-point pro-point | |
6470 | cw-class pro-class cw-arrow pro-arrow)) | |
6471 | ; ((member last-char '(?\' ?\) ?\] ?!)) | |
6472 | ; ;; after these chars, a function makes no sense | |
6473 | ; ;; FIXME: I am sure there can be more in this list | |
6474 | ; ;; FIXME: Do we want to do this at all? | |
6475 | ; nil) | |
6476 | ;; Everywhere else we try a function. | |
6477 | (t | |
6478 | (setq cw 'function) | |
6479 | (save-excursion | |
52a244eb | 6480 | (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t) |
76959b77 | 6481 | (setq cw-arrow (copy-marker (match-beginning 0)) |
52a244eb S |
6482 | cw-class (if (match-end 4) |
6483 | (idlwave-sintern-class (match-string 4)) | |
5e72c6b2 | 6484 | t)))))) |
f32b3b91 CD |
6485 | (list (list pro pro-point pro-class pro-arrow) |
6486 | (list func func-point func-class func-arrow) | |
6487 | cw | |
6488 | (list cw-mod cw-point cw-class cw-arrow) | |
6489 | last-char))) | |
6490 | ||
6491 | (defun idlwave-this-word (&optional class) | |
6492 | ;; Grab the word around point. CLASS is for the `skip-chars=...' functions | |
52a244eb | 6493 | (setq class (or class "a-zA-Z0-9$_.")) |
f32b3b91 | 6494 | (save-excursion |
52a244eb | 6495 | (buffer-substring |
f32b3b91 CD |
6496 | (progn (skip-chars-backward class) (point)) |
6497 | (progn (skip-chars-forward class) (point))))) | |
6498 | ||
f32b3b91 CD |
6499 | (defun idlwave-what-function (&optional bound) |
6500 | ;; Find out if point is within the argument list of a function. | |
76959b77 S |
6501 | ;; The return value is ("function-name" class arrow-start (point) level). |
6502 | ;; Level is 1 on the top level parentheses, higher further down. | |
f32b3b91 CD |
6503 | |
6504 | ;; If the optional BOUND is an integer, bound backwards directed | |
6505 | ;; searches to this point. | |
6506 | ||
6507 | (catch 'exit | |
4b1aaa8b | 6508 | (let (pos |
f32b3b91 | 6509 | func-point |
f32b3b91 CD |
6510 | (cnt 0) |
6511 | func arrow-start class) | |
15e42531 CD |
6512 | (idlwave-with-special-syntax |
6513 | (save-restriction | |
6514 | (save-excursion | |
6515 | (narrow-to-region (max 1 (or bound 0)) (point-max)) | |
6516 | ;; move back out of the current parenthesis | |
6517 | (while (condition-case nil | |
6518 | (progn (up-list -1) t) | |
6519 | (error nil)) | |
6520 | (setq pos (point)) | |
6521 | (incf cnt) | |
6522 | (when (and (= (following-char) ?\() | |
4b1aaa8b | 6523 | (re-search-backward |
15e42531 CD |
6524 | "\\(::\\|\\<\\)\\([a-zA-Z][a-zA-Z0-9$_]*\\)[ \t]*\\=" |
6525 | bound t)) | |
6526 | (setq func (match-string 2) | |
6527 | func-point (goto-char (match-beginning 2)) | |
6528 | pos func-point) | |
4b1aaa8b | 6529 | (if (re-search-backward |
15e42531 | 6530 | "->[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\=" bound t) |
76959b77 | 6531 | (setq arrow-start (copy-marker (match-beginning 0)) |
15e42531 | 6532 | class (or (match-string 2) t))) |
4b1aaa8b PE |
6533 | (throw |
6534 | 'exit | |
15e42531 CD |
6535 | (list |
6536 | (idlwave-sintern-routine-or-method func class) | |
6537 | (idlwave-sintern-class class) | |
6538 | arrow-start func-point cnt))) | |
6539 | (goto-char pos)) | |
6540 | (throw 'exit nil))))))) | |
f32b3b91 CD |
6541 | |
6542 | (defun idlwave-what-procedure (&optional bound) | |
6543 | ;; Find out if point is within the argument list of a procedure. | |
6544 | ;; The return value is ("procedure-name" class arrow-pos (point)). | |
6545 | ||
6546 | ;; If the optional BOUND is an integer, bound backwards directed | |
6547 | ;; searches to this point. | |
6548 | (let ((pos (point)) pro-point | |
6549 | pro class arrow-start string) | |
4b1aaa8b | 6550 | (save-excursion |
05a1abfc | 6551 | ;;(idlwave-beginning-of-statement) |
15e42531 | 6552 | (idlwave-start-of-substatement 'pre) |
f32b3b91 | 6553 | (setq string (buffer-substring (point) pos)) |
4b1aaa8b | 6554 | (if (string-match |
76959b77 S |
6555 | "\\`[ \t]*\\([a-zA-Z][a-zA-Z0-9$_]*\\)[ \t]*\\(,\\|\\'\\)" string) |
6556 | (setq pro (match-string 1 string) | |
6557 | pro-point (+ (point) (match-beginning 1))) | |
f32b3b91 CD |
6558 | (if (and (idlwave-skip-object) |
6559 | (setq string (buffer-substring (point) pos)) | |
4b1aaa8b PE |
6560 | (string-match |
6561 | "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)" | |
52a244eb | 6562 | string)) |
f32b3b91 CD |
6563 | (setq pro (if (match-beginning 4) |
6564 | (match-string 4 string)) | |
6565 | pro-point (if (match-beginning 4) | |
6566 | (+ (point) (match-beginning 4)) | |
6567 | pos) | |
76959b77 | 6568 | arrow-start (copy-marker (+ (point) (match-beginning 1))) |
f32b3b91 CD |
6569 | class (or (match-string 3 string) t))))) |
6570 | (list (idlwave-sintern-routine-or-method pro class) | |
6571 | (idlwave-sintern-class class) | |
6572 | arrow-start | |
6573 | pro-point))) | |
6574 | ||
6575 | (defun idlwave-skip-object () | |
6576 | ;; If there is an object at point, move over it and return t. | |
6577 | (let ((pos (point))) | |
6578 | (if (catch 'exit | |
6579 | (save-excursion | |
6580 | (skip-chars-forward " ") ; white space | |
6581 | (skip-chars-forward "*") ; de-reference | |
6582 | (cond | |
6583 | ((looking-at idlwave-identifier) | |
6584 | (goto-char (match-end 0))) | |
6585 | ((eq (following-char) ?\() | |
6586 | nil) | |
6587 | (t (throw 'exit nil))) | |
6588 | (catch 'endwhile | |
6589 | (while t | |
6590 | (cond ((eq (following-char) ?.) | |
6591 | (forward-char 1) | |
6592 | (if (not (looking-at idlwave-identifier)) | |
6593 | (throw 'exit nil)) | |
6594 | (goto-char (match-end 0))) | |
6595 | ((memq (following-char) '(?\( ?\[)) | |
6596 | (condition-case nil | |
6597 | (forward-list 1) | |
6598 | (error (throw 'exit nil)))) | |
6599 | (t (throw 'endwhile t))))) | |
6600 | (if (looking-at "[ \t]*->") | |
6601 | (throw 'exit (setq pos (match-beginning 0))) | |
6602 | (throw 'exit nil)))) | |
6603 | (goto-char pos) | |
6604 | nil))) | |
4b1aaa8b | 6605 | |
f32b3b91 CD |
6606 | (defun idlwave-last-valid-char () |
6607 | "Return the last character before point which is not white or a comment | |
6608 | and also not part of the current identifier. Since we do this in | |
6609 | order to identify places where keywords are, we consider the initial | |
6610 | `/' of a keyword as part of the identifier. | |
6611 | This function is not general, can only be used for completion stuff." | |
6612 | (catch 'exit | |
6613 | (save-excursion | |
6614 | ;; skip the current identifier | |
6615 | (skip-chars-backward "a-zA-Z0-9_$") | |
6616 | ;; also skip a leading slash which might be belong to the keyword | |
6617 | (if (eq (preceding-char) ?/) | |
6618 | (backward-char 1)) | |
6619 | ;; FIXME: does not check if this is a valid identifier | |
6620 | (while t | |
6621 | (skip-chars-backward " \t") | |
6622 | (cond | |
6623 | ((memq (preceding-char) '(?\; ?\$)) (throw 'exit nil)) | |
6624 | ((eq (preceding-char) ?\n) | |
6625 | (beginning-of-line 0) | |
3938cb82 | 6626 | (if (looking-at "\\([^\n]*\\)\\$[ \t]*\\(;[^\n]*\\)?\n") |
f32b3b91 CD |
6627 | ;; continuation line |
6628 | (goto-char (match-end 1)) | |
6629 | (throw 'exit nil))) | |
6630 | (t (throw 'exit (preceding-char)))))))) | |
6631 | ||
6632 | (defvar idlwave-complete-after-success-form nil | |
6633 | "A form to evaluate after successful completion.") | |
6634 | (defvar idlwave-complete-after-success-form-force nil | |
6635 | "A form to evaluate after completion selection in *Completions* buffer.") | |
6636 | (defconst idlwave-completion-mark (make-marker) | |
6637 | "A mark pointing to the beginning of the completion string.") | |
8d222148 | 6638 | (defvar completion-highlight-first-word-only) ;XEmacs. |
f32b3b91 CD |
6639 | |
6640 | (defun idlwave-complete-in-buffer (type stype list selector prompt isa | |
52a244eb S |
6641 | &optional prepare-display-function |
6642 | special-selector) | |
f32b3b91 | 6643 | "Perform TYPE completion of word before point against LIST. |
76959b77 | 6644 | SELECTOR is the PREDICATE argument for the completion function. Show |
52a244eb | 6645 | PROMPT in echo area. TYPE is one of the intern types, e.g. 'function, |
5a0c3f56 | 6646 | 'procedure, 'class-tag, 'keyword, 'sysvar, etc. SPECIAL-SELECTOR is |
52a244eb S |
6647 | used only once, for `all-completions', and can be used to, e.g., |
6648 | accumulate information on matching completions." | |
f32b3b91 CD |
6649 | (let* ((completion-ignore-case t) |
6650 | beg (end (point)) slash part spart completion all-completions | |
6651 | dpart dcompletion) | |
6652 | ||
6653 | (unless list | |
6654 | (error (concat prompt ": No completions available"))) | |
6655 | ||
6656 | ;; What is already in the buffer? | |
6657 | (save-excursion | |
6658 | (skip-chars-backward "a-zA-Z0-9_$") | |
6659 | (setq slash (eq (preceding-char) ?/) | |
6660 | beg (point) | |
6661 | idlwave-complete-after-success-form | |
6662 | (list 'idlwave-after-successful-completion | |
6663 | (list 'quote type) slash beg) | |
6664 | idlwave-complete-after-success-form-force | |
6665 | (list 'idlwave-after-successful-completion | |
6666 | (list 'quote type) slash (list 'quote 'force)))) | |
6667 | ||
6668 | ;; Try a completion | |
6669 | (setq part (buffer-substring beg end) | |
6670 | dpart (downcase part) | |
6671 | spart (idlwave-sintern stype part) | |
6672 | completion (try-completion part list selector) | |
52a244eb S |
6673 | dcompletion (if (stringp completion) (downcase completion)) |
6674 | idlwave-completion-help-links nil) | |
f32b3b91 CD |
6675 | (cond |
6676 | ((null completion) | |
6677 | ;; nothing available. | |
76959b77 | 6678 | (error (concat prompt ": no completion for \"%s\"") part)) |
f32b3b91 CD |
6679 | ((and (not (equal dpart dcompletion)) |
6680 | (not (eq t completion))) | |
6681 | ;; We can add something | |
6682 | (delete-region beg end) | |
8d222148 SM |
6683 | (insert (if (and (string= part dpart) |
6684 | (or (not (string= part "")) | |
6685 | idlwave-complete-empty-string-as-lower-case) | |
6686 | (not idlwave-completion-force-default-case)) | |
6687 | dcompletion | |
6688 | completion)) | |
f32b3b91 CD |
6689 | (if (eq t (try-completion completion list selector)) |
6690 | ;; Now this is a unique match | |
6691 | (idlwave-after-successful-completion type slash beg)) | |
6692 | t) | |
6693 | ((or (eq completion t) | |
52a244eb | 6694 | (and (= 1 (length (setq all-completions |
f32b3b91 | 6695 | (idlwave-uniquify |
4b1aaa8b PE |
6696 | (all-completions part list |
6697 | (or special-selector | |
52a244eb S |
6698 | selector)))))) |
6699 | (equal dpart dcompletion))) | |
f32b3b91 CD |
6700 | ;; This is already complete |
6701 | (idlwave-after-successful-completion type slash beg) | |
6702 | (message "%s is already the complete %s" part isa) | |
6703 | nil) | |
4b1aaa8b | 6704 | (t |
f32b3b91 CD |
6705 | ;; We cannot add something - offer a list. |
6706 | (message "Making completion list...") | |
4b1aaa8b | 6707 | |
52a244eb | 6708 | (unless idlwave-completion-help-links ; already set somewhere? |
9001c33f GM |
6709 | (mapc (lambda (x) ; Pass link prop through to highlight-linked |
6710 | (let ((link (get-text-property 0 'link (car x)))) | |
6711 | (if link | |
6712 | (push (cons (car x) link) | |
6713 | idlwave-completion-help-links)))) | |
6714 | list)) | |
f32b3b91 | 6715 | (let* ((list all-completions) |
05a1abfc | 6716 | ;; "complete" means, this is already a valid completion |
f32b3b91 | 6717 | (complete (memq spart all-completions)) |
52a244eb | 6718 | (completion-highlight-first-word-only t)) ; XEmacs |
8d222148 SM |
6719 | ;; (completion-fixup-function ; Emacs |
6720 | ;; (lambda () (and (eq (preceding-char) ?>) | |
6721 | ;; (re-search-backward " <" beg t))))) | |
4b1aaa8b | 6722 | |
f32b3b91 CD |
6723 | (setq list (sort list (lambda (a b) |
6724 | (string< (downcase a) (downcase b))))) | |
6725 | (if prepare-display-function | |
6726 | (setq list (funcall prepare-display-function list))) | |
6727 | (if (and (string= part dpart) | |
6728 | (or (not (string= part "")) | |
6729 | idlwave-complete-empty-string-as-lower-case) | |
6730 | (not idlwave-completion-force-default-case)) | |
6731 | (setq list (mapcar (lambda (x) | |
4b1aaa8b | 6732 | (if (listp x) |
f32b3b91 CD |
6733 | (setcar x (downcase (car x))) |
6734 | (setq x (downcase x))) | |
6735 | x) | |
6736 | list))) | |
6737 | (idlwave-display-completion-list list prompt beg complete)) | |
6738 | t)))) | |
6739 | ||
6740 | (defun idlwave-complete-class () | |
6741 | "Complete a class at point." | |
6742 | (interactive) | |
6743 | ;; Call `idlwave-routines' to make sure the class list will be available | |
6744 | (idlwave-routines) | |
15e42531 CD |
6745 | ;; Check for the special case of completing empty string after pro/function |
6746 | (if (let ((case-fold-search t)) | |
6747 | (save-excursion | |
6748 | (and | |
6749 | (re-search-backward "\\<\\(pro\\|function\\)[ \t]+\\=" | |
6750 | (- (point) 15) t) | |
6751 | (goto-char (point-min)) | |
4b1aaa8b | 6752 | (re-search-forward |
15e42531 CD |
6753 | "^[ \t]*\\(pro\\|function\\)[ \t]+\\([a-zA-Z0-9_]+::\\)" nil t)))) |
6754 | ;; Yank the full class specification | |
6755 | (insert (match-string 2)) | |
52a244eb | 6756 | ;; Do the completion, using list gathered from `idlwave-routines' |
4b1aaa8b PE |
6757 | (idlwave-complete-in-buffer |
6758 | 'class 'class (idlwave-class-alist) nil | |
52a244eb | 6759 | "Select a class" "class" |
8d222148 SM |
6760 | (lambda (list) ;; Push it to help-links if system help available |
6761 | (mapcar (lambda (x) | |
6762 | (let* ((entry (idlwave-class-info x)) | |
6763 | (link (nth 1 (assq 'link entry)))) | |
6764 | (if link (push (cons x link) | |
6765 | idlwave-completion-help-links)) | |
6766 | x)) | |
6767 | list))))) | |
f32b3b91 | 6768 | |
76959b77 | 6769 | (defun idlwave-attach-classes (list type show-classes) |
05a1abfc | 6770 | ;; Attach the proper class list to a LIST of completion items. |
76959b77 S |
6771 | ;; TYPE, when 'kwd, shows classes for method keywords, when |
6772 | ;; 'class-tag, for class tags, and otherwise for methods. | |
f32b3b91 | 6773 | ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'. |
76959b77 S |
6774 | (if (or (null show-classes) ; don't want to see classes |
6775 | (null class-selector) ; not a method call | |
4b1aaa8b | 6776 | (and |
76959b77 S |
6777 | (stringp class-selector) ; the class is already known |
6778 | (not super-classes))) ; no possibilities for inheritance | |
6779 | ;; In these cases, we do not have to do anything | |
6780 | list | |
05a1abfc CD |
6781 | (let* ((do-prop (and (>= show-classes 0) |
6782 | (>= emacs-major-version 21))) | |
f32b3b91 | 6783 | (do-buf (not (= show-classes 0))) |
76959b77 | 6784 | ;; (do-dots (featurep 'xemacs)) |
05a1abfc | 6785 | (do-dots t) |
76959b77 | 6786 | (inherit (if (and (not (eq type 'class-tag)) super-classes) |
05a1abfc | 6787 | (cons class-selector super-classes))) |
f32b3b91 CD |
6788 | (max (abs show-classes)) |
6789 | (lmax (if do-dots (apply 'max (mapcar 'length list)))) | |
6790 | classes nclasses class-info space) | |
4b1aaa8b | 6791 | (mapcar |
f32b3b91 CD |
6792 | (lambda (x) |
6793 | ;; get the classes | |
76959b77 S |
6794 | (if (eq type 'class-tag) |
6795 | ;; Just one class for tags | |
6796 | (setq classes | |
4b1aaa8b | 6797 | (list |
76959b77 | 6798 | (idlwave-class-or-superclass-with-tag class-selector x))) |
52a244eb | 6799 | ;; Multiple classes for method or method-keyword |
76959b77 S |
6800 | (setq classes |
6801 | (if (eq type 'kwd) | |
6802 | (idlwave-all-method-keyword-classes | |
6803 | method-selector x type-selector) | |
6804 | (idlwave-all-method-classes x type-selector))) | |
6805 | (if inherit | |
4b1aaa8b | 6806 | (setq classes |
76959b77 S |
6807 | (delq nil |
6808 | (mapcar (lambda (x) (if (memq x inherit) x nil)) | |
6809 | classes))))) | |
f32b3b91 CD |
6810 | (setq nclasses (length classes)) |
6811 | ;; Make the separator between item and class-info | |
6812 | (if do-dots | |
6813 | (setq space (concat " " (make-string (- lmax (length x)) ?.))) | |
6814 | (setq space " ")) | |
6815 | (if do-buf | |
6816 | ;; We do want info in the buffer | |
6817 | (if (<= nclasses max) | |
6818 | (setq class-info (concat | |
6819 | space | |
6820 | "<" (mapconcat 'identity classes ",") ">")) | |
6821 | (setq class-info (format "%s<%d classes>" space nclasses))) | |
6822 | (setq class-info nil)) | |
6823 | (when do-prop | |
6824 | ;; We do want properties | |
6825 | (setq x (copy-sequence x)) | |
6826 | (put-text-property 0 (length x) | |
52a244eb S |
6827 | 'help-echo (mapconcat 'identity classes " ") |
6828 | x)) | |
f32b3b91 CD |
6829 | (if class-info |
6830 | (list x class-info) | |
6831 | x)) | |
6832 | list)))) | |
6833 | ||
6834 | (defun idlwave-attach-method-classes (list) | |
6835 | ;; Call idlwave-attach-classes with method parameters | |
76959b77 | 6836 | (idlwave-attach-classes list 'method idlwave-completion-show-classes)) |
f32b3b91 CD |
6837 | (defun idlwave-attach-keyword-classes (list) |
6838 | ;; Call idlwave-attach-classes with keyword parameters | |
76959b77 S |
6839 | (idlwave-attach-classes list 'kwd idlwave-completion-show-classes)) |
6840 | (defun idlwave-attach-class-tag-classes (list) | |
6841 | ;; Call idlwave-attach-classes with class structure tags | |
6842 | (idlwave-attach-classes list 'class-tag idlwave-completion-show-classes)) | |
4b1aaa8b | 6843 | |
f32b3b91 CD |
6844 | |
6845 | ;;---------------------------------------------------------------------- | |
6846 | ;;---------------------------------------------------------------------- | |
6847 | ;;---------------------------------------------------------------------- | |
6848 | ;;---------------------------------------------------------------------- | |
6849 | ;;---------------------------------------------------------------------- | |
0b03a950 GM |
6850 | (when (featurep 'xemacs) |
6851 | (defvar rtn) | |
6852 | (defun idlwave-pset (item) | |
6853 | (set 'rtn item))) | |
5e72c6b2 S |
6854 | |
6855 | (defun idlwave-popup-select (ev list title &optional sort) | |
6856 | "Select an item in LIST with a popup menu. | |
6857 | TITLE is the title to put atop the popup. If SORT is non-nil, | |
5a0c3f56 | 6858 | sort the list before displaying." |
5e72c6b2 | 6859 | (let ((maxpopup idlwave-max-popup-menu-items) |
8d222148 | 6860 | rtn menu) |
5e72c6b2 S |
6861 | (cond ((null list)) |
6862 | ((= 1 (length list)) | |
6863 | (setq rtn (car list))) | |
6864 | ((featurep 'xemacs) | |
4b1aaa8b | 6865 | (if sort (setq list (sort list (lambda (a b) |
5e72c6b2 S |
6866 | (string< (upcase a) (upcase b)))))) |
6867 | (setq menu | |
6868 | (append (list title) | |
6869 | (mapcar (lambda (x) (vector x (list 'idlwave-pset | |
6870 | x))) | |
6871 | list))) | |
6872 | (setq menu (idlwave-split-menu-xemacs menu maxpopup)) | |
8d222148 SM |
6873 | (let ((resp (get-popup-menu-response menu))) |
6874 | (funcall (event-function resp) (event-object resp)))) | |
5e72c6b2 | 6875 | (t |
4b1aaa8b | 6876 | (if sort (setq list (sort list (lambda (a b) |
5e72c6b2 S |
6877 | (string< (upcase a) (upcase b)))))) |
6878 | (setq menu (cons title | |
6879 | (list | |
6880 | (append (list "") | |
6881 | (mapcar (lambda(x) (cons x x)) list))))) | |
6882 | (setq menu (idlwave-split-menu-emacs menu maxpopup)) | |
6883 | (setq rtn (x-popup-menu ev menu)))) | |
6884 | rtn)) | |
6885 | ||
6886 | (defun idlwave-split-menu-xemacs (menu N) | |
6887 | "Split the MENU into submenus of maximum length N." | |
6888 | (if (<= (length menu) (1+ N)) | |
6889 | ;; No splitting needed | |
6890 | menu | |
6891 | (let* ((title (car menu)) | |
6892 | (entries (cdr menu)) | |
6893 | (menu (list title)) | |
6894 | (cnt 0) | |
6895 | (nextmenu nil)) | |
6896 | (while entries | |
6897 | (while (and entries (< cnt N)) | |
6898 | (setq cnt (1+ cnt) | |
6899 | nextmenu (cons (car entries) nextmenu) | |
6900 | entries (cdr entries))) | |
6901 | (setq nextmenu (nreverse nextmenu)) | |
6902 | (setq nextmenu (cons (format "%s...%s" | |
6903 | (aref (car nextmenu) 0) | |
6904 | (aref (nth (1- cnt) nextmenu) 0)) | |
6905 | nextmenu)) | |
6906 | (setq menu (cons nextmenu menu) | |
6907 | nextmenu nil | |
6908 | cnt 0)) | |
6909 | (nreverse menu)))) | |
6910 | ||
6911 | (defun idlwave-split-menu-emacs (menu N) | |
6912 | "Split the MENU into submenus of maximum length N." | |
6913 | (if (<= (length (nth 1 menu)) (1+ N)) | |
6914 | ;; No splitting needed | |
6915 | menu | |
6916 | (let* ((title (car menu)) | |
6917 | (entries (cdr (nth 1 menu))) | |
6918 | (menu nil) | |
6919 | (cnt 0) | |
6920 | (nextmenu nil)) | |
6921 | (while entries | |
6922 | (while (and entries (< cnt N)) | |
6923 | (setq cnt (1+ cnt) | |
6924 | nextmenu (cons (car entries) nextmenu) | |
6925 | entries (cdr entries))) | |
6926 | (setq nextmenu (nreverse nextmenu)) | |
6927 | (prin1 nextmenu) | |
6928 | (setq nextmenu (cons (format "%s...%s" | |
6929 | (car (car nextmenu)) | |
6930 | (car (nth (1- cnt) nextmenu))) | |
6931 | nextmenu)) | |
6932 | (setq menu (cons nextmenu menu) | |
6933 | nextmenu nil | |
6934 | cnt 0)) | |
6935 | (setq menu (nreverse menu)) | |
6936 | (setq menu (cons title menu)) | |
6937 | menu))) | |
f32b3b91 | 6938 | |
15e42531 CD |
6939 | (defvar idlwave-completion-setup-hook nil) |
6940 | ||
f32b3b91 CD |
6941 | (defun idlwave-scroll-completions (&optional message) |
6942 | "Scroll the completion window on this frame." | |
6943 | (let ((cwin (get-buffer-window "*Completions*" 'visible)) | |
6944 | (win (selected-window))) | |
6945 | (unwind-protect | |
6946 | (progn | |
6947 | (select-window cwin) | |
6948 | (condition-case nil | |
6949 | (scroll-up) | |
6950 | (error (if (and (listp last-command) | |
6951 | (nth 2 last-command)) | |
6952 | (progn | |
6953 | (select-window win) | |
6954 | (eval idlwave-complete-after-success-form)) | |
6955 | (set-window-start cwin (point-min))))) | |
274f1353 | 6956 | (and message (message "%s" message))) |
f32b3b91 CD |
6957 | (select-window win)))) |
6958 | ||
6959 | (defun idlwave-display-completion-list (list &optional message beg complete) | |
6960 | "Display the completions in LIST in the completions buffer and echo MESSAGE." | |
6961 | (unless (and (get-buffer-window "*Completions*") | |
6962 | (idlwave-local-value 'idlwave-completion-p "*Completions*")) | |
6963 | (move-marker idlwave-completion-mark beg) | |
6964 | (setq idlwave-before-completion-wconf (current-window-configuration))) | |
6965 | ||
6966 | (if (featurep 'xemacs) | |
4b1aaa8b | 6967 | (idlwave-display-completion-list-xemacs |
15e42531 | 6968 | list) |
f32b3b91 CD |
6969 | (idlwave-display-completion-list-emacs list)) |
6970 | ||
6971 | ;; Store a special value in `this-command'. When `idlwave-complete' | |
6972 | ;; finds this in `last-command', it will scroll the *Completions* buffer. | |
6973 | (setq this-command (list 'idlwave-display-completion-list message complete)) | |
6974 | ||
6975 | ;; Mark the completions buffer as created by cib | |
6976 | (idlwave-set-local 'idlwave-completion-p t "*Completions*") | |
6977 | ||
6978 | ;; Fontify the classes | |
6979 | (if (and idlwave-completion-fontify-classes | |
6980 | (consp (car list))) | |
6981 | (idlwave-completion-fontify-classes)) | |
6982 | ||
15e42531 CD |
6983 | ;; Run the hook |
6984 | (run-hooks 'idlwave-completion-setup-hook) | |
6985 | ||
f32b3b91 | 6986 | ;; Display the message |
274f1353 | 6987 | (message "%s" (or message "Making completion list...done"))) |
f32b3b91 CD |
6988 | |
6989 | (defun idlwave-choose (function &rest args) | |
6990 | "Call FUNCTION as a completion chooser and pass ARGS to it." | |
6991 | (let ((completion-ignore-case t)) ; install correct value | |
6992 | (apply function args)) | |
175069ef | 6993 | (if (and (derived-mode-p 'idlwave-shell-mode) |
15e42531 CD |
6994 | (boundp 'font-lock-mode) |
6995 | (not font-lock-mode)) | |
52a244eb | 6996 | ;; For the shell, remove the fontification of the word before point |
15e42531 CD |
6997 | (let ((beg (save-excursion |
6998 | (skip-chars-backward "a-zA-Z0-9_") | |
6999 | (point)))) | |
7000 | (remove-text-properties beg (point) '(face nil)))) | |
f32b3b91 CD |
7001 | (eval idlwave-complete-after-success-form-force)) |
7002 | ||
76959b77 S |
7003 | (defun idlwave-keyboard-quit () |
7004 | (interactive) | |
7005 | (unwind-protect | |
7006 | (if (eq (car-safe last-command) 'idlwave-display-completion-list) | |
7007 | (idlwave-restore-wconf-after-completion)) | |
7008 | (keyboard-quit))) | |
7009 | ||
f32b3b91 CD |
7010 | (defun idlwave-restore-wconf-after-completion () |
7011 | "Restore the old (before completion) window configuration." | |
7012 | (and idlwave-completion-restore-window-configuration | |
7013 | idlwave-before-completion-wconf | |
7014 | (set-window-configuration idlwave-before-completion-wconf))) | |
7015 | ||
52a244eb S |
7016 | (defun idlwave-one-key-select (sym prompt delay) |
7017 | "Make the user select an element from the alist in the variable SYM. | |
7018 | The keys of the alist are expected to be strings. The function returns the | |
7019 | car of the selected association. | |
d9271f41 | 7020 | To do this, PROMPT is displayed and the user must hit a letter key to |
52a244eb S |
7021 | select an entry. If the user does not reply within DELAY seconds, a help |
7022 | window with the options is displayed automatically. | |
7023 | The key which is associated with each option is generated automatically. | |
7024 | First, the strings are checked for preselected keys, like in \"[P]rint\". | |
7025 | If these don't exist, a letter in the string is automatically selected." | |
7026 | (let* ((alist (symbol-value sym)) | |
7027 | (temp-buffer-show-hook (if (fboundp 'fit-window-to-buffer) | |
7028 | '(fit-window-to-buffer))) | |
7029 | keys-alist char) | |
7030 | ;; First check the cache | |
7031 | (if (and (eq (symbol-value sym) (get sym :one-key-alist-last))) | |
7032 | (setq keys-alist (get sym :one-key-alist-cache)) | |
7033 | ;; Need to make new list | |
7034 | (setq keys-alist (idlwave-make-one-key-alist alist)) | |
7035 | (put sym :one-key-alist-cache keys-alist) | |
7036 | (put sym :one-key-alist-last alist)) | |
7037 | ;; Display prompt and wait for quick reply | |
7038 | (message "%s[%s]" prompt | |
7039 | (mapconcat (lambda(x) (char-to-string (car x))) | |
7040 | keys-alist "")) | |
7041 | (if (sit-for delay) | |
7042 | ;; No quick reply: Show help | |
7043 | (save-window-excursion | |
7044 | (with-output-to-temp-buffer "*Completions*" | |
26b51db5 JB |
7045 | (dolist (x keys-alist) |
7046 | (princ (nth 1 x)) | |
7047 | (princ "\n"))) | |
52a244eb S |
7048 | (setq char (read-char))) |
7049 | (setq char (read-char))) | |
7050 | (message nil) | |
7051 | ;; Return the selected result | |
7052 | (nth 2 (assoc char keys-alist)))) | |
7053 | ||
7054 | ;; Used for, e.g., electric debug super-examine. | |
7055 | (defun idlwave-make-one-key-alist (alist) | |
7056 | "Make an alist for single key selection." | |
7057 | (let ((l alist) keys-alist name start char help | |
7058 | (cnt 0) | |
7059 | (case-fold-search nil)) | |
7060 | (while l | |
7061 | (setq name (car (car l)) | |
7062 | l (cdr l)) | |
7063 | (catch 'exit | |
7064 | ;; First check if the configuration predetermined a key | |
7065 | (if (string-match "\\[\\(.\\)\\]" name) | |
7066 | (progn | |
7067 | (setq char (string-to-char (downcase (match-string 1 name))) | |
7068 | help (format "%c: %s" char name) | |
7069 | keys-alist (cons (list char help name) keys-alist)) | |
7070 | (throw 'exit t))) | |
7071 | ;; Then check for capital letters | |
7072 | (setq start 0) | |
7073 | (while (string-match "[A-Z]" name start) | |
7074 | (setq start (match-end 0) | |
7075 | char (string-to-char (downcase (match-string 0 name)))) | |
7076 | (if (not (assoc char keys-alist)) | |
7077 | (progn | |
7078 | (setq help (format "%c: %s" char | |
7079 | (replace-match | |
7080 | (concat "[" (match-string 0 name) "]") | |
7081 | t t name)) | |
7082 | keys-alist (cons (list char help name) keys-alist)) | |
7083 | (throw 'exit t)))) | |
7084 | ;; Now check for lowercase letters | |
7085 | (setq start 0) | |
7086 | (while (string-match "[a-z]" name start) | |
7087 | (setq start (match-end 0) | |
7088 | char (string-to-char (match-string 0 name))) | |
7089 | (if (not (assoc char keys-alist)) | |
7090 | (progn | |
7091 | (setq help (format "%c: %s" char | |
7092 | (replace-match | |
7093 | (concat "[" (match-string 0 name) "]") | |
7094 | t t name)) | |
7095 | keys-alist (cons (list char help name) keys-alist)) | |
7096 | (throw 'exit t)))) | |
7097 | ;; Bummer, nothing found! Use a stupid number | |
7098 | (setq char (string-to-char (int-to-string (setq cnt (1+ cnt)))) | |
7099 | help (format "%c: %s" char name) | |
7100 | keys-alist (cons (list char help name) keys-alist)))) | |
7101 | (nreverse keys-alist))) | |
7102 | ||
f32b3b91 CD |
7103 | (defun idlwave-set-local (var value &optional buffer) |
7104 | "Set the buffer-local value of VAR in BUFFER to VALUE." | |
9a529312 | 7105 | (with-current-buffer (or buffer (current-buffer)) |
f32b3b91 CD |
7106 | (set (make-local-variable var) value))) |
7107 | ||
7108 | (defun idlwave-local-value (var &optional buffer) | |
7109 | "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER." | |
9a529312 | 7110 | (with-current-buffer (or buffer (current-buffer)) |
f32b3b91 CD |
7111 | (and (local-variable-p var (current-buffer)) |
7112 | (symbol-value var)))) | |
7113 | ||
15e42531 CD |
7114 | ;; In XEmacs, we can use :activate-callback directly to advice the |
7115 | ;; choose functions. We use the private keymap only for the online | |
7116 | ;; help feature. | |
f32b3b91 | 7117 | |
15e42531 | 7118 | (defvar idlwave-completion-map nil |
5a0c3f56 | 7119 | "Keymap for `completion-list-mode' with `idlwave-complete'.") |
15e42531 CD |
7120 | |
7121 | (defun idlwave-display-completion-list-xemacs (list &rest cl-args) | |
f32b3b91 | 7122 | (with-output-to-temp-buffer "*Completions*" |
15e42531 CD |
7123 | (apply 'display-completion-list list |
7124 | ':activate-callback 'idlwave-default-choose-completion | |
7125 | cl-args)) | |
9a529312 | 7126 | (with-current-buffer "*Completions*" |
15e42531 CD |
7127 | (use-local-map |
7128 | (or idlwave-completion-map | |
7129 | (setq idlwave-completion-map | |
7130 | (idlwave-make-modified-completion-map-xemacs | |
7131 | (current-local-map))))))) | |
f32b3b91 CD |
7132 | |
7133 | (defun idlwave-default-choose-completion (&rest args) | |
7134 | "Execute `default-choose-completion' and then restore the win-conf." | |
7135 | (apply 'idlwave-choose 'default-choose-completion args)) | |
7136 | ||
15e42531 CD |
7137 | (defun idlwave-make-modified-completion-map-xemacs (old-map) |
7138 | "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP." | |
7139 | (let ((new-map (copy-keymap old-map))) | |
7140 | (define-key new-map [button3up] 'idlwave-mouse-completion-help) | |
7141 | (define-key new-map [button3] (lambda () | |
7142 | (interactive) | |
7143 | (setq this-command last-command))) | |
7144 | new-map)) | |
f32b3b91 | 7145 | |
76959b77 | 7146 | ;; In Emacs we also replace keybindings in the completion |
15e42531 | 7147 | ;; map in order to install our wrappers. |
f32b3b91 CD |
7148 | |
7149 | (defun idlwave-display-completion-list-emacs (list) | |
7150 | "Display completion list and install the choose wrappers." | |
7151 | (with-output-to-temp-buffer "*Completions*" | |
7152 | (display-completion-list list)) | |
9a529312 | 7153 | (with-current-buffer "*Completions*" |
f32b3b91 CD |
7154 | (use-local-map |
7155 | (or idlwave-completion-map | |
7156 | (setq idlwave-completion-map | |
15e42531 CD |
7157 | (idlwave-make-modified-completion-map-emacs |
7158 | (current-local-map))))))) | |
7159 | ||
7160 | (defun idlwave-make-modified-completion-map-emacs (old-map) | |
f32b3b91 CD |
7161 | "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP." |
7162 | (let ((new-map (copy-keymap old-map))) | |
4b1aaa8b | 7163 | (substitute-key-definition |
f32b3b91 CD |
7164 | 'choose-completion 'idlwave-choose-completion new-map) |
7165 | (substitute-key-definition | |
7166 | 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map) | |
15e42531 | 7167 | (define-key new-map [mouse-3] 'idlwave-mouse-completion-help) |
f32b3b91 CD |
7168 | new-map)) |
7169 | ||
7170 | (defun idlwave-choose-completion (&rest args) | |
7171 | "Choose the completion that point is in or next to." | |
7172 | (interactive) | |
7173 | (apply 'idlwave-choose 'choose-completion args)) | |
7174 | ||
7175 | (defun idlwave-mouse-choose-completion (&rest args) | |
7176 | "Click on an alternative in the `*Completions*' buffer to choose it." | |
7177 | (interactive "e") | |
7178 | (apply 'idlwave-choose 'mouse-choose-completion args)) | |
7179 | ||
7180 | ;;---------------------------------------------------------------------- | |
7181 | ;;---------------------------------------------------------------------- | |
7182 | ||
05a1abfc | 7183 | ;;; ------------------------------------------------------------------------ |
8350f087 | 7184 | ;;; Structure parsing code, and code to manage class info |
05a1abfc CD |
7185 | |
7186 | ;; | |
7187 | ;; - Go again over the documentation how to write a completion | |
7188 | ;; plugin. It is in self.el, but currently still very bad. | |
4b1aaa8b PE |
7189 | ;; This could be in a separate file in the distribution, or |
7190 | ;; in an appendix for the manual. | |
52a244eb S |
7191 | |
7192 | (defvar idlwave-struct-skip | |
7193 | "[ \t]*\\(\\$.*\n\\(^[ \t]*\\(\\$[ \t]*\\)?\\(;.*\\)?\n\\)*\\)?[ \t]*" | |
5a0c3f56 | 7194 | "Regexp for skipping continued blank or comment-only lines in structures.") |
52a244eb S |
7195 | |
7196 | (defvar idlwave-struct-tag-regexp | |
7197 | (concat "[{,]" ;leading comma/brace | |
7198 | idlwave-struct-skip ; 4 groups | |
7199 | "\\([a-zA-Z][a-zA-Z0-9_]*\\)" ;the tag itself, group 5 | |
7200 | "[ \t]*:") ; the final colon | |
7201 | "Regexp for structure tags.") | |
05a1abfc CD |
7202 | |
7203 | (defun idlwave-struct-tags () | |
7204 | "Return a list of all tags in the structure defined at point. | |
7205 | Point is expected just before the opening `{' of the struct definition." | |
7206 | (save-excursion | |
7207 | (let* ((borders (idlwave-struct-borders)) | |
7208 | (beg (car borders)) | |
7209 | (end (cdr borders)) | |
7210 | tags) | |
7211 | (goto-char beg) | |
52a244eb S |
7212 | (save-restriction |
7213 | (narrow-to-region beg end) | |
7214 | (while (re-search-forward idlwave-struct-tag-regexp end t) | |
7215 | ;; Check if we are still on the top level of the structure. | |
7216 | (if (and (condition-case nil (progn (up-list -1) t) (error nil)) | |
7217 | (= (point) beg)) | |
7218 | (push (match-string-no-properties 5) tags)) | |
7219 | (goto-char (match-end 0)))) | |
7220 | (nreverse tags)))) | |
05a1abfc | 7221 | |
76959b77 S |
7222 | (defun idlwave-find-struct-tag (tag) |
7223 | "Find a given TAG in the structure defined at point." | |
7224 | (let* ((borders (idlwave-struct-borders)) | |
76959b77 S |
7225 | (end (cdr borders)) |
7226 | (case-fold-search t)) | |
4b1aaa8b | 7227 | (re-search-forward (concat "\\(^[ \t]*\\|[,{][ \t]*\\)" tag "[ \t]*:") |
76959b77 S |
7228 | end t))) |
7229 | ||
05a1abfc CD |
7230 | (defun idlwave-struct-inherits () |
7231 | "Return a list of all `inherits' names in the struct at point. | |
7232 | Point is expected just before the opening `{' of the struct definition." | |
7233 | (save-excursion | |
7234 | (let* ((borders (idlwave-struct-borders)) | |
7235 | (beg (car borders)) | |
7236 | (end (cdr borders)) | |
7237 | (case-fold-search t) | |
7238 | names) | |
7239 | (goto-char beg) | |
52a244eb S |
7240 | (save-restriction |
7241 | (narrow-to-region beg end) | |
4b1aaa8b | 7242 | (while (re-search-forward |
52a244eb S |
7243 | (concat "[{,]" ;leading comma/brace |
7244 | idlwave-struct-skip ; 4 groups | |
7245 | "inherits" ; The INHERITS tag | |
7246 | idlwave-struct-skip ; 4 more | |
7247 | "\\([a-zA-Z][a-zA-Z0-9_]*\\)") ; The super-group, #9 | |
7248 | end t) | |
7249 | ;; Check if we are still on the top level of the structure. | |
7250 | (if (and (condition-case nil (progn (up-list -1) t) (error nil)) | |
7251 | (= (point) beg)) | |
7252 | (push (match-string-no-properties 9) names)) | |
7253 | (goto-char (match-end 0)))) | |
05a1abfc CD |
7254 | (nreverse names)))) |
7255 | ||
5e72c6b2 | 7256 | (defun idlwave-in-structure () |
52a244eb | 7257 | "Return t if point is inside an IDL structure definition." |
5e72c6b2 S |
7258 | (let ((beg (point))) |
7259 | (save-excursion | |
7260 | (if (not (or (idlwave-in-comment) (idlwave-in-quote))) | |
7261 | (if (idlwave-find-structure-definition nil nil 'back) | |
7262 | (let ((borders (idlwave-struct-borders))) | |
7263 | (or (= (car borders) (cdr borders)) ;; struct not yet closed... | |
7264 | (and (> beg (car borders)) (< beg (cdr borders)))))))))) | |
05a1abfc CD |
7265 | |
7266 | (defun idlwave-struct-borders () | |
7267 | "Return the borders of the {...} after point as a cons cell." | |
7268 | (let (beg) | |
7269 | (save-excursion | |
7270 | (skip-chars-forward "^{") | |
7271 | (setq beg (point)) | |
7272 | (condition-case nil (forward-list 1) | |
7273 | (error (goto-char beg))) | |
7274 | (cons beg (point))))) | |
7275 | ||
7276 | (defun idlwave-find-structure-definition (&optional var name bound) | |
5a0c3f56 JB |
7277 | "Search forward for a structure definition. |
7278 | If VAR is non-nil, search for a structure assigned to variable VAR. | |
7279 | If NAME is non-nil, search for a named structure NAME, if a string, | |
7280 | or a generic named structure otherwise. If BOUND is an integer, limit | |
7281 | the search. If BOUND is the symbol `all', we search first back and | |
7282 | then forward through the entire file. If BOUND is the symbol `back' | |
7283 | we search only backward." | |
76959b77 | 7284 | (let* ((ws "[ \t]*\\(\\$.*\n[ \t]*\\)*") |
05a1abfc CD |
7285 | (case-fold-search t) |
7286 | (lim (if (integerp bound) bound nil)) | |
7287 | (re (concat | |
7288 | (if var | |
7289 | (concat "\\<" (regexp-quote (downcase var)) "\\>" ws) | |
7290 | "\\(\\)") | |
7291 | "=" ws "\\({\\)" | |
4b1aaa8b | 7292 | (if name |
52a244eb | 7293 | (if (stringp name) |
4b1aaa8b | 7294 | (concat ws "\\(\\<" (downcase name) "\\)[^a-zA-Z0-9_$]") |
52a244eb S |
7295 | ;; Just a generic name |
7296 | (concat ws "\\<\\([a-zA-Z_0-9$]+\\)" ws ",")) | |
7297 | "")))) | |
5e72c6b2 | 7298 | (if (or (and (or (eq bound 'all) (eq bound 'back)) |
05a1abfc | 7299 | (re-search-backward re nil t)) |
5e72c6b2 | 7300 | (and (not (eq bound 'back)) (re-search-forward re lim t))) |
52a244eb S |
7301 | (progn |
7302 | (goto-char (match-beginning 3)) | |
7303 | (match-string-no-properties 5))))) | |
7304 | ||
4b1aaa8b | 7305 | (defvar idlwave-class-info nil) |
52a244eb | 7306 | (defvar idlwave-class-reset nil) ; to reset buffer-local classes |
05a1abfc | 7307 | |
05a1abfc | 7308 | (add-hook 'idlwave-update-rinfo-hook |
52a244eb | 7309 | (lambda () (setq idlwave-class-reset t))) |
05a1abfc CD |
7310 | (add-hook 'idlwave-after-load-rinfo-hook |
7311 | (lambda () (setq idlwave-class-info nil))) | |
7312 | ||
7313 | (defun idlwave-class-info (class) | |
7314 | (let (list entry) | |
52a244eb S |
7315 | (if idlwave-class-info |
7316 | (if idlwave-class-reset | |
4b1aaa8b | 7317 | (setq |
52a244eb S |
7318 | idlwave-class-reset nil |
7319 | idlwave-class-info ; Remove any visited in a buffer | |
4b1aaa8b PE |
7320 | (delq nil (mapcar |
7321 | (lambda (x) | |
7322 | (let ((filebuf | |
7323 | (idlwave-class-file-or-buffer | |
52a244eb S |
7324 | (or (cdr (assq 'found-in x)) (car x))))) |
7325 | (if (cdr filebuf) | |
7326 | nil | |
7327 | x))) | |
7328 | idlwave-class-info)))) | |
7329 | ;; Info is nil, put in the system stuff to start. | |
05a1abfc CD |
7330 | (setq idlwave-class-info idlwave-system-class-info) |
7331 | (setq list idlwave-class-info) | |
7332 | (while (setq entry (pop list)) | |
7333 | (idlwave-sintern-class-info entry))) | |
7334 | (setq class (idlwave-sintern-class class)) | |
52a244eb S |
7335 | (or (assq class idlwave-class-info) |
7336 | (progn (idlwave-scan-class-info class) | |
7337 | (assq class idlwave-class-info))))) | |
05a1abfc CD |
7338 | |
7339 | (defun idlwave-sintern-class-info (entry) | |
7340 | "Sintern the class names in a class-info entry." | |
8d222148 | 7341 | (let ((inherits (assq 'inherits entry))) |
05a1abfc CD |
7342 | (setcar entry (idlwave-sintern-class (car entry) 'set)) |
7343 | (if inherits | |
7344 | (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set)) | |
7345 | (cdr inherits)))))) | |
7346 | ||
52a244eb | 7347 | (defun idlwave-find-class-definition (class &optional all-hook alt-class) |
5a0c3f56 | 7348 | "Find class structure definition(s). |
52a244eb S |
7349 | If ALL-HOOK is set, find all named structure definitions in a given |
7350 | class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is | |
7351 | set, look for the name__define pro, and inside of it, for the ALT-CLASS | |
5a0c3f56 | 7352 | class/struct definition." |
8d222148 | 7353 | (let ((case-fold-search t) end-lim name) |
52a244eb S |
7354 | (when (re-search-forward |
7355 | (concat "^[ \t]*pro[ \t]+" (downcase class) "__define" "\\>") nil t) | |
7356 | (if all-hook | |
7357 | (progn | |
7358 | ;; For everything there | |
7359 | (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point))) | |
4b1aaa8b | 7360 | (while (setq name |
52a244eb S |
7361 | (idlwave-find-structure-definition nil t end-lim)) |
7362 | (funcall all-hook name))) | |
7363 | (idlwave-find-structure-definition nil (or alt-class class)))))) | |
76959b77 | 7364 | |
52a244eb S |
7365 | |
7366 | (defun idlwave-class-file-or-buffer (class) | |
5a0c3f56 | 7367 | "Find buffer visiting CLASS definition." |
05a1abfc | 7368 | (let* ((pro (concat (downcase class) "__define")) |
52a244eb S |
7369 | (file (idlwave-routine-source-file |
7370 | (nth 3 (idlwave-rinfo-assoc pro 'pro nil | |
7371 | (idlwave-routines)))))) | |
7372 | (cons file (if file (idlwave-get-buffer-visiting file))))) | |
7373 | ||
7374 | ||
7375 | (defun idlwave-scan-class-info (class) | |
5a0c3f56 | 7376 | "Scan all class and named structure info in the class__define pro." |
52a244eb S |
7377 | (let* ((idlwave-auto-routine-info-updates nil) |
7378 | (filebuf (idlwave-class-file-or-buffer class)) | |
7379 | (file (car filebuf)) | |
7380 | (buf (cdr filebuf)) | |
7381 | (class (idlwave-sintern-class class))) | |
7382 | (if (or | |
7383 | (not file) | |
7384 | (and ;; neither a regular file nor a visited buffer | |
7385 | (not buf) | |
7386 | (not (file-regular-p file)))) | |
7387 | nil ; Cannot find the file/buffer to get any info | |
05a1abfc | 7388 | (save-excursion |
52a244eb S |
7389 | (if buf (set-buffer buf) |
7390 | ;; Read the file in temporarily | |
05a1abfc CD |
7391 | (set-buffer (get-buffer-create " *IDLWAVE-tmp*")) |
7392 | (erase-buffer) | |
175069ef | 7393 | (unless (derived-mode-p 'idlwave-mode) |
05a1abfc CD |
7394 | (idlwave-mode)) |
7395 | (insert-file-contents file)) | |
7396 | (save-excursion | |
7397 | (goto-char 1) | |
4b1aaa8b | 7398 | (idlwave-find-class-definition class |
52a244eb S |
7399 | ;; Scan all of the structures found there |
7400 | (lambda (name) | |
7401 | (let* ((this-class (idlwave-sintern-class name)) | |
4b1aaa8b | 7402 | (entry |
52a244eb S |
7403 | (list this-class |
7404 | (cons 'tags (idlwave-struct-tags)) | |
7405 | (cons 'inherits (idlwave-struct-inherits))))) | |
7406 | (if (not (eq this-class class)) | |
7407 | (setq entry (nconc entry (list (cons 'found-in class))))) | |
7408 | (idlwave-sintern-class-info entry) | |
7409 | (push entry idlwave-class-info))))))))) | |
7410 | ||
7411 | (defun idlwave-class-found-in (class) | |
5a0c3f56 | 7412 | "Return the FOUND-IN property of the CLASS." |
52a244eb | 7413 | (cdr (assq 'found-in (idlwave-class-info class)))) |
05a1abfc CD |
7414 | (defun idlwave-class-tags (class) |
7415 | "Return the native tags in CLASS." | |
7416 | (cdr (assq 'tags (idlwave-class-info class)))) | |
7417 | (defun idlwave-class-inherits (class) | |
7418 | "Return the direct superclasses of CLASS." | |
7419 | (cdr (assq 'inherits (idlwave-class-info class)))) | |
7420 | ||
52a244eb | 7421 | |
05a1abfc CD |
7422 | (defun idlwave-all-class-tags (class) |
7423 | "Return a list of native and inherited tags in CLASS." | |
76959b77 S |
7424 | (condition-case err |
7425 | (apply 'append (mapcar 'idlwave-class-tags | |
7426 | (cons class (idlwave-all-class-inherits class)))) | |
4b1aaa8b | 7427 | (error |
76959b77 S |
7428 | (idlwave-class-tag-reset) |
7429 | (error "%s" (error-message-string err))))) | |
7430 | ||
05a1abfc CD |
7431 | |
7432 | (defun idlwave-all-class-inherits (class) | |
7433 | "Return a list of all superclasses of CLASS (recursively expanded). | |
5e72c6b2 | 7434 | The list is cached in `idlwave-class-info' for faster access." |
05a1abfc CD |
7435 | (cond |
7436 | ((not idlwave-support-inheritance) nil) | |
7437 | ((eq class nil) nil) | |
7438 | ((eq class t) nil) | |
7439 | (t | |
7440 | (let ((info (idlwave-class-info class)) | |
7441 | entry) | |
7442 | (if (setq entry (assq 'all-inherits info)) | |
7443 | (cdr entry) | |
76959b77 S |
7444 | ;; Save the depth of inheritance scan to check for circular references |
7445 | (let ((inherits (mapcar (lambda (x) (cons x 0)) | |
7446 | (idlwave-class-inherits class))) | |
05a1abfc CD |
7447 | rtn all-inherits cl) |
7448 | (while inherits | |
7449 | (setq cl (pop inherits) | |
76959b77 S |
7450 | rtn (cons (car cl) rtn) |
7451 | inherits (append (mapcar (lambda (x) | |
7452 | (cons x (1+ (cdr cl)))) | |
7453 | (idlwave-class-inherits (car cl))) | |
7454 | inherits)) | |
7455 | (if (> (cdr cl) 999) | |
7456 | (error | |
7457 | "Class scan: inheritance depth exceeded. Circular inheritance?") | |
7458 | )) | |
05a1abfc CD |
7459 | (setq all-inherits (nreverse rtn)) |
7460 | (nconc info (list (cons 'all-inherits all-inherits))) | |
7461 | all-inherits)))))) | |
7462 | ||
52a244eb | 7463 | (defun idlwave-entry-keywords (entry &optional record-link) |
4b1aaa8b | 7464 | "Return the flat entry keywords alist from routine-info entry. |
52a244eb S |
7465 | If RECORD-LINK is non-nil, the keyword text is copied and a text |
7466 | property indicating the link is added." | |
7467 | (let (kwds) | |
8ffcfb27 | 7468 | (mapc |
4b1aaa8b | 7469 | (lambda (key-list) |
52a244eb S |
7470 | (let ((file (car key-list))) |
7471 | (mapcar (lambda (key-cons) | |
7472 | (let ((key (car key-cons)) | |
7473 | (link (cdr key-cons))) | |
7474 | (when (and record-link file) | |
7475 | (setq key (copy-sequence key)) | |
4b1aaa8b | 7476 | (put-text-property |
52a244eb | 7477 | 0 (length key) |
4b1aaa8b PE |
7478 | 'link |
7479 | (concat | |
7480 | file | |
7481 | (if link | |
52a244eb S |
7482 | (concat idlwave-html-link-sep |
7483 | (number-to-string link)))) | |
7484 | key)) | |
7485 | (push (list key) kwds))) | |
7486 | (cdr key-list)))) | |
7487 | (nthcdr 5 entry)) | |
7488 | (nreverse kwds))) | |
7489 | ||
7490 | (defun idlwave-entry-find-keyword (entry keyword) | |
5a0c3f56 | 7491 | "Find keyword KEYWORD in entry ENTRY, and return (with link) if set." |
52a244eb S |
7492 | (catch 'exit |
7493 | (mapc | |
4b1aaa8b | 7494 | (lambda (key-list) |
52a244eb S |
7495 | (let ((file (car key-list)) |
7496 | (kwd (assoc keyword (cdr key-list)))) | |
7497 | (when kwd | |
4b1aaa8b | 7498 | (setq kwd (cons (car kwd) |
52a244eb | 7499 | (if (and file (cdr kwd)) |
4b1aaa8b | 7500 | (concat file |
52a244eb S |
7501 | idlwave-html-link-sep |
7502 | (number-to-string (cdr kwd))) | |
7503 | (cdr kwd)))) | |
7504 | (throw 'exit kwd)))) | |
7505 | (nthcdr 5 entry)))) | |
05a1abfc CD |
7506 | |
7507 | ;;========================================================================== | |
7508 | ;; | |
7509 | ;; Completing class structure tags. This is a completion plugin. | |
7510 | ;; The necessary taglist is constructed dynamically | |
7511 | ||
7512 | (defvar idlwave-current-tags-class nil) | |
7513 | (defvar idlwave-current-class-tags nil) | |
7514 | (defvar idlwave-current-native-class-tags nil) | |
76959b77 | 7515 | (defvar idlwave-sint-class-tags nil) |
1a717047 | 7516 | (declare-function idlwave-sintern-class-tag "idlwave" t t) |
76959b77 | 7517 | (idlwave-new-sintern-type 'class-tag) |
05a1abfc | 7518 | (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag) |
76959b77 | 7519 | (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset) |
05a1abfc CD |
7520 | |
7521 | (defun idlwave-complete-class-structure-tag () | |
7522 | "Complete a structure tag on a `self' argument in an object method." | |
7523 | (interactive) | |
7524 | (let ((pos (point)) | |
7525 | (case-fold-search t)) | |
7526 | (if (save-excursion | |
7527 | ;; Check if the context is right | |
52a244eb | 7528 | (skip-chars-backward "a-zA-Z0-9._$") |
05a1abfc CD |
7529 | (and (< (point) (- pos 4)) |
7530 | (looking-at "self\\."))) | |
76959b77 S |
7531 | (let* ((class-selector (nth 2 (idlwave-current-routine))) |
7532 | (super-classes (idlwave-all-class-inherits class-selector))) | |
05a1abfc | 7533 | ;; Check if we are in a class routine |
76959b77 | 7534 | (unless class-selector |
e8af40ee | 7535 | (error "Not in a method procedure or function")) |
05a1abfc | 7536 | ;; Check if we need to update the "current" class |
76959b77 S |
7537 | (if (not (equal class-selector idlwave-current-tags-class)) |
7538 | (idlwave-prepare-class-tag-completion class-selector)) | |
4b1aaa8b | 7539 | (setq idlwave-completion-help-info |
76959b77 | 7540 | (list 'idlwave-complete-class-structure-tag-help |
4b1aaa8b | 7541 | (idlwave-sintern-routine |
76959b77 S |
7542 | (concat class-selector "__define")) |
7543 | nil)) | |
8d222148 | 7544 | ;; FIXME: idlwave-cpl-bold doesn't seem used anywhere. |
05a1abfc CD |
7545 | (let ((idlwave-cpl-bold idlwave-current-native-class-tags)) |
7546 | (idlwave-complete-in-buffer | |
4b1aaa8b | 7547 | 'class-tag 'class-tag |
05a1abfc | 7548 | idlwave-current-class-tags nil |
76959b77 S |
7549 | (format "Select a tag of class %s" class-selector) |
7550 | "class tag" | |
7551 | 'idlwave-attach-class-tag-classes)) | |
05a1abfc CD |
7552 | t) ; return t to skip other completions |
7553 | nil))) | |
7554 | ||
76959b77 | 7555 | (defun idlwave-class-tag-reset () |
05a1abfc CD |
7556 | (setq idlwave-current-tags-class nil)) |
7557 | ||
7558 | (defun idlwave-prepare-class-tag-completion (class) | |
7559 | "Find and parse the necessary class definitions for class structure tags." | |
76959b77 | 7560 | (setq idlwave-sint-class-tags nil) |
05a1abfc CD |
7561 | (setq idlwave-current-tags-class class) |
7562 | (setq idlwave-current-class-tags | |
7563 | (mapcar (lambda (x) | |
76959b77 | 7564 | (list (idlwave-sintern-class-tag x 'set))) |
05a1abfc CD |
7565 | (idlwave-all-class-tags class))) |
7566 | (setq idlwave-current-native-class-tags | |
7567 | (mapcar 'downcase (idlwave-class-tags class)))) | |
7568 | ||
7569 | ;=========================================================================== | |
7570 | ;; | |
7571 | ;; Completing system variables and their structure fields | |
52a244eb | 7572 | ;; This is also a plugin. |
05a1abfc CD |
7573 | |
7574 | (defvar idlwave-sint-sysvars nil) | |
7575 | (defvar idlwave-sint-sysvartags nil) | |
1a717047 GM |
7576 | (declare-function idlwave-sintern-sysvar "idlwave" t t) |
7577 | (declare-function idlwave-sintern-sysvartag "idlwave" t t) | |
05a1abfc CD |
7578 | (idlwave-new-sintern-type 'sysvar) |
7579 | (idlwave-new-sintern-type 'sysvartag) | |
7580 | (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag) | |
7581 | (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset) | |
05a1abfc CD |
7582 | (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist) |
7583 | ||
05a1abfc CD |
7584 | |
7585 | (defun idlwave-complete-sysvar-or-tag () | |
7586 | "Complete a system variable." | |
7587 | (interactive) | |
7588 | (let ((pos (point)) | |
7589 | (case-fold-search t)) | |
7590 | (cond ((save-excursion | |
7591 | ;; Check if the context is right for system variable | |
7592 | (skip-chars-backward "[a-zA-Z0-9_$]") | |
7593 | (equal (char-before) ?!)) | |
7594 | (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help)) | |
4b1aaa8b | 7595 | (idlwave-complete-in-buffer 'sysvar 'sysvar |
05a1abfc CD |
7596 | idlwave-system-variables-alist nil |
7597 | "Select a system variable" | |
7598 | "system variable") | |
7599 | t) ; return t to skip other completions | |
7600 | ((save-excursion | |
7601 | ;; Check if the context is right for sysvar tag | |
52a244eb | 7602 | (skip-chars-backward "a-zA-Z0-9_$.") |
05a1abfc CD |
7603 | (and (equal (char-before) ?!) |
7604 | (looking-at "\\([a-zA-Z][a-zA-Z0-9_$]*\\)\\.") | |
7605 | (<= (match-end 0) pos))) | |
7606 | ;; Complete a system variable tag | |
7607 | (let* ((var (idlwave-sintern-sysvar (match-string 1))) | |
7608 | (entry (assq var idlwave-system-variables-alist)) | |
52a244eb S |
7609 | (tags (cdr (assq 'tags entry)))) |
7610 | (or entry (error "!%s is not a known system variable" var)) | |
05a1abfc CD |
7611 | (or tags (error "System variable !%s is not a structure" var)) |
7612 | (setq idlwave-completion-help-info | |
52a244eb | 7613 | (list 'idlwave-complete-sysvar-tag-help var)) |
4b1aaa8b | 7614 | (idlwave-complete-in-buffer 'sysvartag 'sysvartag |
05a1abfc CD |
7615 | tags nil |
7616 | "Select a system variable tag" | |
7617 | "system variable tag") | |
7618 | t)) ; return t to skip other completions | |
7619 | (t nil)))) | |
7620 | ||
e7c4fb1e | 7621 | (defvar idlw-help-link) ;dynamic variables set by help callback |
05a1abfc | 7622 | (defun idlwave-complete-sysvar-help (mode word) |
52a244eb S |
7623 | (let ((word (or (nth 1 idlwave-completion-help-info) word)) |
7624 | (entry (assoc word idlwave-system-variables-alist))) | |
7625 | (cond | |
7626 | ((eq mode 'test) | |
7627 | (and (stringp word) entry (nth 1 (assq 'link entry)))) | |
7628 | ((eq mode 'set) | |
e7c4fb1e GM |
7629 | ;; Setting dynamic!!! |
7630 | (if entry (setq idlw-help-link (nth 1 (assq 'link entry))))) | |
52a244eb S |
7631 | (t (error "This should not happen"))))) |
7632 | ||
7633 | (defun idlwave-complete-sysvar-tag-help (mode word) | |
7634 | (let* ((var (nth 1 idlwave-completion-help-info)) | |
7635 | (entry (assoc var idlwave-system-variables-alist)) | |
7636 | (tags (cdr (assq 'tags entry))) | |
7637 | (main (nth 1 (assq 'link entry))) | |
8d222148 | 7638 | target) |
52a244eb S |
7639 | (cond |
7640 | ((eq mode 'test) ; we can at least link the main | |
7641 | (and (stringp word) entry main)) | |
7642 | ((eq mode 'set) | |
4b1aaa8b | 7643 | (if entry |
e7c4fb1e | 7644 | (setq idlw-help-link |
e08734e2 | 7645 | (if (setq target (cdr (assoc-string word tags t))) |
e7c4fb1e GM |
7646 | (idlwave-substitute-link-target main target) |
7647 | main)))) ;; setting dynamic!!! | |
52a244eb S |
7648 | (t (error "This should not happen"))))) |
7649 | ||
f66f03de | 7650 | (defun idlwave-split-link-target (link) |
5a0c3f56 | 7651 | "Split a given LINK into link file and anchor." |
f66f03de S |
7652 | (if (string-match idlwave-html-link-sep link) |
7653 | (cons (substring link 0 (match-beginning 0)) | |
7654 | (string-to-number (substring link (match-end 0)))))) | |
7655 | ||
52a244eb | 7656 | (defun idlwave-substitute-link-target (link target) |
5a0c3f56 | 7657 | "Substitute the TARGET anchor for the given LINK." |
52a244eb S |
7658 | (let (main-base) |
7659 | (setq main-base (if (string-match "#" link) | |
7660 | (substring link 0 (match-beginning 0)) | |
7661 | link)) | |
7662 | (if target | |
7663 | (concat main-base idlwave-html-link-sep (number-to-string target)) | |
7664 | link))) | |
76959b77 S |
7665 | |
7666 | ;; Fake help in the source buffer for class structure tags. | |
e7c4fb1e GM |
7667 | ;; IDLW-HELP-LINK AND IDLW-HELP-NAME ARE GLOBAL-VARIABLES HERE. |
7668 | ;; (from idlwave-do-mouse-completion-help) | |
7669 | (defvar idlw-help-name) | |
7670 | (defvar idlw-help-link) | |
76959b77 S |
7671 | (defvar idlwave-help-do-class-struct-tag nil) |
7672 | (defun idlwave-complete-class-structure-tag-help (mode word) | |
7673 | (cond | |
7674 | ((eq mode 'test) ; nothing gets fontified for class tags | |
7675 | nil) | |
7676 | ((eq mode 'set) | |
52a244eb | 7677 | (let (class-with found-in) |
4b1aaa8b PE |
7678 | (when (setq class-with |
7679 | (idlwave-class-or-superclass-with-tag | |
76959b77 S |
7680 | idlwave-current-tags-class |
7681 | word)) | |
4b1aaa8b | 7682 | (if (assq (idlwave-sintern-class class-with) |
76959b77 | 7683 | idlwave-system-class-info) |
ff689efd | 7684 | (error "No help available for system class tags")) |
52a244eb | 7685 | (if (setq found-in (idlwave-class-found-in class-with)) |
e7c4fb1e GM |
7686 | (setq idlw-help-name (cons (concat found-in "__define") class-with)) |
7687 | (setq idlw-help-name (concat class-with "__define"))))) | |
7688 | (setq idlw-help-link word | |
76959b77 S |
7689 | idlwave-help-do-class-struct-tag t)) |
7690 | (t (error "This should not happen")))) | |
7691 | ||
7692 | (defun idlwave-class-or-superclass-with-tag (class tag) | |
7693 | "Find and return the CLASS or one of its superclass with the | |
7694 | associated TAG, if any." | |
e08734e2 | 7695 | (let ((sclasses (cons class (idlwave-all-class-inherits class))) |
76959b77 S |
7696 | cl) |
7697 | (catch 'exit | |
7698 | (while sclasses | |
7699 | (setq cl (pop sclasses)) | |
7700 | (let ((tags (idlwave-class-tags cl))) | |
7701 | (while tags | |
7702 | (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t)) | |
4b1aaa8b | 7703 | (throw 'exit cl)) |
76959b77 S |
7704 | (setq tags (cdr tags)))))))) |
7705 | ||
05a1abfc CD |
7706 | |
7707 | (defun idlwave-sysvars-reset () | |
7708 | (if (and (fboundp 'idlwave-shell-is-running) | |
52a244eb S |
7709 | (idlwave-shell-is-running) |
7710 | idlwave-idlwave_routine_info-compiled) | |
05a1abfc CD |
7711 | (idlwave-shell-send-command "idlwave_get_sysvars" |
7712 | 'idlwave-process-sysvars 'hide))) | |
7713 | ||
7714 | (defun idlwave-process-sysvars () | |
7715 | (idlwave-shell-filter-sysvars) | |
7716 | (setq idlwave-sint-sysvars nil | |
7717 | idlwave-sint-sysvartags nil) | |
7718 | (idlwave-sintern-sysvar-alist)) | |
7719 | ||
05a1abfc | 7720 | (defun idlwave-sintern-sysvar-alist () |
52a244eb | 7721 | (let ((list idlwave-system-variables-alist) entry tags) |
05a1abfc CD |
7722 | (while (setq entry (pop list)) |
7723 | (setcar entry (idlwave-sintern-sysvar (car entry) 'set)) | |
52a244eb S |
7724 | (setq tags (assq 'tags entry)) |
7725 | (if tags | |
4b1aaa8b PE |
7726 | (setcdr tags |
7727 | (mapcar (lambda (x) | |
52a244eb S |
7728 | (cons (idlwave-sintern-sysvartag (car x) 'set) |
7729 | (cdr x))) | |
7730 | (cdr tags))))))) | |
05a1abfc CD |
7731 | |
7732 | (defvar idlwave-shell-command-output) | |
7733 | (defun idlwave-shell-filter-sysvars () | |
52a244eb | 7734 | "Get any new system variables and tags." |
05a1abfc CD |
7735 | (let ((text idlwave-shell-command-output) |
7736 | (start 0) | |
7737 | (old idlwave-system-variables-alist) | |
52a244eb | 7738 | var tags type name class link old-entry) |
05a1abfc CD |
7739 | (setq idlwave-system-variables-alist nil) |
7740 | (while (string-match "^IDLWAVE-SYSVAR: !\\([a-zA-Z0-9_$]+\\)\\( \\(.*\\)\\)?" | |
7741 | text start) | |
7742 | (setq start (match-end 0) | |
7743 | var (match-string 1 text) | |
4b1aaa8b | 7744 | tags (if (match-end 3) |
52a244eb S |
7745 | (idlwave-split-string (match-string 3 text)))) |
7746 | ;; Maintain old links, if present | |
7747 | (setq old-entry (assq (idlwave-sintern-sysvar var) old)) | |
7748 | (setq link (assq 'link old-entry)) | |
05a1abfc | 7749 | (setq idlwave-system-variables-alist |
4b1aaa8b PE |
7750 | (cons (list var |
7751 | (cons | |
7752 | 'tags | |
7753 | (mapcar (lambda (x) | |
7754 | (cons x | |
7755 | (cdr (assq | |
7756 | (idlwave-sintern-sysvartag x) | |
52a244eb S |
7757 | (cdr (assq 'tags old-entry)))))) |
7758 | tags)) link) | |
05a1abfc CD |
7759 | idlwave-system-variables-alist))) |
7760 | ;; Keep the old value if query was not successful | |
7761 | (setq idlwave-system-variables-alist | |
7762 | (or idlwave-system-variables-alist old)))) | |
7763 | ||
f32b3b91 CD |
7764 | (defun idlwave-completion-fontify-classes () |
7765 | "Goto the *Completions* buffer and fontify the class info." | |
7766 | (when (featurep 'font-lock) | |
9a529312 | 7767 | (with-current-buffer "*Completions*" |
f32b3b91 CD |
7768 | (save-excursion |
7769 | (goto-char (point-min)) | |
76959b77 S |
7770 | (let ((buffer-read-only nil)) |
7771 | (while (re-search-forward "\\.*<[^>]+>" nil t) | |
7772 | (put-text-property (match-beginning 0) (match-end 0) | |
7773 | 'face 'font-lock-string-face))))))) | |
f32b3b91 CD |
7774 | |
7775 | (defun idlwave-uniquify (list) | |
52a244eb | 7776 | (let ((ht (make-hash-table :size (length list) :test 'equal))) |
4b1aaa8b | 7777 | (delq nil |
52a244eb | 7778 | (mapcar (lambda (x) |
4b1aaa8b | 7779 | (unless (gethash x ht) |
52a244eb S |
7780 | (puthash x t ht) |
7781 | x)) | |
7782 | list)))) | |
f32b3b91 CD |
7783 | |
7784 | (defun idlwave-after-successful-completion (type slash &optional verify) | |
7785 | "Add `=' or `(' after successful completion of keyword and function. | |
7786 | Restore the pre-completion window configuration if possible." | |
7787 | (cond | |
7788 | ((eq type 'procedure) | |
7789 | nil) | |
7790 | ((eq type 'function) | |
7791 | (cond | |
7792 | ((equal idlwave-function-completion-adds-paren nil) nil) | |
7793 | ((or (equal idlwave-function-completion-adds-paren t) | |
7794 | (equal idlwave-function-completion-adds-paren 1)) | |
7795 | (insert "(")) | |
7796 | ((equal idlwave-function-completion-adds-paren 2) | |
7797 | (insert "()") | |
7798 | (backward-char 1)) | |
7799 | (t nil))) | |
7800 | ((eq type 'keyword) | |
7801 | (if (and idlwave-keyword-completion-adds-equal | |
7802 | (not slash)) | |
7803 | (progn (insert "=") t) | |
7804 | nil))) | |
7805 | ||
7806 | ;; Restore the pre-completion window configuration if this is safe. | |
4b1aaa8b PE |
7807 | |
7808 | (if (or (eq verify 'force) ; force | |
7809 | (and | |
f32b3b91 | 7810 | (get-buffer-window "*Completions*") ; visible |
4b1aaa8b | 7811 | (idlwave-local-value 'idlwave-completion-p |
f32b3b91 CD |
7812 | "*Completions*") ; cib-buffer |
7813 | (eq (marker-buffer idlwave-completion-mark) | |
7814 | (current-buffer)) ; buffer OK | |
7815 | (equal (marker-position idlwave-completion-mark) | |
7816 | verify))) ; pos OK | |
7817 | (idlwave-restore-wconf-after-completion)) | |
7818 | (move-marker idlwave-completion-mark nil) | |
7819 | (setq idlwave-before-completion-wconf nil)) | |
7820 | ||
15e42531 CD |
7821 | (defun idlwave-mouse-context-help (ev &optional arg) |
7822 | "Call `idlwave-context-help' on the clicked location." | |
7823 | (interactive "eP") | |
7824 | (mouse-set-point ev) | |
7825 | (idlwave-context-help arg)) | |
7826 | ||
7827 | (defvar idlwave-last-context-help-pos nil) | |
7828 | (defun idlwave-context-help (&optional arg) | |
7829 | "Display IDL Online Help on context. | |
76959b77 S |
7830 | If point is on a keyword, help for that keyword will be shown. If |
7831 | point is on a routine name or in the argument list of a routine, help | |
7832 | for that routine will be displayed. Works for system routines and | |
9858f6c3 | 7833 | keywords, it pulls up text help. For other routines and keywords, |
76959b77 S |
7834 | visits the source file, finding help in the header (if |
7835 | `idlwave-help-source-try-header' is non-nil) or the routine definition | |
7836 | itself." | |
f32b3b91 | 7837 | (interactive "P") |
15e42531 CD |
7838 | (idlwave-do-context-help arg)) |
7839 | ||
7840 | (defun idlwave-mouse-completion-help (ev) | |
7841 | "Display online help about the completion at point." | |
7842 | (interactive "eP") | |
52a244eb | 7843 | ;; Restore last-command for next command, to make |
c80e3b4a | 7844 | ;; scrolling/canceling of completions work. |
15e42531 CD |
7845 | (setq this-command last-command) |
7846 | (idlwave-do-mouse-completion-help ev)) | |
15e42531 | 7847 | |
f32b3b91 | 7848 | (defun idlwave-routine-info (&optional arg external) |
5a0c3f56 JB |
7849 | "Display a routines calling sequence and list of keywords. |
7850 | When point is on the name a function or procedure, or in the argument | |
7851 | list of a function or procedure, this command displays a help buffer with | |
52a244eb | 7852 | the information. When called with prefix arg, enforce class query. |
f32b3b91 CD |
7853 | |
7854 | When point is on an object operator `->', display the class stored in | |
5a0c3f56 JB |
7855 | this arrow, if any (see `idlwave-store-inquired-class'). With a prefix |
7856 | arg, the class property is cleared out." | |
f32b3b91 CD |
7857 | |
7858 | (interactive "P") | |
7859 | (idlwave-routines) | |
7860 | (if (string-match "->" (buffer-substring | |
7861 | (max (point-min) (1- (point))) | |
7862 | (min (+ 2 (point)) (point-max)))) | |
7863 | ;; Cursor is on an arrow | |
7864 | (if (get-text-property (point) 'idlwave-class) | |
7865 | ;; arrow has class property | |
7866 | (if arg | |
7867 | ;; Remove property | |
7868 | (save-excursion | |
7869 | (backward-char 1) | |
7870 | (when (looking-at ".?\\(->\\)") | |
7871 | (remove-text-properties (match-beginning 1) (match-end 1) | |
7872 | '(idlwave-class nil face nil)) | |
7873 | (message "Class property removed from arrow"))) | |
7874 | ;; Echo class property | |
7875 | (message "Arrow has text property identifying object to be class %s" | |
7876 | (get-text-property (point) 'idlwave-class))) | |
7877 | ;; No property found | |
7878 | (message "Arrow has no class text property")) | |
7879 | ||
7880 | ;; Not on an arrow... | |
7881 | (let* ((idlwave-query-class nil) | |
7882 | (idlwave-force-class-query (equal arg '(4))) | |
7883 | (module (idlwave-what-module))) | |
15e42531 | 7884 | (if (car module) |
05a1abfc CD |
7885 | (apply 'idlwave-display-calling-sequence |
7886 | (idlwave-fix-module-if-obj_new module)) | |
e8af40ee | 7887 | (error "Don't know which calling sequence to show"))))) |
f32b3b91 CD |
7888 | |
7889 | (defun idlwave-resolve (&optional arg) | |
52a244eb | 7890 | "Call RESOLVE_ROUTINE on the module name at point. |
f32b3b91 CD |
7891 | Like `idlwave-routine-info', this looks for a routine call at point. |
7892 | After confirmation in the minibuffer, it will use the shell to issue | |
7893 | a RESOLVE call for this routine, to attempt to make it defined and its | |
7894 | routine info available for IDLWAVE. If the routine is a method call, | |
7895 | both `class__method' and `class__define' will be tried. | |
7896 | With ARG, enforce query for the class of object methods." | |
7897 | (interactive "P") | |
7898 | (let* ((idlwave-query-class nil) | |
7899 | (idlwave-force-class-query (equal arg '(4))) | |
7900 | (module (idlwave-what-module)) | |
7901 | (name (idlwave-make-full-name (nth 2 module) (car module))) | |
7902 | (type (if (eq (nth 1 module) 'pro) "pro" "function")) | |
7903 | (resolve (read-string "Resolve: " (format "%s %s" type name))) | |
7904 | (kwd "") | |
7905 | class) | |
7906 | (if (string-match "\\(pro\\|function\\)[ \t]+\\(\\(.*\\)::\\)?\\(.*\\)" | |
7907 | resolve) | |
7908 | (setq type (match-string 1 resolve) | |
4b1aaa8b | 7909 | class (if (match-beginning 2) |
f32b3b91 CD |
7910 | (match-string 3 resolve) |
7911 | nil) | |
7912 | name (match-string 4 resolve))) | |
7913 | (if (string= (downcase type) "function") | |
7914 | (setq kwd ",/is_function")) | |
7915 | ||
7916 | (cond | |
7917 | ((null class) | |
4b1aaa8b | 7918 | (idlwave-shell-send-command |
f32b3b91 CD |
7919 | (format "resolve_routine,'%s'%s" (downcase name) kwd) |
7920 | 'idlwave-update-routine-info | |
7921 | nil t)) | |
7922 | (t | |
4b1aaa8b | 7923 | (idlwave-shell-send-command |
f32b3b91 | 7924 | (format "resolve_routine,'%s__define'%s" (downcase class) kwd) |
4b1aaa8b PE |
7925 | (list 'idlwave-shell-send-command |
7926 | (format "resolve_routine,'%s__%s'%s" | |
f32b3b91 CD |
7927 | (downcase class) (downcase name) kwd) |
7928 | '(idlwave-update-routine-info) | |
7929 | nil t)))))) | |
7930 | ||
3938cb82 S |
7931 | (defun idlwave-find-module-this-file () |
7932 | (interactive) | |
7933 | (idlwave-find-module '(4))) | |
7934 | ||
f32b3b91 CD |
7935 | (defun idlwave-find-module (&optional arg) |
7936 | "Find the source code of an IDL module. | |
5a0c3f56 JB |
7937 | Works for modules for which IDLWAVE has routine info available. |
7938 | The function offers as default the module name `idlwave-routine-info' | |
52a244eb S |
7939 | would use. With ARG limit to this buffer. With two prefix ARG's |
7940 | force class query for object methods." | |
f32b3b91 CD |
7941 | (interactive "P") |
7942 | (let* ((idlwave-query-class nil) | |
52a244eb S |
7943 | (idlwave-force-class-query (equal arg '(16))) |
7944 | (this-buffer (equal arg '(4))) | |
05a1abfc | 7945 | (module (idlwave-fix-module-if-obj_new (idlwave-what-module))) |
52a244eb | 7946 | (default (if module |
4b1aaa8b | 7947 | (concat (idlwave-make-full-name |
52a244eb S |
7948 | (nth 2 module) (car module)) |
7949 | (if (eq (nth 1 module) 'pro) "<p>" "<f>")) | |
7950 | "none")) | |
4b1aaa8b | 7951 | (list |
52a244eb S |
7952 | (idlwave-uniquify |
7953 | (delq nil | |
4b1aaa8b | 7954 | (mapcar (lambda (x) |
52a244eb S |
7955 | (if (eq 'system (car-safe (nth 3 x))) |
7956 | ;; Take out system routines with no source. | |
7957 | nil | |
7958 | (list | |
4b1aaa8b | 7959 | (concat (idlwave-make-full-name |
52a244eb S |
7960 | (nth 2 x) (car x)) |
7961 | (if (eq (nth 1 x) 'pro) "<p>" "<f>"))))) | |
7962 | (if this-buffer | |
7963 | (idlwave-save-buffer-update) | |
7964 | (idlwave-routines)))))) | |
f32b3b91 | 7965 | (name (idlwave-completing-read |
52a244eb S |
7966 | (if (or (not this-buffer) |
7967 | (assoc default list)) | |
7968 | (format "Module (Default %s): " default) | |
7969 | (format "Module in this file: ")) | |
f32b3b91 CD |
7970 | list)) |
7971 | type class) | |
7972 | (if (string-match "\\`\\s-*\\'" name) | |
7973 | ;; Nothing, use the default. | |
7974 | (setq name default)) | |
7975 | (if (string-match "<[fp]>" name) | |
7976 | (setq type (substring name -2 -1) | |
7977 | name (substring name 0 -3))) | |
7978 | (if (string-match "\\(.*\\)::\\(.*\\)" name) | |
7979 | (setq class (match-string 1 name) | |
7980 | name (match-string 2 name))) | |
7981 | (setq name (idlwave-sintern-routine-or-method name class) | |
7982 | class (idlwave-sintern-class class) | |
7983 | type (cond ((equal type "f") 'fun) | |
7984 | ((equal type "p") 'pro) | |
7985 | (t t))) | |
52a244eb | 7986 | (idlwave-do-find-module name type class nil this-buffer))) |
f32b3b91 | 7987 | |
4b1aaa8b | 7988 | (defun idlwave-do-find-module (name type class |
52a244eb | 7989 | &optional force-source this-buffer) |
f32b3b91 | 7990 | (let ((name1 (idlwave-make-full-name class name)) |
4b1aaa8b | 7991 | source buf1 entry |
f32b3b91 | 7992 | (buf (current-buffer)) |
05a1abfc | 7993 | (pos (point)) |
52a244eb S |
7994 | file name2) |
7995 | (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines) | |
7996 | 'WITH-FILE) | |
05a1abfc CD |
7997 | source (or force-source (nth 3 entry)) |
7998 | name2 (if (nth 2 entry) | |
7999 | (idlwave-make-full-name (nth 2 entry) name) | |
775591f7 | 8000 | name1)) |
4b1aaa8b | 8001 | (if source |
52a244eb S |
8002 | (setq file (idlwave-routine-source-file source))) |
8003 | (unless file ; Try to find it on the path. | |
4b1aaa8b PE |
8004 | (setq file |
8005 | (idlwave-expand-lib-file-name | |
52a244eb S |
8006 | (if class |
8007 | (format "%s__define.pro" (downcase class)) | |
8008 | (format "%s.pro" (downcase name)))))) | |
f32b3b91 CD |
8009 | (cond |
8010 | ((or (null name) (equal name "")) | |
8011 | (error "Abort")) | |
f32b3b91 | 8012 | ((eq (car source) 'system) |
4b1aaa8b | 8013 | (error "Source code for system routine %s is not available" |
05a1abfc | 8014 | name2)) |
52a244eb | 8015 | ((or (not file) (not (file-regular-p file))) |
e8af40ee | 8016 | (error "Source code for routine %s is not available" |
05a1abfc | 8017 | name2)) |
52a244eb S |
8018 | (t |
8019 | (when (not this-buffer) | |
4b1aaa8b | 8020 | (setq buf1 |
52a244eb S |
8021 | (idlwave-find-file-noselect file 'find)) |
8022 | (pop-to-buffer buf1 t)) | |
15e42531 | 8023 | (goto-char (point-max)) |
f32b3b91 | 8024 | (let ((case-fold-search t)) |
15e42531 | 8025 | (if (re-search-backward |
f32b3b91 | 8026 | (concat "^[ \t]*\\<" |
52a244eb S |
8027 | (cond ((eq type 'fun) "function") |
8028 | ((eq type 'pro) "pro") | |
f32b3b91 | 8029 | (t "\\(pro\\|function\\)")) |
4b1aaa8b | 8030 | "\\>[ \t]+" |
05a1abfc | 8031 | (regexp-quote (downcase name2)) |
f32b3b91 CD |
8032 | "[^a-zA-Z0-9_$]") |
8033 | nil t) | |
8034 | (goto-char (match-beginning 0)) | |
8035 | (pop-to-buffer buf) | |
8036 | (goto-char pos) | |
05a1abfc | 8037 | (error "Could not find routine %s" name2))))))) |
f32b3b91 CD |
8038 | |
8039 | (defun idlwave-what-module () | |
8040 | "Return a default module for stuff near point. | |
8041 | Used by `idlwave-routine-info' and `idlwave-find-module'." | |
8042 | (idlwave-routines) | |
15e42531 CD |
8043 | (if (let ((case-fold-search t)) |
8044 | (save-excursion | |
8045 | (idlwave-beginning-of-statement) | |
8046 | (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)"))) | |
8047 | ;; This is a function or procedure definition statement | |
8048 | ;; We return the defined routine as module. | |
8049 | (list | |
52a244eb S |
8050 | (idlwave-sintern-routine-or-method (match-string-no-properties 4) |
8051 | (match-string-no-properties 2)) | |
15e42531 CD |
8052 | (if (equal (downcase (match-string 1)) "pro") 'pro 'fun) |
8053 | (idlwave-sintern-class (match-string 3))) | |
8054 | ||
52a244eb | 8055 | ;; Not a definition statement - analyze precise position. |
15e42531 CD |
8056 | (let* ((where (idlwave-where)) |
8057 | (cw (nth 2 where)) | |
8058 | (pro (car (nth 0 where))) | |
8059 | (func (car (nth 1 where))) | |
8060 | (this-word (idlwave-this-word "a-zA-Z0-9$_")) | |
8061 | (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_") | |
8062 | (following-char))) | |
8063 | ) | |
8064 | (cond | |
8065 | ((and (eq cw 'procedure) | |
8066 | (not (equal this-word ""))) | |
4b1aaa8b | 8067 | (setq this-word (idlwave-sintern-routine-or-method |
15e42531 CD |
8068 | this-word (nth 2 (nth 3 where)))) |
8069 | (list this-word 'pro | |
4b1aaa8b | 8070 | (idlwave-determine-class |
15e42531 CD |
8071 | (cons this-word (cdr (nth 3 where))) |
8072 | 'pro))) | |
4b1aaa8b | 8073 | ((and (eq cw 'function) |
15e42531 CD |
8074 | (not (equal this-word "")) |
8075 | (or (eq next-char ?\() ; exclude arrays, vars. | |
8076 | (looking-at "[a-zA-Z0-9_]*[ \t]*("))) | |
4b1aaa8b | 8077 | (setq this-word (idlwave-sintern-routine-or-method |
15e42531 CD |
8078 | this-word (nth 2 (nth 3 where)))) |
8079 | (list this-word 'fun | |
8080 | (idlwave-determine-class | |
8081 | (cons this-word (cdr (nth 3 where))) | |
8082 | 'fun))) | |
8083 | ((and (memq cw '(function-keyword procedure-keyword)) | |
8084 | (not (equal this-word "")) | |
8085 | (eq next-char ?\()) ; A function! | |
8086 | (setq this-word (idlwave-sintern-routine this-word)) | |
8087 | (list this-word 'fun nil)) | |
8088 | (func | |
8089 | (list func 'fun (idlwave-determine-class (nth 1 where) 'fun))) | |
8090 | (pro | |
8091 | (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro))) | |
8092 | (t nil))))) | |
f32b3b91 | 8093 | |
05a1abfc | 8094 | (defun idlwave-what-module-find-class () |
5a0c3f56 | 8095 | "Call `idlwave-what-module' and find the inherited class if necessary." |
05a1abfc | 8096 | (let* ((module (idlwave-what-module)) |
8d222148 | 8097 | (class (nth 2 module))) |
05a1abfc CD |
8098 | (if (and (= (length module) 3) |
8099 | (stringp class)) | |
8100 | (list (car module) | |
8101 | (nth 1 module) | |
8102 | (apply 'idlwave-find-inherited-class module)) | |
8103 | module))) | |
8104 | ||
8105 | (defun idlwave-find-inherited-class (name type class) | |
8106 | "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS." | |
8107 | (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))) | |
8108 | (if entry | |
8109 | (nth 2 entry) | |
8110 | class))) | |
8111 | ||
8112 | (defun idlwave-fix-module-if-obj_new (module) | |
4b1aaa8b | 8113 | "Check if MODULE points to obj_new. |
52a244eb S |
8114 | If yes, and if the cursor is in the keyword region, change to the |
8115 | appropriate Init method." | |
05a1abfc CD |
8116 | (let* ((name (car module)) |
8117 | (pos (point)) | |
8118 | (case-fold-search t) | |
8119 | string) | |
8120 | (if (and (stringp name) | |
8121 | (equal (downcase name) "obj_new") | |
8122 | (save-excursion | |
8123 | (idlwave-beginning-of-statement) | |
8124 | (setq string (buffer-substring (point) pos)) | |
8125 | (string-match "obj_new([^'\"]*['\"]\\([a-zA-Z0-9_]+\\)" | |
8126 | string))) | |
8127 | (let ((name "Init") | |
8128 | (class (match-string 1 string))) | |
8129 | (setq module (list (idlwave-sintern-method "Init") | |
8130 | 'fun | |
8131 | (idlwave-sintern-class class))))) | |
8132 | module)) | |
8133 | ||
4b1aaa8b | 8134 | (defun idlwave-fix-keywords (name type class keywords |
3938cb82 | 8135 | &optional super-classes system) |
52a244eb S |
8136 | "Update a list of keywords. |
8137 | Translate OBJ_NEW, adding all super-class keywords, or all keywords | |
5a0c3f56 | 8138 | from all classes if CLASS equals t. If SYSTEM is non-nil, don't |
3938cb82 | 8139 | demand _EXTRA in the keyword list." |
5e72c6b2 | 8140 | (let ((case-fold-search t)) |
f32b3b91 CD |
8141 | |
8142 | ;; If this is the OBJ_NEW function, try to figure out the class and use | |
8143 | ;; the keywords from the corresponding INIT method. | |
5e72c6b2 | 8144 | (if (and (equal (upcase name) "OBJ_NEW") |
175069ef | 8145 | (derived-mode-p 'idlwave-mode 'idlwave-shell-mode)) |
f32b3b91 CD |
8146 | (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point))) |
8147 | (string (buffer-substring bos (point))) | |
8148 | (case-fold-search t) | |
8149 | class) | |
8150 | (and (string-match "obj_new([^'\"]*['\"]\\([a-zA-Z0-9_]+\\)" | |
8151 | string) | |
8152 | (setq class (idlwave-sintern-class (match-string 1 string))) | |
15e42531 | 8153 | (setq idlwave-current-obj_new-class class) |
4b1aaa8b PE |
8154 | (setq keywords |
8155 | (append keywords | |
52a244eb S |
8156 | (idlwave-entry-keywords |
8157 | (idlwave-rinfo-assq | |
8158 | (idlwave-sintern-method "INIT") | |
8159 | 'fun | |
8160 | class | |
8161 | (idlwave-routines)) 'do-link)))))) | |
4b1aaa8b | 8162 | |
f32b3b91 CD |
8163 | ;; If the class is `t', combine all keywords of all methods NAME |
8164 | (when (eq class t) | |
52a244eb S |
8165 | (mapc (lambda (entry) |
8166 | (and | |
8167 | (nth 2 entry) ; non-nil class | |
8168 | (eq (nth 1 entry) type) ; correct type | |
4b1aaa8b PE |
8169 | (setq keywords |
8170 | (append keywords | |
52a244eb S |
8171 | (idlwave-entry-keywords entry 'do-link))))) |
8172 | (idlwave-all-assq name (idlwave-routines))) | |
5e72c6b2 | 8173 | (setq keywords (idlwave-uniquify keywords))) |
4b1aaa8b | 8174 | |
5e72c6b2 | 8175 | ;; If we have inheritance, add all keywords from superclasses, if |
52a244eb | 8176 | ;; the user indicated that method in `idlwave-keyword-class-inheritance' |
4b1aaa8b | 8177 | (when (and |
52a244eb | 8178 | super-classes |
5e72c6b2 S |
8179 | idlwave-keyword-class-inheritance |
8180 | (stringp class) | |
4b1aaa8b | 8181 | (or |
3938cb82 S |
8182 | system |
8183 | (assq (idlwave-sintern-keyword "_extra") keywords) | |
8184 | (assq (idlwave-sintern-keyword "_ref_extra") keywords)) | |
5e72c6b2 S |
8185 | ;; Check if one of the keyword-class regexps matches the name |
8186 | (let ((regexps idlwave-keyword-class-inheritance) re) | |
8187 | (catch 'exit | |
8188 | (while (setq re (pop regexps)) | |
8189 | (if (string-match re name) (throw 'exit t)))))) | |
52a244eb S |
8190 | |
8191 | (loop for entry in (idlwave-routines) do | |
8192 | (and (nth 2 entry) ; non-nil class | |
8193 | (memq (nth 2 entry) super-classes) ; an inherited class | |
8194 | (eq (nth 1 entry) type) ; correct type | |
8195 | (eq (car entry) name) ; correct name | |
8ffcfb27 GM |
8196 | (mapc (lambda (k) (add-to-list 'keywords k)) |
8197 | (idlwave-entry-keywords entry 'do-link)))) | |
f32b3b91 | 8198 | (setq keywords (idlwave-uniquify keywords))) |
4b1aaa8b | 8199 | |
f32b3b91 CD |
8200 | ;; Return the final list |
8201 | keywords)) | |
8202 | ||
15e42531 | 8203 | (defun idlwave-expand-keyword (keyword module) |
2e8b9c7d | 8204 | "Expand KEYWORD to one of the valid keyword parameters of MODULE. |
15e42531 CD |
8205 | KEYWORD may be an exact match or an abbreviation of a keyword. |
8206 | If the match is exact, KEYWORD itself is returned, even if there may be other | |
8207 | keywords of which KEYWORD is an abbreviation. This is necessary because some | |
8208 | system routines have keywords which are prefixes of other keywords. | |
8209 | If KEYWORD is an abbreviation of several keywords, a list of all possible | |
8210 | completions is returned. | |
8211 | If the abbreviation was unique, the correct keyword is returned. | |
8212 | If it cannot be a keyword, the function return nil. | |
8213 | If we do not know about MODULE, just return KEYWORD literally." | |
8214 | (let* ((name (car module)) | |
8215 | (type (nth 1 module)) | |
8216 | (class (nth 2 module)) | |
8217 | (kwd (idlwave-sintern-keyword keyword)) | |
8218 | (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))) | |
52a244eb | 8219 | (kwd-alist (idlwave-entry-keywords entry)) |
15e42531 CD |
8220 | (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist) |
8221 | (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist))) | |
8222 | (completion-ignore-case t) | |
8223 | candidates) | |
4b1aaa8b | 8224 | (cond ((assq kwd kwd-alist) |
15e42531 CD |
8225 | kwd) |
8226 | ((setq candidates (all-completions kwd kwd-alist)) | |
8227 | (if (= (length candidates) 1) | |
8228 | (car candidates) | |
8229 | candidates)) | |
8230 | ((and entry extra) | |
4b1aaa8b | 8231 | ;; Inheritance may cause this keyword to be correct |
15e42531 CD |
8232 | keyword) |
8233 | (entry | |
8234 | ;; We do know the function, which does not have the keyword. | |
8235 | nil) | |
8236 | (t | |
8237 | ;; We do not know the function, so this just might be a correct | |
8238 | ;; keyword - return it as it is. | |
8239 | keyword)))) | |
8240 | ||
b016851c SM |
8241 | (defvar idlwave-rinfo-mouse-map |
8242 | (let ((map (make-sparse-keymap))) | |
8243 | (define-key map | |
8244 | (if (featurep 'xemacs) [button2] [mouse-2]) | |
8245 | 'idlwave-mouse-active-rinfo) | |
8246 | (define-key map | |
8247 | (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)]) | |
8248 | 'idlwave-mouse-active-rinfo-shift) | |
8249 | (define-key map | |
8250 | (if (featurep 'xemacs) [button3] [mouse-3]) | |
8251 | 'idlwave-mouse-active-rinfo-right) | |
8252 | (define-key map " " 'idlwave-active-rinfo-space) | |
8253 | (define-key map "q" 'idlwave-quit-help) | |
8254 | map)) | |
8255 | ||
8256 | (defvar idlwave-rinfo-map | |
8257 | (let ((map (make-sparse-keymap))) | |
8258 | (define-key map "q" 'idlwave-quit-help) | |
8259 | map)) | |
8260 | ||
15e42531 CD |
8261 | (defvar idlwave-popup-source nil) |
8262 | (defvar idlwave-rinfo-marker (make-marker)) | |
8263 | ||
8264 | (defun idlwave-quit-help () | |
8265 | (interactive) | |
8266 | (let ((ri-window (get-buffer-window "*Help*")) | |
8267 | (olh-window (get-buffer-window "*IDLWAVE Help*"))) | |
8268 | (when (and olh-window | |
8269 | (fboundp 'idlwave-help-quit)) | |
8270 | (select-window olh-window) | |
8271 | (idlwave-help-quit)) | |
8272 | (when (window-live-p ri-window) | |
8273 | (delete-window ri-window)))) | |
f32b3b91 | 8274 | |
05a1abfc CD |
8275 | (defun idlwave-display-calling-sequence (name type class |
8276 | &optional initial-class) | |
f32b3b91 | 8277 | ;; Display the calling sequence of module NAME, type TYPE in class CLASS. |
05a1abfc CD |
8278 | (let* ((initial-class (or initial-class class)) |
8279 | (entry (or (idlwave-best-rinfo-assq name type class | |
15e42531 | 8280 | (idlwave-routines)) |
4b1aaa8b | 8281 | (idlwave-rinfo-assq name type class |
15e42531 | 8282 | idlwave-unresolved-routines))) |
f32b3b91 CD |
8283 | (name (or (car entry) name)) |
8284 | (class (or (nth 2 entry) class)) | |
05a1abfc | 8285 | (superclasses (idlwave-all-class-inherits initial-class)) |
15e42531 CD |
8286 | (twins (idlwave-routine-twins entry)) |
8287 | (dtwins (idlwave-study-twins twins)) | |
8288 | (all dtwins) | |
52a244eb | 8289 | (system (eq (car (nth 3 entry)) 'system)) |
f32b3b91 | 8290 | (calling-seq (nth 4 entry)) |
52a244eb S |
8291 | (keywords (idlwave-entry-keywords entry 'do-link)) |
8292 | (html-file (car (nth 5 entry))) | |
15e42531 | 8293 | (help-echo-kwd |
52a244eb | 8294 | "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ") |
15e42531 | 8295 | (help-echo-use |
52a244eb | 8296 | "Button2/3: Online Help") |
15e42531 | 8297 | (help-echo-src |
52a244eb | 8298 | "Button2: Jump to source and back | Button3: Source in Help window.") |
05a1abfc CD |
8299 | (help-echo-class |
8300 | "Button2: Display info about same method in superclass") | |
f32b3b91 | 8301 | (col 0) |
52a244eb | 8302 | (data (list name type class (current-buffer) nil initial-class)) |
f32b3b91 | 8303 | (km-prop (if (featurep 'xemacs) 'keymap 'local-map)) |
f66f03de | 8304 | (face 'idlwave-help-link) |
15e42531 | 8305 | beg props win cnt total) |
4b1aaa8b | 8306 | ;; Fix keywords, but don't add chained super-classes, since these |
52a244eb | 8307 | ;; are shown separately for that super-class |
f32b3b91 CD |
8308 | (setq keywords (idlwave-fix-keywords name type class keywords)) |
8309 | (cond | |
8310 | ((null entry) | |
05a1abfc CD |
8311 | (error "No %s %s known %s" type name |
8312 | (if initial-class (concat "in class " initial-class) ""))) | |
f32b3b91 | 8313 | ((or (null name) (equal name "")) |
e8af40ee | 8314 | (error "No function or procedure call at point")) |
f32b3b91 | 8315 | ((null calling-seq) |
52a244eb | 8316 | (error "Calling sequence of %s %s not available" type name)) |
f32b3b91 | 8317 | (t |
9a529312 SM |
8318 | (move-marker idlwave-rinfo-marker (point)) |
8319 | (with-current-buffer (get-buffer-create "*Help*") | |
15e42531 | 8320 | (use-local-map idlwave-rinfo-map) |
f32b3b91 CD |
8321 | (setq buffer-read-only nil) |
8322 | (erase-buffer) | |
8323 | (set (make-local-variable 'idlwave-popup-source) nil) | |
15e42531 CD |
8324 | (set (make-local-variable 'idlwave-current-obj_new-class) |
8325 | idlwave-current-obj_new-class) | |
05a1abfc CD |
8326 | (when superclasses |
8327 | (setq props (list 'mouse-face 'highlight | |
8328 | km-prop idlwave-rinfo-mouse-map | |
8329 | 'help-echo help-echo-class | |
8330 | 'data (cons 'class data))) | |
8331 | (let ((classes (cons initial-class superclasses)) c) | |
8332 | (insert "Classes: ") | |
8333 | (while (setq c (pop classes)) | |
8334 | (insert " ") | |
8335 | (setq beg (point)) | |
8336 | (insert c) | |
8337 | (if (equal (downcase c) (downcase class)) | |
8338 | (add-text-properties beg (point) (list 'face 'bold)) | |
52a244eb | 8339 | ;; If Method exists in a different class link it |
05a1abfc CD |
8340 | (if (idlwave-rinfo-assq name type c (idlwave-routines)) |
8341 | (add-text-properties beg (point) props)))) | |
8342 | (insert "\n"))) | |
52a244eb S |
8343 | (setq props (list 'mouse-face 'highlight |
8344 | km-prop idlwave-rinfo-mouse-map | |
8345 | 'help-echo help-echo-use | |
8346 | 'data (cons 'usage data))) | |
4b1aaa8b | 8347 | (if html-file (setq props (append (list 'face face 'link html-file) |
52a244eb | 8348 | props))) |
f32b3b91 CD |
8349 | (insert "Usage: ") |
8350 | (setq beg (point)) | |
8351 | (insert (if class | |
52a244eb S |
8352 | (format calling-seq class name class name class name) |
8353 | (format calling-seq name name name name)) | |
f32b3b91 CD |
8354 | "\n") |
8355 | (add-text-properties beg (point) props) | |
4b1aaa8b | 8356 | |
f32b3b91 CD |
8357 | (insert "Keywords:") |
8358 | (if (null keywords) | |
8359 | (insert " No keywords accepted.") | |
8360 | (setq col 9) | |
8ffcfb27 | 8361 | (mapc |
f32b3b91 | 8362 | (lambda (x) |
4b1aaa8b | 8363 | (if (>= (+ col 1 (length (car x))) |
f32b3b91 CD |
8364 | (window-width)) |
8365 | (progn | |
8366 | (insert "\n ") | |
8367 | (setq col 9))) | |
8368 | (insert " ") | |
8369 | (setq beg (point) | |
52a244eb | 8370 | ;; Relevant keywords already have link property attached |
f32b3b91 | 8371 | props (list 'mouse-face 'highlight |
15e42531 | 8372 | km-prop idlwave-rinfo-mouse-map |
f32b3b91 | 8373 | 'data (cons 'keyword data) |
15e42531 | 8374 | 'help-echo help-echo-kwd |
f32b3b91 | 8375 | 'keyword (car x))) |
52a244eb | 8376 | (if system (setq props (append (list 'face face) props))) |
f32b3b91 CD |
8377 | (insert (car x)) |
8378 | (add-text-properties beg (point) props) | |
8379 | (setq col (+ col 1 (length (car x))))) | |
8380 | keywords)) | |
4b1aaa8b | 8381 | |
15e42531 | 8382 | (setq cnt 1 total (length all)) |
52a244eb | 8383 | ;; Here entry is (key file (list of type-conses)) |
15e42531 CD |
8384 | (while (setq entry (pop all)) |
8385 | (setq props (list 'mouse-face 'highlight | |
8386 | km-prop idlwave-rinfo-mouse-map | |
8387 | 'help-echo help-echo-src | |
52a244eb S |
8388 | 'source (list (car (car (nth 2 entry))) ;type |
8389 | (nth 1 entry) | |
8390 | nil | |
8391 | (cdr (car (nth 2 entry)))) | |
15e42531 CD |
8392 | 'data (cons 'source data))) |
8393 | (idlwave-insert-source-location | |
4b1aaa8b | 8394 | (format "\n%-8s %s" |
15e42531 CD |
8395 | (if (equal cnt 1) |
8396 | (if (> total 1) "Sources:" "Source:") | |
8397 | "") | |
8398 | (if (> total 1) "- " "")) | |
8399 | entry props) | |
8400 | (incf cnt) | |
8401 | (when (and all (> cnt idlwave-rinfo-max-source-lines)) | |
8402 | ;; No more source lines, please | |
4b1aaa8b | 8403 | (insert (format |
15e42531 CD |
8404 | "\n Source information truncated to %d entries." |
8405 | idlwave-rinfo-max-source-lines)) | |
8406 | (setq all nil))) | |
10c8e594 | 8407 | (goto-char (point-min)) |
f32b3b91 CD |
8408 | (setq buffer-read-only t)) |
8409 | (display-buffer "*Help*") | |
8410 | (if (and (setq win (get-buffer-window "*Help*")) | |
8411 | idlwave-resize-routine-help-window) | |
8412 | (progn | |
8413 | (let ((ww (selected-window))) | |
8414 | (unwind-protect | |
8415 | (progn | |
8416 | (select-window win) | |
4b1aaa8b | 8417 | (enlarge-window (- (/ (frame-height) 2) |
f32b3b91 CD |
8418 | (window-height))) |
8419 | (shrink-window-if-larger-than-buffer)) | |
8420 | (select-window ww))))))))) | |
8421 | ||
15e42531 CD |
8422 | (defun idlwave-insert-source-location (prefix entry &optional file-props) |
8423 | "Insert a source location into the routine info buffer. | |
5a0c3f56 JB |
8424 | Start line with PREFIX. If a file name is inserted, add FILE-PROPS |
8425 | to it." | |
15e42531 CD |
8426 | (let* ((key (car entry)) |
8427 | (file (nth 1 entry)) | |
8428 | (types (nth 2 entry)) | |
52a244eb S |
8429 | (shell-flag (assq 'compiled types)) |
8430 | (buffer-flag (assq 'buffer types)) | |
8431 | (user-flag (assq 'user types)) | |
8432 | (lib-flag (assq 'lib types)) | |
8433 | (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types)) | |
8434 | (and user-flag (idlwave-count-memq 'user types)) | |
8435 | (and lib-flag (idlwave-count-memq 'lib types)) | |
15e42531 CD |
8436 | 1)) |
8437 | (doflags t) | |
8438 | beg special) | |
8439 | ||
8440 | (insert prefix) | |
8441 | ||
8442 | (cond | |
8443 | ((eq key 'system) | |
8444 | (setq doflags nil) | |
52a244eb S |
8445 | (insert "System ")) |
8446 | ||
15e42531 CD |
8447 | ((eq key 'builtin) |
8448 | (setq doflags nil) | |
52a244eb S |
8449 | (insert "Builtin ")) |
8450 | ||
15e42531 | 8451 | ((and (not file) shell-flag) |
52a244eb S |
8452 | (insert "Unresolved")) |
8453 | ||
4b1aaa8b | 8454 | ((null file) |
52a244eb | 8455 | (insert "ERROR")) |
4b1aaa8b | 8456 | |
15e42531 CD |
8457 | ((idlwave-syslib-p file) |
8458 | (if (string-match "obsolete" (file-name-directory file)) | |
52a244eb S |
8459 | (insert "Obsolete ") |
8460 | (insert "SystemLib "))) | |
8461 | ||
8462 | ;; New special syntax: taken directly from routine-info for | |
8463 | ;; library catalog routines | |
8464 | ((setq special (or (cdr lib-flag) (cdr user-flag))) | |
8465 | (insert (format "%-10s" special))) | |
8466 | ||
8467 | ;; Old special syntax: a matching regexp | |
8468 | ((setq special (idlwave-special-lib-test file)) | |
8469 | (insert (format "%-10s" special))) | |
4b1aaa8b | 8470 | |
52a244eb | 8471 | ;; Catch-all with file |
15e42531 | 8472 | ((idlwave-lib-p file) (insert "Library ")) |
52a244eb S |
8473 | |
8474 | ;; Sanity catch all | |
15e42531 CD |
8475 | (t (insert "Other "))) |
8476 | ||
8477 | (when doflags | |
8478 | (insert (concat | |
8479 | " [" | |
52a244eb S |
8480 | (if lib-flag "L" "-") |
8481 | (if user-flag "C" "-") | |
15e42531 CD |
8482 | (if shell-flag "S" "-") |
8483 | (if buffer-flag "B" "-") | |
8484 | "] "))) | |
4b1aaa8b | 8485 | (when (> ndupl 1) |
15e42531 CD |
8486 | (setq beg (point)) |
8487 | (insert (format "(%dx) " ndupl)) | |
8488 | (add-text-properties beg (point) (list 'face 'bold))) | |
8489 | (when (and file (not (equal file ""))) | |
8490 | (setq beg (point)) | |
8491 | (insert (apply 'abbreviate-file-name | |
8492 | (if (featurep 'xemacs) (list file t) (list file)))) | |
8493 | (if file-props | |
8494 | (add-text-properties beg (point) file-props))))) | |
8495 | ||
8496 | (defun idlwave-special-lib-test (file) | |
8497 | "Check the path of FILE against the regexps which define special libs. | |
8498 | Return the name of the special lib if there is a match." | |
8499 | (let ((alist idlwave-special-lib-alist) | |
8500 | entry rtn) | |
8501 | (cond | |
8502 | ((stringp file) | |
8503 | (while (setq entry (pop alist)) | |
8504 | (if (string-match (car entry) file) | |
8505 | (setq rtn (cdr entry) | |
8506 | alist nil))) | |
8507 | rtn) | |
8508 | (t nil)))) | |
4b1aaa8b | 8509 | |
f32b3b91 CD |
8510 | (defun idlwave-mouse-active-rinfo-right (ev) |
8511 | (interactive "e") | |
8512 | (idlwave-mouse-active-rinfo ev 'right)) | |
8513 | ||
15e42531 | 8514 | (defun idlwave-mouse-active-rinfo-shift (ev) |
f32b3b91 | 8515 | (interactive "e") |
15e42531 CD |
8516 | (idlwave-mouse-active-rinfo ev nil 'shift)) |
8517 | ||
8518 | (defun idlwave-active-rinfo-space () | |
8519 | (interactive) | |
8520 | (idlwave-mouse-active-rinfo nil 'right)) | |
8521 | ||
8522 | (defun idlwave-mouse-active-rinfo (ev &optional right shift) | |
5a0c3f56 | 8523 | "Do the mouse actions in the routine info buffer. |
15e42531 CD |
8524 | Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT |
8525 | was pressed." | |
8526 | (interactive "e") | |
8527 | (if ev (mouse-set-point ev)) | |
4b1aaa8b | 8528 | (let (data id name type class buf bufwin source link keyword |
3938cb82 | 8529 | word initial-class) |
f32b3b91 | 8530 | (setq data (get-text-property (point) 'data) |
15e42531 | 8531 | source (get-text-property (point) 'source) |
f32b3b91 | 8532 | keyword (get-text-property (point) 'keyword) |
52a244eb | 8533 | link (get-text-property (point) 'link) |
f32b3b91 | 8534 | id (car data) |
15e42531 | 8535 | name (nth 1 data) type (nth 2 data) class (nth 3 data) |
f32b3b91 | 8536 | buf (nth 4 data) |
05a1abfc CD |
8537 | initial-class (nth 6 data) |
8538 | word (idlwave-this-word) | |
f32b3b91 | 8539 | bufwin (get-buffer-window buf t)) |
52a244eb S |
8540 | |
8541 | (cond ((eq id 'class) ; Switch class being displayed | |
05a1abfc | 8542 | (if (window-live-p bufwin) (select-window bufwin)) |
4b1aaa8b | 8543 | (idlwave-display-calling-sequence |
05a1abfc | 8544 | (idlwave-sintern-method name) |
4b1aaa8b | 8545 | type (idlwave-sintern-class word) |
05a1abfc | 8546 | initial-class)) |
52a244eb S |
8547 | ((eq id 'usage) ; Online help on this routine |
8548 | (idlwave-online-help link name type class)) | |
8549 | ((eq id 'source) ; Source in help or buffer | |
8550 | (if right ; In help | |
15e42531 CD |
8551 | (let ((idlwave-extra-help-function 'idlwave-help-with-source) |
8552 | (idlwave-help-source-try-header nil) | |
52a244eb | 8553 | ;; Fake idlwave-routines so help will find the right entry |
15e42531 | 8554 | (idlwave-routines |
52a244eb | 8555 | (list (list name type class source "")))) |
15e42531 | 8556 | (idlwave-help-get-special-help name type class nil)) |
52a244eb | 8557 | ;; Otherwise just pop to the source |
f32b3b91 CD |
8558 | (setq idlwave-popup-source (not idlwave-popup-source)) |
8559 | (if idlwave-popup-source | |
8560 | (condition-case err | |
15e42531 | 8561 | (idlwave-do-find-module name type class source) |
f32b3b91 CD |
8562 | (error |
8563 | (setq idlwave-popup-source nil) | |
8564 | (if (window-live-p bufwin) (select-window bufwin)) | |
8565 | (error (nth 1 err)))) | |
8566 | (if bufwin | |
8567 | (select-window bufwin) | |
15e42531 CD |
8568 | (pop-to-buffer buf)) |
8569 | (goto-char (marker-position idlwave-rinfo-marker))))) | |
f32b3b91 CD |
8570 | ((eq id 'keyword) |
8571 | (if right | |
52a244eb | 8572 | (idlwave-online-help link name type class keyword) |
15e42531 CD |
8573 | (idlwave-rinfo-insert-keyword keyword buf shift)))))) |
8574 | ||
8575 | (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift) | |
8576 | "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window." | |
8577 | (let ((bwin (get-buffer-window buffer))) | |
8578 | (if idlwave-complete-empty-string-as-lower-case | |
8579 | (setq keyword (downcase keyword))) | |
8580 | (if bwin | |
8581 | (select-window bwin) | |
8582 | (pop-to-buffer buffer) | |
8583 | (setq bwin (get-buffer-window buffer))) | |
8584 | (if (eq (preceding-char) ?/) | |
8585 | (insert keyword) | |
4b1aaa8b | 8586 | (unless (save-excursion |
15e42531 | 8587 | (re-search-backward |
4b1aaa8b | 8588 | "[(,][ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\)?[ \t]*\\=" |
15e42531 CD |
8589 | (min (- (point) 100) (point-min)) t)) |
8590 | (insert ", ")) | |
8591 | (if shift (insert "/")) | |
8592 | (insert keyword) | |
8593 | (if (and (not shift) | |
8594 | idlwave-keyword-completion-adds-equal) | |
8595 | (insert "="))))) | |
8596 | ||
8597 | (defun idlwave-list-buffer-load-path-shadows (&optional arg) | |
8598 | "List the load path shadows of all routines defined in current buffer." | |
8599 | (interactive "P") | |
8600 | (idlwave-routines) | |
175069ef | 8601 | (if (derived-mode-p 'idlwave-mode) |
15e42531 CD |
8602 | (idlwave-list-load-path-shadows |
8603 | nil (idlwave-update-current-buffer-info 'save-buffer) | |
8604 | "in current buffer") | |
8605 | (error "Current buffer is not in idlwave-mode"))) | |
8606 | ||
8607 | (defun idlwave-list-shell-load-path-shadows (&optional arg) | |
8608 | "List the load path shadows of all routines compiled under the shell. | |
8609 | This is very useful for checking an IDL application. Just compile the | |
8610 | application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced | |
8611 | routines and update IDLWAVE internal info. Then check for shadowing | |
8612 | with this command." | |
8613 | (interactive "P") | |
8614 | (cond | |
8615 | ((or (not (fboundp 'idlwave-shell-is-running)) | |
8616 | (not (idlwave-shell-is-running))) | |
8617 | (error "Shell is not running")) | |
8618 | ((null idlwave-compiled-routines) | |
e8af40ee | 8619 | (error "No compiled routines. Maybe you need to update with `C-c C-i'")) |
15e42531 CD |
8620 | (t |
8621 | (idlwave-list-load-path-shadows nil idlwave-compiled-routines | |
8622 | "in the shell")))) | |
8623 | ||
8624 | (defun idlwave-list-all-load-path-shadows (&optional arg) | |
8625 | "List the load path shadows of all routines known to IDLWAVE." | |
8626 | (interactive "P") | |
8627 | (idlwave-list-load-path-shadows nil nil "globally")) | |
8628 | ||
8d222148 SM |
8629 | (defvar idlwave-sort-prefer-buffer-info t |
8630 | "Internal variable used to influence `idlwave-routine-twin-compare'.") | |
8631 | ||
15e42531 CD |
8632 | (defun idlwave-list-load-path-shadows (arg &optional special-routines loc) |
8633 | "List the routines which are defined multiple times. | |
8634 | Search the information IDLWAVE has about IDL routines for multiple | |
8635 | definitions. | |
8636 | When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines. | |
8637 | ||
8638 | When IDL hits a routine call which is not defined, it will search on | |
5a0c3f56 JB |
8639 | the load path in order to find a definition. The output of this command |
8640 | can be used to detect possible name clashes during this process." | |
15e42531 | 8641 | (idlwave-routines) ; Make sure everything is loaded. |
52a244eb | 8642 | (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines) |
4b1aaa8b | 8643 | (or (y-or-n-p |
52a244eb | 8644 | "You don't have any user or library catalogs. Continue anyway? ") |
15e42531 CD |
8645 | (error "Abort"))) |
8646 | (let* ((routines (append idlwave-system-routines | |
8647 | idlwave-compiled-routines | |
52a244eb S |
8648 | idlwave-library-catalog-routines |
8649 | idlwave-user-catalog-routines | |
15e42531 CD |
8650 | idlwave-buffer-routines |
8651 | nil)) | |
8652 | (km-prop (if (featurep 'xemacs) 'keymap 'local-map)) | |
8653 | (keymap (make-sparse-keymap)) | |
8654 | (props (list 'mouse-face 'highlight | |
8655 | km-prop keymap | |
4b1aaa8b | 8656 | 'help-echo "Mouse2: Find source")) |
15e42531 | 8657 | (nroutines (length (or special-routines routines))) |
f66f03de | 8658 | (step (/ nroutines 100)) |
15e42531 | 8659 | (n 0) |
15e42531 CD |
8660 | (cnt 0) |
8661 | (idlwave-sort-prefer-buffer-info nil) | |
8662 | routine twins dtwins twin done props1 lroutines) | |
8663 | ||
8664 | (if special-routines | |
8665 | ;; Just looking for shadows of a few special routines | |
8666 | (setq lroutines routines | |
8667 | routines special-routines)) | |
8668 | ||
8669 | (message "Sorting routines...") | |
8670 | (setq routines (sort routines | |
8671 | (lambda (a b) | |
8672 | (string< (downcase (idlwave-make-full-name | |
8673 | (nth 2 a) (car a))) | |
8674 | (downcase (idlwave-make-full-name | |
8675 | (nth 2 b) (car b))))))) | |
8676 | (message "Sorting routines...done") | |
8677 | ||
8678 | (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)]) | |
4b1aaa8b | 8679 | (lambda (ev) |
15e42531 CD |
8680 | (interactive "e") |
8681 | (mouse-set-point ev) | |
8682 | (apply 'idlwave-do-find-module | |
8683 | (get-text-property (point) 'find-args)))) | |
8684 | (define-key keymap [(return)] | |
4b1aaa8b | 8685 | (lambda () |
15e42531 CD |
8686 | (interactive) |
8687 | (apply 'idlwave-do-find-module | |
8688 | (get-text-property (point) 'find-args)))) | |
8689 | (message "Compiling list...( 0%%)") | |
9a529312 | 8690 | (with-current-buffer (get-buffer-create "*Shadows*") |
15e42531 CD |
8691 | (setq buffer-read-only nil) |
8692 | (erase-buffer) | |
8693 | (while (setq routine (pop routines)) | |
f66f03de S |
8694 | (if (= (mod (setq n (1+ n)) step) 0) |
8695 | (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines))) | |
8696 | ||
15e42531 CD |
8697 | ;; Get a list of all twins |
8698 | (setq twins (idlwave-routine-twins routine (or lroutines routines))) | |
8699 | (if (memq routine done) | |
8700 | (setq dtwins nil) | |
8701 | (setq dtwins (idlwave-study-twins twins))) | |
5e72c6b2 | 8702 | ;; Mark all twins as dealt with |
15e42531 CD |
8703 | (setq done (append twins done)) |
8704 | (when (or (> (length dtwins) 1) | |
52a244eb S |
8705 | (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1) |
8706 | (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1) | |
8707 | (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1)) | |
15e42531 CD |
8708 | (incf cnt) |
8709 | (insert (format "\n%s%s" | |
4b1aaa8b | 8710 | (idlwave-make-full-name (nth 2 routine) |
52a244eb | 8711 | (car routine)) |
15e42531 CD |
8712 | (if (eq (nth 1 routine) 'fun) "()" ""))) |
8713 | (while (setq twin (pop dtwins)) | |
8714 | (setq props1 (append (list 'find-args | |
4b1aaa8b PE |
8715 | (list (nth 0 routine) |
8716 | (nth 1 routine) | |
52a244eb | 8717 | (nth 2 routine))) |
15e42531 CD |
8718 | props)) |
8719 | (idlwave-insert-source-location "\n - " twin props1)))) | |
8720 | (goto-char (point-min)) | |
8721 | (setq buffer-read-only t)) | |
8722 | (setq loc (or loc "")) | |
8723 | (if (> cnt 0) | |
8724 | (progn | |
8725 | (display-buffer (get-buffer "*Shadows*")) | |
8726 | (message "%d case%s of shadowing found %s" | |
8727 | cnt (if (= cnt 1) "" "s") loc)) | |
8728 | (message "No shadowing conflicts found %s" loc)))) | |
8729 | ||
8730 | (defun idlwave-print-source (routine) | |
8731 | (let* ((source (nth 3 routine)) | |
8732 | (stype (car source)) | |
52a244eb S |
8733 | (sfile (idlwave-routine-source-file source))) |
8734 | (if (idlwave-syslib-p sfile) (setq stype 'syslib)) | |
15e42531 CD |
8735 | (if (and (eq stype 'compiled) |
8736 | (or (not (stringp sfile)) | |
8737 | (not (string-match "\\S-" sfile)))) | |
8738 | (setq stype 'unresolved)) | |
4b1aaa8b | 8739 | (princ (format " %-10s %s\n" |
15e42531 CD |
8740 | stype |
8741 | (if sfile sfile "No source code available"))))) | |
8742 | ||
8743 | (defun idlwave-routine-twins (entry &optional list) | |
8744 | "Return all twin entries of ENTRY in LIST. | |
8745 | LIST defaults to `idlwave-routines'. | |
8746 | Twin entries are those which have the same name, type, and class. | |
8747 | ENTRY will also be returned, as the first item of this list." | |
8748 | (let* ((name (car entry)) | |
8749 | (type (nth 1 entry)) | |
8750 | (class (nth 2 entry)) | |
8751 | (candidates (idlwave-all-assq name (or list (idlwave-routines)))) | |
8752 | twins candidate) | |
8753 | (while (setq candidate (pop candidates)) | |
8754 | (if (and (not (eq candidate entry)) | |
8755 | (eq type (nth 1 candidate)) | |
8756 | (eq class (nth 2 candidate))) | |
8757 | (push candidate twins))) | |
4b1aaa8b | 8758 | (if (setq candidate (idlwave-rinfo-assq name type class |
15e42531 CD |
8759 | idlwave-unresolved-routines)) |
8760 | (push candidate twins)) | |
8761 | (cons entry (nreverse twins)))) | |
8762 | ||
8763 | (defun idlwave-study-twins (entries) | |
4b1aaa8b | 8764 | "Return dangerous twins of first entry in ENTRIES. |
52a244eb S |
8765 | Dangerous twins are routines with same name, but in different files on |
8766 | the load path. If a file is in the system library and has an entry in | |
8767 | the `idlwave-system-routines' list, we omit the latter as | |
8768 | non-dangerous because many IDL routines are implemented as library | |
8769 | routines, and may have been scanned." | |
15e42531 | 8770 | (let* ((entry (car entries)) |
e7c4fb1e | 8771 | (idlwave-twin-name (car entry)) ; |
15e42531 | 8772 | (type (nth 1 entry)) ; Must be bound for |
e2a9c0bc | 8773 | (idlwave-twin-class (nth 2 entry)) ; idlwave-routine-twin-compare |
15e42531 | 8774 | (cnt 0) |
52a244eb | 8775 | source type type-cons file alist syslibp key) |
15e42531 CD |
8776 | (while (setq entry (pop entries)) |
8777 | (incf cnt) | |
8778 | (setq source (nth 3 entry) | |
8779 | type (car source) | |
52a244eb S |
8780 | type-cons (cons type (nth 3 source)) |
8781 | file (idlwave-routine-source-file source)) | |
8782 | ||
15e42531 CD |
8783 | ;; Make KEY to index entry properly |
8784 | (setq key (cond ((eq type 'system) type) | |
8785 | (file (file-truename file)) | |
8786 | (t 'unresolved))) | |
52a244eb S |
8787 | |
8788 | ;; Check for an entry in the system library | |
4b1aaa8b | 8789 | (if (and file |
15e42531 CD |
8790 | (not syslibp) |
8791 | (idlwave-syslib-p file)) | |
15e42531 | 8792 | (setq syslibp t)) |
4b1aaa8b | 8793 | |
52a244eb S |
8794 | ;; If there's more than one matching entry for the same file, just |
8795 | ;; append the type-cons to the type list. | |
15e42531 | 8796 | (if (setq entry (assoc key alist)) |
52a244eb S |
8797 | (push type-cons (nth 2 entry)) |
8798 | (push (list key file (list type-cons)) alist))) | |
4b1aaa8b | 8799 | |
15e42531 | 8800 | (setq alist (nreverse alist)) |
4b1aaa8b | 8801 | |
15e42531 | 8802 | (when syslibp |
52a244eb S |
8803 | ;; File is in system *library* - remove any 'system entry |
8804 | (setq alist (delq (assq 'system alist) alist))) | |
4b1aaa8b | 8805 | |
52a244eb S |
8806 | ;; If 'system remains and we've scanned the syslib, it's a builtin |
8807 | ;; (rather than a !DIR/lib/.pro file bundled as source). | |
15e42531 CD |
8808 | (when (and (idlwave-syslib-scanned-p) |
8809 | (setq entry (assoc 'system alist))) | |
8810 | (setcar entry 'builtin)) | |
8811 | (sort alist 'idlwave-routine-twin-compare))) | |
8812 | ||
8d222148 SM |
8813 | ;; FIXME: Dynamically scoped vars need to use the `idlwave-' prefix. |
8814 | ;; (defvar type) | |
15e42531 CD |
8815 | (defmacro idlwave-xor (a b) |
8816 | `(and (or ,a ,b) | |
8817 | (not (and ,a ,b)))) | |
8818 | ||
8819 | (defun idlwave-routine-entry-compare (a b) | |
5a0c3f56 JB |
8820 | "Compare two routine info entries for sorting. |
8821 | This is the general case. It first compares class, names, and type. | |
8822 | If it turns out that A and B are twins (same name, class, and type), | |
8823 | calls another routine which compares twins on the basis of their file | |
8824 | names and path locations." | |
15e42531 CD |
8825 | (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a))) |
8826 | (cond | |
8827 | ((not (equal (idlwave-downcase-safe class) | |
8828 | (idlwave-downcase-safe (nth 2 b)))) | |
8829 | ;; Class decides | |
8830 | (cond ((null (nth 2 b)) nil) | |
8831 | ((null class) t) | |
8832 | (t (string< (downcase class) (downcase (nth 2 b)))))) | |
8833 | ((not (equal (downcase name) (downcase (car b)))) | |
8834 | ;; Name decides | |
8835 | (string< (downcase name) (downcase (car b)))) | |
8836 | ((not (eq type (nth 1 b))) | |
8837 | ;; Type decides | |
8838 | (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0))) | |
4b1aaa8b | 8839 | (t |
15e42531 CD |
8840 | ;; A and B are twins - so the decision is more complicated. |
8841 | ;; Call twin-compare with the proper arguments. | |
8842 | (idlwave-routine-entry-compare-twins a b))))) | |
8843 | ||
8844 | (defun idlwave-routine-entry-compare-twins (a b) | |
5a0c3f56 JB |
8845 | "Compare two routine entries, under the assumption that they are twins. |
8846 | This basically calls `idlwave-routine-twin-compare' with the correct args." | |
e7c4fb1e | 8847 | (let* ((idlwave-twin-name (car a)) |
e2a9c0bc GM |
8848 | (type (nth 1 a)) |
8849 | (idlwave-twin-class (nth 2 a)) ; used in idlwave-routine-twin-compare | |
52a244eb S |
8850 | (asrc (nth 3 a)) |
8851 | (atype (car asrc)) | |
8852 | (bsrc (nth 3 b)) | |
8853 | (btype (car bsrc)) | |
8854 | (afile (idlwave-routine-source-file asrc)) | |
8855 | (bfile (idlwave-routine-source-file bsrc))) | |
15e42531 CD |
8856 | (idlwave-routine-twin-compare |
8857 | (if (stringp afile) | |
8858 | (list (file-truename afile) afile (list atype)) | |
8859 | (list atype afile (list atype))) | |
8860 | (if (stringp bfile) | |
8861 | (list (file-truename bfile) bfile (list btype)) | |
e2a9c0bc | 8862 | (list btype bfile (list btype)))))) |
15e42531 | 8863 | |
627e0a14 | 8864 | ;; Bound in idlwave-study-twins,idlwave-routine-entry-compare-twins. |
e2a9c0bc | 8865 | (defvar idlwave-twin-class) |
e7c4fb1e | 8866 | (defvar idlwave-twin-name) |
627e0a14 | 8867 | |
15e42531 CD |
8868 | (defun idlwave-routine-twin-compare (a b) |
8869 | "Compare two routine twin entries for sorting. | |
8870 | In here, A and B are not normal routine info entries, but special | |
8871 | lists (KEY FILENAME (TYPES...)). | |
e2a9c0bc | 8872 | This expects NAME TYPE IDLWAVE-TWIN-CLASS to be bound to the right values." |
15e42531 CD |
8873 | (let* (;; Dis-assemble entries |
8874 | (akey (car a)) (bkey (car b)) | |
8875 | (afile (nth 1 a)) (bfile (nth 1 b)) | |
8876 | (atypes (nth 2 a)) (btypes (nth 2 b)) | |
8877 | ;; System routines? | |
8878 | (asysp (memq akey '(builtin system))) | |
8879 | (bsysp (memq bkey '(builtin system))) | |
8880 | ;; Compiled routines? | |
8881 | (acompp (memq 'compiled atypes)) | |
8882 | (bcompp (memq 'compiled btypes)) | |
8883 | ;; Unresolved? | |
8884 | (aunresp (or (eq akey 'unresolved) | |
8885 | (and acompp (not afile)))) | |
8886 | (bunresp (or (eq bkey 'unresolved) | |
8887 | (and bcompp (not bfile)))) | |
8888 | ;; Buffer info available? | |
8889 | (abufp (memq 'buffer atypes)) | |
8890 | (bbufp (memq 'buffer btypes)) | |
8891 | ;; On search path? | |
8892 | (tpath-alist (idlwave-true-path-alist)) | |
52a244eb S |
8893 | (apathp (and (stringp akey) |
8894 | (assoc (file-name-directory akey) tpath-alist))) | |
4b1aaa8b | 8895 | (bpathp (and (stringp bkey) |
52a244eb | 8896 | (assoc (file-name-directory bkey) tpath-alist))) |
15e42531 CD |
8897 | ;; How early on search path? High number means early since we |
8898 | ;; measure the tail of the path list | |
8899 | (anpath (length (memq apathp tpath-alist))) | |
8900 | (bnpath (length (memq bpathp tpath-alist))) | |
8901 | ;; Look at file names | |
8902 | (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) "")) | |
8903 | (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) "")) | |
e2a9c0bc GM |
8904 | (fname-re (if idlwave-twin-class |
8905 | (format "\\`%s__\\(%s\\|define\\)\\.pro\\'" | |
8906 | (regexp-quote (downcase idlwave-twin-class)) | |
e7c4fb1e GM |
8907 | (regexp-quote (downcase idlwave-twin-name))) |
8908 | (format "\\`%s\\.pro" (regexp-quote (downcase idlwave-twin-name))))) | |
15e42531 CD |
8909 | ;; Is file name derived from the routine name? |
8910 | ;; Method file or class definition file? | |
8911 | (anamep (string-match fname-re aname)) | |
e2a9c0bc GM |
8912 | (adefp (and idlwave-twin-class anamep |
8913 | (string= "define" (match-string 1 aname)))) | |
15e42531 | 8914 | (bnamep (string-match fname-re bname)) |
e2a9c0bc GM |
8915 | (bdefp (and idlwave-twin-class bnamep |
8916 | (string= "define" (match-string 1 bname))))) | |
15e42531 CD |
8917 | |
8918 | ;; Now: follow JD's ideas about sorting. Looks really simple now, | |
8919 | ;; doesn't it? The difficult stuff is hidden above... | |
8920 | (cond | |
8921 | ((idlwave-xor asysp bsysp) asysp) ; System entries first | |
8922 | ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last | |
8923 | ((and idlwave-sort-prefer-buffer-info | |
8924 | (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers | |
8925 | ((idlwave-xor acompp bcompp) acompp) ; Compiled entries | |
8926 | ((idlwave-xor apathp bpathp) apathp) ; Library before non-library | |
8927 | ((idlwave-xor anamep bnamep) anamep) ; Correct file names first | |
e2a9c0bc | 8928 | ((and idlwave-twin-class anamep bnamep ; both file names match -> |
15e42531 CD |
8929 | (idlwave-xor adefp bdefp)) bdefp) ; __define after __method |
8930 | ((> anpath bnpath) t) ; Who is first on path? | |
8931 | (t nil)))) ; Default | |
8932 | ||
52a244eb | 8933 | (defun idlwave-routine-source-file (source) |
4b1aaa8b | 8934 | (if (nth 2 source) |
52a244eb S |
8935 | (expand-file-name (nth 1 source) (nth 2 source)) |
8936 | (nth 1 source))) | |
8937 | ||
15e42531 | 8938 | (defun idlwave-downcase-safe (string) |
dbdb7031 | 8939 | "Downcase if string, else return unchanged." |
15e42531 CD |
8940 | (if (stringp string) |
8941 | (downcase string) | |
8942 | string)) | |
8943 | ||
8944 | (defun idlwave-count-eq (elt list) | |
8945 | "How often is ELT in LIST?" | |
8946 | (length (delq nil (mapcar (lambda (x) (eq x elt)) list)))) | |
8947 | ||
52a244eb S |
8948 | (defun idlwave-count-memq (elt alist) |
8949 | "How often is ELT a key in ALIST?" | |
8950 | (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist)))) | |
8951 | ||
15e42531 | 8952 | (defun idlwave-syslib-p (file) |
52a244eb | 8953 | "Non-nil if FILE is in the system library." |
15e42531 CD |
8954 | (let* ((true-syslib (file-name-as-directory |
8955 | (file-truename | |
8956 | (expand-file-name "lib" (idlwave-sys-dir))))) | |
8957 | (true-file (file-truename file))) | |
8958 | (string-match (concat "^" (regexp-quote true-syslib)) true-file))) | |
8959 | ||
8960 | (defun idlwave-lib-p (file) | |
5a0c3f56 | 8961 | "Non-nil if FILE is in the library." |
15e42531 CD |
8962 | (let ((true-dir (file-name-directory (file-truename file)))) |
8963 | (assoc true-dir (idlwave-true-path-alist)))) | |
8964 | ||
52a244eb S |
8965 | (defun idlwave-path-alist-add-flag (list-entry flag) |
8966 | "Add a flag to the path list entry, if not set." | |
8967 | (let ((flags (cdr list-entry))) | |
8968 | (add-to-list 'flags flag) | |
8969 | (setcdr list-entry flags))) | |
8970 | ||
8971 | (defun idlwave-path-alist-remove-flag (list-entry flag) | |
8972 | "Remove a flag to the path list entry, if set." | |
8973 | (let ((flags (delq flag (cdr list-entry)))) | |
8974 | (setcdr list-entry flags))) | |
8975 | ||
15e42531 CD |
8976 | (defun idlwave-true-path-alist () |
8977 | "Return `idlwave-path-alist' alist with true-names. | |
52a244eb | 8978 | Info is cached, but relies on the functions setting `idlwave-path-alist' |
15e42531 CD |
8979 | to reset the variable `idlwave-true-path-alist' to nil." |
8980 | (or idlwave-true-path-alist | |
8981 | (setq idlwave-true-path-alist | |
8982 | (mapcar (lambda(x) (cons | |
8983 | (file-name-as-directory | |
8984 | (file-truename | |
8985 | (directory-file-name | |
8986 | (car x)))) | |
8987 | (cdr x))) | |
8988 | idlwave-path-alist)))) | |
8989 | ||
8990 | (defun idlwave-syslib-scanned-p () | |
8991 | "Non-nil if the system lib file !DIR/lib has been scanned." | |
8992 | (let* ((true-syslib (file-name-as-directory | |
8993 | (file-truename | |
8994 | (expand-file-name "lib" (idlwave-sys-dir)))))) | |
8995 | (cdr (assoc true-syslib (idlwave-true-path-alist))))) | |
8996 | ||
8997 | ;; ---------------------------------------------------------------------------- | |
8998 | ;; | |
8999 | ;; Online Help display | |
9000 | ||
f32b3b91 CD |
9001 | |
9002 | ;; ---------------------------------------------------------------------------- | |
9003 | ;; | |
9004 | ;; Additions for use with imenu.el and func-menu.el | |
9005 | ;; (pop-up a list of IDL units in the current file). | |
9006 | ;; | |
9007 | ||
9008 | (defun idlwave-prev-index-position () | |
9009 | "Search for the previous procedure or function. | |
9010 | Return nil if not found. For use with imenu.el." | |
9011 | (save-match-data | |
9012 | (cond | |
9013 | ((idlwave-find-key "\\<\\(pro\\|function\\)\\>" -1 'nomark)) | |
9014 | ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark) | |
9015 | (t nil)))) | |
9016 | ||
9017 | (defun idlwave-unit-name () | |
9018 | "Return the unit name. | |
9019 | Assumes that point is at the beginning of the unit as found by | |
9020 | `idlwave-prev-index-position'." | |
9021 | (forward-sexp 2) | |
9022 | (forward-sexp -1) | |
9023 | (let ((begin (point))) | |
4b1aaa8b | 9024 | (re-search-forward |
52a244eb | 9025 | "[a-zA-Z_][a-zA-Z0-9$_]+\\(::[a-zA-Z_][a-zA-Z0-9$_]+\\)?") |
f32b3b91 CD |
9026 | (if (fboundp 'buffer-substring-no-properties) |
9027 | (buffer-substring-no-properties begin (point)) | |
9028 | (buffer-substring begin (point))))) | |
9029 | ||
facebc7b S |
9030 | (defalias 'idlwave-function-menu |
9031 | (condition-case nil | |
f32b3b91 CD |
9032 | (progn |
9033 | (require 'func-menu) | |
facebc7b S |
9034 | 'function-menu) |
9035 | (error (condition-case nil | |
9036 | (progn | |
9037 | (require 'imenu) | |
9038 | 'imenu) | |
9039 | (error nil))))) | |
f32b3b91 | 9040 | |
52a244eb | 9041 | ;; Here we hack func-menu.el in order to support this new mode. |
f32b3b91 CD |
9042 | ;; The latest versions of func-menu.el already have this stuff in, so |
9043 | ;; we hack only if it is not already there. | |
bdd779ec | 9044 | (when (featurep 'xemacs) |
f32b3b91 CD |
9045 | (eval-after-load "func-menu" |
9046 | '(progn | |
9047 | (or (assq 'idlwave-mode fume-function-name-regexp-alist) | |
9048 | (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems | |
9049 | (setq fume-function-name-regexp-alist | |
9050 | (cons '(idlwave-mode . fume-function-name-regexp-idl) | |
9051 | fume-function-name-regexp-alist))) | |
9052 | (or (assq 'idlwave-mode fume-find-function-name-method-alist) | |
9053 | (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems | |
9054 | (setq fume-find-function-name-method-alist | |
9055 | (cons '(idlwave-mode . fume-find-next-idl-function-name) | |
9056 | fume-find-function-name-method-alist)))))) | |
9057 | ||
9058 | (defun idlwave-edit-in-idlde () | |
9059 | "Edit the current file in IDL Development environment." | |
9060 | (interactive) | |
9061 | (start-process "idldeclient" nil | |
9062 | idlwave-shell-explicit-file-name "-c" "-e" | |
f66f03de | 9063 | (buffer-file-name))) |
4b1aaa8b | 9064 | |
f66f03de | 9065 | (defvar idlwave-help-use-assistant) |
f32b3b91 CD |
9066 | (defun idlwave-launch-idlhelp () |
9067 | "Start the IDLhelp application." | |
9068 | (interactive) | |
f66f03de S |
9069 | (if idlwave-help-use-assistant |
9070 | (idlwave-help-assistant-raise) | |
9071 | (start-process "idlhelp" nil idlwave-help-application))) | |
4b1aaa8b | 9072 | |
f32b3b91 CD |
9073 | ;; Menus - using easymenu.el |
9074 | (defvar idlwave-mode-menu-def | |
9075 | `("IDLWAVE" | |
9076 | ["PRO/FUNC menu" idlwave-function-menu t] | |
9077 | ("Motion" | |
9078 | ["Subprogram Start" idlwave-beginning-of-subprogram t] | |
9079 | ["Subprogram End" idlwave-end-of-subprogram t] | |
9080 | ["Block Start" idlwave-beginning-of-block t] | |
9081 | ["Block End" idlwave-end-of-block t] | |
9082 | ["Up Block" idlwave-backward-up-block t] | |
9083 | ["Down Block" idlwave-down-block t] | |
9084 | ["Skip Block Backward" idlwave-backward-block t] | |
9085 | ["Skip Block Forward" idlwave-forward-block t]) | |
9086 | ("Mark" | |
9087 | ["Subprogram" idlwave-mark-subprogram t] | |
9088 | ["Block" idlwave-mark-block t] | |
9089 | ["Header" idlwave-mark-doclib t]) | |
9090 | ("Format" | |
4b1aaa8b | 9091 | ["Indent Entire Statement" idlwave-indent-statement |
f66f03de | 9092 | :active t :keys "C-u \\[indent-for-tab-command]" ] |
f32b3b91 | 9093 | ["Indent Subprogram" idlwave-indent-subprogram t] |
f66f03de | 9094 | ["(Un)Comment Region" idlwave-toggle-comment-region t] |
f32b3b91 CD |
9095 | ["Continue/Split line" idlwave-split-line t] |
9096 | "--" | |
9097 | ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle | |
9098 | :selected (symbol-value idlwave-fill-function)]) | |
9099 | ("Templates" | |
9100 | ["Procedure" idlwave-procedure t] | |
9101 | ["Function" idlwave-function t] | |
9102 | ["Doc Header" idlwave-doc-header t] | |
9103 | ["Log" idlwave-doc-modification t] | |
9104 | "--" | |
9105 | ["Case" idlwave-case t] | |
9106 | ["For" idlwave-for t] | |
9107 | ["Repeat" idlwave-repeat t] | |
9108 | ["While" idlwave-while t] | |
9109 | "--" | |
9110 | ["Close Block" idlwave-close-block t]) | |
15e42531 | 9111 | ("Completion" |
f32b3b91 | 9112 | ["Complete" idlwave-complete t] |
f66f03de | 9113 | ("Complete Specific" |
f32b3b91 CD |
9114 | ["1 Procedure Name" (idlwave-complete 'procedure) t] |
9115 | ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t] | |
9116 | "--" | |
9117 | ["3 Function Name" (idlwave-complete 'function) t] | |
9118 | ["4 Function Keyword" (idlwave-complete 'function-keyword) t] | |
9119 | "--" | |
9120 | ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t] | |
9121 | ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t] | |
9122 | "--" | |
9123 | ["7 Function Method Name" (idlwave-complete 'function-method) t] | |
9124 | ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t] | |
9125 | "--" | |
15e42531 CD |
9126 | ["9 Class Name" idlwave-complete-class t])) |
9127 | ("Routine Info" | |
f32b3b91 | 9128 | ["Show Routine Info" idlwave-routine-info t] |
52a244eb | 9129 | ["Online Context Help" idlwave-context-help t] |
f32b3b91 CD |
9130 | "--" |
9131 | ["Find Routine Source" idlwave-find-module t] | |
15e42531 | 9132 | ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)] |
f32b3b91 CD |
9133 | "--" |
9134 | ["Update Routine Info" idlwave-update-routine-info t] | |
f66f03de | 9135 | ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t] |
f32b3b91 | 9136 | "--" |
52a244eb S |
9137 | "IDL User Catalog" |
9138 | ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t] | |
15e42531 | 9139 | ["Scan Directories" (idlwave-update-routine-info '(16)) |
5e72c6b2 S |
9140 | (and idlwave-path-alist (not idlwave-catalog-process))] |
9141 | ["Scan Directories &" (idlwave-update-routine-info '(64)) | |
9142 | (and idlwave-path-alist (not idlwave-catalog-process))] | |
15e42531 CD |
9143 | "--" |
9144 | "Routine Shadows" | |
9145 | ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t] | |
9146 | ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t] | |
9147 | ["Check Everything" idlwave-list-all-load-path-shadows t]) | |
9148 | ("Misc" | |
9149 | ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t] | |
9150 | "--" | |
9151 | ["Insert TAB character" idlwave-hard-tab t]) | |
f32b3b91 CD |
9152 | "--" |
9153 | ("External" | |
f32b3b91 CD |
9154 | ["Start IDL shell" idlwave-shell t] |
9155 | ["Edit file in IDLDE" idlwave-edit-in-idlde t] | |
9156 | ["Launch IDL Help" idlwave-launch-idlhelp t]) | |
9157 | "--" | |
9158 | ("Customize" | |
9159 | ["Browse IDLWAVE Group" idlwave-customize t] | |
9160 | "--" | |
4b1aaa8b | 9161 | ["Build Full Customize Menu" idlwave-create-customize-menu |
f32b3b91 CD |
9162 | (fboundp 'customize-menu-create)]) |
9163 | ("Documentation" | |
9164 | ["Describe Mode" describe-mode t] | |
9165 | ["Abbreviation List" idlwave-list-abbrevs t] | |
9166 | "--" | |
9167 | ["Commentary in idlwave.el" idlwave-show-commentary t] | |
595ab50b | 9168 | ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t] |
f32b3b91 CD |
9169 | "--" |
9170 | ["Info" idlwave-info t] | |
9171 | "--" | |
8c43762b | 9172 | ["Help with Topic" idlwave-help-assistant-help-with-topic |
e08734e2 | 9173 | idlwave-help-use-assistant] |
f32b3b91 CD |
9174 | ["Launch IDL Help" idlwave-launch-idlhelp t]))) |
9175 | ||
9176 | (defvar idlwave-mode-debug-menu-def | |
9177 | '("Debug" | |
9178 | ["Start IDL shell" idlwave-shell t] | |
9179 | ["Save and .RUN buffer" idlwave-shell-save-and-run | |
4b1aaa8b | 9180 | (and (boundp 'idlwave-shell-automatic-start) |
f32b3b91 CD |
9181 | idlwave-shell-automatic-start)])) |
9182 | ||
9183 | (if (or (featurep 'easymenu) (load "easymenu" t)) | |
9184 | (progn | |
4b1aaa8b PE |
9185 | (easy-menu-define idlwave-mode-menu idlwave-mode-map |
9186 | "IDL and WAVE CL editing menu" | |
f32b3b91 | 9187 | idlwave-mode-menu-def) |
4b1aaa8b PE |
9188 | (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map |
9189 | "IDL and WAVE CL editing menu" | |
f32b3b91 CD |
9190 | idlwave-mode-debug-menu-def))) |
9191 | ||
9192 | (defun idlwave-customize () | |
5a0c3f56 | 9193 | "Call the customize function with `idlwave' as argument." |
f32b3b91 | 9194 | (interactive) |
4b1aaa8b | 9195 | ;; Try to load the code for the shell, so that we can customize it |
f32b3b91 | 9196 | ;; as well. |
22d5821d CD |
9197 | (or (featurep 'idlw-shell) |
9198 | (load "idlw-shell" t)) | |
f32b3b91 CD |
9199 | (customize-browse 'idlwave)) |
9200 | ||
9201 | (defun idlwave-create-customize-menu () | |
9202 | "Create a full customization menu for IDLWAVE, insert it into the menu." | |
9203 | (interactive) | |
9204 | (if (fboundp 'customize-menu-create) | |
9205 | (progn | |
4b1aaa8b | 9206 | ;; Try to load the code for the shell, so that we can customize it |
f32b3b91 | 9207 | ;; as well. |
22d5821d CD |
9208 | (or (featurep 'idlw-shell) |
9209 | (load "idlw-shell" t)) | |
4b1aaa8b | 9210 | (easy-menu-change |
f32b3b91 CD |
9211 | '("IDLWAVE") "Customize" |
9212 | `(["Browse IDLWAVE group" idlwave-customize t] | |
9213 | "--" | |
9214 | ,(customize-menu-create 'idlwave) | |
9215 | ["Set" Custom-set t] | |
9216 | ["Save" Custom-save t] | |
9217 | ["Reset to Current" Custom-reset-current t] | |
9218 | ["Reset to Saved" Custom-reset-saved t] | |
9219 | ["Reset to Standard Settings" Custom-reset-standard t])) | |
9220 | (message "\"IDLWAVE\"-menu now contains full customization menu")) | |
9221 | (error "Cannot expand menu (outdated version of cus-edit.el)"))) | |
9222 | ||
9223 | (defun idlwave-show-commentary () | |
9224 | "Use the finder to view the file documentation from `idlwave.el'." | |
9225 | (interactive) | |
f32b3b91 CD |
9226 | (finder-commentary "idlwave.el")) |
9227 | ||
9228 | (defun idlwave-shell-show-commentary () | |
595ab50b | 9229 | "Use the finder to view the file documentation from `idlw-shell.el'." |
f32b3b91 | 9230 | (interactive) |
595ab50b | 9231 | (finder-commentary "idlw-shell.el")) |
f32b3b91 CD |
9232 | |
9233 | (defun idlwave-info () | |
9234 | "Read documentation for IDLWAVE in the info system." | |
9235 | (interactive) | |
d6a277d0 | 9236 | (info "idlwave")) |
f32b3b91 CD |
9237 | |
9238 | (defun idlwave-list-abbrevs (arg) | |
9239 | "Show the code abbreviations define in IDLWAVE mode. | |
9240 | This lists all abbrevs where the replacement text differs from the input text. | |
9241 | These are the ones the users want to learn to speed up their writing. | |
9242 | ||
9243 | The function does *not* list abbrevs which replace a word with itself | |
9244 | to call a hook. These hooks are used to change the case of words or | |
9245 | to blink the matching `begin', and the user does not need to know them. | |
9246 | ||
9247 | With arg, list all abbrevs with the corresponding hook. | |
9248 | ||
9249 | This function was written since `list-abbrevs' looks terrible for IDLWAVE mode." | |
9250 | ||
9251 | (interactive "P") | |
9252 | (let ((table (symbol-value 'idlwave-mode-abbrev-table)) | |
9253 | abbrevs | |
9254 | str rpl func fmt (len-str 0) (len-rpl 0)) | |
4b1aaa8b | 9255 | (mapatoms |
f32b3b91 CD |
9256 | (lambda (sym) |
9257 | (if (symbol-value sym) | |
9258 | (progn | |
9259 | (setq str (symbol-name sym) | |
9260 | rpl (symbol-value sym) | |
9261 | func (symbol-function sym)) | |
9262 | (if arg | |
9263 | (setq func (prin1-to-string func)) | |
9264 | (if (and (listp func) (stringp (nth 2 func))) | |
9265 | (setq rpl (concat "EVAL: " (nth 2 func)) | |
9266 | func "") | |
9267 | (setq func ""))) | |
9268 | (if (or arg (not (string= rpl str))) | |
9269 | (progn | |
9270 | (setq len-str (max len-str (length str))) | |
9271 | (setq len-rpl (max len-rpl (length rpl))) | |
9272 | (setq abbrevs (cons (list str rpl func) abbrevs))))))) | |
9273 | table) | |
9274 | ;; sort the list | |
9275 | (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b))))) | |
9276 | ;; Make the format | |
9277 | (setq fmt (format "%%-%ds %%-%ds %%s\n" len-str len-rpl)) | |
9278 | (with-output-to-temp-buffer "*Help*" | |
9279 | (if arg | |
9280 | (progn | |
4b1aaa8b | 9281 | (princ "Abbreviations and Actions in IDLWAVE-Mode\n") |
f32b3b91 CD |
9282 | (princ "=========================================\n\n") |
9283 | (princ (format fmt "KEY" "REPLACE" "HOOK")) | |
9284 | (princ (format fmt "---" "-------" "----"))) | |
9285 | (princ "Code Abbreviations and Templates in IDLWAVE-Mode\n") | |
9286 | (princ "================================================\n\n") | |
9287 | (princ (format fmt "KEY" "ACTION" "")) | |
9288 | (princ (format fmt "---" "------" ""))) | |
26b51db5 JB |
9289 | (dolist (list abbrevs) |
9290 | (setq str (car list) | |
9291 | rpl (nth 1 list) | |
9292 | func (nth 2 list)) | |
9293 | (princ (format fmt str rpl func))))) | |
f32b3b91 | 9294 | ;; Make sure each abbreviation uses only one display line |
9a529312 | 9295 | (with-current-buffer "*Help*" |
f32b3b91 CD |
9296 | (setq truncate-lines t))) |
9297 | ||
bdd779ec GM |
9298 | (declare-function speedbar-add-supported-extension "speedbar" (extension)) |
9299 | ||
5e72c6b2 S |
9300 | ;; Add .pro files to speedbar for support, if it's loaded |
9301 | (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro")) | |
9302 | ||
5e72c6b2 S |
9303 | ;; Set an idle timer to load the routine info. |
9304 | ;; Will only work on systems which support this. | |
9305 | (or idlwave-routines (idlwave-start-load-rinfo-timer)) | |
9306 | ||
15e42531 | 9307 | ;; Run the hook |
f32b3b91 CD |
9308 | (run-hooks 'idlwave-load-hook) |
9309 | ||
9310 | (provide 'idlwave) | |
9311 | ||
9312 | ;;; idlwave.el ends here |