1 ;; idlwave.el --- IDL editing mode for GNU Emacs
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4 ;; Free Software Foundation, Inc.
6 ;; Authors: J.D. Smith <jdsmith@as.arizona.edu>
7 ;; Carsten Dominik <dominik@science.uva.nl>
8 ;; Chris Chase <chase@att.com>
9 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
11 ;; Keywords: languages
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 3, or (at your option)
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING. If not, write to the
27 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
28 ;; Boston, MA 02110-1301, USA.
32 ;; IDLWAVE enables feature-rich development and interaction with IDL,
33 ;; the Interactive Data Language. It provides a compelling,
34 ;; full-featured alternative to the IDLDE development environment
37 ;; In the remotely distant past, based on pascal.el, though bears
38 ;; little resemblance to it now.
40 ;; Incorporates many ideas, such as abbrevs, action routines, and
41 ;; continuation line indenting, from wave.el.
42 ;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder.
44 ;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode")
45 ;; for features, key bindings, and info.
46 ;; Also, Info format documentation is available with `M-x idlwave-info'
48 ;; New versions of IDLWAVE, documentation, and more information
55 ;; Follow the instructions in the INSTALL file of the distribution.
56 ;; In short, put this file on your load path and add the following
57 ;; lines to your .emacs file:
59 ;; (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
60 ;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
61 ;; (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
67 ;; The newest version of this file is available from the maintainer's
75 ;; IDLWAVE is documented online in info format. A printable version
76 ;; of the documentation is available from the maintainers webpage (see
83 ;; Thanks to the following people for their contributions and comments:
85 ;; Ulrik Dickow <dickow_at_nbi.dk>
86 ;; Eric E. Dors <edors_at_lanl.gov>
87 ;; Stein Vidar H. Haugan <s.v.h.haugan_at_astro.uio.no>
88 ;; David Huenemoerder <dph_at_space.mit.edu>
89 ;; Kevin Ivory <Kevin.Ivory_at_linmpi.mpg.de>
90 ;; Dick Jackson <dick_at_d-jackson.com>
91 ;; Xuyong Liu <liu_at_stsci.edu>
92 ;; Simon Marshall <Simon.Marshall_at_esrin.esa.it>
93 ;; Laurent Mugnier <mugnier_at_onera.fr>
94 ;; Lubos Pochman <lubos_at_rsinc.com>
95 ;; Bob Portmann <portmann_at_al.noaa.gov>
96 ;; Patrick M. Ryan <pat_at_jaameri.gsfc.nasa.gov>
97 ;; Marty Ryba <ryba_at_ll.mit.edu>
98 ;; Paul Sorenson <aardvark62_at_msn.com>
99 ;; Phil Sterne <sterne_at_dublin.llnl.gov>
100 ;; Phil Williams <williams_at_irc.chmcc.org>
105 ;; IDLWAVE has extensive customize support; to learn about the
106 ;; variables which control the mode's behavior, use `M-x
107 ;; idlwave-customize'.
109 ;; You can set your own preferred values with Customize, or with Lisp
110 ;; code in .emacs. For an example of what to put into .emacs, check
111 ;; the TexInfo documentation or see a complete .emacs available at the
117 ;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual
118 ;; Numerics, Inc. is growing less and less complete as the two
119 ;; languages grow increasingly apart. The mode probably shouldn't
120 ;; even have "WAVE" in its title, but it's catchy, and was required
121 ;; to avoid conflict with the CORBA idl.el mode. Caveat WAVEor.
123 ;; Moving the point backwards in conjunction with abbrev expansion
124 ;; does not work as I would like it, but this is a problem with
125 ;; emacs abbrev expansion done by the self-insert-command. It ends
126 ;; up inserting the character that expanded the abbrev after moving
127 ;; point backward, e.g., "\cl" expanded with a space becomes
128 ;; "LONG( )" with point before the close paren. This is solved by
129 ;; using a temporary function in `post-command-hook' - not pretty,
132 ;; Tabs and spaces are treated equally as whitespace when filling a
133 ;; comment paragraph. To accomplish this, tabs are permanently
134 ;; replaced by spaces in the text surrounding the paragraph, which
135 ;; may be an undesirable side-effect. Replacing tabs with spaces is
136 ;; limited to comments only and occurs only when a comment
137 ;; paragraph is filled via `idlwave-fill-paragraph'.
139 ;; Muti-statement lines (using "&") on block begin and end lines can
140 ;; ruin the formatting. For example, multiple end statements on a
141 ;; line: endif & endif. Using "&" outside of block begin/end lines
144 ;; Determining the expression at point for printing and other
145 ;; examination commands is somewhat rough: currently only fairly
146 ;; simple entities are found. You can always drag-select or examine
147 ;; a pre-selected region.
149 ;; When forcing completion of method keywords, the initial
150 ;; query for a method has multiple entries for some methods. Would
151 ;; be too difficult to fix this hardly used case.
157 (eval-when-compile (require 'cl
))
161 (unless (fboundp 'line-beginning-position
)
162 (defalias 'line-beginning-position
'point-at-bol
))
163 (unless (fboundp 'line-end-position
)
164 (defalias 'line-end-position
'point-at-eol
))
165 (unless (fboundp 'char-valid-p
)
166 (defalias 'char-valid-p
'characterp
))
167 (unless (fboundp 'match-string-no-properties
)
168 (defalias 'match-string-no-properties
'match-string
))
170 (if (not (fboundp 'cancel-timer
))
176 ;; Kludge to allow `defcustom' for Emacs 19.
177 (condition-case () (require 'custom
) (error nil
))
178 (if (and (featurep 'custom
) (fboundp 'custom-declare-variable
))
179 nil
;; We've got what we needed
180 ;; We have the old or no custom-library, hack around it!
181 (defmacro defgroup
(&rest args
) nil
)
182 (defmacro defcustom
(var value doc
&rest args
)
183 `(defvar ,var
,value
,doc
))))
185 (declare-function idlwave-shell-get-path-info
"idlw-shell")
186 (declare-function idlwave-shell-temp-file
"idlw-shell")
187 (declare-function idlwave-shell-is-running
"idlw-shell")
188 (declare-function widget-value
"wid-edit" (widget))
189 (declare-function comint-dynamic-complete-filename
"comint" ())
190 (declare-function Info-goto-node
"info" (nodename &optional fork
))
192 (defgroup idlwave nil
193 "Major mode for editing IDL .pro files."
195 :link
'(url-link :tag
"Home Page"
196 "http://idlwave.org")
197 :link
'(emacs-commentary-link :tag
"Commentary in idlw-shell.el"
199 :link
'(emacs-commentary-link :tag
"Commentary in idlwave.el" "idlwave.el")
200 :link
'(custom-manual "(idlwave)Top")
205 ;;; Variables for indentation behavior ---------------------------------------
207 (defgroup idlwave-code-formatting nil
208 "Indentation and formatting options for IDLWAVE mode."
211 (defcustom idlwave-main-block-indent
2
212 "*Extra indentation for the main block of code.
213 That is the block between the FUNCTION/PRO statement and the END
214 statement for that program unit."
215 :group
'idlwave-code-formatting
218 (defcustom idlwave-block-indent
3
219 "*Extra indentation applied to block lines.
220 If you change this, you probably also want to change `idlwave-end-offset'."
221 :group
'idlwave-code-formatting
224 (defcustom idlwave-end-offset -
3
225 "*Extra indentation applied to block END lines.
226 A value equal to negative `idlwave-block-indent' will make END lines
227 line up with the block BEGIN lines."
228 :group
'idlwave-code-formatting
231 (defcustom idlwave-continuation-indent
3
232 "*Extra indentation applied to continuation lines.
233 This extra offset applies to the first of a set of continuation lines.
234 The following lines receive the same indentation as the first."
235 :group
'idlwave-code-formatting
238 (defcustom idlwave-max-extra-continuation-indent
40
239 "*Maximum additional indentation for special continuation indent.
240 Several special indentations are tried to help line up continuation
241 lines in routine calls or definitions, other statements with
242 parentheses, or assignment statements. This variable specifies a
243 maximum amount by which this special indentation can exceed the
244 standard continuation indentation, otherwise defaulting to a fixed
245 offset. Set to 0 to effectively disable all special continuation
246 indentation, or to a large number (like 100) to enable it in all
247 cases. See also `idlwave-indent-to-open-paren', which can override
249 :group
'idlwave-code-formatting
252 (defcustom idlwave-indent-to-open-paren t
253 "*Non-nil means, indent continuation lines to innermost open
254 parenthesis. This indentation occurs even if otherwise disallowed by
255 `idlwave-max-extra-continuation-indent'. Matching parens and the
256 interleaving args are lined up. Example:
258 x = function_a(function_b(function_c( a, b, [1,2,3, $
264 When this variable is nil, paren alignment may still occur, based on
265 the value of `max-extra-continuation-indent', which, if zero, would
268 x = function_a(function_b(function_c( a, b, [1,2,3, $
273 :group
'idlwave-code-formatting
276 (defcustom idlwave-indent-parens-nested nil
277 "*Non-nil means, indent continuation lines with parens by nesting
278 lines at consecutively deeper levels."
279 :group
'idlwave-code-formatting
283 (defcustom idlwave-hanging-indent t
284 "*If set non-nil then comment paragraphs are indented under the
285 hanging indent given by `idlwave-hang-indent-regexp' match in the first line
287 :group
'idlwave-code-formatting
290 (defcustom idlwave-hang-indent-regexp
"- "
291 "*Regular expression matching the position of the hanging indent
292 in the first line of a comment paragraph. The size of the indent
293 extends to the end of the match for the regular expression."
294 :group
'idlwave-code-formatting
297 (defcustom idlwave-use-last-hang-indent nil
298 "*If non-nil then use last match on line for `idlwave-indent-regexp'."
299 :group
'idlwave-code-formatting
302 (defcustom idlwave-fill-comment-line-only t
303 "*If non-nil then auto fill will only operate on comment lines."
304 :group
'idlwave-code-formatting
307 (defcustom idlwave-auto-fill-split-string t
308 "*If non-nil then auto fill will split strings with the IDL `+' operator.
309 When the line end falls within a string, string concatenation with the
310 '+' operator will be used to distribute a long string over lines.
311 If nil and a string is split then a terminal beep and warning are issued.
313 This variable is ignored when `idlwave-fill-comment-line-only' is
314 non-nil, since in this case code is not auto-filled."
315 :group
'idlwave-code-formatting
318 (defcustom idlwave-split-line-string t
319 "*If non-nil then `idlwave-split-line' will split strings with `+'.
320 When the splitting point of a line falls inside a string, split the string
321 using the `+' string concatenation operator. If nil and a string is
322 split then a terminal beep and warning are issued."
323 :group
'idlwave-code-formatting
326 (defcustom idlwave-no-change-comment
";;;"
327 "*The indentation of a comment that starts with this regular
328 expression will not be changed. Note that the indentation of a comment
329 at the beginning of a line is never changed."
330 :group
'idlwave-code-formatting
333 (defcustom idlwave-begin-line-comment nil
334 "*A comment anchored at the beginning of line.
335 A comment matching this regular expression will not have its
336 indentation changed. If nil the default is \"^;\", i.e., any line
337 beginning with a \";\". Expressions for comments at the beginning of
338 the line should begin with \"^\"."
339 :group
'idlwave-code-formatting
340 :type
'(choice (const :tag
"Any line beginning with `;'" nil
)
343 (defcustom idlwave-code-comment
";;[^;]"
344 "*A comment that starts with this regular expression on a line by
345 itself is indented as if it is a part of IDL code. As a result if
346 the comment is not preceded by whitespace it is unchanged."
347 :group
'idlwave-code-formatting
350 ;; Comments not matching any of the above will be indented as a
351 ;; right-margin comment, i.e., to a minimum of `comment-column'.
353 ;;; Routine Info and Completion ---------------------------------------
355 (defgroup idlwave-routine-info nil
356 "Routine Info options for IDLWAVE mode."
359 (defcustom idlwave-use-library-catalogs t
360 "*Non-nil means search the IDL path for library catalog files.
362 These files, named .idlwave_catalog, document routine information for
363 individual directories and libraries of IDL .pro files. Many popular
364 libraries come with catalog files by default, so leaving this on is a
365 usually a good idea.."
366 :group
'idlwave-routine-info
369 (defcustom idlwave-init-rinfo-when-idle-after
10
370 "*Seconds of idle time before routine info is automatically
371 initialized. Initializing the routine info can take a long time, in
372 particular if a large number of library catalogs are involved. When
373 Emacs is idle for more than the number of seconds specified by this
374 variable, it starts the initialization. The process is split into
375 five steps, in order to keep work interruption as short as possible.
376 If one of the steps finishes, and no user input has arrived in the
377 mean time, initialization proceeds immediately to the next step. A
378 good value for this variable is about 1/3 of the time initialization
379 take in your setup. So if you have a fast machine and no problems
380 with a slow network connection, don't hesitate to set this to 2
381 seconds. A Value of 0 means, don't initialize automatically, but
382 instead wait until routine information is needed, and initialize
384 :group
'idlwave-routine-info
387 (defcustom idlwave-scan-all-buffers-for-routine-info t
388 "*Non-nil means, scan buffers for IDL programs when updating info.
389 The scanning is done by the command `idlwave-update-routine-info'.
390 The following values are allowed:
392 nil Don't scan any buffers.
393 t Scan all idlwave-mode buffers in the current editing session.
394 current Scan only the current buffer, but no other buffers."
395 :group
'idlwave-routine-info
397 (const :tag
"No buffer" nil
)
398 (const :tag
"All buffers" t
)
399 (const :tag
"Current buffer only" 'current
)))
401 (defcustom idlwave-query-shell-for-routine-info t
402 "*Non-nil means query the shell for info about compiled routines.
403 Querying the shell is useful to get information about compiled modules,
404 and it is turned on by default. However, when you have a complete library
405 scan, this is not necessary."
406 :group
'idlwave-routine-info
409 (defcustom idlwave-auto-routine-info-updates
410 '(find-file save-buffer kill-buffer compile-buffer
)
411 "*Controls under what circumstances routine info is updated automatically.
415 \(...) A list of circumstances. Allowed members are:
416 find-file Add info for new IDLWAVE buffers.
417 save-buffer Update buffer info when buffer is saved
418 kill-buffer Remove buffer info when buffer gets killed
419 compile-buffer Update shell info after `idlwave-shell-save-and...'"
420 :group
'idlwave-routine-info
422 (const :tag
"Never" nil
)
423 (const :tag
"As often as possible" t
)
424 (set :tag
"Checklist" :greedy t
425 (const :tag
"When visiting a file" find-file
)
426 (const :tag
"When saving a buffer" save-buffer
)
427 (const :tag
"After a buffer was killed" kill-buffer
)
428 (const :tag
"After a buffer was compiled successfully, update shell info" compile-buffer
))))
430 (defcustom idlwave-rinfo-max-source-lines
5
431 "*Maximum number of source files displayed in the Routine Info window.
432 When an integer, it is the maximum number of source files displayed.
433 t means to show all source files."
434 :group
'idlwave-routine-info
437 (defcustom idlwave-library-path nil
438 "Library path for Windows and MacOS (OS9). Not needed under UNIX.
439 When selecting the directories to scan for IDL user catalog routine
440 info, IDLWAVE can, under UNIX, query the shell for the exact search
441 path \(the value of !PATH). However, under Windows and MacOS
442 \(pre-OSX), the IDLWAVE shell does not work. In this case, this
443 variable can be set to specify the paths where IDLWAVE can find PRO
444 files. The shell will only be asked for a list of paths when this
445 variable is nil. The value is a list of directories. A directory
446 preceeded by a `+' will be searched recursively. If you set this
447 variable on a UNIX system, the shell will not be queried. See also
448 `idlwave-system-directory'."
449 :group
'idlwave-routine-info
450 :type
'(repeat (directory)))
452 (defcustom idlwave-system-directory
""
453 "The IDL system directory for Windows and MacOS. Not needed under
454 UNIX. Set this to the value of the `!DIR' system variable in IDL.
455 IDLWAVE uses this to find out which of the library routines belong to
456 the official system library. All files inside the `lib' subdirectory
457 are considered system library files - so don't install private stuff
458 in this directory. On UNIX systems, IDLWAVE queries the shell for the
459 value of `!DIR'. See also `idlwave-library-path'."
460 :group
'idlwave-routine-info
463 ;; Configuration files
464 (defcustom idlwave-config-directory
465 (convert-standard-filename "~/.idlwave")
466 "*Directory for configuration files and user-library catalog."
467 :group
'idlwave-routine-info
470 (defvar idlwave-user-catalog-file
"idlusercat.el")
471 (defvar idlwave-xml-system-rinfo-converted-file
"idl_xml_rinfo.el")
472 (defvar idlwave-path-file
"idlpath.el")
474 (defvar idlwave-libinfo-file nil
475 "*Obsolete variable, no longer used.")
477 (defcustom idlwave-special-lib-alist nil
478 "Alist of regular expressions matching special library directories.
479 When listing routine source locations, IDLWAVE gives a short hint where
480 the file defining the routine is located. By default it lists `SystemLib'
481 for routines in the system library `!DIR/lib' and `Library' for anything
482 else. This variable can define additional types. The car of each entry
483 is a regular expression matching the file name (they normally will match
484 on the path). The cdr is the string to be used as identifier. Max 10
486 :group
'idlwave-routine-info
488 (cons regexp string
)))
490 (defcustom idlwave-auto-write-paths t
491 "Write out path (!PATH) and system directory (!DIR) info automatically.
492 Path info is needed to locate library catalog files. If non-nil,
493 whenever the path-list changes as a result of shell-query, etc., it is
494 written to file. Otherwise, the menu option \"Write Paths\" can be
495 used to force a write."
496 :group
'idlwave-routine-info
499 (defgroup idlwave-completion nil
500 "Completion options for IDLWAVE mode."
505 (defconst idlwave-tmp
506 '(choice :tag
"by applying the function"
511 (symbol :tag
"Other"))))
513 (defcustom idlwave-completion-case
'((routine . upcase
)
517 "Association list setting the case of completed words.
519 This variable determines the case (UPPER/lower/Capitalized...) of
520 words inserted into the buffer by completion. The preferred case can
521 be specified separately for routine names, keywords, classes and
523 This alist should therefore have entries for `routine' (normal
524 functions and procedures, i.e. non-methods), `keyword', `class', and
525 `method'. Plausible values are
527 upcase upcase whole word, like `BOX_CURSOR'
528 downcase downcase whole word, like `read_ppm'
529 capitalize capitalize each part, like `Widget_Control'
530 preserve preserve case as is, like `IDLgrView'
532 The value can also be any Emacs Lisp function which transforms the
533 case of characters in a string.
535 A value of `preserve' means that the case of the completed word is
536 identical to the way it was written in the definition statement of the
537 routine. This was implemented to allow for mixed-case completion, in
538 particular of object classes and methods.
539 If a completable word is defined in multiple locations, the meaning of
540 `preserve' is not unique since the different definitions might be
541 cased differently. Therefore IDLWAVE always takes the case of the
542 *first* definition it encounters during routine info collection and
543 uses the case derived from it consistently.
545 Note that a lowercase-only string in the buffer will always be completed in
546 lower case (but see the variable `idlwave-completion-force-default-case').
548 After changing this variable, you need to either restart Emacs or press
549 `C-u C-c C-i' to update the internal lists."
550 :group
'idlwave-completion
552 (cons (symbol :tag
"Derive completion case for")
555 (defcustom idlwave-completion-force-default-case nil
556 "*Non-nil means, completion will always honor `idlwave-completion-case'.
557 When nil, only the completion of a mixed case or upper case string
558 will honor the default settings in `idlwave-completion-case', while
559 the completion of lower case strings will be completed entirely in
561 :group
'idlwave-completion
564 (defcustom idlwave-complete-empty-string-as-lower-case nil
565 "*Non-nil means, the empty string is considered downcase for completion.
566 The case of what is already in the buffer determines the case of completions.
567 When this variable is non-nil, the empty string is considered to be downcase.
568 Completing on the empty string then offers downcase versions of the possible
570 :group
'idlwave-completion
573 (defvar idlwave-default-completion-case-is-down nil
574 "Obsolete variable. See `idlwave-complete-empty-string-as-lower-case' and
575 `idlwave-completion-case'.")
577 (defcustom idlwave-buffer-case-takes-precedence nil
578 "*Non-nil means, the case of tokens in buffers dominates over system stuff.
579 To make this possible, we need to re-case everything each time we update
580 the routine info from the buffers. This is slow.
581 The default is to consider the case given in the system and library files
582 first which makes updating much faster."
583 :group
'idlwave-completion
586 (defcustom idlwave-highlight-help-links-in-completion t
587 "*Non-nil means, highlight completions for which system help is available.
588 Help can then be accessed with mouse-3.
589 This option is only effective when the online help system is installed."
590 :group
'idlwave-completion
593 (defcustom idlwave-support-inheritance t
594 "Non-nil means, treat inheritance with completion, online help etc.
595 When nil, IDLWAVE only knows about the native methods and tags of a class,
596 not about inherited ones."
597 :group
'idlwave-routine-info
600 (defcustom idlwave-keyword-class-inheritance
'("^[gs]etproperty$" "^init$")
601 "List of regular expressions for class-driven keyword inheritance.
602 Keyword inheritance is often tied to class inheritance by \"chaining\"
603 up the class tree. While it cannot be assumed that the presence of an
604 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
605 certain methods this assumption is almost always true. The methods
606 for which to assume this can be set here."
607 :group
'idlwave-routine-info
608 :type
'(repeat (regexp :tag
"Match method:")))
611 (defcustom idlwave-completion-show-classes
1
612 "*Number of classes to show when completing object methods and keywords.
613 When completing methods or keywords for an object with unknown class,
614 the *Completions* buffer will show the valid classes for each completion
617 MyMethod <Class1,Class2,Class3>
619 The value of this variable may be nil to inhibit display, or an integer to
620 indicate the maximum number of classes to display.
622 On XEmacs, a full list of classes will also be placed into a `help-echo'
623 property on the competion items, so that the list of classes for the current
624 item is displayed in the echo area. If the value of this variable is a
625 negative integer, the `help-echo' property will be suppressed."
626 :group
'idlwave-completion
627 :type
'(choice (const :tag
"Don't show" nil
)
628 (integer :tag
"Number of classes shown" 1)))
630 (defcustom idlwave-completion-fontify-classes t
631 "*Non-nil means, fontify the classes in completions buffer.
632 This makes it easier to distinguish the completion items from the extra
633 class info listed. See `idlwave-completion-show-classes'."
634 :group
'idlwave-completion
637 (defcustom idlwave-query-class
'((method-default . nil
)
638 (keyword-default . nil
))
639 "Association list governing specification of object classes for completion.
641 When IDLWAVE tries to complete object-oriented methods, it usually
642 cannot determine the class of a given object from context. In order
643 to provide the user with a correct list of methods or keywords, it
644 needs to determine the appropriate class. IDLWAVE has two ways of
645 doing this (well, three ways if you count the shell... see
646 `idlwave-shell-query-for-class'):
648 1. Combine the items of all available classes which contain this
649 method for the purpose of completion. So when completing a method,
650 all methods of all known classes are available, and when completing
651 a keyword, all keywords allowed for this method in any class are
652 shown. This behavior is very much like normal completion and is
653 therefore the default. It works much better than one might think -
654 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
655 become uncomfortably long. See also
656 `idlwave-completion-show-classes'.
658 2. The second possibility is to ask the user on each occasion. To
659 make this less interruptive, IDLWAVE can store the class as a text
660 property on the object operator `->'. For a given object in the
661 source code, class selection will then be needed only once
662 - for example to complete the method. Keywords to the method can
663 then be completed directly, because the class is already known.
664 You will have to turn on the storage of the selected class
665 explicitly with the variable `idlwave-store-inquired-class'.
667 This variable allows you to configure IDLWAVE's method and
668 method-keyword completion behavior. Its value is an alist, which
669 should contain at least two elements: (method-default . VALUE) and
670 \(keyword-default . VALUE), where VALUE is either t or nil. These
671 specify if the class should be found during method and keyword
672 completion, respectively.
674 The alist may have additional entries specifying exceptions from the
675 keyword completion rule for specific methods, like INIT or
676 GETPROPERTY. In order to turn on class specification for the INIT
677 method, add an entry (\"INIT\" . t). The method name must be ALL-CAPS."
678 :group
'idlwave-completion
680 (cons (const method-default
)
681 (boolean :tag
"Determine class when completing METHODS "))
682 (cons (const keyword-default
)
683 (boolean :tag
"Determine class when completing KEYWORDS "))
685 :tag
"Exceptions to defaults"
687 (cons (string :tag
"MODULE" :value
"")
688 (boolean :tag
"Determine class for this method")))))
690 (defcustom idlwave-store-inquired-class t
691 "*Non-nil means, store class of a method call as text property on `->'.
692 IDLWAVE sometimes has to ask the user for the class associated with a
693 particular object method call. This happens during the commands
694 `idlwave-routine-info' and `idlwave-complete', depending upon the
695 value of the variable `idlwave-query-class'.
697 When you specify a class, this information can be stored as a text
698 property on the `->' arrow in the source code, so that during the same
699 editing session, IDLWAVE will not have to ask again. When this
700 variable is non-nil, IDLWAVE will store and reuse the class information.
701 The class stored can be checked and removed with `\\[idlwave-routine-info]'
704 The default of this variable is nil, since the result of commands then
705 is more predictable. However, if you know what you are doing, it can
706 be nice to turn this on.
708 An arrow which knows the class will be highlighted with
709 `idlwave-class-arrow-face'. The command \\[idlwave-routine-info]
710 displays (with prefix arg: deletes) the class stored on the arrow
712 :group
'idlwave-completion
715 (defcustom idlwave-class-arrow-face
'bold
716 "*Face to highlight object operator arrows `->' which carry a class property.
717 When IDLWAVE stores a class name as text property on an object arrow
718 \(see variable `idlwave-store-inquired-class', it highlights the arrow
719 with this font in order to remind the user that this arrow is special."
720 :group
'idlwave-completion
723 (defcustom idlwave-resize-routine-help-window t
724 "*Non-nil means, resize the Routine-info *Help* window to fit the content."
725 :group
'idlwave-completion
728 (defcustom idlwave-keyword-completion-adds-equal t
729 "*Non-nil means, completion automatically adds `=' after completed keywords."
730 :group
'idlwave-completion
733 (defcustom idlwave-function-completion-adds-paren t
734 "*Non-nil means, completion automatically adds `(' after completed function.
735 nil means, don't add anything.
736 A value of `2' means, also add the closing parenthesis and position cursor
738 :group
'idlwave-completion
739 :type
'(choice (const :tag
"Nothing" nil
)
741 (const :tag
"()" 2)))
743 (defcustom idlwave-completion-restore-window-configuration t
744 "*Non-nil means, try to restore the window configuration after completion.
745 When completion is not unique, Emacs displays a list of completions.
746 This messes up your window configuration. With this variable set, IDLWAVE
747 restores the old configuration after successful completion."
748 :group
'idlwave-completion
751 ;;; Variables for abbrev and action behavior -----------------------------
753 (defgroup idlwave-abbrev-and-indent-action nil
754 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
755 The variables in this group govern this."
758 (defcustom idlwave-do-actions nil
759 "*Non-nil means performs actions when indenting.
760 The actions that can be performed are listed in `idlwave-indent-action-table'."
761 :group
'idlwave-abbrev-and-indent-action
764 (defcustom idlwave-abbrev-start-char
"\\"
765 "*A single character string used to start abbreviations in abbrev mode.
766 Possible characters to chose from: ~`\%
767 or even '?'. '.' is not a good choice because it can make structure
768 field names act like abbrevs in certain circumstances.
770 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
771 must set it directly using `setq' in the .emacs file before idlwave.el
773 :group
'idlwave-abbrev-and-indent-action
776 (defcustom idlwave-surround-by-blank nil
777 "*Non-nil means, enable `idlwave-surround'.
778 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
780 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
782 Also see the default key bindings for keys using `idlwave-surround'.
783 Keys are bound and made into actions calling `idlwave-surround' with
784 `idlwave-action-and-binding'.
785 See help for `idlwave-action-and-binding' for examples.
787 Also see help for `idlwave-surround'."
788 :group
'idlwave-abbrev-and-indent-action
791 (defcustom idlwave-pad-keyword t
792 "*Non-nil means pad '=' in keywords (routine calls or defs) like assignment.
793 Whenever `idlwave-surround' is non-nil then this affects how '=' is
794 padded for keywords and for variables. If t, pad the same as for
795 assignments. If nil then spaces are removed. With any other value,
796 spaces are left unchanged."
797 :group
'idlwave-abbrev-and-indent-action
799 (const :tag
"Pad like assignments" t
)
800 (const :tag
"Remove space near `='" nil
)
801 (const :tag
"Keep space near `='" 'keep
)))
803 (defcustom idlwave-show-block t
804 "*Non-nil means point blinks to block beginning for `idlwave-show-begin'."
805 :group
'idlwave-abbrev-and-indent-action
808 (defcustom idlwave-expand-generic-end nil
809 "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
810 :group
'idlwave-abbrev-and-indent-action
813 (defcustom idlwave-reindent-end t
814 "*Non-nil means re-indent line after END was typed."
815 :group
'idlwave-abbrev-and-indent-action
818 (defcustom idlwave-abbrev-move t
819 "*Non-nil means the abbrev hook can move point.
820 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
821 definitions, use the command `list-abbrevs', for abbrevs that move
822 point. Moving point is useful, for example, to place point between
823 parentheses of expanded functions.
825 See `idlwave-check-abbrev'."
826 :group
'idlwave-abbrev-and-indent-action
829 (defcustom idlwave-abbrev-change-case nil
830 "*Non-nil means all abbrevs will be forced to either upper or lower case.
831 If the value t, all expanded abbrevs will be upper case.
832 If the value is 'down then abbrevs will be forced to lower case.
833 If nil, the case will not change.
834 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
835 upper case, regardless of this variable."
836 :group
'idlwave-abbrev-and-indent-action
839 (defcustom idlwave-reserved-word-upcase nil
840 "*Non-nil means, reserved words will be made upper case via abbrev expansion.
841 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
842 Has effect only if in abbrev-mode."
843 :group
'idlwave-abbrev-and-indent-action
846 ;;; Action/Expand Tables.
848 ;; The average user may have difficulty modifying this directly. It
849 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
850 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
851 ;; examples of how to add an action.
853 ;; The action table is used by `idlwave-indent-line' whereas both the
854 ;; action and expand tables are used by `idlwave-indent-and-action'. In
855 ;; general, the expand table is only used when a line is explicitly
856 ;; indented. Whereas, in addition to being used when the expand table
857 ;; is used, the action table is used when a line is indirectly
858 ;; indented via line splitting, auto-filling or a new line creation.
862 ;; Capitalize system vars
863 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
865 ;; Capitalize procedure name
866 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
867 ;; '(capitalize-word 1) t)
869 ;; Capitalize common block name
870 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
871 ;; '(capitalize-word 1) t)
873 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
874 ;; '(capitalize-word -1) t)
876 (defvar idlwave-indent-action-table nil
877 "*Associated array containing action lists of search string (car),
878 and function as a cdr. This table is used by `idlwave-indent-line'.
879 See documentation for `idlwave-do-action' for a complete description of
882 Additions to the table are made with `idlwave-action-and-binding' when a
883 binding is not requested.
884 See help on `idlwave-action-and-binding' for examples.")
886 (defvar idlwave-indent-expand-table nil
887 "*Associated array containing action lists of search string (car),
888 and function as a cdr. The table is used by the
889 `idlwave-indent-and-action' function. See documentation for
890 `idlwave-do-action' for a complete description of the action lists.
892 Additions to the table are made with `idlwave-action-and-binding' when a
893 binding is requested.
894 See help on `idlwave-action-and-binding' for examples.")
896 ;;; Documentation header and history keyword ---------------------------------
898 (defgroup idlwave-documentation nil
899 "Options for documenting IDLWAVE files."
902 ;; FIXME: make defcustom?
903 (defvar idlwave-file-header
930 ; KEYWORD PARAMETERS:
962 ; MODIFICATION HISTORY:
966 "*A list (PATHNAME STRING) specifying the doc-header template to use for
967 summarizing a file. If PATHNAME is non-nil then this file will be included.
968 Otherwise STRING is used. If nil, the file summary will be omitted.
969 For example you might set PATHNAME to the path for the
970 lib_template.pro file included in the IDL distribution.")
972 (defcustom idlwave-header-to-beginning-of-file t
973 "*Non-nil means, the documentation header will always be at start of file.
974 When nil, the header is positioned between the PRO/FUNCTION line of
975 the current routine and the code, allowing several routine headers in
977 :group
'idlwave-documentation
980 (defcustom idlwave-timestamp-hook
'idlwave-default-insert-timestamp
981 "*The hook function used to update the timestamp of a function."
982 :group
'idlwave-documentation
985 (defcustom idlwave-doc-modifications-keyword
"HISTORY"
986 "*The modifications keyword to use with the log documentation commands.
987 A ':' is added to the keyword end.
988 Inserted by doc-header and used to position logs by doc-modification.
989 If nil it will not be inserted."
990 :group
'idlwave-documentation
993 (defcustom idlwave-doclib-start
"^;+\\+"
994 "*Regexp matching the start of a document library header."
995 :group
'idlwave-documentation
998 (defcustom idlwave-doclib-end
"^;+-"
999 "*Regexp matching the end of a document library header."
1000 :group
'idlwave-documentation
1003 ;;; External Programs -------------------------------------------------------
1005 (defgroup idlwave-external-programs nil
1006 "Path locations of external commands used by IDLWAVE."
1009 (defcustom idlwave-shell-explicit-file-name
"idl"
1010 "*If non-nil, this is the command to run IDL.
1011 Should be an absolute file path or path relative to the current environment
1012 execution search path. If you want to specify command line switches
1013 for the idl program, use `idlwave-shell-command-line-options'.
1015 I know the name of this variable is badly chosen, but I cannot change
1016 it without compromizing backwards-compatibility."
1017 :group
'idlwave-external-programs
1020 (defcustom idlwave-shell-command-line-options nil
1021 "*A list of command line options for calling the IDL program.
1022 Since IDL is executed directly without going through a shell like /bin/sh,
1023 this should be a list of strings like '(\"-rt=file\" \"-nw\") with a separate
1024 string for each argument. But you may also give a single string which
1025 contains the options whitespace-separated. Emacs will be kind enough to
1029 (repeat (string :value
"")))
1030 :group
'idlwave-external-programs
)
1032 (defcustom idlwave-help-application
"idlhelp"
1033 "*The external application providing reference help for programming.
1034 Obsolete, if the IDL Assistant is being used for help."
1035 :group
'idlwave-external-programs
1038 ;;; Some Shell variables which must be defined here.-----------------------
1040 (defcustom idlwave-shell-debug-modifiers
'()
1041 "List of modifiers to be used for the debugging commands.
1042 Will be used to bind debugging commands in the shell buffer and in all
1043 source buffers. These are additional convenience bindings, the debugging
1044 commands are always available with the `C-c C-d' prefix.
1045 If you set this to '(control shift), this means setting a breakpoint will
1046 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1047 are `control', `meta', `super', `hyper', `alt', and `shift'."
1048 :group
'idlwave-shell-general-setup
1049 :type
'(set :tag
"Specify modifiers"
1057 (defcustom idlwave-shell-automatic-start nil
1058 "*If non-nil attempt invoke idlwave-shell if not already running.
1059 This is checked when an attempt to send a command to an
1060 IDL process is made."
1061 :group
'idlwave-shell-general-setup
1064 ;;; Miscellaneous variables -------------------------------------------------
1066 (defgroup idlwave-misc nil
1067 "Miscellaneous options for IDLWAVE mode."
1068 :link
'(custom-group-link :tag
"Font Lock Faces group" font-lock-faces
)
1071 (defcustom idlwave-startup-message t
1072 "*Non-nil displays a startup message when `idlwave-mode' is first called."
1073 :group
'idlwave-misc
1076 (defcustom idlwave-default-font-lock-items
1077 '(pros-and-functions batch-files idlwave-idl-keywords label goto
1078 common-blocks class-arrows
)
1079 "Items which should be fontified on the default fontification level 2.
1080 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1081 is everything and level 2 is specified by this list.
1082 This variable must be set before IDLWAVE gets loaded. It is
1083 a list of symbols, the following symbols are allowed.
1085 pros-and-functions Procedure and Function definitions
1086 batch-files Batch Files
1087 idlwave-idl-keywords IDL Keywords
1088 label Statement Labels
1089 goto Goto Statements
1090 common-blocks Common Blocks
1091 keyword-parameters Keyword Parameters in routine definitions and calls
1092 system-variables System Variables
1093 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1094 class-arrows Object Arrows with class property"
1095 :group
'idlwave-misc
1098 (const :tag
"Procedure and Function definitions" pros-and-functions
)
1099 (const :tag
"Batch Files" batch-files
)
1100 (const :tag
"IDL Keywords (reserved words)" idlwave-idl-keywords
)
1101 (const :tag
"Statement Labels" label
)
1102 (const :tag
"Goto Statements" goto
)
1103 (const :tag
"Tags in Structure Definition" structtag
)
1104 (const :tag
"Structure Name" structname
)
1105 (const :tag
"Common Blocks" common-blocks
)
1106 (const :tag
"Keyword Parameters" keyword-parameters
)
1107 (const :tag
"System Variables" system-variables
)
1108 (const :tag
"FIXME: Warning" fixme
)
1109 (const :tag
"Object Arrows with class property " class-arrows
)))
1111 (defcustom idlwave-mode-hook nil
1112 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1113 :group
'idlwave-misc
1116 (defcustom idlwave-load-hook nil
1117 "Normal hook. Executed when idlwave.el is loaded."
1118 :group
'idlwave-misc
1121 (defvar idlwave-experimental nil
1122 "Non-nil means turn on a few experimental features.
1123 This variable is only for the maintainer, to test difficult stuff,
1124 while still distributing stable releases.
1125 As a user, you should not set this to t.")
1128 ;;; End customization variables section
1131 ;;; Non customization variables
1133 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1134 ;;; Simon Marshall <simon_at_gnu.ai.mit.edu>
1135 ;;; and Carsten Dominik...
1137 ;; The following are the reserved words in IDL. Maybe we should
1138 ;; highlight some more stuff as well?
1139 ;; Procedure declarations. Fontify keyword plus procedure name.
1140 (defvar idlwave-idl-keywords
1141 ;; To update this regexp, update the list of keywords and
1142 ;; evaluate the form.
1148 ;; '("||" "&&" "and" "or" "xor" "not"
1149 ;; "eq" "ge" "gt" "le" "lt" "ne"
1150 ;; "for" "do" "endfor"
1151 ;; "if" "then" "endif" "else" "endelse"
1152 ;; "case" "of" "endcase"
1153 ;; "switch" "break" "continue" "endswitch"
1155 ;; "repeat" "until" "endrep"
1156 ;; "while" "endwhile"
1159 ;; "compile_opt" "forward_function"
1160 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1162 "\\<\\(&&\\|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\\|||\\)\\>")
1165 (let* (;; Procedure declarations. Fontify keyword plus procedure name.
1166 ;; Function declarations. Fontify keyword plus function name.
1168 '("\\<\\(function\\|pro\\)\\>[ \t]+\\(\\sw+\\(::\\sw+\\)?\\)"
1169 (1 font-lock-keyword-face
)
1170 (2 font-lock-function-name-face nil t
)))
1174 '("\\<\\(common\\)\\>[ \t]*\\(\\sw+\\)?[ \t]*,?"
1175 (1 font-lock-keyword-face
) ; "common"
1176 (2 font-lock-reference-face nil t
) ; block name
1177 ("[ \t]*\\(\\sw+\\)[ ,]*"
1178 ;; Start with point after block name and comma
1179 (goto-char (match-end 0)) ; needed for XEmacs, could be nil
1181 (1 font-lock-variable-name-face
) ; variable names
1186 '("^[ \t]*\\(@[^ \t\n]+\\)" (1 font-lock-string-face
)))
1190 '("\\<FIXME:" (0 font-lock-warning-face t
)))
1194 '("^[ \t]*\\([a-zA-Z]\\sw*:\\)" (1 font-lock-reference-face
)))
1196 ;; The goto statement and its label
1198 '("\\(goto\\)[ \t]*,[ \t]*\\([a-zA-Z]\\sw*\\)"
1199 (1 font-lock-keyword-face
)
1200 (2 font-lock-reference-face
)))
1202 ;; Tags in structure definitions. Note that this definition
1203 ;; actually collides with labels, so we have to use the same
1204 ;; face. It also matches named subscript ranges,
1205 ;; e.g. vec{bottom:top]. No good way around this.
1207 '("\\<\\([a-zA-Z][a-zA-Z0-9_]*:\\)[^:]" (1 font-lock-reference-face
)))
1211 '("\\({\\|\\<inherits\\s-\\)\\s-*\\([a-zA-Z][a-zA-Z0-9_]*\\)[},\t \n]"
1212 (2 font-lock-function-name-face
)))
1214 ;; Keyword parameters, like /xlog or ,xrange=[]
1215 ;; This is anchored to the comma preceeding the keyword.
1216 ;; Treats continuation lines, works only during whole buffer
1217 ;; fontification. Slow, use it only in fancy fontification.
1219 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\([ \t]*\\(;.*\\)?\n\\)*[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1220 (6 font-lock-reference-face
)))
1222 ;; System variables start with a bang.
1224 '("\\(![a-zA-Z_0-9]+\\(\\.\\sw+\\)?\\)"
1225 (1 font-lock-variable-name-face
)))
1227 ;; Special and unusual operators (not used because too noisy)
1229 '("[<>#]" (0 font-lock-keyword-face
)))
1231 ;; All operators (not used because too noisy)
1233 '("[-*^#+<>/]" (0 font-lock-keyword-face
)))
1235 ;; Arrows with text property `idlwave-class'
1237 '(idlwave-match-class-arrows (0 idlwave-class-arrow-face
))))
1239 (defconst idlwave-font-lock-keywords-1
1240 (list pros-and-functions batch-files
)
1241 "Subdued level highlighting for IDLWAVE mode.")
1243 (defconst idlwave-font-lock-keywords-2
1244 (mapcar 'symbol-value idlwave-default-font-lock-items
)
1245 "Medium level highlighting for IDLWAVE mode.")
1247 (defconst idlwave-font-lock-keywords-3
1248 (list pros-and-functions
1250 idlwave-idl-keywords
1258 "Gaudy level highlighting for IDLWAVE mode."))
1260 (defun idlwave-match-class-arrows (limit)
1261 ;; Match an object arrow with class property
1262 (and idlwave-store-inquired-class
1263 (re-search-forward "->" limit
'limit
)
1264 (get-text-property (match-beginning 0) 'idlwave-class
)))
1266 (defvar idlwave-font-lock-keywords idlwave-font-lock-keywords-2
1267 "Default expressions to highlight in IDLWAVE mode.")
1269 (defvar idlwave-font-lock-defaults
1270 '((idlwave-font-lock-keywords
1271 idlwave-font-lock-keywords-1
1272 idlwave-font-lock-keywords-2
1273 idlwave-font-lock-keywords-3
)
1275 ((?$ .
"w") (?_ .
"w") (?. .
"w") (?| .
"w") (?
& .
"w"))
1278 (put 'idlwave-mode
'font-lock-defaults
1279 idlwave-font-lock-defaults
) ; XEmacs
1281 (defconst idlwave-comment-line-start-skip
"^[ \t]*;"
1282 "Regexp to match the start of a full-line comment.
1283 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1284 only by whitespace.")
1286 (defconst idlwave-begin-block-reg
1287 "\\<\\(pro\\|function\\|begin\\|case\\|switch\\)\\>"
1288 "Regular expression to find the beginning of a block. The case does
1289 not matter. The search skips matches in comments.")
1291 (defconst idlwave-begin-unit-reg
"^\\s-*\\(pro\\|function\\)\\>\\|\\`"
1292 "Regular expression to find the beginning of a unit. The case does
1295 (defconst idlwave-end-unit-reg
"^\\s-*\\(pro\\|function\\)\\>\\|\\'"
1296 "Regular expression to find the line that indicates the end of unit.
1297 This line is the end of buffer or the start of another unit. The case does
1298 not matter. The search skips matches in comments.")
1300 (defconst idlwave-continue-line-reg
"\\<\\$"
1301 "Regular expression to match a continued line.")
1303 (defconst idlwave-end-block-reg
1304 "\\<end\\(\\|case\\|switch\\|else\\|for\\|if\\|rep\\|while\\)\\>"
1305 "Regular expression to find the end of a block. The case does
1306 not matter. The search skips matches found in comments.")
1308 (defconst idlwave-block-matches
1310 ("function" .
"end")
1311 ("case" .
"endcase")
1312 ("else" .
"endelse")
1315 ("repeat" .
"endrep")
1316 ("switch" .
"endswitch")
1317 ("while" .
"endwhile"))
1318 "Matches between statements and the corresponding END variant.
1319 The cars are the reserved words starting a block. If the block really
1320 begins with BEGIN, the cars are the reserved words before the begin
1321 which can be used to identify the block type.
1322 This is used to check for the correct END type, to close blocks and
1323 to expand generic end statements to their detailed form.")
1325 (defconst idlwave-block-match-regexp
1326 "\\<\\(else\\|for\\|then\\|repeat\\|while\\)\\>"
1327 "Regular expression matching reserved words which can stand before
1328 blocks starting with a BEGIN statement. The matches must have associations
1329 `idlwave-block-matches'")
1331 (defconst idlwave-identifier
"[a-zA-Z_][a-zA-Z0-9$_]*"
1332 "Regular expression matching an IDL identifier.")
1334 (defconst idlwave-sysvar
(concat "!" idlwave-identifier
)
1335 "Regular expression matching IDL system variables.")
1337 (defconst idlwave-variable
(concat idlwave-identifier
"\\|" idlwave-sysvar
)
1338 "Regular expression matching IDL variable names.")
1340 (defconst idlwave-label
(concat idlwave-identifier
":")
1341 "Regular expression matching IDL labels.")
1343 (defconst idlwave-method-call
(concat idlwave-identifier
"\\s *->"
1344 "\\(\\s *" idlwave-identifier
"::\\)?"
1347 (defconst idlwave-statement-match
1349 ;; "endif else" is the only possible "end" that can be
1350 ;; followed by a statement on the same line.
1351 '(endelse .
("end\\(\\|if\\)\\s +else" "end\\(\\|if\\)\\s +else"))
1352 ;; all other "end"s can not be followed by a statement.
1353 (cons 'end
(list idlwave-end-block-reg nil
))
1354 '(if .
("if\\>" "then"))
1355 '(for .
("for\\>" "do"))
1356 '(begin .
("begin\\>" nil
))
1357 '(pdef .
("pro\\>\\|function\\>" nil
))
1358 '(while .
("while\\>" "do"))
1359 '(repeat .
("repeat\\>" "repeat"))
1360 '(goto .
("goto\\>" nil
))
1361 '(case .
("case\\>" nil
))
1362 '(switch .
("switch\\>" nil
))
1363 (cons 'call
(list (concat "\\(" idlwave-variable
"\\) *= *"
1364 "\\(" idlwave-method-call
"\\s *\\)?"
1367 (cons 'call
(list (concat
1368 "\\(" idlwave-method-call
"\\s *\\)?"
1370 "\\( *\\($\\|\\$\\)\\|\\s *,\\)") nil
))
1371 (cons 'assign
(list (concat
1372 "\\(" idlwave-variable
"\\) *=") nil
)))
1374 "Associated list of statement matching regular expressions.
1375 Each regular expression matches the start of an IDL statement. The
1376 first element of each association is a symbol giving the statement
1377 type. The associated value is a list. The first element of this list
1378 is a regular expression matching the start of an IDL statement for
1379 identifying the statement type. The second element of this list is a
1380 regular expression for finding a substatement for the type. The
1381 substatement starts after the end of the found match modulo
1382 whitespace. If it is nil then the statement has no substatement. The
1383 list order matters since matching an assignment statement exactly is
1384 not possible without parsing. Thus assignment statement become just
1385 the leftover unidentified statements containing an equal sign." )
1387 (defvar idlwave-fill-function
'auto-fill-function
1388 "IDL mode auto fill function.")
1390 (defvar idlwave-comment-indent-function
'comment-indent-function
1391 "IDL mode comment indent function.")
1393 ;; Note that this is documented in the v18 manuals as being a string
1394 ;; of length one rather than a single character.
1395 ;; The code in this file accepts either format for compatibility.
1396 (defvar idlwave-comment-indent-char ?\
1397 "Character to be inserted for IDL comment indentation.
1400 (defconst idlwave-continuation-char ?$
1401 "Character which is inserted as a last character on previous line by
1402 \\[idlwave-split-line] to begin a continuation line. Normally $.")
1404 (defconst idlwave-mode-version
"6.1_em22")
1406 (defmacro idlwave-keyword-abbrev
(&rest args
)
1407 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1409 ,(append '(idlwave-check-abbrev) args
))))
1411 ;; If I take the time I can replace idlwave-keyword-abbrev with
1412 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1413 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1414 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1415 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1417 (defmacro idlwave-code-abbrev
(&rest args
)
1418 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1419 Specifically, if the abbrev is in a comment or string it is unexpanded.
1420 Otherwise ARGS forms a list that is evaluated."
1422 ,(prin1-to-string args
) ;; Puts the code in the doc string
1423 (if (idlwave-quoted)
1424 (progn (unexpand-abbrev) nil
)
1427 (defvar idlwave-mode-map
(make-sparse-keymap)
1428 "Keymap used in IDL mode.")
1430 (defvar idlwave-mode-syntax-table
(make-syntax-table)
1431 "Syntax table in use in `idlwave-mode' buffers.")
1433 (modify-syntax-entry ?
+ "." idlwave-mode-syntax-table
)
1434 (modify-syntax-entry ?-
"." idlwave-mode-syntax-table
)
1435 (modify-syntax-entry ?
* "." idlwave-mode-syntax-table
)
1436 (modify-syntax-entry ?
/ "." idlwave-mode-syntax-table
)
1437 (modify-syntax-entry ?^
"." idlwave-mode-syntax-table
)
1438 (modify-syntax-entry ?
# "." idlwave-mode-syntax-table
)
1439 (modify-syntax-entry ?
= "." idlwave-mode-syntax-table
)
1440 (modify-syntax-entry ?%
"." idlwave-mode-syntax-table
)
1441 (modify-syntax-entry ?
< "." idlwave-mode-syntax-table
)
1442 (modify-syntax-entry ?
> "." idlwave-mode-syntax-table
)
1443 (modify-syntax-entry ?
\' "\"" idlwave-mode-syntax-table
)
1444 (modify-syntax-entry ?
\" "\"" idlwave-mode-syntax-table
)
1445 (modify-syntax-entry ?
\\ "." idlwave-mode-syntax-table
)
1446 (modify-syntax-entry ?_
"_" idlwave-mode-syntax-table
)
1447 (modify-syntax-entry ?
{ "(}" idlwave-mode-syntax-table
)
1448 (modify-syntax-entry ?
} "){" idlwave-mode-syntax-table
)
1449 (modify-syntax-entry ?$
"_" idlwave-mode-syntax-table
)
1450 (modify-syntax-entry ?.
"." idlwave-mode-syntax-table
)
1451 (modify-syntax-entry ?\
; "<" idlwave-mode-syntax-table)
1452 (modify-syntax-entry ?
\n ">" idlwave-mode-syntax-table
)
1453 (modify-syntax-entry ?
\f ">" idlwave-mode-syntax-table
)
1455 (defvar idlwave-find-symbol-syntax-table
1456 (copy-syntax-table idlwave-mode-syntax-table
)
1457 "Syntax table that treats symbol characters as word characters.")
1459 (modify-syntax-entry ?$
"w" idlwave-find-symbol-syntax-table
)
1460 (modify-syntax-entry ?_
"w" idlwave-find-symbol-syntax-table
)
1461 (modify-syntax-entry ?
! "w" idlwave-find-symbol-syntax-table
)
1462 (modify-syntax-entry ?.
"w" idlwave-find-symbol-syntax-table
)
1464 (defmacro idlwave-with-special-syntax
(&rest body
)
1465 "Execute BODY with a different syntax table."
1466 `(let ((saved-syntax (syntax-table)))
1469 (set-syntax-table idlwave-find-symbol-syntax-table
)
1471 (set-syntax-table saved-syntax
))))
1473 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1474 ; "Execute BODY with a different syntax table."
1475 ; `(let ((saved-syntax (syntax-table)))
1478 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1480 ; (set-syntax-table saved-syntax))))
1482 (defun idlwave-action-and-binding (key cmd
&optional select
)
1483 "KEY and CMD are made into a key binding and an indent action.
1484 KEY is a string - same as for the `define-key' function. CMD is a
1485 function of no arguments or a list to be evaluated. CMD is bound to
1486 KEY in `idlwave-mode-map' by defining an anonymous function calling
1487 `self-insert-command' followed by CMD. If KEY contains more than one
1488 character a binding will only be set if SELECT is 'both.
1490 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1491 replacing any previous value for KEY. If a binding is not set then it
1492 will instead be placed in `idlwave-indent-action-table'.
1494 If the optional argument SELECT is nil then an action and binding are
1495 created. If SELECT is 'noaction, then a binding is always set and no
1496 action is created. If SELECT is 'both then an action and binding
1497 will both be created even if KEY contains more than one character.
1498 Otherwise, if SELECT is non-nil then only an action is created.
1501 No spaces before and 1 after a comma
1502 (idlwave-action-and-binding \",\" '(idlwave-surround 0 1))
1503 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1504 (idlwave-action-and-binding \"=\" '(idlwave-expand-equal -1 -1))
1505 Capitalize system variables - action only
1506 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1507 (if (not (equal select
'noaction
))
1509 (let* ((table (if select
'idlwave-indent-action-table
1510 'idlwave-indent-expand-table
))
1511 (table-key (regexp-quote key
))
1512 (cell (assoc table-key
(eval table
))))
1514 ;; Replace action command
1517 (set table
(append (eval table
) (list (cons table-key cmd
)))))))
1518 ;; Make key binding for action
1519 (if (or (and (null select
) (= (length key
) 1))
1520 (equal select
'noaction
)
1521 (equal select
'both
))
1522 (define-key idlwave-mode-map key
1525 (self-insert-command 1))
1526 (list (if (listp cmd
)
1530 (fset 'idlwave-debug-map
(make-sparse-keymap))
1532 (define-key idlwave-mode-map
"\C-c " 'idlwave-hard-tab
)
1533 (define-key idlwave-mode-map
[(control tab
)] 'idlwave-hard-tab
)
1534 ;(define-key idlwave-mode-map "\C-c\C- " 'idlwave-hard-tab)
1535 (define-key idlwave-mode-map
"'" 'idlwave-show-matching-quote
)
1536 (define-key idlwave-mode-map
"\"" 'idlwave-show-matching-quote
)
1537 (define-key idlwave-mode-map
"\C-g" 'idlwave-keyboard-quit
)
1538 (define-key idlwave-mode-map
"\C-c;" 'idlwave-toggle-comment-region
)
1539 (define-key idlwave-mode-map
"\C-\M-a" 'idlwave-beginning-of-subprogram
)
1540 (define-key idlwave-mode-map
"\C-\M-e" 'idlwave-end-of-subprogram
)
1541 (define-key idlwave-mode-map
"\C-c{" 'idlwave-beginning-of-block
)
1542 (define-key idlwave-mode-map
"\C-c}" 'idlwave-end-of-block
)
1543 (define-key idlwave-mode-map
"\C-c]" 'idlwave-close-block
)
1544 (define-key idlwave-mode-map
[(meta control h
)] 'idlwave-mark-subprogram
)
1545 (define-key idlwave-mode-map
"\M-\C-n" 'idlwave-forward-block
)
1546 (define-key idlwave-mode-map
"\M-\C-p" 'idlwave-backward-block
)
1547 (define-key idlwave-mode-map
"\M-\C-d" 'idlwave-down-block
)
1548 (define-key idlwave-mode-map
"\M-\C-u" 'idlwave-backward-up-block
)
1549 (define-key idlwave-mode-map
"\M-\r" 'idlwave-split-line
)
1550 (define-key idlwave-mode-map
"\M-\C-q" 'idlwave-indent-subprogram
)
1551 (define-key idlwave-mode-map
"\C-c\C-p" 'idlwave-previous-statement
)
1552 (define-key idlwave-mode-map
"\C-c\C-n" 'idlwave-next-statement
)
1553 ;; (define-key idlwave-mode-map "\r" 'idlwave-newline)
1554 ;; (define-key idlwave-mode-map "\t" 'idlwave-indent-line)
1555 (define-key idlwave-mode-map
[(shift iso-lefttab
)] 'idlwave-indent-statement
)
1556 (define-key idlwave-mode-map
"\C-c\C-a" 'idlwave-auto-fill-mode
)
1557 (define-key idlwave-mode-map
"\M-q" 'idlwave-fill-paragraph
)
1558 (define-key idlwave-mode-map
"\M-s" 'idlwave-edit-in-idlde
)
1559 (define-key idlwave-mode-map
"\C-c\C-h" 'idlwave-doc-header
)
1560 (define-key idlwave-mode-map
"\C-c\C-m" 'idlwave-doc-modification
)
1561 (define-key idlwave-mode-map
"\C-c\C-c" 'idlwave-case
)
1562 (define-key idlwave-mode-map
"\C-c\C-d" 'idlwave-debug-map
)
1563 (when (and (boundp 'idlwave-shell-debug-modifiers
)
1564 (listp idlwave-shell-debug-modifiers
)
1565 (not (equal idlwave-shell-debug-modifiers
'())))
1566 ;; Bind the debug commands also with the special modifiers.
1567 (let ((shift (memq 'shift idlwave-shell-debug-modifiers
))
1568 (mods-noshift (delq 'shift
1569 (copy-sequence idlwave-shell-debug-modifiers
))))
1570 (define-key idlwave-mode-map
1571 (vector (append mods-noshift
(list (if shift ?C ?c
))))
1572 'idlwave-shell-save-and-run
)
1573 (define-key idlwave-mode-map
1574 (vector (append mods-noshift
(list (if shift ?B ?b
))))
1575 'idlwave-shell-break-here
)
1576 (define-key idlwave-mode-map
1577 (vector (append mods-noshift
(list (if shift ?E ?e
))))
1578 'idlwave-shell-run-region
)))
1579 (define-key idlwave-mode-map
"\C-c\C-d\C-c" 'idlwave-shell-save-and-run
)
1580 (define-key idlwave-mode-map
"\C-c\C-d\C-b" 'idlwave-shell-break-here
)
1581 (define-key idlwave-mode-map
"\C-c\C-d\C-e" 'idlwave-shell-run-region
)
1582 (define-key idlwave-mode-map
"\C-c\C-f" 'idlwave-for
)
1583 ;; (define-key idlwave-mode-map "\C-c\C-f" 'idlwave-function)
1584 ;; (define-key idlwave-mode-map "\C-c\C-p" 'idlwave-procedure)
1585 (define-key idlwave-mode-map
"\C-c\C-r" 'idlwave-repeat
)
1586 (define-key idlwave-mode-map
"\C-c\C-w" 'idlwave-while
)
1587 (define-key idlwave-mode-map
"\C-c\C-k" 'idlwave-kill-autoloaded-buffers
)
1588 (define-key idlwave-mode-map
"\C-c\C-s" 'idlwave-shell
)
1589 (define-key idlwave-mode-map
"\C-c\C-l" 'idlwave-shell-recenter-shell-window
)
1590 (define-key idlwave-mode-map
"\C-c\C-b" 'idlwave-list-buffer-load-path-shadows
)
1591 (autoload 'idlwave-shell
"idlw-shell"
1592 "Run an inferior IDL, with I/O through buffer `(idlwave-shell-buffer)'." t
)
1593 (autoload 'idlwave-shell-send-command
"idlw-shell")
1594 (autoload 'idlwave-shell-recenter-shell-window
"idlw-shell"
1595 "Run `idlwave-shell' and switch back to current window" t
)
1596 (autoload 'idlwave-shell-save-and-run
"idlw-shell"
1597 "Save and run buffer under the shell." t
)
1598 (autoload 'idlwave-shell-break-here
"idlw-shell"
1599 "Set breakpoint in current line." t
)
1600 (autoload 'idlwave-shell-run-region
"idlw-shell"
1601 "Compile and run the region." t
)
1602 (define-key idlwave-mode-map
"\C-c\C-v" 'idlwave-find-module
)
1603 (define-key idlwave-mode-map
"\C-c\C-t" 'idlwave-find-module-this-file
)
1604 (define-key idlwave-mode-map
"\C-c?" 'idlwave-routine-info
)
1605 (define-key idlwave-mode-map
"\M-?" 'idlwave-context-help
)
1606 (define-key idlwave-mode-map
[(control meta ?
\?)]
1607 'idlwave-help-assistant-help-with-topic
)
1608 ;; Pickup both forms of Esc/Meta binding
1609 (define-key idlwave-mode-map
[(meta tab
)] 'idlwave-complete
)
1610 (define-key idlwave-mode-map
[?\e?
\t] 'idlwave-complete
)
1611 (define-key idlwave-mode-map
"\M-\C-i" 'idlwave-complete
)
1612 (define-key idlwave-mode-map
"\C-c\C-i" 'idlwave-update-routine-info
)
1613 (define-key idlwave-mode-map
"\C-c=" 'idlwave-resolve
)
1614 (define-key idlwave-mode-map
1615 (if (featurep 'xemacs
) [(shift button3
)] [(shift mouse-3
)])
1616 'idlwave-mouse-context-help
)
1618 ;; Set action and key bindings.
1619 ;; See description of the function `idlwave-action-and-binding'.
1620 ;; Automatically add spaces for the following characters
1622 ;; Actions for & are complicated by &&
1623 (idlwave-action-and-binding "&" 'idlwave-custom-ampersand-surround
)
1625 ;; Automatically add spaces to equal sign if not keyword. This needs
1626 ;; to go ahead of > and <, so >= and <= will be treated correctly
1627 (idlwave-action-and-binding "=" '(idlwave-expand-equal -
1 -
1))
1629 ;; Actions for > and < are complicated by >=, <=, and ->...
1630 (idlwave-action-and-binding "<" '(idlwave-custom-ltgtr-surround nil
))
1631 (idlwave-action-and-binding ">" '(idlwave-custom-ltgtr-surround 'gtr
))
1633 (idlwave-action-and-binding "," '(idlwave-surround 0 -
1 1))
1639 ;;; When expanding abbrevs and the abbrev hook moves backward, an extra
1640 ;;; space is inserted (this is the space typed by the user to expanded
1643 (defvar idlwave-mode-abbrev-table nil
1644 "Abbreviation table used for IDLWAVE mode")
1645 (define-abbrev-table 'idlwave-mode-abbrev-table
())
1647 (defun idlwave-define-abbrev (name expansion hook
&optional noprefix table
)
1648 "Define-abbrev with backward compatibility.
1650 If NOPREFIX is non-nil, don't prepend prefix character. Installs into
1651 idlwave-mode-abbrev-table unless TABLE is non-nil."
1652 (let ((abbrevs-changed nil
) ;; mask the current value to avoid save
1653 (args (list (or table idlwave-mode-abbrev-table
)
1654 (if noprefix name
(concat idlwave-abbrev-start-char name
))
1658 (apply 'define-abbrev
(append args
'(0 t
)))
1659 (error (apply 'define-abbrev args
)))))
1662 (modify-syntax-entry (string-to-char idlwave-abbrev-start-char
)
1663 "w" idlwave-mode-syntax-table
)
1669 (idlwave-define-abbrev "c" "" (idlwave-code-abbrev idlwave-case
))
1670 (idlwave-define-abbrev "sw" "" (idlwave-code-abbrev idlwave-switch
))
1671 (idlwave-define-abbrev "f" "" (idlwave-code-abbrev idlwave-for
))
1672 (idlwave-define-abbrev "fu" "" (idlwave-code-abbrev idlwave-function
))
1673 (idlwave-define-abbrev "pr" "" (idlwave-code-abbrev idlwave-procedure
))
1674 (idlwave-define-abbrev "r" "" (idlwave-code-abbrev idlwave-repeat
))
1675 (idlwave-define-abbrev "w" "" (idlwave-code-abbrev idlwave-while
))
1676 (idlwave-define-abbrev "i" "" (idlwave-code-abbrev idlwave-if
))
1677 (idlwave-define-abbrev "elif" "" (idlwave-code-abbrev idlwave-elif
))
1679 ;; Keywords, system functions, conversion routines
1681 (idlwave-define-abbrev "ap" "arg_present()" (idlwave-keyword-abbrev 1))
1682 (idlwave-define-abbrev "b" "begin" (idlwave-keyword-abbrev 0 t
))
1683 (idlwave-define-abbrev "co" "common" (idlwave-keyword-abbrev 0 t
))
1684 (idlwave-define-abbrev "cb" "byte()" (idlwave-keyword-abbrev 1))
1685 (idlwave-define-abbrev "cx" "fix()" (idlwave-keyword-abbrev 1))
1686 (idlwave-define-abbrev "cl" "long()" (idlwave-keyword-abbrev 1))
1687 (idlwave-define-abbrev "cf" "float()" (idlwave-keyword-abbrev 1))
1688 (idlwave-define-abbrev "cs" "string()" (idlwave-keyword-abbrev 1))
1689 (idlwave-define-abbrev "cc" "complex()" (idlwave-keyword-abbrev 1))
1690 (idlwave-define-abbrev "cd" "double()" (idlwave-keyword-abbrev 1))
1691 (idlwave-define-abbrev "e" "else" (idlwave-keyword-abbrev 0 t
))
1692 (idlwave-define-abbrev "ec" "endcase" 'idlwave-show-begin
)
1693 (idlwave-define-abbrev "es" "endswitch" 'idlwave-show-begin
)
1694 (idlwave-define-abbrev "ee" "endelse" 'idlwave-show-begin
)
1695 (idlwave-define-abbrev "ef" "endfor" 'idlwave-show-begin
)
1696 (idlwave-define-abbrev "ei" "endif else if" 'idlwave-show-begin
)
1697 (idlwave-define-abbrev "el" "endif else" 'idlwave-show-begin
)
1698 (idlwave-define-abbrev "en" "endif" 'idlwave-show-begin
)
1699 (idlwave-define-abbrev "er" "endrep" 'idlwave-show-begin
)
1700 (idlwave-define-abbrev "ew" "endwhile" 'idlwave-show-begin
)
1701 (idlwave-define-abbrev "g" "goto," (idlwave-keyword-abbrev 0 t
))
1702 (idlwave-define-abbrev "h" "help," (idlwave-keyword-abbrev 0))
1703 (idlwave-define-abbrev "k" "keyword_set()" (idlwave-keyword-abbrev 1))
1704 (idlwave-define-abbrev "n" "n_elements()" (idlwave-keyword-abbrev 1))
1705 (idlwave-define-abbrev "on" "on_error," (idlwave-keyword-abbrev 0))
1706 (idlwave-define-abbrev "oi" "on_ioerror," (idlwave-keyword-abbrev 0 1))
1707 (idlwave-define-abbrev "ow" "openw," (idlwave-keyword-abbrev 0))
1708 (idlwave-define-abbrev "or" "openr," (idlwave-keyword-abbrev 0))
1709 (idlwave-define-abbrev "ou" "openu," (idlwave-keyword-abbrev 0))
1710 (idlwave-define-abbrev "p" "print," (idlwave-keyword-abbrev 0))
1711 (idlwave-define-abbrev "pt" "plot," (idlwave-keyword-abbrev 0))
1712 (idlwave-define-abbrev "re" "read," (idlwave-keyword-abbrev 0))
1713 (idlwave-define-abbrev "rf" "readf," (idlwave-keyword-abbrev 0))
1714 (idlwave-define-abbrev "ru" "readu," (idlwave-keyword-abbrev 0))
1715 (idlwave-define-abbrev "rt" "return" (idlwave-keyword-abbrev 0))
1716 (idlwave-define-abbrev "sc" "strcompress()" (idlwave-keyword-abbrev 1))
1717 (idlwave-define-abbrev "sn" "strlen()" (idlwave-keyword-abbrev 1))
1718 (idlwave-define-abbrev "sl" "strlowcase()" (idlwave-keyword-abbrev 1))
1719 (idlwave-define-abbrev "su" "strupcase()" (idlwave-keyword-abbrev 1))
1720 (idlwave-define-abbrev "sm" "strmid()" (idlwave-keyword-abbrev 1))
1721 (idlwave-define-abbrev "sp" "strpos()" (idlwave-keyword-abbrev 1))
1722 (idlwave-define-abbrev "st" "strput()" (idlwave-keyword-abbrev 1))
1723 (idlwave-define-abbrev "sr" "strtrim()" (idlwave-keyword-abbrev 1))
1724 (idlwave-define-abbrev "t" "then" (idlwave-keyword-abbrev 0 t
))
1725 (idlwave-define-abbrev "u" "until" (idlwave-keyword-abbrev 0 t
))
1726 (idlwave-define-abbrev "wu" "writeu," (idlwave-keyword-abbrev 0))
1727 (idlwave-define-abbrev "iap" "if arg_present() then" (idlwave-keyword-abbrev 6))
1728 (idlwave-define-abbrev "ik" "if keyword_set() then" (idlwave-keyword-abbrev 6))
1729 (idlwave-define-abbrev "ine" "if n_elements() eq 0 then" (idlwave-keyword-abbrev 11))
1730 (idlwave-define-abbrev "inn" "if n_elements() ne 0 then" (idlwave-keyword-abbrev 11))
1731 (idlwave-define-abbrev "np" "n_params()" (idlwave-keyword-abbrev 0))
1732 (idlwave-define-abbrev "s" "size()" (idlwave-keyword-abbrev 1))
1733 (idlwave-define-abbrev "wi" "widget_info()" (idlwave-keyword-abbrev 1))
1734 (idlwave-define-abbrev "wc" "widget_control," (idlwave-keyword-abbrev 0))
1735 (idlwave-define-abbrev "pv" "ptr_valid()" (idlwave-keyword-abbrev 1))
1736 (idlwave-define-abbrev "ipv" "if ptr_valid() then" (idlwave-keyword-abbrev 6))
1738 ;; This section is reserved words only. (From IDL user manual)
1740 (idlwave-define-abbrev "and" "and" (idlwave-keyword-abbrev 0 t
) t
)
1741 (idlwave-define-abbrev "begin" "begin" (idlwave-keyword-abbrev 0 t
) t
)
1742 (idlwave-define-abbrev "break" "break" (idlwave-keyword-abbrev 0 t
) t
)
1743 (idlwave-define-abbrev "case" "case" (idlwave-keyword-abbrev 0 t
) t
)
1744 (idlwave-define-abbrev "common" "common" (idlwave-keyword-abbrev 0 t
) t
)
1745 (idlwave-define-abbrev "continue" "continue" (idlwave-keyword-abbrev 0 t
) t
)
1746 (idlwave-define-abbrev "do" "do" (idlwave-keyword-abbrev 0 t
) t
)
1747 (idlwave-define-abbrev "else" "else" (idlwave-keyword-abbrev 0 t
) t
)
1748 (idlwave-define-abbrev "end" "end" 'idlwave-show-begin-check t
)
1749 (idlwave-define-abbrev "endcase" "endcase" 'idlwave-show-begin-check t
)
1750 (idlwave-define-abbrev "endelse" "endelse" 'idlwave-show-begin-check t
)
1751 (idlwave-define-abbrev "endfor" "endfor" 'idlwave-show-begin-check t
)
1752 (idlwave-define-abbrev "endif" "endif" 'idlwave-show-begin-check t
)
1753 (idlwave-define-abbrev "endrep" "endrep" 'idlwave-show-begin-check t
)
1754 (idlwave-define-abbrev "endswitch" "endswitch" 'idlwave-show-begin-check t
)
1755 (idlwave-define-abbrev "endwhi" "endwhi" 'idlwave-show-begin-check t
)
1756 (idlwave-define-abbrev "endwhile" "endwhile" 'idlwave-show-begin-check t
)
1757 (idlwave-define-abbrev "eq" "eq" (idlwave-keyword-abbrev 0 t
) t
)
1758 (idlwave-define-abbrev "for" "for" (idlwave-keyword-abbrev 0 t
) t
)
1759 (idlwave-define-abbrev "function" "function" (idlwave-keyword-abbrev 0 t
) t
)
1760 (idlwave-define-abbrev "ge" "ge" (idlwave-keyword-abbrev 0 t
) t
)
1761 (idlwave-define-abbrev "goto" "goto" (idlwave-keyword-abbrev 0 t
) t
)
1762 (idlwave-define-abbrev "gt" "gt" (idlwave-keyword-abbrev 0 t
) t
)
1763 (idlwave-define-abbrev "if" "if" (idlwave-keyword-abbrev 0 t
) t
)
1764 (idlwave-define-abbrev "le" "le" (idlwave-keyword-abbrev 0 t
) t
)
1765 (idlwave-define-abbrev "lt" "lt" (idlwave-keyword-abbrev 0 t
) t
)
1766 (idlwave-define-abbrev "mod" "mod" (idlwave-keyword-abbrev 0 t
) t
)
1767 (idlwave-define-abbrev "ne" "ne" (idlwave-keyword-abbrev 0 t
) t
)
1768 (idlwave-define-abbrev "not" "not" (idlwave-keyword-abbrev 0 t
) t
)
1769 (idlwave-define-abbrev "of" "of" (idlwave-keyword-abbrev 0 t
) t
)
1770 (idlwave-define-abbrev "on_ioerror" "on_ioerror" (idlwave-keyword-abbrev 0 t
) t
)
1771 (idlwave-define-abbrev "or" "or" (idlwave-keyword-abbrev 0 t
) t
)
1772 (idlwave-define-abbrev "pro" "pro" (idlwave-keyword-abbrev 0 t
) t
)
1773 (idlwave-define-abbrev "repeat" "repeat" (idlwave-keyword-abbrev 0 t
) t
)
1774 (idlwave-define-abbrev "switch" "switch" (idlwave-keyword-abbrev 0 t
) t
)
1775 (idlwave-define-abbrev "then" "then" (idlwave-keyword-abbrev 0 t
) t
)
1776 (idlwave-define-abbrev "until" "until" (idlwave-keyword-abbrev 0 t
) t
)
1777 (idlwave-define-abbrev "while" "while" (idlwave-keyword-abbrev 0 t
) t
)
1778 (idlwave-define-abbrev "xor" "xor" (idlwave-keyword-abbrev 0 t
) t
)
1780 (defvar imenu-create-index-function
)
1781 (defvar extract-index-name-function
)
1782 (defvar prev-index-position-function
)
1783 (defvar imenu-extract-index-name-function
)
1784 (defvar imenu-prev-index-position-function
)
1785 ;; defined later - so just make the compiler hush
1786 (defvar idlwave-mode-menu
)
1787 (defvar idlwave-mode-debug-menu
)
1790 (defun idlwave-mode ()
1791 "Major mode for editing IDL source files (version 6.1_em22).
1793 The main features of this mode are
1795 1. Indentation and Formatting
1796 --------------------------
1797 Like other Emacs programming modes, C-j inserts a newline and indents.
1798 TAB is used for explicit indentation of the current line.
1800 To start a continuation line, use \\[idlwave-split-line]. This
1801 function can also be used in the middle of a line to split the line
1802 at that point. When used inside a long constant string, the string
1803 is split at that point with the `+' concatenation operator.
1805 Comments are indented as follows:
1807 `;;;' Indentation remains unchanged.
1808 `;;' Indent like the surrounding code
1809 `;' Indent to a minimum column.
1811 The indentation of comments starting in column 0 is never changed.
1813 Use \\[idlwave-fill-paragraph] to refill a paragraph inside a
1814 comment. The indentation of the second line of the paragraph
1815 relative to the first will be retained. Use
1816 \\[idlwave-auto-fill-mode] to toggle auto-fill mode for these
1817 comments. When the variable `idlwave-fill-comment-line-only' is
1818 nil, code can also be auto-filled and auto-indented.
1820 To convert pre-existing IDL code to your formatting style, mark the
1821 entire buffer with \\[mark-whole-buffer] and execute
1822 \\[idlwave-expand-region-abbrevs]. Then mark the entire buffer
1823 again followed by \\[indent-region] (`indent-region').
1827 IDLWAVE displays information about the calling sequence and the
1828 accepted keyword parameters of a procedure or function with
1829 \\[idlwave-routine-info]. \\[idlwave-find-module] jumps to the
1830 source file of a module. These commands know about system
1831 routines, all routines in idlwave-mode buffers and (when the
1832 idlwave-shell is active) about all modules currently compiled under
1833 this shell. It also makes use of pre-compiled or custom-scanned
1834 user and library catalogs many popular libraries ship with by
1835 default. Use \\[idlwave-update-routine-info] to update this
1836 information, which is also used for completion (see item 4).
1841 \\[idlwave-context-help] displays the IDL documentation relevant
1842 for the system variable, keyword, or routines at point. A single
1843 key stroke gets you directly to the right place in the docs. See
1844 the manual to configure where and how the HTML help is displayed.
1848 \\[idlwave-complete] completes the names of procedures, functions
1849 class names, keyword parameters, system variables and tags, class
1850 tags, structure tags, filenames and much more. It is context
1851 sensitive and figures out what is expected at point. Lower case
1852 strings are completed in lower case, other strings in mixed or
1855 5. Code Templates and Abbreviations
1856 --------------------------------
1857 Many Abbreviations are predefined to expand to code fragments and templates.
1858 The abbreviations start generally with a `\\`. Some examples
1860 \\pr PROCEDURE template
1861 \\fu FUNCTION template
1862 \\c CASE statement template
1863 \\sw SWITCH statement template
1864 \\f FOR loop template
1865 \\r REPEAT Loop template
1866 \\w WHILE loop template
1867 \\i IF statement template
1868 \\elif IF-ELSE statement template
1871 For a full list, use \\[idlwave-list-abbrevs]. Some templates also
1872 have direct keybindings - see the list of keybindings below.
1874 \\[idlwave-doc-header] inserts a documentation header at the
1875 beginning of the current program unit (pro, function or main).
1876 Change log entries can be added to the current program unit with
1877 \\[idlwave-doc-modification].
1879 6. Automatic Case Conversion
1880 -------------------------
1881 The case of reserved words and some abbrevs is controlled by
1882 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1884 7. Automatic END completion
1885 ------------------------
1886 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1887 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1891 Loading idlwave.el runs `idlwave-load-hook'.
1892 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1894 9. Documentation and Customization
1895 -------------------------------
1896 Info documentation for this package is available. Use
1897 \\[idlwave-info] to display (complain to your sysadmin if that does
1898 not work). For Postscript, PDF, and HTML versions of the
1899 documentation, check IDLWAVE's homepage at `http://idlwave.org'.
1900 IDLWAVE has customize support - see the group `idlwave'.
1904 Here is a list of all keybindings of this mode.
1905 If some of the key bindings below show with ??, use \\[describe-key]
1906 followed by the key sequence to see what the key sequence does.
1908 \\{idlwave-mode-map}"
1911 (kill-all-local-variables)
1913 (if idlwave-startup-message
1914 (message "Emacs IDLWAVE mode version %s." idlwave-mode-version
))
1915 (setq idlwave-startup-message nil
)
1917 (setq local-abbrev-table idlwave-mode-abbrev-table
)
1918 (set-syntax-table idlwave-mode-syntax-table
)
1920 (set (make-local-variable 'indent-line-function
) 'idlwave-indent-and-action
)
1922 (make-local-variable idlwave-comment-indent-function
)
1923 (set idlwave-comment-indent-function
'idlwave-comment-hook
)
1925 (set (make-local-variable 'comment-start-skip
) ";+[ \t]*")
1926 (set (make-local-variable 'comment-start
) ";")
1927 (set (make-local-variable 'comment-add
) 1) ; ";;" for new and regions
1928 (set (make-local-variable 'require-final-newline
) t
)
1929 (set (make-local-variable 'abbrev-all-caps
) t
)
1930 (set (make-local-variable 'indent-tabs-mode
) nil
)
1931 (set (make-local-variable 'completion-ignore-case
) t
)
1933 (use-local-map idlwave-mode-map
)
1935 (when (featurep 'easymenu
)
1936 (easy-menu-add idlwave-mode-menu idlwave-mode-map
)
1937 (easy-menu-add idlwave-mode-debug-menu idlwave-mode-map
))
1939 (setq mode-name
"IDLWAVE")
1940 (setq major-mode
'idlwave-mode
)
1941 (setq abbrev-mode t
)
1943 (set (make-local-variable idlwave-fill-function
) 'idlwave-auto-fill
)
1944 (setq comment-end
"")
1945 (set (make-local-variable 'comment-multi-line
) nil
)
1946 (set (make-local-variable 'paragraph-separate
)
1947 "[ \t\f]*$\\|[ \t]*;+[ \t]*$\\|;+[+=-_*]+$")
1948 (set (make-local-variable 'paragraph-start
) "[ \t\f]\\|[ \t]*;+[ \t]")
1949 (set (make-local-variable 'paragraph-ignore-fill-prefix
) nil
)
1950 (set (make-local-variable 'parse-sexp-ignore-comments
) t
)
1953 (set (make-local-variable 'add-log-current-defun-function
)
1954 'idlwave-current-routine-fullname
)
1956 ;; Set tag table list to use IDLTAGS as file name.
1957 (if (boundp 'tag-table-alist
)
1958 (add-to-list 'tag-table-alist
'("\\.pro$" .
"IDLTAGS")))
1960 ;; Font-lock additions
1961 ;; Following line is for Emacs - XEmacs uses the corresponding property
1962 ;; on the `idlwave-mode' symbol.
1963 (set (make-local-variable 'font-lock-defaults
) idlwave-font-lock-defaults
)
1964 (set (make-local-variable 'font-lock-mark-block-function
)
1965 'idlwave-mark-subprogram
)
1966 (set (make-local-variable 'font-lock-fontify-region-function
)
1967 'idlwave-font-lock-fontify-region
)
1970 (set (make-local-variable 'imenu-create-index-function
)
1971 'imenu-default-create-index-function
)
1972 (set (make-local-variable 'imenu-extract-index-name-function
)
1974 (set (make-local-variable 'imenu-prev-index-position-function
)
1975 'idlwave-prev-index-position
)
1978 (add-to-list 'hs-special-modes-alist
1980 idlwave-begin-block-reg
1981 idlwave-end-block-reg
1983 'idlwave-forward-block nil
))
1985 ;; Make a local post-command-hook and add our hook to it
1986 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1987 ;; (make-local-hook 'post-command-hook)
1988 (add-hook 'post-command-hook
'idlwave-command-hook nil
'local
)
1990 ;; Make local hooks for buffer updates
1991 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1992 ;; (make-local-hook 'kill-buffer-hook)
1993 (add-hook 'kill-buffer-hook
'idlwave-kill-buffer-update nil
'local
)
1994 ;; (make-local-hook 'after-save-hook)
1995 (add-hook 'after-save-hook
'idlwave-save-buffer-update nil
'local
)
1996 (add-hook 'after-save-hook
'idlwave-revoke-license-to-kill nil
'local
)
1998 ;; Setup directories and file, if necessary
2001 ;; Update the routine info with info about current buffer?
2002 (idlwave-new-buffer-update)
2004 ;; Check help location
2005 (idlwave-help-check-locations)
2007 ;; Run the mode hook
2008 (run-mode-hooks 'idlwave-mode-hook
))
2010 (defvar idlwave-setup-done nil
)
2011 (defun idlwave-setup ()
2012 (unless idlwave-setup-done
2013 (if (not (file-directory-p idlwave-config-directory
))
2014 (make-directory idlwave-config-directory
))
2016 idlwave-user-catalog-file
(expand-file-name
2017 idlwave-user-catalog-file
2018 idlwave-config-directory
)
2019 idlwave-xml-system-rinfo-converted-file
2021 idlwave-xml-system-rinfo-converted-file
2022 idlwave-config-directory
)
2023 idlwave-path-file
(expand-file-name
2025 idlwave-config-directory
))
2026 (idlwave-read-paths) ; we may need these early
2027 (setq idlwave-setup-done t
)))
2029 (defun idlwave-font-lock-fontify-region (beg end
&optional verbose
)
2030 "Fontify continuation lines correctly."
2035 (when (setq pos
(idlwave-is-continuation-line))
2037 (idlwave-beginning-of-statement)
2038 (setq beg
(point)))))
2039 (font-lock-default-fontify-region beg end verbose
))
2042 ;; Code Formatting ----------------------------------------------------
2045 (defun idlwave-hard-tab ()
2046 "Inserts TAB in buffer in current position."
2050 ;;; This stuff is experimental
2052 (defvar idlwave-command-hook nil
2053 "If non-nil, a list that can be evaluated using `eval'.
2054 It is evaluated in the lisp function `idlwave-command-hook' which is
2055 placed in `post-command-hook'.")
2057 (defun idlwave-command-hook ()
2058 "Command run after every command.
2059 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
2060 sets the variable to zero afterwards."
2061 (and idlwave-command-hook
2062 (listp idlwave-command-hook
)
2064 (eval idlwave-command-hook
)
2066 (setq idlwave-command-hook nil
))
2070 ;; It would be better to use expand.el for better abbrev handling and
2073 (defun idlwave-check-abbrev (arg &optional reserved
)
2074 "Reverses abbrev expansion if in comment or string.
2075 Argument ARG is the number of characters to move point
2076 backward if `idlwave-abbrev-move' is non-nil.
2077 If optional argument RESERVED is non-nil then the expansion
2078 consists of reserved words, which will be capitalized if
2079 `idlwave-reserved-word-upcase' is non-nil.
2080 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2081 is non-nil, unless its value is \`down in which case the abbrev will be
2082 made into all lowercase.
2083 Returns non-nil if abbrev is left expanded."
2084 (if (idlwave-quoted)
2085 (progn (unexpand-abbrev)
2087 (if (and reserved idlwave-reserved-word-upcase
)
2088 (upcase-region last-abbrev-location
(point))
2090 ((equal idlwave-abbrev-change-case
'down
)
2091 (downcase-region last-abbrev-location
(point)))
2092 (idlwave-abbrev-change-case
2093 (upcase-region last-abbrev-location
(point)))))
2094 (if (and idlwave-abbrev-move
(> arg
0))
2095 (if (boundp 'post-command-hook
)
2096 (setq idlwave-command-hook
(list 'backward-char
(1+ arg
)))
2097 (backward-char arg
)))
2100 (defun idlwave-in-comment ()
2101 "Returns t if point is inside a comment, nil otherwise."
2103 (let ((here (point)))
2104 (and (idlwave-goto-comment) (> here
(point))))))
2106 (defun idlwave-goto-comment ()
2107 "Move to start of comment delimiter on current line.
2108 Moves to end of line if there is no comment delimiter.
2109 Ignores comment delimiters in strings.
2110 Returns point if comment found and nil otherwise."
2111 (let ((eos (progn (end-of-line) (point)))
2114 ;; Look for first comment delimiter not in a string
2116 (setq found
(search-forward comment-start eos
'lim
))
2117 (while (and found
(idlwave-in-quote))
2118 (setq found
(search-forward comment-start eos
'lim
)))
2119 (store-match-data data
)
2120 (and found
(not (idlwave-in-quote))
2125 (defvar transient-mark-mode
)
2126 (defvar zmacs-regions
)
2127 (defvar mark-active
)
2128 (defun idlwave-region-active-p ()
2129 "Is transient-mark-mode on and the region active?
2130 Works on both Emacs and XEmacs."
2131 (if (featurep 'xemacs
)
2132 (and zmacs-regions
(region-active-p))
2133 (and transient-mark-mode mark-active
)))
2135 (defun idlwave-show-matching-quote ()
2136 "Insert quote and show matching quote if this is end of a string."
2138 (let ((bq (idlwave-in-quote))
2139 (inq last-command-char
))
2140 (if (and bq
(not (idlwave-in-comment)))
2141 (let ((delim (char-after bq
)))
2147 ;; Not the end of a string
2150 (defun idlwave-show-begin-check ()
2151 "Ensure that the previous word was a token before `idlwave-show-begin'.
2152 An END token must be preceded by whitespace."
2153 (if (not (idlwave-quoted))
2158 (looking-at "[ \t\n\f]"))
2159 (idlwave-show-begin))))
2161 (defun idlwave-show-begin ()
2162 "Finds the start of current block and blinks to it for a second.
2163 Also checks if the correct end statement has been used."
2164 ;; All end statements are reserved words
2165 ;; Re-indent end line
2166 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2168 (let* ((pos (point-marker))
2169 (last-abbrev-marker (copy-marker last-abbrev-location
))
2170 (eol-pos (save-excursion (end-of-line) (point)))
2171 begin-pos end-pos end end1
)
2172 (if idlwave-reindent-end
(idlwave-indent-line))
2173 (setq last-abbrev-location
(marker-position last-abbrev-marker
))
2174 (when (and (idlwave-check-abbrev 0 t
)
2177 ;; Move inside current block
2178 (goto-char last-abbrev-marker
)
2179 (idlwave-block-jump-out -
1 'nomark
)
2180 (setq begin-pos
(point))
2181 (idlwave-block-jump-out 1 'nomark
)
2182 (setq end-pos
(point))
2183 (if (> end-pos eol-pos
)
2186 (setq end
(buffer-substring
2188 (skip-chars-backward "a-zA-Z")
2191 (goto-char begin-pos
)
2192 (when (setq end1
(cdr (idlwave-block-master)))
2194 ((null end1
)) ; no-operation
2195 ((string= (downcase end
) (downcase end1
))
2197 ((string= (downcase end
) "end")
2199 (if idlwave-expand-generic-end
2203 (insert (if (string= end
"END") (upcase end1
) end1
))
2208 (message "Warning: Shouldn't this be \"%s\" instead of \"%s\"?"
2213 (defun idlwave-block-master ()
2214 (let ((case-fold-search t
))
2217 ((looking-at "pro\\|case\\|switch\\|function\\>")
2218 (assoc (downcase (match-string 0)) idlwave-block-matches
))
2219 ((looking-at "begin\\>")
2220 (let ((limit (save-excursion
2221 (idlwave-beginning-of-statement)
2224 ((re-search-backward ":[ \t]*\\=" limit t
)
2225 ;; seems to be a case thing
2227 ((re-search-backward idlwave-block-match-regexp limit t
)
2228 (assoc (downcase (match-string 1))
2229 idlwave-block-matches
))
2231 ;; Just a normal block
2232 '("begin" .
"end")))))
2235 (defun idlwave-close-block ()
2236 "Terminate the current block with the correct END statement."
2238 ;; Start new line if we are not in a new line
2239 (unless (save-excursion
2240 (skip-chars-backward " \t")
2242 (let ((idlwave-show-block nil
))
2243 (newline-and-indent)))
2244 (let ((last-abbrev-location (point))) ; for upcasing
2246 (idlwave-show-begin)))
2248 (defun idlwave-custom-ampersand-surround (&optional is-action
)
2249 "Surround &, leaving room for && (which surrround as well)."
2250 (let* ((prev-char (char-after (- (point) 2)))
2251 (next-char (char-after (point)))
2252 (amp-left (eq prev-char ?
&))
2253 (amp-right (eq next-char ?
&))
2254 (len (if amp-left
2 1)))
2255 (unless amp-right
;no need to do it twice, amp-left will catch it.
2256 (idlwave-surround -
1 (if (or is-action amp-left
) -
1) len
))))
2258 (defun idlwave-custom-ltgtr-surround (gtr &optional is-action
)
2259 "Surround > and < by blanks, leaving room for >= and <=, and considering ->."
2260 (let* ((prev-char (char-after (- (point) 2)))
2261 (next-char (char-after (point)))
2262 (method-invoke (and gtr
(eq prev-char ?-
)))
2263 (len (if method-invoke
2 1)))
2264 (unless (eq next-char ?
=)
2265 ;; Key binding: pad only on left, to save for possible >=/<=
2266 (idlwave-surround -
1 (if (or is-action method-invoke
) -
1) len
))))
2268 (defun idlwave-surround (&optional before after length is-action
)
2269 "Surround the LENGTH characters before point with blanks.
2270 LENGTH defaults to 1.
2271 Optional arguments BEFORE and AFTER affect the behavior before and
2272 after the characters (see also description of `idlwave-make-space'):
2276 integer > 0 force exactly n spaces
2277 integer < 0 at least |n| spaces
2279 The function does nothing if any of the following conditions is true:
2280 - `idlwave-surround-by-blank' is nil
2281 - the character before point is inside a string or comment"
2282 (when (and idlwave-surround-by-blank
(not (idlwave-quoted)))
2283 (let ((length (or length
1))) ; establish a default for LENGTH
2284 (backward-char length
)
2286 (let ((here (point)))
2287 (skip-chars-backward " \t")
2289 ;; avoid clobbering indent
2291 (move-to-column (idlwave-calculate-indent))
2292 (if (<= (point) here
)
2293 (narrow-to-region (point) here
))
2295 (idlwave-make-space before
))
2296 (skip-chars-forward " \t"))
2297 (forward-char length
)
2298 (idlwave-make-space after
)
2299 ;; Check to see if the line should auto wrap
2300 (if (and (equal (char-after (1- (point))) ?\
)
2301 (> (current-column) fill-column
))
2302 (funcall auto-fill-function
)))))
2304 (defun idlwave-make-space (n)
2305 "Make space at point.
2306 The space affected is all the spaces and tabs around point.
2307 If n is non-nil then point is left abs(n) spaces from the beginning of
2308 the contiguous space.
2309 The amount of space at point is determined by N.
2310 If the value of N is:
2312 > 0 - exactly N spaces.
2313 < 0 - a minimum of -N spaces, i.e., do not change if there are
2315 0 - no spaces (i.e. remove any existing space)."
2318 ((start-col (progn (skip-chars-backward " \t") (current-column)))
2320 (end-col (progn (skip-chars-forward " \t") (current-column))))
2321 (delete-horizontal-space)
2324 (idlwave-indent-to (+ start-col n
))
2325 (goto-char (+ left n
)))
2327 (idlwave-indent-to end-col
(- n
))
2328 (goto-char (- left n
)))
2332 (defun idlwave-newline ()
2333 "Inserts a newline and indents the current and previous line."
2336 ;; Handle unterminated single and double quotes
2337 ;; If not in a comment and in a string then insertion of a newline
2338 ;; will mean unbalanced quotes.
2340 (if (and (not (idlwave-in-comment)) (idlwave-in-quote))
2342 (message "Warning: unbalanced quotes?")))
2345 ;; The current line is being split, the cursor should be at the
2346 ;; beginning of the new line skipping the leading indentation.
2348 ;; The reason we insert the new line before indenting is that the
2349 ;; indenting could be confused by keywords (e.g. END) on the line
2350 ;; after the split point. This prevents us from just using
2351 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2353 (beginning-of-line 0)
2354 (idlwave-indent-line)
2356 (idlwave-indent-line))
2359 ;; Use global variable 'comment-column' to set parallel comment
2361 ;; Modeled on lisp.el
2362 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2363 (defun idlwave-comment-hook ()
2364 "Compute indent for the beginning of the IDL comment delimiter."
2365 (if (or (looking-at idlwave-no-change-comment
)
2366 (if idlwave-begin-line-comment
2367 (looking-at idlwave-begin-line-comment
)
2370 (if (looking-at idlwave-code-comment
)
2371 (if (save-excursion (skip-chars-backward " \t") (bolp))
2372 ;; On line by itself, indent as code
2373 (let ((tem (idlwave-calculate-indent)))
2374 (if (listp tem
) (car tem
) tem
))
2375 ;; after code - do not change
2377 (skip-chars-backward " \t")
2378 (max (if (bolp) 0 (1+ (current-column)))
2381 (defun idlwave-split-line ()
2382 "Continue line by breaking line at point and indent the lines.
2383 For a code line insert continuation marker. If the line is a line comment
2384 then the new line will contain a comment with the same indentation.
2385 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2388 ;; Expand abbreviation, just like normal RET would.
2389 (and abbrev-mode
(expand-abbrev))
2391 (if (not (idlwave-in-comment))
2392 ;; For code line add continuation.
2393 ;; Check if splitting a string.
2395 (if (setq beg
(idlwave-in-quote))
2396 (if idlwave-split-line-string
2397 ;; Split the string.
2398 (progn (insert (setq beg
(char-after beg
)) " + "
2399 idlwave-continuation-char beg
)
2401 (newline-and-indent)
2403 ;; Do not split the string.
2405 (message "Warning: continuation inside string!!")
2406 (insert " " idlwave-continuation-char
))
2407 ;; Not splitting a string.
2408 (if (not (member (char-before) '(?\ ?
\t)))
2410 (insert idlwave-continuation-char
)
2411 (newline-and-indent)))
2412 (indent-new-comment-line))
2413 ;; Indent previous line
2414 (setq beg
(- (point-max) (point)))
2416 (idlwave-indent-line)
2417 (goto-char (- (point-max) beg
))
2418 ;; Reindent new line
2419 (idlwave-indent-line)))
2421 (defun idlwave-beginning-of-subprogram (&optional nomark
)
2422 "Moves point to the beginning of the current program unit.
2423 If NOMARK is non-nil, do not push mark."
2425 (idlwave-find-key idlwave-begin-unit-reg -
1 nomark
))
2427 (defun idlwave-end-of-subprogram (&optional nomark
)
2428 "Moves point to the start of the next program unit.
2429 If NOMARK is non-nil, do not push mark."
2431 (idlwave-end-of-statement)
2432 (idlwave-find-key idlwave-end-unit-reg
1 nomark
))
2434 (defun idlwave-mark-statement ()
2435 "Mark current IDL statement."
2437 (idlwave-end-of-statement)
2438 (let ((end (point)))
2439 (idlwave-beginning-of-statement)
2440 (push-mark end nil t
)))
2442 (defun idlwave-mark-block ()
2443 "Mark containing block."
2445 (idlwave-end-of-statement)
2446 (idlwave-backward-up-block -
1)
2447 (idlwave-end-of-statement)
2448 (let ((end (point)))
2449 (idlwave-backward-block)
2450 (idlwave-beginning-of-statement)
2451 (push-mark end nil t
)))
2454 (defun idlwave-mark-subprogram ()
2455 "Put mark at beginning of program, point at end.
2456 The marks are pushed."
2458 (idlwave-end-of-statement)
2459 (idlwave-beginning-of-subprogram)
2460 (let ((beg (point)))
2461 (idlwave-forward-block)
2462 (push-mark beg nil t
))
2463 (exchange-point-and-mark))
2465 (defun idlwave-backward-up-block (&optional arg
)
2466 "Move to beginning of enclosing block if prefix ARG >= 0.
2467 If prefix ARG < 0 then move forward to enclosing block end."
2469 (idlwave-block-jump-out (- arg
) 'nomark
))
2471 (defun idlwave-beginning-of-block ()
2472 "Go to the beginning of the current block."
2474 (idlwave-block-jump-out -
1 'nomark
)
2477 (defun idlwave-end-of-block ()
2478 "Go to the beginning of the current block."
2480 (idlwave-block-jump-out 1 'nomark
)
2483 (defun idlwave-forward-block (&optional arg
)
2484 "Move across next nested block."
2486 (let ((arg (or arg
1)))
2487 (if (idlwave-down-block arg
)
2488 (idlwave-block-jump-out arg
'nomark
))))
2490 (defun idlwave-backward-block ()
2491 "Move backward across previous nested block."
2493 (if (idlwave-down-block -
1)
2494 (idlwave-block-jump-out -
1 'nomark
)))
2496 (defun idlwave-down-block (&optional arg
)
2498 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2499 Returns non-nil if successfull."
2504 (let ((eos (save-excursion
2505 (idlwave-block-jump-out -
1 'nomark
)
2507 (if (setq status
(idlwave-find-key
2508 idlwave-end-block-reg -
1 'nomark eos
))
2509 (idlwave-beginning-of-statement)
2510 (message "No nested block before beginning of containing block.")))
2512 (let ((eos (save-excursion
2513 (idlwave-block-jump-out 1 'nomark
)
2515 (if (setq status
(idlwave-find-key
2516 idlwave-begin-block-reg
1 'nomark eos
))
2517 (idlwave-end-of-statement)
2518 (message "No nested block before end of containing block."))))
2521 (defun idlwave-mark-doclib ()
2522 "Put point at beginning of doc library header, mark at end.
2523 The marks are pushed."
2527 (goto-char (point-max))
2528 (if (re-search-backward idlwave-doclib-start nil t
)
2530 (setq beg
(progn (beginning-of-line) (point)))
2531 (if (re-search-forward idlwave-doclib-end nil t
)
2534 (push-mark beg nil t
)
2535 (message "Could not find end of doc library header.")))
2536 (message "Could not find doc library header start.")
2537 (goto-char here
)))))
2539 (defun idlwave-current-routine-fullname ()
2540 (let ((name (idlwave-current-routine)))
2541 (idlwave-make-full-name (nth 2 name
) (car name
))))
2543 (defun idlwave-current-routine ()
2544 "Return (NAME TYPE CLASS) of current routine."
2547 (idlwave-beginning-of-subprogram 'nomark
)
2548 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2549 (let* ((type (if (string= (downcase (match-string 1)) "pro")
2551 (class (idlwave-sintern-class (match-string 3)))
2552 (name (idlwave-sintern-routine-or-method (match-string 4) class
)))
2553 (list name type class
)))))
2555 (defvar idlwave-shell-prompt-pattern
)
2556 (defun idlwave-beginning-of-statement ()
2557 "Move to beginning of the current statement.
2558 Skips back past statement continuations.
2559 Point is placed at the beginning of the line whether or not this is an
2563 ((eq major-mode
'idlwave-shell-mode
)
2564 (if (re-search-backward idlwave-shell-prompt-pattern nil t
)
2565 (goto-char (match-end 0))))
2567 (if (save-excursion (forward-line -
1) (idlwave-is-continuation-line))
2568 (idlwave-previous-statement)
2569 (beginning-of-line)))))
2571 (defun idlwave-previous-statement ()
2572 "Moves point to beginning of the previous statement.
2573 Returns t if the current line before moving is the beginning of
2574 the first non-comment statement in the file, and nil otherwise."
2576 (let (first-statement)
2577 (if (not (= (forward-line -
1) 0))
2578 ;; first line in file
2580 ;; skip blank lines, label lines, include lines and line comments
2582 ;; The current statement is the first statement until we
2583 ;; reach another statement.
2584 (setq first-statement
2586 (looking-at idlwave-comment-line-start-skip
)
2587 (looking-at "[ \t]*$")
2588 (looking-at (concat "[ \t]*" idlwave-label
"[ \t]*$"))
2590 (= (forward-line -
1) 0)))
2591 ;; skip continuation lines
2595 (idlwave-is-continuation-line))
2596 (= (forward-line -
1) 0)))
2599 (defun idlwave-end-of-statement ()
2600 "Moves point to the end of the current IDL statement.
2601 If not in a statement just moves to end of line. Returns position."
2603 (while (and (idlwave-is-continuation-line)
2604 (= (forward-line 1) 0))
2605 (while (and (idlwave-is-comment-or-empty-line)
2606 (= (forward-line 1) 0))))
2610 (defun idlwave-end-of-statement0 ()
2611 "Moves point to the end of the current IDL statement.
2612 If not in a statement just moves to end of line. Returns position."
2614 (while (and (idlwave-is-continuation-line)
2615 (= (forward-line 1) 0)))
2619 (defun idlwave-next-statement ()
2620 "Moves point to beginning of the next IDL statement.
2621 Returns t if that statement is the last
2622 non-comment IDL statement in the file, and nil otherwise."
2624 (let (last-statement)
2625 (idlwave-end-of-statement)
2626 ;; skip blank lines, label lines, include lines and line comments
2627 (while (and (= (forward-line 1) 0)
2628 ;; The current statement is the last statement until
2629 ;; we reach a new statement.
2630 (setq last-statement
2632 (looking-at idlwave-comment-line-start-skip
)
2633 (looking-at "[ \t]*$")
2634 (looking-at (concat "[ \t]*" idlwave-label
"[ \t]*$"))
2635 (looking-at "^@")))))
2638 (defun idlwave-skip-multi-commands (&optional lim
)
2639 "Skip past multiple commands on a line (with `&')."
2640 (let ((save-point (point)))
2641 (when (re-search-forward ".*&" lim t
)
2642 (goto-char (match-end 0))
2643 (if (idlwave-quoted)
2644 (goto-char save-point
)
2645 (if (eq (char-after (- (point) 2)) ?
&) (goto-char save-point
))))
2648 (defun idlwave-skip-label-or-case ()
2649 "Skip label or case statement element.
2650 Returns position after label.
2651 If there is no label point is not moved and nil is returned."
2652 ;; Case expressions and labels are terminated by a colon.
2653 ;; So we find the first colon in the line and make sure
2654 ;; - no `?' is before it (might be a ? b : c)
2655 ;; - it is not in a comment
2656 ;; - not in a string constant
2657 ;; - not in parenthesis (like a[0:3])
2658 ;; - not followed by another ":" in explicit class, ala a->b::c
2659 ;; As many in this mode, this function is heuristic and not an exact
2661 (let* ((start (point))
2662 (eos (save-excursion (idlwave-end-of-statement) (point)))
2663 (end (idlwave-find-key ":" 1 'nomark eos
)))
2665 (= (nth 0 (parse-partial-sexp start end
)) 0)
2666 (not (string-match "\\?" (buffer-substring start end
)))
2667 (not (string-match "^::" (buffer-substring end eos
))))
2674 (defun idlwave-start-of-substatement (&optional pre
)
2675 "Move to start of next IDL substatement after point.
2676 Uses the type of the current IDL statement to determine if the next
2677 statement is on a new line or is a subpart of the current statement.
2678 Returns point at start of substatement modulo whitespace.
2679 If optional argument is non-nil move to beginning of current
2681 (let ((orig (point))
2682 (eos (idlwave-end-of-statement))
2685 (idlwave-beginning-of-statement)
2686 (idlwave-skip-label-or-case)
2687 (if (< (point) orig
)
2688 (idlwave-skip-multi-commands orig
))
2690 ;; Continue looking for substatements until we are past orig
2691 (while (and (<= (point) orig
) (not (eobp)))
2693 (setq nst
(nth 1 (cdr (setq st
(car (idlwave-statement-type))))))
2694 (if (equal (car st
) 'if
) (setq ifnest
(1+ ifnest
)))
2696 (idlwave-find-key nst
1 'nomark eos
))
2697 (goto-char (match-end 0)))
2698 ((and (> ifnest
0) (idlwave-find-key "\\<else\\>" 1 'nomark eos
))
2699 (setq ifnest
(1- ifnest
))
2700 (goto-char (match-end 0)))
2702 (idlwave-next-statement))))
2703 (if pre
(goto-char last
))
2704 ;; If a continuation line starts here, move to next line
2705 (if (looking-at "[ \t]*\\$\\([ \t]*\\(;\\|$\\)\\)")
2706 (beginning-of-line 2))
2709 (defun idlwave-statement-type ()
2710 "Return the type of the current IDL statement.
2711 Uses `idlwave-statement-match' to return a cons of (type . point) with
2712 point the ending position where the type was determined. Type is the
2713 association from `idlwave-statement-match', i.e. the cons cell from the
2714 list not just the type symbol. Returns nil if not an identifiable
2717 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2718 ;; and possibly comments
2719 (while (looking-at "[ \t]*\\$")
2721 (skip-chars-forward " \t")
2722 (let ((st idlwave-statement-match
)
2723 (case-fold-search t
))
2724 (while (and (not (looking-at (nth 0 (cdr (car st
)))))
2725 (setq st
(cdr st
))))
2727 (append st
(match-end 0))))))
2729 (defun idlwave-expand-equal (&optional before after is-action
)
2730 "Pad '=' with spaces. Two cases: Assignment statement, and keyword
2731 assignment. Which case is determined using
2732 `idlwave-start-of-substatement' and `idlwave-statement-type'. The
2733 equal sign will be surrounded by BEFORE and AFTER blanks. If
2734 `idlwave-pad-keyword' is t then keyword assignment is treated just
2735 like assignment statements. When nil, spaces are removed for keyword
2736 assignment. Any other value keeps the current space around the `='.
2737 Limits in for loops are treated as keyword assignment.
2739 Starting with IDL 6.0, a number of op= assignments are available.
2740 Since ambiguities of the form:
2745 can occur, alphanumeric operator assignment will never be pre-padded,
2746 only post-padded. You must use a space before these to disambiguate
2747 \(not just for padding, but for proper parsing by IDL too!). Other
2748 operators, such as ##=, ^=, etc., will be pre-padded.
2750 IS-ACTION is ignored.
2752 See `idlwave-surround'."
2753 (if idlwave-surround-by-blank
2755 ((non-an-ops "\\(##\\|\\*\\|\\+\\|-\\|/\\|<\\|>\\|\\^\\)\\=")
2757 "\\s-\\(AND\\|EQ\\|GE\\|GT\\|LE\\|LT\\|MOD\\|NE\\|OR\\|XOR\\)\\=")
2761 (let ((case-fold-search t
))
2764 (re-search-backward non-an-ops nil t
)
2765 ;; Why doesn't ##? work for both?
2766 (re-search-backward "\\(#\\)\\=" nil t
))
2767 (setq len
(1+ (length (match-string 1))))
2768 (when (re-search-backward an-ops nil t
)
2769 ;(setq begin nil) ; won't modify begin
2770 (setq len
(1+ (length (match-string 1))))))))
2772 (if (eq t idlwave-pad-keyword
)
2773 ;; Everything gets padded equally
2774 (idlwave-surround before after len
)
2775 ;; Treating keywords/for variables specially...
2776 (let ((st (save-excursion ; To catch "for" variables
2777 (idlwave-start-of-substatement t
)
2778 (idlwave-statement-type)))
2779 (what (save-excursion ; To catch keywords
2780 (skip-chars-backward "= \t")
2781 (nth 2 (idlwave-where)))))
2782 (cond ((or (memq what
'(function-keyword procedure-keyword
))
2783 (memq (caar st
) '(for pdef
)))
2785 ((null idlwave-pad-keyword
)
2786 (idlwave-surround 0 0)
2788 (t))) ; leave any spaces alone
2789 (t (idlwave-surround before after len
))))))))
2792 (defun idlwave-indent-and-action (&optional arg
)
2793 "Call `idlwave-indent-line' and do expand actions.
2794 With prefix ARG non-nil, indent the entire sub-statement."
2797 (if (and idlwave-expand-generic-end
2798 (re-search-backward "\\<\\(end\\)\\s-*\\="
2799 (max 0 (- (point) 10)) t
)
2800 (looking-at "\\(end\\)\\([ \n\t]\\|\\'\\)"))
2801 (progn (goto-char (match-end 1))
2802 ;;Expand the END abbreviation, just as RET or Space would have.
2803 (if abbrev-mode
(expand-abbrev)
2804 (idlwave-show-begin)))))
2805 (when (and (not arg
) current-prefix-arg
)
2806 (setq arg current-prefix-arg
)
2807 (setq current-prefix-arg nil
))
2809 (idlwave-indent-statement)
2810 (idlwave-indent-line t
)))
2812 (defun idlwave-indent-line (&optional expand
)
2813 "Indents current IDL line as code or as a comment.
2814 The actions in `idlwave-indent-action-table' are performed.
2815 If the optional argument EXPAND is non-nil then the actions in
2816 `idlwave-indent-expand-table' are performed."
2818 ;; Move point out of left margin.
2820 (skip-chars-backward " \t")
2822 (skip-chars-forward " \t"))
2823 (let ((mloc (point-marker)))
2826 (if (looking-at idlwave-comment-line-start-skip
)
2827 ;; Indentation for a line comment
2829 (skip-chars-forward " \t")
2830 (idlwave-indent-left-margin (idlwave-comment-hook)))
2834 ;; Before indenting, run action routines.
2836 (if (and expand idlwave-do-actions
)
2837 (mapc 'idlwave-do-action idlwave-indent-expand-table
))
2839 (if idlwave-do-actions
2840 (mapc 'idlwave-do-action idlwave-indent-action-table
))
2842 ;; No longer expand abbrevs on the line. The user can do this
2843 ;; manually using expand-region-abbrevs.
2845 ;; Indent for code line
2850 (looking-at (concat "^" idlwave-label
"[ \t]*$"))
2852 (looking-at "^[ \t]*@"))
2856 (idlwave-indent-left-margin (idlwave-calculate-indent)))
2857 ;; Adjust parallel comment
2859 (if (idlwave-in-comment)
2860 ;; Emacs 21 is too smart with fill-column on comment indent
2861 (let ((fill-column (if (fboundp 'comment-indent-new-line
)
2864 (indent-for-comment)))))
2866 ;; Get rid of marker
2867 (set-marker mloc nil
)))
2869 (defun idlwave-do-action (action)
2870 "Perform an action repeatedly on a line. ACTION is a list (REG
2871 . FUNC). REG is a regular expression. FUNC is either a function name
2872 to be called with `funcall' or a list to be evaluated with `eval'.
2873 The action performed by FUNC should leave point after the match for
2874 REG - otherwise an infinite loop may be entered. FUNC is always
2875 passed a final argument of 'is-action, so it can discriminate between
2876 being run as an action, or a key binding"
2877 (let ((action-key (car action
))
2878 (action-routine (cdr action
)))
2880 (while (idlwave-look-at action-key
)
2881 (if (listp action-routine
)
2882 (eval (append action-routine
'('is-action
)))
2883 (funcall action-routine
'is-action
)))))
2885 (defun idlwave-indent-to (col &optional min
)
2886 "Indent from point with spaces until column COL.
2887 Inserts space before markers at point."
2888 (if (not min
) (setq min
0))
2889 (insert-before-markers
2890 (make-string (max min
(- col
(current-column))) ?\
)))
2892 (defun idlwave-indent-left-margin (col)
2893 "Indent the current line to column COL.
2894 Indents such that first non-whitespace character is at column COL
2895 Inserts spaces before markers at point."
2898 (delete-horizontal-space)
2899 (idlwave-indent-to col
)))
2901 (defun idlwave-indent-subprogram ()
2902 "Indents program unit which contains point."
2905 (idlwave-end-of-statement)
2906 (idlwave-beginning-of-subprogram)
2907 (let ((beg (point)))
2908 (idlwave-forward-block)
2909 (message "Indenting subprogram...")
2910 (indent-region beg
(point) nil
))
2911 (message "Indenting subprogram...done.")))
2913 (defun idlwave-indent-statement ()
2914 "Indent current statement, including all continuation lines."
2917 (idlwave-beginning-of-statement)
2918 (let ((beg (point)))
2919 (idlwave-end-of-statement)
2920 (indent-region beg
(point) nil
))))
2922 (defun idlwave-calculate-indent ()
2923 "Return appropriate indentation for current line as IDL code."
2927 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2929 ((idlwave-look-at idlwave-begin-unit-reg
)
2931 ;; Check for continuation line
2933 (and (= (forward-line -
1) 0)
2934 (idlwave-is-continuation-line)))
2935 (idlwave-calculate-cont-indent))
2936 ;; calculate indent based on previous and current statements
2937 (t (let* (beg-prev-pos
2939 ;; calculate indent based on previous statement
2942 ;; Beginning of file
2944 (idlwave-previous-statement)
2945 (setq beg-prev-pos
(point)))
2948 ((idlwave-look-at idlwave-begin-unit-reg t
)
2949 (+ (idlwave-current-statement-indent)
2950 idlwave-main-block-indent
))
2952 ((idlwave-look-at idlwave-begin-block-reg t
)
2953 (+ (idlwave-min-current-statement-indent)
2954 idlwave-block-indent
))
2956 ((idlwave-look-at idlwave-end-block-reg t
)
2958 ;; Match to the *beginning* of the block opener
2959 (goto-char beg-prev-pos
)
2960 (idlwave-block-jump-out -
1 'nomark
) ; go to begin block
2961 (idlwave-min-current-statement-indent)))
2962 ;; idlwave-end-offset
2963 ;; idlwave-block-indent))
2965 ;; Default to current indent
2966 ((idlwave-current-statement-indent))))))
2967 ;; adjust the indentation based on the current statement
2970 ((idlwave-look-at idlwave-end-block-reg
)
2971 (+ the-indent idlwave-end-offset
))
2975 ;; Parentheses indent
2978 (defun idlwave-calculate-paren-indent (beg-reg end-reg close-exp
)
2979 "Calculate the continuation indent inside a paren group.
2980 Returns a cons-cell with (open . indent), where open is the
2981 location of the open paren"
2982 (let ((open (nth 1 (parse-partial-sexp beg-reg end-reg
))))
2983 ;; Found an innermost open paren.
2986 ;; Line up with next word unless this is a closing paren.
2989 ;; Plain Kernighan-style nested indent
2990 (idlwave-indent-parens-nested
2991 (+ idlwave-continuation-indent
(idlwave-current-indent)))
2993 ;; This is a closed paren - line up under open paren.
2997 ;; Empty (or just comment) follows -- revert to basic indent
3001 (looking-at "[ \t$]*\\(;.*\\)?$"))
3004 ;; Line up with first word after any blank space
3006 (skip-chars-forward " \t")
3007 (current-column))))))))
3009 (defun idlwave-calculate-cont-indent ()
3010 "Calculates the IDL continuation indent column from the previous
3011 statement. Note that here previous statement usually means the
3012 beginning of the current statement if this statement is a continuation
3013 of the previous line. Various special types of continuations,
3014 including assignments, routine definitions, and parenthetical
3015 groupings, are treated separately."
3017 (let* ((case-fold-search t
)
3018 (end-reg (progn (beginning-of-line) (point)))
3019 (beg-last-statement (save-excursion (idlwave-previous-statement)
3021 (beg-reg (progn (idlwave-start-of-substatement 'pre
)
3022 (if (eq (line-beginning-position) end-reg
)
3023 (goto-char beg-last-statement
)
3025 (basic-indent (+ (idlwave-min-current-statement-indent end-reg
)
3026 idlwave-continuation-indent
))
3027 fancy-nonparen-indent fancy-paren-indent
)
3029 ;; Align then with its matching if, etc.
3030 ((let ((matchers '(("\\<if\\>" .
"[ \t]*then")
3031 ("\\<\\(if\\|end\\(if\\)?\\)\\>" .
"[ \t]*else")
3032 ("\\<\\(for\\|while\\)\\>" .
"[ \t]*do")
3033 ("\\<\\(repeat\\|end\\(rep\\)?\\)\\>" .
3035 ("\\<case\\>" .
"[ \t]*of")))
3041 (while (setq match
(car matchers
))
3042 (if (looking-at (cdr match
))
3043 (throw 'exit
(car match
)))
3044 (setq matchers
(cdr matchers
)))))
3045 (idlwave-find-key cont-re -
1 'nomark beg-last-statement
)))
3046 (if (looking-at "end") ;; that one's special
3047 (- (idlwave-current-indent)
3048 (+ idlwave-block-indent idlwave-end-offset
))
3049 (idlwave-current-indent)))
3051 ;; Indent in from the previous line for continuing statements
3052 ((let ((matchers '("\\<then\\>"
3059 (if (/= (forward-line -
1) 0)
3061 (while (setq match
(car matchers
))
3062 (if (looking-at (concat ".*" match
"[ \t]*\\$[ \t]*"
3065 (setq matchers
(cdr matchers
)))))
3066 (+ idlwave-continuation-indent
(idlwave-current-indent)))
3068 ;; Parenthetical indent, either traditional or Kernighan style
3069 ((setq fancy-paren-indent
3070 (let* ((end-reg end-reg
)
3073 (skip-chars-forward " \t")
3074 (looking-at "\\s)")))
3077 (while (setq indent-cons
(idlwave-calculate-paren-indent
3078 beg-reg end-reg close-exp
))
3079 ;; First permitted containing paren
3081 idlwave-indent-to-open-paren
3082 idlwave-indent-parens-nested
3083 (null (cdr indent-cons
))
3084 (< (- (cdr indent-cons
) basic-indent
)
3085 idlwave-max-extra-continuation-indent
))
3086 (throw 'loop
(cdr indent-cons
)))
3087 (setq end-reg
(car indent-cons
))))))
3090 ;; A continued assignment, or procedure call/definition
3092 (> idlwave-max-extra-continuation-indent
0)
3093 (setq fancy-nonparen-indent
3096 (while (idlwave-look-at "&")) ; skip continued statements
3098 ;; A continued Procedure call or definition
3100 (idlwave-look-at "^[ \t]*\\(pro\\|function\\)") ;skip over
3101 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3102 (goto-char (match-end 0))
3103 ;; Comment only, or blank line with "$"? Basic indent.
3104 (if (save-match-data (looking-at "[ \t$]*\\(;.*\\)?$"))
3108 ;; Continued assignment (with =):
3110 (while (looking-at "[^=\n\r]*\\(=\\)[ \t]*")
3111 (goto-char (match-end 0))
3112 (if (null (idlwave-what-function beg-reg
))
3113 (throw 'assign t
))))
3116 (looking-at "[ \t$]*\\(;.*\\)?$") ; use basic
3118 (goto-char beg-last-statement
)
3119 (eq (caar (idlwave-statement-type)) 'for
)))
3120 (current-column))))))
3121 (< (- fancy-nonparen-indent basic-indent
)
3122 idlwave-max-extra-continuation-indent
))
3123 (if fancy-paren-indent
;calculated but disallowed paren indent
3124 (+ fancy-nonparen-indent idlwave-continuation-indent
)
3125 fancy-nonparen-indent
))
3127 ;; Basic indent, by default
3128 (t basic-indent
)))))
3132 (defun idlwave-find-key (key-re &optional dir nomark limit
)
3133 "Move to next match of the regular expression KEY-RE.
3134 Matches inside comments or string constants will be ignored.
3135 If DIR is negative, the search will be backwards.
3136 At a successful match, the mark is pushed unless NOMARK is non-nil.
3137 Searches are limited to LIMIT.
3138 Searches are case-insensitive and use a special syntax table which
3139 treats `$' and `_' as word characters.
3140 Return value is the beginning of the match or (in case of failure) nil."
3141 (setq dir
(or dir
0))
3142 (let ((case-fold-search t
)
3143 (search-func (if (> dir
0) 're-search-forward
're-search-backward
))
3145 (idlwave-with-special-syntax
3148 (while (funcall search-func key-re limit t
)
3149 (if (not (idlwave-quoted))
3150 (throw 'exit
(setq found
(match-beginning 0)))
3151 (if (or (and (> dir
0) (eobp))
3152 (and (< dir
0) (bobp)))
3153 (throw 'exit nil
)))))))
3156 (if (not nomark
) (push-mark))
3161 (defun idlwave-block-jump-out (&optional dir nomark
)
3162 "When optional argument DIR is non-negative, move forward to end of
3163 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3164 regular expressions. When DIR is negative, move backwards to block beginning.
3165 Recursively calls itself to skip over nested blocks. DIR defaults to
3166 forward. Calls `push-mark' unless the optional argument NOMARK is
3167 non-nil. Movement is limited by the start of program units because of
3168 possibility of unbalanced blocks."
3170 (or dir
(setq dir
0))
3171 (let* ((here (point))
3172 (case-fold-search t
)
3173 (limit (if (>= dir
0) (point-max) (point-min)))
3174 (block-limit (if (>= dir
0)
3175 idlwave-begin-block-reg
3176 idlwave-end-block-reg
))
3178 (block-reg (concat idlwave-begin-block-reg
"\\|"
3179 idlwave-end-block-reg
))
3180 (unit-limit (or (save-excursion
3183 idlwave-begin-unit-reg dir t limit
)
3186 idlwave-end-unit-reg dir t limit
)))
3188 (if (>= dir
0) (end-of-line)) ;Make sure we are in current block
3189 (if (setq found
(idlwave-find-key block-reg dir t unit-limit
))
3190 (while (and found
(looking-at block-limit
))
3191 (if (>= dir
0) (forward-word 1))
3192 (idlwave-block-jump-out dir t
)
3193 (setq found
(idlwave-find-key block-reg dir t unit-limit
))))
3194 (if (not nomark
) (push-mark here
))
3195 (if (not found
) (goto-char unit-limit
)
3196 (if (>= dir
0) (forward-word 1)))))
3198 (defun idlwave-min-current-statement-indent (&optional end-reg
)
3199 "The minimum indent in the current statement."
3200 (idlwave-beginning-of-statement)
3201 (if (not (idlwave-is-continuation-line))
3202 (idlwave-current-indent)
3203 (let ((min (idlwave-current-indent)) comm-or-empty
)
3204 (while (and (= (forward-line 1) 0)
3205 (or (setq comm-or-empty
(idlwave-is-comment-or-empty-line))
3206 (idlwave-is-continuation-line))
3207 (or (null end-reg
) (< (point) end-reg
)))
3208 (unless comm-or-empty
(setq min
(min min
(idlwave-current-indent)))))
3209 (if (or comm-or-empty
(and end-reg
(>= (point) end-reg
)))
3211 (min min
(idlwave-current-indent))))))
3213 (defun idlwave-current-statement-indent (&optional last-line
)
3214 "Return indentation of the current statement.
3215 If in a statement, moves to beginning of statement before finding indent."
3217 (idlwave-end-of-statement)
3218 (idlwave-beginning-of-statement))
3219 (idlwave-current-indent))
3221 (defun idlwave-current-indent ()
3222 "Return the column of the indentation of the current line.
3223 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3226 (skip-chars-forward " \t")
3227 ;; if we are at the end of blank line return 0
3229 ((current-column)))))
3231 (defun idlwave-is-continuation-line ()
3232 "Tests if current line is continuation line.
3233 Blank or comment-only lines following regular continuation lines (with
3234 `$') count as continuations too."
3238 (idlwave-look-at "\\<\\$")
3240 (while (and (looking-at "^[ \t]*\\(;.*\\)?$")
3241 (eq (forward-line -
1) 0))
3242 (if (setq p
(idlwave-look-at "\\<\\$")) (throw 'loop p
))))))))
3244 (defun idlwave-is-comment-line ()
3245 "Tests if the current line is a comment line."
3247 (beginning-of-line 1)
3248 (looking-at "[ \t]*;")))
3250 (defun idlwave-is-comment-or-empty-line ()
3251 "Tests if the current line is a comment line."
3253 (beginning-of-line 1)
3254 (looking-at "[ \t]*[;\n]")))
3256 (defun idlwave-look-at (regexp &optional cont beg
)
3257 "Searches current line from current point for REGEXP.
3258 If optional argument CONT is non-nil, searches to the end of
3259 the current statement.
3260 If optional arg BEG is non-nil, search starts from the beginning of the
3262 Ignores matches that end in a comment or inside a string expression.
3263 Returns point if successful, nil otherwise.
3264 This function produces unexpected results if REGEXP contains quotes or
3265 a comment delimiter. The search is case insensitive.
3266 If successful leaves point after the match, otherwise, does not move point."
3267 (let ((here (point))
3268 (case-fold-search t
)
3269 (eos (save-excursion
3270 (if cont
(idlwave-end-of-statement) (end-of-line))
3273 (idlwave-with-special-syntax
3274 (if beg
(idlwave-beginning-of-statement))
3275 (while (and (setq found
(re-search-forward regexp eos t
))
3277 (if (not found
) (goto-char here
))
3280 (defun idlwave-fill-paragraph (&optional nohang
)
3281 "Fills paragraphs in comments.
3282 A paragraph is made up of all contiguous lines having the same comment
3283 leader (the leading whitespace before the comment delimiter and the
3284 comment delimiter). In addition, paragraphs are separated by blank
3285 line comments. The indentation is given by the hanging indent of the
3286 first line, otherwise by the minimum indentation of the lines after
3287 the first line. The indentation of the first line does not change.
3288 Does not effect code lines. Does not fill comments on the same line
3289 with code. The hanging indent is given by the end of the first match
3290 matching `idlwave-hang-indent-regexp' on the paragraph's first line . If the
3291 optional argument NOHANG is non-nil then the hanging indent is
3294 ;; check if this is a line comment
3297 (skip-chars-forward " \t")
3298 (looking-at comment-start
))
3301 pre here diff fill-prefix-reg bcl first-indent
3303 ;; Change tabs to spaces in the surrounding paragraph.
3304 ;; The surrounding paragraph will be the largest containing block of
3305 ;; contiguous line comments. Thus, we may be changing tabs in
3306 ;; a much larger area than is needed, but this is the easiest
3307 ;; brute force way to do it.
3309 ;; This has the undesirable side effect of replacing the tabs
3310 ;; permanently without the user's request or knowledge.
3312 (backward-paragraph)
3313 (setq start
(point)))
3317 (untabify start end
)
3323 (concat "^[ \t]*" comment-start
"+")
3324 (save-excursion (end-of-line) (point))
3326 ;; Get the comment leader on the line and its length
3327 (setq pre
(current-column))
3328 ;; the comment leader is the indentation plus exactly the
3329 ;; number of consecutive ";".
3330 (setq fill-prefix-reg
3334 (buffer-substring (save-excursion
3335 (beginning-of-line) (point))
3339 ;; Mark the beginning and end of the paragraph
3341 (while (and (looking-at fill-prefix-reg
)
3342 (not (looking-at paragraph-separate
))
3345 ;; Move to first line of paragraph
3346 (if (/= (point) bcl
)
3348 (setq start
(point))
3350 (while (and (looking-at fill-prefix-reg
)
3351 (not (looking-at paragraph-separate
))
3355 (if (or (not (looking-at fill-prefix-reg
))
3356 (looking-at paragraph-separate
))
3359 ;; if at end of buffer add a newline (need this because
3360 ;; fill-region needs END to be at the beginning of line after
3361 ;; the paragraph or it will add a line).
3363 (progn (insert ?
\n) (backward-char 1)))
3364 ;; Set END to the beginning of line after the paragraph
3365 ;; END is calculated as distance from end of buffer
3366 (setq end
(- (point-max) (point) 1))
3368 ;; Calculate the indentation for the paragraph.
3370 ;; In the following while statements, after one iteration
3371 ;; point will be at the beginning of a line in which case
3372 ;; the while will not be executed for the
3373 ;; the first paragraph line and thus will not affect the
3376 ;; First check to see if indentation is based on hanging indent.
3377 (if (and (not nohang
) idlwave-hanging-indent
3381 (idlwave-calc-hanging-indent))))
3382 ;; Adjust lines of paragraph by inserting spaces so that
3383 ;; each line's indent is at least as great as the hanging
3384 ;; indent. This is needed for fill-paragraph to work with
3389 (while (> (point) start
)
3390 (re-search-forward comment-start-skip
3391 (save-excursion (end-of-line) (point))
3393 (if (> (setq diff
(- indent
(current-column))) 0)
3395 (if (>= here
(point))
3396 ;; adjust the original location for the
3398 (setq here
(+ here diff
)))
3399 (insert (make-string diff ?\
))))
3403 ;; No hang. Instead find minimum indentation of paragraph
3404 ;; after first line.
3405 ;; For the following while statement, since START is at the
3406 ;; beginning of line and END is at the end of line
3407 ;; point is greater than START at least once (which would
3408 ;; be the case for a single line paragraph).
3409 (while (> (point) start
)
3416 (save-excursion (end-of-line) (point))
3421 (setq fill-prefix
(concat fill-prefix
3422 (make-string (- indent pre
)
3424 ;; first-line indent
3430 (save-excursion (end-of-line) (point))
3435 ;; try to keep point at its original place
3438 ;; In place of the more modern fill-region-as-paragraph, a hack
3439 ;; to keep whitespace untouched on the first line within the
3440 ;; indent length and to preserve any indent on the first line
3444 (buffer-substring start
(+ start first-indent -
1)))
3445 (subst-char-in-region start
(+ start first-indent -
1) ?\ ?~ nil
)
3446 (fill-region-as-paragraph
3449 (current-justification)
3451 (delete-region start
(+ start first-indent -
1))
3454 ;; When we want the point at the beginning of the comment
3455 ;; body fill-region will put it at the beginning of the line.
3456 (if (bolp) (skip-chars-forward (concat " \t" comment-start
)))
3457 (setq fill-prefix nil
))))
3459 (defun idlwave-calc-hanging-indent ()
3460 "Calculate the position of the hanging indent for the comment
3461 paragraph. The hanging indent position is given by the first match
3462 with the `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3463 non-nil then use last occurrence matching `idlwave-hang-indent-regexp' on
3465 If not found returns nil."
3466 (if idlwave-use-last-hang-indent
3469 (if (re-search-backward
3470 idlwave-hang-indent-regexp
3471 (save-excursion (beginning-of-line) (point))
3473 (+ (current-column) (length idlwave-hang-indent-regexp
))))
3476 (if (re-search-forward
3477 idlwave-hang-indent-regexp
3478 (save-excursion (end-of-line) (point))
3480 (current-column)))))
3482 (defun idlwave-auto-fill ()
3483 "Called to break lines in auto fill mode.
3484 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3485 non-nil. Places a continuation character at the end of the line if
3486 not in a comment. Splits strings with IDL concatenation operator `+'
3487 if `idlwave-auto-fill-split-string' is non-nil."
3488 (if (<= (current-column) fill-column
)
3489 nil
; do not to fill
3490 (if (or (not idlwave-fill-comment-line-only
)
3492 ;; Check for comment line
3494 (looking-at idlwave-comment-line-start-skip
)))
3496 (idlwave-indent-line)
3497 ;; Prevent actions do-auto-fill which calls indent-line-function.
3498 (let (idlwave-do-actions
3499 (paragraph-separate ".")
3500 (fill-nobreak-predicate
3501 (if (and (idlwave-in-quote)
3502 idlwave-auto-fill-split-string
)
3503 (lambda () ;; We'll need 5 spaces for " ' + $"
3504 (<= (- fill-column
(current-column)) 5)
3509 ;; Indent the split line
3510 (idlwave-indent-line))
3513 (looking-at idlwave-comment-line-start-skip
))
3514 ;; A continued line comment
3515 ;; We treat continued line comments as part of a comment
3516 ;; paragraph. So we check for a hanging indent.
3517 (if idlwave-hanging-indent
3518 (let ((here (- (point-max) (point)))
3522 (idlwave-calc-hanging-indent))))
3525 ;; Remove whitespace between comment delimiter and
3526 ;; text, insert spaces for appropriate indentation.
3530 (save-excursion (end-of-line) (point)) t
)
3531 (delete-horizontal-space)
3532 (idlwave-indent-to indent
)
3533 (goto-char (- (point-max) here
)))
3535 ;; Split code or comment?
3538 (idlwave-in-comment))
3539 ;; Splitting a non-full-line comment.
3540 ;; Insert the comment delimiter from split line
3544 (skip-chars-forward " \t")
3545 ;; Insert blank to keep off beginning of line
3549 (buffer-substring (idlwave-goto-comment)
3551 (skip-chars-forward "; ")
3553 (idlwave-indent-line))
3554 ;; Split code line - add continuation character
3557 ;; Check to see if we split a string
3558 (if (and (setq beg
(idlwave-in-quote))
3559 idlwave-auto-fill-split-string
)
3560 ;; Split the string and concatenate.
3561 ;; The first extra space is for the space
3562 ;; the line was split. That space was removed.
3563 (insert " " (char-after beg
) " +"))
3566 (if idlwave-auto-fill-split-string
3567 ;; Make the second part of continued string
3570 (skip-chars-forward " \t")
3571 (insert (char-after beg
)))
3574 (message "Warning: continuation inside a string.")))
3575 ;; Although do-auto-fill (via indent-new-comment-line) calls
3576 ;; idlwave-indent-line for the new line, re-indent again
3577 ;; because of the addition of the continuation character.
3578 (idlwave-indent-line))
3581 (defun idlwave-auto-fill-mode (arg)
3582 "Toggle auto-fill mode for IDL mode.
3583 With arg, turn auto-fill mode on if arg is positive.
3584 In auto-fill mode, inserting a space at a column beyond `fill-column'
3585 automatically breaks the line at a previous space."
3587 (prog1 (set idlwave-fill-function
3589 (not (symbol-value idlwave-fill-function
))
3590 (> (prefix-numeric-value arg
) 0))
3594 (set-buffer-modified-p (buffer-modified-p))))
3596 ;(defun idlwave-fill-routine-call ()
3597 ; "Fill a routine definition or statement, indenting appropriately."
3598 ; (let ((where (idlwave-where)))))
3601 (defun idlwave-doc-header (&optional nomark
)
3602 "Insert a documentation header at the beginning of the unit.
3603 Inserts the value of the variable idlwave-file-header. Sets mark before
3604 moving to do insertion unless the optional prefix argument NOMARK
3607 (or nomark
(push-mark))
3608 ;; make sure we catch the current line if it begins the unit
3609 (if idlwave-header-to-beginning-of-file
3610 (goto-char (point-min))
3612 (idlwave-beginning-of-subprogram)
3614 ;; skip function or procedure line
3615 (if (idlwave-look-at "\\<\\(pro\\|function\\)\\>")
3617 (idlwave-end-of-statement)
3618 (if (> (forward-line 1) 0) (insert "\n")))))
3619 (let ((pos (point)))
3620 (if idlwave-file-header
3621 (cond ((car idlwave-file-header
)
3622 (insert-file-contents (car idlwave-file-header
)))
3623 ((stringp (car (cdr idlwave-file-header
)))
3624 (insert (car (cdr idlwave-file-header
))))))
3627 (defun idlwave-default-insert-timestamp ()
3628 "Default timestamp insertion function"
3629 (insert (current-time-string))
3630 (insert ", " (user-full-name))
3631 (if (boundp 'user-mail-address
)
3632 (insert " <" user-mail-address
">")
3633 (insert " <" (user-login-name) "@" (system-name) ">"))
3634 ;; Remove extra spaces from line
3635 (idlwave-fill-paragraph)
3636 ;; Insert a blank line comment to separate from the date entry -
3637 ;; will keep the entry from flowing onto date line if re-filled.
3638 (insert "\n;\n;\t\t"))
3640 (defun idlwave-doc-modification ()
3641 "Insert a brief modification log at the beginning of the current program.
3642 Looks for an occurrence of the value of user variable
3643 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user name
3644 and places the point for the user to add a log. Before moving, saves
3645 location on mark ring so that the user can return to previous point."
3649 (if (and (or (re-search-backward idlwave-doclib-start nil t
)
3651 (goto-char (point-min))
3652 (re-search-forward idlwave-doclib-start nil t
)))
3653 (setq beg
(match-beginning 0))
3654 (re-search-forward idlwave-doclib-end nil t
)
3655 (setq end
(match-end 0)))
3658 (if (re-search-forward
3659 (concat idlwave-doc-modifications-keyword
":")
3664 (insert "\n" comment-start
"\n")
3665 (insert comment-start
" " idlwave-doc-modifications-keyword
":"))
3667 (run-hooks 'idlwave-timestamp-hook
))
3668 (error "No valid DOCLIB header"))))
3672 ;;; Interface to expand-region-abbrevs which did not work when the
3673 ;;; abbrev hook associated with an abbrev moves point backwards
3674 ;;; after abbrev expansion, e.g., as with the abbrev '.n'.
3675 ;;; The original would enter an infinite loop in attempting to expand
3676 ;;; .n (it would continually expand and unexpand the abbrev without expanding
3677 ;;; because the point would keep going back to the beginning of the
3678 ;;; abbrev instead of to the end of the abbrev). We now keep the
3679 ;;; abbrev hook from moving backwards.
3681 (defun idlwave-expand-region-abbrevs (start end
)
3682 "Expand each abbrev occurrence in the region.
3683 Calling from a program, arguments are START END."
3686 (goto-char (min start end
))
3687 (let ((idlwave-show-block nil
) ;Do not blink
3688 (idlwave-abbrev-move nil
)) ;Do not move
3689 (expand-region-abbrevs start end
'noquery
))))
3691 (defun idlwave-quoted ()
3692 "Returns t if point is in a comment or quoted string.
3694 (or (idlwave-in-comment) (idlwave-in-quote)))
3696 (defun idlwave-in-quote ()
3697 "Returns location of the opening quote
3698 if point is in a IDL string constant, nil otherwise.
3699 Ignores comment delimiters on the current line.
3700 Properly handles nested quotation marks and octal
3701 constants - a double quote followed by an octal digit."
3702 ;;; Treat an octal inside an apostrophe to be a normal string. Treat a
3703 ;;; double quote followed by an octal digit to be an octal constant
3704 ;;; rather than a string. Therefore, there is no terminating double
3707 ;; Because single and double quotes can quote each other we must
3708 ;; search for the string start from the beginning of line.
3709 (let* ((start (point))
3710 (eol (progn (end-of-line) (point)))
3711 (bq (progn (beginning-of-line) (point)))
3716 (while (< endq start
)
3717 ;; Find string start
3718 ;; Don't find an octal constant beginning with a double quote
3719 (if (re-search-forward "[\"']" eol
'lim
)
3720 ;; Find the string end.
3721 ;; In IDL, two consecutive delimiters after the start of a
3723 ;; escape for the delimiter in the string.
3724 ;; Two consecutive delimiters alone (i.e., not after the
3725 ;; start of a string) is the null string.
3727 ;; Move to position after quote
3728 (goto-char (1+ (match-beginning 0)))
3729 (setq bq
(1- (point)))
3730 ;; Get the string delimiter
3731 (setq delim
(char-to-string (preceding-char)))
3732 ;; Check for null string
3733 (if (looking-at delim
)
3734 (progn (setq endq
(point)) (forward-char 1))
3735 ;; Look for next unpaired delimiter
3736 (setq found
(search-forward delim eol
'lim
))
3737 (while (looking-at delim
)
3739 (setq found
(search-forward delim eol
'lim
)))
3741 (setq endq
(- (point) 1))
3742 (setq endq
(point)))
3744 (progn (setq bq
(point)) (setq endq
(point)))))
3745 (store-match-data data
)
3746 ;; return string beginning position or nil
3747 (if (> start bq
) bq
))))
3749 (defun idlwave-is-pointer-dereference (&optional limit
)
3750 "Determines if the character after point is a pointer dereference *."
3751 (let ((pos (point)))
3753 (eq (char-after) ?\
*)
3754 (not (idlwave-in-quote))
3757 (re-search-backward (concat "\\(" idlwave-idl-keywords
3758 "\\|[[(*+-/=,^><]\\)\\s-*\\*") limit t
)))))
3761 ;; Statement templates
3763 ;; Replace these with a general template function, something like
3764 ;; expand.el (I think there was also something with a name similar to
3767 (defun idlwave-template (s1 s2
&optional prompt noindent
)
3768 "Build a template with optional prompt expression.
3770 Opens a line if point is not followed by a newline modulo intervening
3771 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3772 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3773 adjusted according to `idlwave-abbrev-change-case'. If optional argument
3774 PROMPT is a string then it is displayed as a message in the
3775 minibuffer. The PROMPT serves as a reminder to the user of an
3776 expression to enter.
3778 The lines containing S1 and S2 are reindented using `indent-region'
3779 unless the optional second argument NOINDENT is non-nil."
3780 (if (eq major-mode
'idlwave-shell-mode
)
3781 ;; This is a gross hack to avoit template abbrev expansion
3782 ;; in the shell. FIXME: This is a dirty hack.
3783 (if (and (eq this-command
'self-insert-command
)
3784 (equal last-abbrev-location
(point)))
3785 (insert last-abbrev-text
)
3786 (error "No templates in idlwave-shell"))
3787 (cond ((eq idlwave-abbrev-change-case
'down
)
3788 (setq s1
(downcase s1
) s2
(downcase s2
)))
3789 (idlwave-abbrev-change-case
3790 (setq s1
(upcase s1
) s2
(upcase s2
))))
3791 (let ((beg (save-excursion (beginning-of-line) (point)))
3793 (if (not (looking-at "\\s-*\n"))
3800 (indent-region beg end nil
))
3801 (if (stringp prompt
)
3802 (message "%s" prompt
)))))
3804 (defun idlwave-rw-case (string)
3805 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3806 (if idlwave-reserved-word-upcase
3810 (defun idlwave-elif ()
3811 "Build skeleton IDL if-else block."
3814 (idlwave-rw-case "if")
3815 (idlwave-rw-case " then begin\n\nendif else begin\n\nendelse")
3816 "Condition expression"))
3818 (defun idlwave-case ()
3819 "Build skeleton IDL case statement."
3822 (idlwave-rw-case "case")
3823 (idlwave-rw-case " of\n\nendcase")
3824 "Selector expression"))
3826 (defun idlwave-switch ()
3827 "Build skeleton IDL switch statement."
3830 (idlwave-rw-case "switch")
3831 (idlwave-rw-case " of\n\nendswitch")
3832 "Selector expression"))
3834 (defun idlwave-for ()
3835 "Build skeleton for loop statment."
3838 (idlwave-rw-case "for")
3839 (idlwave-rw-case " do begin\n\nendfor")
3842 (defun idlwave-if ()
3843 "Build skeleton for loop statment."
3846 (idlwave-rw-case "if")
3847 (idlwave-rw-case " then begin\n\nendif")
3848 "Scalar logical expression"))
3850 (defun idlwave-procedure ()
3853 (idlwave-rw-case "pro")
3854 (idlwave-rw-case "\n\nreturn\nend")
3857 (defun idlwave-function ()
3860 (idlwave-rw-case "function")
3861 (idlwave-rw-case "\n\nreturn\nend")
3864 (defun idlwave-repeat ()
3867 (idlwave-rw-case "repeat begin\n\nendrep until")
3868 (idlwave-rw-case "")
3871 (defun idlwave-while ()
3874 (idlwave-rw-case "while")
3875 (idlwave-rw-case " do begin\n\nendwhile")
3878 (defun idlwave-split-string (string &optional pattern
)
3879 "Return a list of substrings of STRING which are separated by PATTERN.
3880 If PATTERN is omitted, it defaults to \"[ \\f\\t\\n\\r\\v]+\"."
3882 (setq pattern
"[ \f\t\n\r\v]+"))
3883 (let (parts (start 0))
3884 (while (string-match pattern string start
)
3885 (setq parts
(cons (substring string start
(match-beginning 0)) parts
)
3886 start
(match-end 0)))
3887 (nreverse (cons (substring string start
) parts
))))
3889 (defun idlwave-replace-string (string replace_string replace_with
)
3891 (last (length string
))
3894 (while (setq end
(string-match replace_string string start
))
3896 (concat ret_string
(substring string start end
) replace_with
))
3897 (setq start
(match-end 0)))
3898 (setq ret_string
(concat ret_string
(substring string start last
)))))
3900 (defun idlwave-get-buffer-visiting (file)
3901 ;; Return the buffer currently visiting FILE
3903 ((boundp 'find-file-compare-truenames
) ; XEmacs
3904 (let ((find-file-compare-truenames t
))
3905 (get-file-buffer file
)))
3906 ((fboundp 'find-buffer-visiting
) ; Emacs
3907 (find-buffer-visiting file
))
3908 (t (error "This should not happen (idlwave-get-buffer-visiting)"))))
3910 (defvar idlwave-outlawed-buffers nil
3911 "List of buffer pulled up by idlwave for special reasons.
3912 Buffers in this list may be killed by `idlwave-kill-autoloaded-buffers'.")
3914 (defun idlwave-find-file-noselect (file &optional why
)
3915 ;; Return a buffer visiting file.
3916 (or (idlwave-get-buffer-visiting file
)
3917 (let ((buf (find-file-noselect file
)))
3918 (if why
(add-to-list 'idlwave-outlawed-buffers
(cons buf why
)))
3921 (defun idlwave-kill-autoloaded-buffers ()
3922 "Kill buffers created automatically by IDLWAVE.
3923 Function prompts for a letter to identify the buffers to kill.
3924 Possible letters are:
3926 f Buffers created by the command \\[idlwave-find-module] or mouse
3927 clicks in the routine info window.
3928 s Buffers created by the IDLWAVE Shell to display where execution
3929 stopped or an error was found.
3930 a Both of the above.
3932 Buffer containing unsaved changes require confirmation before they are killed."
3934 (if (null idlwave-outlawed-buffers
)
3935 (error "No IDLWAVE-created buffers available")
3936 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3937 (idlwave-count-outlawed-buffers 'find
)
3938 (idlwave-count-outlawed-buffers 'shell
)))
3939 (let ((c (read-char)))
3941 ((member c
'(?f ?\C-f
))
3942 (idlwave-do-kill-autoloaded-buffers 'find
))
3943 ((member c
'(?s ?\C-s
))
3944 (idlwave-do-kill-autoloaded-buffers 'shell
))
3945 ((member c
'(?a ?\C-a
))
3946 (idlwave-do-kill-autoloaded-buffers t
))
3947 (t (error "Abort"))))))
3949 (defun idlwave-count-outlawed-buffers (tag)
3950 "How many outlawed buffers have tag TAG?"
3953 (lambda (x) (eq (cdr x
) tag
))
3954 idlwave-outlawed-buffers
))))
3956 (defun idlwave-do-kill-autoloaded-buffers (&rest reasons
)
3957 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3958 (let* ((list (copy-sequence idlwave-outlawed-buffers
))
3961 (while (setq entry
(pop list
))
3962 (if (buffer-live-p (car entry
))
3963 (and (or (memq t reasons
)
3964 (memq (cdr entry
) reasons
))
3965 (kill-buffer (car entry
))
3967 (setq idlwave-outlawed-buffers
3968 (delq entry idlwave-outlawed-buffers
)))
3969 (setq idlwave-outlawed-buffers
3970 (delq entry idlwave-outlawed-buffers
))))
3971 (message "%d buffer%s killed" cnt
(if (= cnt
1) "" "s"))))
3973 (defun idlwave-revoke-license-to-kill ()
3974 "Remove BUFFER from the buffers which may be killed.
3975 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3976 Intended for `after-save-hook'."
3977 (let* ((buf (current-buffer))
3978 (entry (assq buf idlwave-outlawed-buffers
)))
3981 (setq idlwave-outlawed-buffers
3982 (delq entry idlwave-outlawed-buffers
)))
3983 ;; Remove this function from the hook.
3984 (remove-hook 'after-save-hook
'idlwave-revoke-license-to-kill
'local
)))
3986 (defvar idlwave-path-alist
)
3987 (defun idlwave-locate-lib-file (file)
3988 ;; Find FILE on the scanned lib path and return a buffer visiting it
3989 (let* ((dirs idlwave-path-alist
)
3992 (while (setq dir
(car (pop dirs
)))
3994 (setq efile
(expand-file-name file dir
)))
3995 (throw 'exit efile
))))))
3997 (defun idlwave-expand-lib-file-name (file)
3998 ;; Find FILE on the scanned lib path and return a buffer visiting it
3999 ;; This is for, e.g., finding source with no user catalog
4002 ((file-name-absolute-p file
) file
)
4003 (t (idlwave-locate-lib-file file
))))
4005 (defun idlwave-make-tags ()
4006 "Creates the IDL tags file IDLTAGS in the current directory from
4007 the list of directories specified in the minibuffer. Directories may be
4008 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
4009 specified top directories are searched if the directory name is prefixed
4010 by @. Specify @ directories with care, it may take a long, long time if
4013 (let (directory directories cmd append status numdirs dir getsubdirs
4014 buffer save_buffer files numfiles item errbuf
)
4017 ;; Read list of directories
4018 (setq directory
(read-string "Tag Directories: " "."))
4019 (setq directories
(idlwave-split-string directory
"[ \t]+"))
4021 ;; Set etags command, vars
4022 (setq cmd
"etags --output=IDLTAGS --language=none --regex='/[
4023 \\t]*[pP][Rr][Oo][ \\t]+\\([^ \\t,]+\\)/' --regex='/[
4024 \\t]*[Ff][Uu][Nn][Cc][Tt][Ii][Oo][Nn][ \\t]+\\([^ \\t,]+\\)/' ")
4028 ;; For each directory
4030 (setq dir
(nth numdirs directories
))
4033 ;; Find the subdirectories
4034 (if (string-match "^[@]\\(.+\\)$" dir
)
4035 (setq getsubdirs t
) (setq getsubdirs nil
))
4036 (if (and getsubdirs
) (setq dir
(substring dir
1 (length dir
))))
4037 (setq dir
(expand-file-name dir
))
4038 (if (file-directory-p dir
)
4040 (if (and getsubdirs
)
4042 (setq buffer
(get-buffer-create "*idltags*"))
4043 (call-process "sh" nil buffer nil
"-c"
4044 (concat "find " dir
" -type d -print"))
4045 (setq save_buffer
(current-buffer))
4047 (setq files
(idlwave-split-string
4048 (idlwave-replace-string
4049 (buffer-substring 1 (point-max))
4052 (set-buffer save_buffer
)
4053 (kill-buffer buffer
))
4054 (setq files
(list (concat dir
"/*.pro"))))
4056 ;; For each subdirectory
4058 (setq item
(nth numfiles files
))
4062 (if (not (string-match "^[ \\t]*$" item
))
4064 (message "%s" (concat "Tagging " item
"..."))
4065 (setq errbuf
(get-buffer-create "*idltags-error*"))
4066 (setq status
(+ status
4067 (if (eq 0 (call-process
4068 "sh" nil errbuf nil
"-c"
4069 (concat cmd append item
)))
4073 ;; Append additional tags
4074 (setq append
" --append ")
4075 (setq numfiles
(1+ numfiles
))
4076 (setq item
(nth numfiles files
)))
4078 (setq numfiles
(1+ numfiles
))
4079 (setq item
(nth numfiles files
))
4082 (setq numdirs
(1+ numdirs
))
4083 (setq dir
(nth numdirs directories
)))
4085 (setq numdirs
(1+ numdirs
))
4086 (setq dir
(nth numdirs directories
)))))
4088 (setq errbuf
(get-buffer-create "*idltags-error*"))
4090 (kill-buffer errbuf
))
4094 (defun idlwave-toggle-comment-region (beg end
&optional n
)
4095 "Comment the lines in the region if the first non-blank line is
4096 commented, and conversely, uncomment region. If optional prefix arg
4097 N is non-nil, then for N positive, add N comment delimiters or for N
4098 negative, remove N comment delimiters.
4099 Uses `comment-region' which does not place comment delimiters on
4101 (interactive "r\nP")
4103 (comment-region beg end
(prefix-numeric-value n
))
4108 (skip-chars-forward " \t\n")
4109 (if (looking-at (concat "[ \t]*\\(" comment-start
"+\\)"))
4110 (if (fboundp 'uncomment-region
)
4111 (uncomment-region beg end
)
4112 (comment-region beg end
4113 (- (length (buffer-substring
4116 (comment-region beg end
)))))
4119 ;; ----------------------------------------------------------------------------
4120 ;; ----------------------------------------------------------------------------
4121 ;; ----------------------------------------------------------------------------
4122 ;; ----------------------------------------------------------------------------
4124 ;; Completion and Routine Info
4127 ;; String "intern" functions
4129 ;; For the completion and routine info function, we want to normalize
4130 ;; the case of procedure names etc. We do this by "interning" these
4131 ;; string is a hand-crafted way. Hashes are used to map the downcase
4132 ;; version of the strings to the cased versions. Most *-sint-*
4133 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4134 ;; system hash. The former is re-scanned, and the latter takes case
4137 ;; Since these cased versions are really lisp objects, we can use `eq'
4138 ;; to search, which is a large performance boost. All new strings
4139 ;; need to be "sinterned". We do this as early as possible after
4140 ;; getting these strings from completion or buffer substrings. So
4141 ;; most of the code can simply assume to deal with "sinterned"
4142 ;; strings. The only exception is that the functions which scan whole
4143 ;; buffers for routine information do not intern the grabbed strings.
4144 ;; This is only done afterwards. Therefore in these functions it is
4145 ;; *not* safe to assume the strings can be compared with `eq' and be
4146 ;; fed into the routine assq functions.
4148 ;; Here we define the hashing functions.
4150 ;; The variables which hold the hashes.
4151 (defvar idlwave-sint-routines
'(nil))
4152 (defvar idlwave-sint-keywords
'(nil))
4153 (defvar idlwave-sint-methods
'(nil))
4154 (defvar idlwave-sint-classes
'(nil))
4155 (defvar idlwave-sint-dirs
'(nil))
4156 (defvar idlwave-sint-libnames
'(nil))
4158 (defun idlwave-reset-sintern (&optional what
)
4159 "Reset all sintern hashes."
4160 ;; Make sure the hash functions are accessible.
4161 (if (or (not (fboundp 'gethash
))
4162 (not (fboundp 'puthash
)))
4165 (or (fboundp 'puthash
)
4166 (defalias 'puthash
'cl-puthash
))))
4167 (let ((entries '((idlwave-sint-routines 1000 10)
4168 (idlwave-sint-keywords 1000 10)
4169 (idlwave-sint-methods 100 10)
4170 (idlwave-sint-classes 10 10))))
4172 ;; Make sure these are lists
4173 (loop for entry in entries
4174 for var
= (car entry
)
4175 do
(if (not (consp (symbol-value var
))) (set var
(list nil
))))
4177 ;; Reset the system & library hash
4178 (when (or (eq what t
) (eq what
'syslib
)
4179 (null (cdr idlwave-sint-routines
)))
4180 (loop for entry in entries
4181 for var
= (car entry
) for size
= (nth 1 entry
)
4182 do
(setcdr (symbol-value var
)
4183 (make-hash-table ':size size
':test
'equal
)))
4184 (setq idlwave-sint-dirs nil
4185 idlwave-sint-libnames nil
))
4187 ;; Reset the buffer & shell hash
4188 (when (or (eq what t
) (eq what
'bufsh
)
4189 (null (car idlwave-sint-routines
)))
4190 (loop for entry in entries
4191 for var
= (car entry
) for size
= (nth 1 entry
)
4192 do
(setcar (symbol-value var
)
4193 (make-hash-table ':size size
':test
'equal
))))))
4195 (defun idlwave-sintern-routine-or-method (name &optional class set
)
4197 (idlwave-sintern-method name set
)
4198 (idlwave-sintern-routine name set
)))
4200 (defun idlwave-sintern (stype &rest args
)
4201 (apply (intern (concat "idlwave-sintern-" (symbol-name stype
))) args
))
4203 ;;(defmacro idlwave-sintern (type var)
4204 ;; `(cond ((not (stringp name)) name)
4205 ;; ((gethash (downcase name) (cdr ,var)))
4206 ;; ((gethash (downcase name) (car ,var)))
4207 ;; (set (idlwave-sintern-set name ,type ,var set))
4210 (defun idlwave-sintern-routine (name &optional set
)
4211 (cond ((not (stringp name
)) name
)
4212 ((gethash (downcase name
) (cdr idlwave-sint-routines
)))
4213 ((gethash (downcase name
) (car idlwave-sint-routines
)))
4214 (set (idlwave-sintern-set name
'routine idlwave-sint-routines set
))
4216 (defun idlwave-sintern-keyword (name &optional set
)
4217 (cond ((not (stringp name
)) name
)
4218 ((gethash (downcase name
) (cdr idlwave-sint-keywords
)))
4219 ((gethash (downcase name
) (car idlwave-sint-keywords
)))
4220 (set (idlwave-sintern-set name
'keyword idlwave-sint-keywords set
))
4222 (defun idlwave-sintern-method (name &optional set
)
4223 (cond ((not (stringp name
)) name
)
4224 ((gethash (downcase name
) (cdr idlwave-sint-methods
)))
4225 ((gethash (downcase name
) (car idlwave-sint-methods
)))
4226 (set (idlwave-sintern-set name
'method idlwave-sint-methods set
))
4228 (defun idlwave-sintern-class (name &optional set
)
4229 (cond ((not (stringp name
)) name
)
4230 ((gethash (downcase name
) (cdr idlwave-sint-classes
)))
4231 ((gethash (downcase name
) (car idlwave-sint-classes
)))
4232 (set (idlwave-sintern-set name
'class idlwave-sint-classes set
))
4235 (defun idlwave-sintern-dir (dir &optional set
)
4236 (car (or (member dir idlwave-sint-dirs
)
4237 (setq idlwave-sint-dirs
(cons dir idlwave-sint-dirs
)))))
4238 (defun idlwave-sintern-libname (name &optional set
)
4239 (car (or (member name idlwave-sint-libnames
)
4240 (setq idlwave-sint-libnames
(cons name idlwave-sint-libnames
)))))
4242 (defun idlwave-sintern-set (name type tables set
)
4243 (let* ((func (or (cdr (assq type idlwave-completion-case
))
4245 (iname (funcall (if (eq func
'preserve
) 'identity func
) name
))
4246 (table (if (eq set
'sys
) (cdr tables
) (car tables
))))
4247 (puthash (downcase name
) iname table
)
4250 (defun idlwave-sintern-keyword-list (kwd-list &optional set
)
4251 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4253 (setcar x
(idlwave-sintern-keyword (car x
) set
)))
4257 (defun idlwave-sintern-rinfo-list (list &optional set default-dir
)
4258 "Sintern all strings in the rinfo LIST. With optional parameter
4259 SET: also set new patterns. Probably this will always have to be t.
4260 If DEFAULT-DIR is passed, it is used as the base of the directory"
4261 (let (entry name type class kwds res source call new
)
4263 (setq entry
(car list
)
4268 source
(nth 3 entry
)
4270 kwds
(nthcdr 5 entry
))
4272 ;; The class and name
4275 (if (symbolp class
) (setq class
(symbol-name class
)))
4276 (setq class
(idlwave-sintern-class class set
))
4277 (setq name
(idlwave-sintern-method name set
)))
4278 (setq name
(idlwave-sintern-routine name set
)))
4281 (let ((source-type (car source
))
4282 (source-file (nth 1 source
))
4283 (source-dir (if default-dir
4284 (file-name-as-directory default-dir
)
4286 (source-lib (nth 3 source
)))
4287 (if (stringp source-dir
)
4288 (setq source-dir
(idlwave-sintern-dir source-dir set
)))
4289 (if (stringp source-lib
)
4290 (setq source-lib
(idlwave-sintern-libname source-lib set
)))
4291 (setq source
(list source-type source-file source-dir source-lib
)))
4294 (setq kwds
(mapcar (lambda (x)
4295 (idlwave-sintern-keyword-list x set
))
4298 ;; Build a canonicalized list
4299 (setq new
(nconc (list name type class source call
) kwds
)
4300 res
(cons new res
)))
4303 ;; Creating new sintern tables
4305 (defun idlwave-new-sintern-type (tag)
4306 "Define a variable and a function to sintern the new type TAG.
4307 This defines the function `idlwave-sintern-TAG' and the variable
4308 `idlwave-sint-TAGs'."
4309 (let* ((name (symbol-name tag
))
4310 (names (concat name
"s"))
4311 (var (intern (concat "idlwave-sint-" names
)))
4312 (func (intern (concat "idlwave-sintern-" name
))))
4313 (set var nil
) ; initial value of the association list
4314 (fset func
; set the function
4315 `(lambda (name &optional set
)
4316 (cond ((not (stringp name
)) name
)
4317 ((cdr (assoc (downcase name
) ,var
)))
4319 (setq ,var
(cons (cons (downcase name
) name
) ,var
))
4323 (defun idlwave-reset-sintern-type (tag)
4324 "Reset the sintern variable associated with TAG."
4325 (set (intern (concat "idlwave-sint-" (symbol-name tag
) "s")) nil
))
4327 ;;---------------------------------------------------------------------------
4330 ;; The variables which hold the information
4331 (defvar idlwave-system-routines nil
4332 "Holds the routine-info obtained by scanning buffers.")
4333 (defvar idlwave-buffer-routines nil
4334 "Holds the routine-info obtained by scanning buffers.")
4335 (defvar idlwave-compiled-routines nil
4336 "Holds the routine-info obtained by asking the shell.")
4337 (defvar idlwave-unresolved-routines nil
4338 "Holds the unresolved routine-info obtained by asking the shell.")
4339 (defvar idlwave-user-catalog-routines nil
4340 "Holds the procedure routine-info from the user scan.")
4341 (defvar idlwave-library-catalog-routines nil
4342 "Holds the procedure routine-info from the .idlwave_catalog library files.")
4343 (defvar idlwave-library-catalog-libname nil
4344 "Name of library catalog loaded from .idlwave_catalog files.")
4345 (defvar idlwave-path-alist nil
4346 "Alist with !PATH directories and zero or more flags if the dir has
4347 been scanned in a user catalog ('user) or discovered in a library
4349 (defvar idlwave-true-path-alist nil
4350 "Like `idlwave-path-alist', but with true filenames.")
4351 (defvar idlwave-routines nil
4352 "Holds the combined procedure/function/method routine-info.")
4353 (defvar idlwave-class-alist nil
4354 "Holds the class names known to IDLWAVE.")
4355 (defvar idlwave-class-history nil
4356 "The history of classes selected with the minibuffer.")
4357 (defvar idlwave-force-class-query nil
)
4358 (defvar idlwave-before-completion-wconf nil
4359 "The window configuration just before the completion buffer was displayed.")
4360 (defvar idlwave-last-system-routine-info-cons-cell nil
4361 "The last cons cell in the system routine info.")
4364 ;; The code to get routine info from different sources.
4366 (defvar idlwave-system-routines
)
4367 (defvar idlwave-catalog-process nil
4368 "The background process currently updating the catalog.")
4370 (defun idlwave-routines ()
4371 "Provide a list of IDL routines.
4372 This routine loads the builtin routines on the first call. Later it
4373 only returns the value of the variable."
4374 (if (and idlwave-catalog-process
4375 (processp idlwave-catalog-process
))
4378 ((equal (process-status idlwave-catalog-process
) 'exit
)
4379 (message "updating........")
4380 (setq idlwave-catalog-process nil
)
4381 (idlwave-update-routine-info '(4)))
4382 ((equal (process-status idlwave-catalog-process
) 'run
)
4383 ;; Keep it running...
4386 ;; Something is wrong, get rid of the process
4387 (message "Problem with catalog process") (beep)
4389 (kill-process idlwave-catalog-process
)
4391 (setq idlwave-catalog-process nil
)))))
4392 (or idlwave-routines
4394 (idlwave-update-routine-info)
4395 ;; return the current value
4398 (defvar idlwave-update-rinfo-hook nil
4399 "List of functions which should run after a global rinfo update.
4400 Does not run after automatic updates of buffer or the shell.")
4402 (defun idlwave-rescan-catalog-directories ()
4403 "Rescan the previously selected directories. For batch processing."
4404 (idlwave-update-routine-info '(16)))
4406 (defun idlwave-rescan-asynchronously ()
4407 "Dispatch another Emacs instance to update the idlwave catalog.
4408 After the process finishes normally, the first access to routine info
4409 will re-read the catalog."
4411 (if (processp idlwave-catalog-process
)
4412 (if (eq (process-status idlwave-catalog-process
) 'run
)
4413 (if (yes-or-no-p "A catalog-updating process is running. Kill it? ")
4416 (kill-process idlwave-catalog-process
)
4418 (error "Process killed, no new process started"))
4421 (kill-process idlwave-catalog-process
)
4423 (if (or (not idlwave-user-catalog-file
)
4424 (not (stringp idlwave-user-catalog-file
))
4425 (not (file-regular-p idlwave-user-catalog-file
)))
4426 (error "No catalog has been produced yet"))
4427 (let* ((emacs (concat invocation-directory invocation-name
))
4428 (args (list "-batch"
4429 "-l" (expand-file-name "~/.emacs")
4431 "-f" "idlwave-rescan-catalog-directories"))
4432 (process (apply 'start-process
"idlcat"
4434 (setq idlwave-catalog-process process
)
4435 (set-process-sentinel
4438 (when (string-match "finished" why
)
4439 (setq idlwave-routines nil
4440 idlwave-system-routines nil
4441 idlwave-catalog-process nil
)
4442 (or (idlwave-start-load-rinfo-timer)
4443 (idlwave-update-routine-info '(4))))))
4444 (message "Background job started to update catalog file")))
4447 ;; Format for all routine info user catalog, library catalogs, etc.:
4449 ;; ("ROUTINE" type class
4450 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4451 ;; (buffer pro_file dir) | (compiled pro_file dir)
4452 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4453 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4455 ;; DIR will be supplied dynamically while loading library catalogs,
4456 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4457 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4458 ;; be nil, as can LINK1, etc., if no HTML help is available.
4461 (defvar idlwave-load-rinfo-idle-timer
)
4462 (defvar idlwave-shell-path-query
)
4464 (defun idlwave-update-routine-info (&optional arg no-concatenate
)
4465 "Update the internal routine-info lists.
4466 These lists are used by `idlwave-routine-info' (\\[idlwave-routine-info])
4467 and by `idlwave-complete' (\\[idlwave-complete]) to provide information
4468 about individual routines.
4470 The information can come from 4 sources:
4471 1. IDL programs in the current editing session
4472 2. Compiled modules in an IDL shell running as Emacs subprocess
4473 3. A list which covers the IDL system routines.
4474 4. A list which covers the prescanned library files.
4476 Scans all IDLWAVE-mode buffers of the current editing session (see
4477 `idlwave-scan-all-buffers-for-routine-info').
4478 When an IDL shell is running, this command also queries the IDL program
4479 for currently compiled routines.
4481 With prefix ARG, also reload the system and library lists.
4482 With two prefix ARG's, also rescans the chosen user catalog tree.
4483 With three prefix args, dispatch asynchronous process to do the update.
4485 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4486 lists, but instead wait for the shell query to complete and
4487 asynchronously finish updating routine info. This is set
4488 automatically when called interactively. When you need routine
4489 information updated immediately, leave NO-CONCATENATE nil."
4490 (interactive "P\np")
4491 ;; Stop any idle processing
4492 (if (or (and (fboundp 'itimerp
)
4493 (itimerp idlwave-load-rinfo-idle-timer
))
4494 (and (fboundp 'timerp
)
4495 (timerp idlwave-load-rinfo-idle-timer
)))
4496 (cancel-timer idlwave-load-rinfo-idle-timer
))
4499 ;; Start a background process which updates the catalog.
4500 (idlwave-rescan-asynchronously))
4502 ;; Update the user catalog now, and wait for them.
4503 (idlwave-create-user-catalog-file t
))
4505 (let* ((load (or arg
4506 idlwave-buffer-case-takes-precedence
4507 (null idlwave-routines
)))
4508 ;; The override-idle means, even if the idle timer has done some
4509 ;; preparing work, load and renormalize everything anyway.
4510 (override-idle (or arg idlwave-buffer-case-takes-precedence
)))
4512 (setq idlwave-buffer-routines nil
4513 idlwave-compiled-routines nil
4514 idlwave-unresolved-routines nil
)
4515 ;; Reset the appropriate hashes
4516 (if (get 'idlwave-reset-sintern
'done-by-idle
)
4517 ;; reset was already done in idle time, so skip this step now once
4518 (put 'idlwave-reset-sintern
'done-by-idle nil
)
4519 (idlwave-reset-sintern (cond (load t
)
4520 ((null idlwave-system-routines
) t
)
4523 (if idlwave-buffer-case-takes-precedence
4524 ;; We can safely scan the buffer stuff first
4526 (idlwave-update-buffer-routine-info)
4527 (and load
(idlwave-load-all-rinfo override-idle
)))
4528 ;; We first do the system info, and then the buffers
4529 (and load
(idlwave-load-all-rinfo override-idle
))
4530 (idlwave-update-buffer-routine-info))
4532 ;; Let's see if there is a shell
4533 (let* ((shell-is-running (and (fboundp 'idlwave-shell-is-running
)
4534 (idlwave-shell-is-running)))
4535 (ask-shell (and shell-is-running
4536 idlwave-query-shell-for-routine-info
)))
4538 ;; Load the library catalogs again, first re-scanning the path
4540 (if shell-is-running
4541 (idlwave-shell-send-command idlwave-shell-path-query
4543 (idlwave-shell-get-path-info)
4544 (idlwave-scan-library-catalogs))
4546 (idlwave-scan-library-catalogs)))
4548 (if (or (not ask-shell
)
4549 (not no-concatenate
))
4550 ;; 1. If we are not going to ask the shell, we need to do the
4551 ;; concatenation now.
4552 ;; 2. When this function is called non-interactively, it
4553 ;; means that someone needs routine info *now*. The
4554 ;; shell update causes the concatenation to be
4555 ;; *delayed*, so not in time for the current command.
4556 ;; Therefore, we do a concatenation now, even though
4557 ;; the shell might do it again.
4558 (idlwave-concatenate-rinfo-lists nil
'run-hooks
))
4561 ;; Ask the shell about the routines it knows of.
4562 (message "Querying the shell")
4563 (idlwave-shell-update-routine-info nil t
)))))))
4566 (defvar idlwave-load-rinfo-steps-done
(make-vector 6 nil
))
4567 (defvar idlwave-load-rinfo-idle-timer nil
)
4568 (defun idlwave-start-load-rinfo-timer ()
4569 (if (or (and (fboundp 'itimerp
)
4570 (itimerp idlwave-load-rinfo-idle-timer
))
4571 (and (fboundp 'timerp
)
4572 (timerp idlwave-load-rinfo-idle-timer
)))
4573 (cancel-timer idlwave-load-rinfo-idle-timer
))
4574 (setq idlwave-load-rinfo-steps-done
(make-vector 6 nil
))
4575 (setq idlwave-load-rinfo-idle-timer nil
)
4576 (if (and idlwave-init-rinfo-when-idle-after
4577 (numberp idlwave-init-rinfo-when-idle-after
)
4578 (not (equal 0 idlwave-init-rinfo-when-idle-after
))
4579 (not idlwave-routines
))
4582 (setq idlwave-load-rinfo-idle-timer
4583 (run-with-idle-timer
4584 idlwave-init-rinfo-when-idle-after
4585 nil
'idlwave-load-rinfo-next-step
)))
4588 (defvar idlwave-library-routines nil
"Obsolete variable.")
4590 ;;------ XML Help routine info system
4591 (defun idlwave-load-system-routine-info ()
4592 ;; Load the system routine info from the cached routine info file,
4593 ;; which, if necessary, will be re-created from the XML file on
4594 ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo
4595 ;; file distributed with older IDLWAVE versions (<6.0)
4596 (unless (and (load idlwave-xml-system-rinfo-converted-file
4597 'noerror
'nomessage
)
4598 (idlwave-xml-system-routine-info-up-to-date))
4599 ;; See if we can create it from XML source
4601 (idlwave-convert-xml-system-routine-info)
4603 (unless (load idlwave-xml-system-rinfo-converted-file
4604 'noerror
'nomessage
)
4605 (if idlwave-system-routines
4607 "Failed to load converted routine info, using old conversion.")
4609 "Failed to convert XML routine info, falling back on idlw-rinfo.")
4610 (if (not (load "idlw-rinfo" 'noerror
'nomessage
))
4612 "Could not locate any system routine information."))))))))
4614 (defun idlwave-xml-system-routine-info-up-to-date()
4615 (let* ((dir (file-name-as-directory
4616 (expand-file-name "help/online_help" (idlwave-sys-dir))))
4617 (catalog-file (expand-file-name "idl_catalog.xml" dir
)))
4618 (file-newer-than-file-p ;converted file is newer than catalog
4619 idlwave-xml-system-rinfo-converted-file
4622 (defvar idlwave-system-class-info nil
) ; Gathered from idlw-rinfo
4623 (defvar idlwave-system-variables-alist nil
4624 "Alist of system variables and the associated structure tags.
4625 Gets set in cached XML rinfo, or `idlw-rinfo.el'.")
4626 (defvar idlwave-executive-commands-alist nil
4627 "Alist of system variables and their help files.")
4628 (defvar idlwave-help-special-topic-words nil
)
4631 (defun idlwave-shorten-syntax (syntax name
&optional class
)
4632 ;; From a list of syntax statments, shorten with %s and group with "or"
4633 (let ((case-fold-search t
))
4636 (while (string-match name x
)
4637 (setq x
(replace-match "%s" t t x
)))
4639 (while (string-match class x
)
4640 (setq x
(replace-match "%s" t t x
))))
4645 (defun idlwave-xml-create-class-method-lists (xml-entry)
4646 ;; Create a class list entry from the xml parsed list., returning a
4647 ;; cons of form (class-entry method-entries).
4648 (let* ((nameblock (nth 1 xml-entry
))
4649 (class (cdr (assq 'name nameblock
)))
4650 (link (cdr (assq 'link nameblock
)))
4651 (params (cddr xml-entry
))
4652 (case-fold-search t
)
4654 method methods-entry extra-kwds
4655 props get-props set-props init-props inherits
4658 (setq pelem
(car params
))
4660 (setq ptype
(car pelem
)
4661 props
(car (cdr pelem
)))
4663 ((eq ptype
'SUPERCLASS
)
4664 (let ((pname (cdr (assq 'name props
)))
4665 (plink (cdr (assq 'link props
))))
4666 (unless (and (string= pname
"None")
4667 (string= plink
"None"))
4668 (push pname inherits
))))
4670 ((eq ptype
'PROPERTY
)
4671 (let ((pname (cdr (assq 'name props
)))
4672 (plink (cdr (assq 'link props
)))
4673 (get (string= (cdr (assq 'get props
)) "Yes"))
4674 (set (string= (cdr (assq 'set props
)) "Yes"))
4675 (init (string= (cdr (assq 'init props
)) "Yes")))
4676 (if get
(push (list pname plink
) get-props
))
4677 (if set
(push (list pname plink
) set-props
))
4678 (if init
(push (list pname plink
) init-props
))))
4681 (setq method
(cdr (assq 'name props
)))
4682 (setq extra-kwds
;;Assume all property keywords are gathered already
4684 ((string-match (concat class
"::Init") method
)
4685 (put 'init-props
'matched t
)
4687 ((string-match (concat class
"::GetProperty") method
)
4688 (put 'get-props
'matched t
)
4690 ((string-match (concat class
"::SetProperty") method
)
4691 (put 'set-props
'matched t
)
4695 (nconc (idlwave-xml-create-rinfo-list pelem class extra-kwds
)
4698 (setq params
(cdr params
)))
4699 ;(unless (get 'init-props 'matched)
4700 ; (message "Failed to match Init in class %s" class))
4701 ;(unless (get 'get-props 'matched)
4702 ; (message "Failed to match GetProperty in class %s" class))
4703 ;(unless (get 'set-props 'matched)
4704 ; (message "Failed to match SetProperty in class %s" class))
4707 (list class
(append '(inherits) inherits
) (list 'link link
))
4708 (list class
(list 'link link
))))
4709 (cons class-entry methods-entry
)))
4711 (defun idlwave-xml-create-rinfo-list (xml-entry &optional class extra-kws
)
4712 ;; Create correctly structured list elements from ROUTINE or METHOD
4713 ;; XML list structures. Return a list of list elements, with more
4714 ;; than one sub-list possible if a routine can serve as both
4715 ;; procedure and function (e.g. call_method).
4716 (let* ((nameblock (nth 1 xml-entry
))
4717 (name (cdr (assq 'name nameblock
)))
4718 (link (cdr (assq 'link nameblock
)))
4719 (params (cddr xml-entry
))
4720 (syntax-vec (make-vector 3 nil
)) ; procedure, function, exec command
4721 (case-fold-search t
)
4722 syntax kwd klink pref-list kwds pelem ptype entry props result type
)
4723 (if class
;; strip out class name from class method name string
4724 (if (string-match (concat class
"::") name
)
4725 (setq name
(substring name
(match-end 0)))))
4727 (setq pelem
(car params
))
4729 (setq ptype
(car pelem
)
4730 props
(car (cdr pelem
)))
4733 (setq syntax
(cdr (assq 'name props
)))
4734 (if (string-match "->" syntax
)
4735 (setq syntax
(replace-match "->" t nil syntax
)))
4736 (setq type
(cdr (assq 'type props
)))
4738 (aref syntax-vec
(cond
4739 ((string-match "^pro" type
) 0)
4740 ((string-match "^fun" type
) 1)
4741 ((string-match "^exec" type
) 2)))))
4742 ((eq ptype
'KEYWORD
)
4743 (setq kwd
(cdr (assq 'name props
))
4744 klink
(cdr (assq 'link props
)))
4745 (if (string-match "^\\[XY\\(Z?\\)\\]" kwd
)
4748 (if (match-string 1 kwd
) '("X" "Y" "Z") '("X" "Y"))
4749 kwd
(substring kwd
(match-end 0)))
4750 (loop for x in pref-list do
4751 (push (list (concat x kwd
) klink
) kwds
)))
4752 (push (list kwd klink
) kwds
)))
4754 (t))); Do nothing for the others
4755 (setq params
(cdr params
)))
4758 ; (if (and (null (aref syntax-vec 0))
4759 ; (null (aref syntax-vec 1))
4760 ; (null (aref syntax-vec 2)))
4761 ; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints")
4763 ; (insert (format "Missing SYNTAX entry for %s::%s\n" class name))
4764 ; (insert (message "Missing SYNTAX entry for %s\n" name)))))
4766 ;; Executive commands are treated specially
4767 (if (aref syntax-vec
2)
4768 (cons (substring name
1) link
)
4769 (if extra-kws
(setq kwds
(nconc kwds extra-kws
)))
4770 (setq kwds
(idlwave-rinfo-group-keywords kwds link
))
4771 (loop for idx from
0 to
1 do
4772 (if (aref syntax-vec idx
)
4773 (push (append (list name
(if (eq idx
0) 'pro
'fun
)
4775 (idlwave-shorten-syntax
4776 (aref syntax-vec idx
) name class
))
4781 (defun idlwave-rinfo-group-keywords (kwds master-link
)
4782 ;; Group keywords by link file, as a list with elements
4783 ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2))
4784 (let (kwd link anchor linkfiles block master-elt
)
4786 (setq kwd
(car kwds
)
4787 link
(idlwave-split-link-target (nth 1 kwd
))
4791 (if (setq block
(assoc link linkfiles
))
4792 (push (cons kwd anchor
) (cdr block
))
4793 (push (list link
(cons kwd anchor
)) linkfiles
))
4794 (setq kwds
(cdr kwds
)))
4795 ;; Ensure the master link is there
4796 (if (setq master-elt
(assoc master-link linkfiles
))
4797 (if (eq (car linkfiles
) master-elt
)
4799 (cons master-elt
(delq master-elt linkfiles
)))
4800 (push (list master-link
) linkfiles
))))
4802 (defun idlwave-convert-xml-clean-statement-aliases (aliases)
4803 ;; Clean up the syntax of routines which are actually aliases by
4804 ;; removing the "OR" from the statements
4806 (loop for x in aliases do
4807 (setq entry
(assoc x idlwave-system-routines
))
4809 (while (string-match " +or +" (setq syntax
(nth 4 entry
)))
4810 (setf (nth 4 entry
) (replace-match ", " t t syntax
)))))))
4812 (defun idlwave-convert-xml-clean-routine-aliases (aliases)
4813 ;; Duplicate and trim original routine aliases from rinfo list
4814 ;; This if for, e.g. OPENR/OPENW/OPENU
4815 (let (alias remove-list new parts all-parts
)
4816 (loop for x in aliases do
4817 (when (setq parts
(split-string (cdr x
) "/"))
4818 (setq new
(assoc (cdr x
) all-parts
))
4820 (setq new
(cons (cdr x
) parts
))
4821 (push new all-parts
))
4822 (setcdr new
(delete (car x
) (cdr new
)))))
4824 ;; Add any missing aliases (separate by slashes)
4825 (loop for x in all-parts do
4827 (push (cons (nth 1 x
) (car x
)) aliases
)))
4829 (loop for x in aliases do
4830 (when (setq alias
(assoc (cdr x
) idlwave-system-routines
))
4831 (unless (memq alias remove-list
) (push alias remove-list
))
4832 (setq alias
(copy-sequence alias
))
4833 (setcar alias
(car x
))
4834 (push alias idlwave-system-routines
)))
4835 (loop for x in remove-list do
4836 (delq x idlwave-system-routines
))))
4838 (defun idlwave-convert-xml-clean-sysvar-aliases (aliases)
4839 ;; Duplicate and trim original routine aliases from rinfo list
4840 ;; This if for, e.g. !X, !Y, !Z.
4841 (let (alias remove-list new parts all-parts
)
4842 (loop for x in aliases do
4843 (when (setq alias
(assoc (cdr x
) idlwave-system-variables-alist
))
4844 (unless (memq alias remove-list
) (push alias remove-list
))
4845 (setq alias
(copy-sequence alias
))
4846 (setcar alias
(car x
))
4847 (push alias idlwave-system-variables-alist
)))
4848 (loop for x in remove-list do
4849 (delq x idlwave-system-variables-alist
))))
4852 (defun idlwave-xml-create-sysvar-alist (xml-entry)
4853 ;; Create a sysvar list entry from the xml parsed list.
4854 (let* ((nameblock (nth 1 xml-entry
))
4855 (name (cdr (assq 'name nameblock
)))
4856 (sysvar (substring name
(progn (string-match "^ *!" name
)
4858 (link (cdr (assq 'link nameblock
)))
4859 (params (cddr xml-entry
))
4860 (case-fold-search t
)
4861 pelem ptype props fields tags
)
4863 (setq pelem
(car params
))
4865 (setq ptype
(car pelem
)
4866 props
(car (cdr pelem
)))
4869 (push (cons (cdr (assq 'name props
))
4871 (idlwave-split-link-target (cdr (assq 'link props
)))))
4873 (setq params
(cdr params
)))
4875 (list sysvar
(if tags
(cons 'tags tags
)) (list 'link link
)))))
4878 (defvar idlwave-xml-routine-info-file nil
)
4880 (defun idlwave-save-routine-info ()
4881 (if idlwave-xml-routine-info-file
4882 (with-temp-file idlwave-xml-system-rinfo-converted-file
4884 (concat ";; *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
4885 ;; IDLWAVE Routine Information File (IDLWAVE version " idlwave-mode-version
")
4886 ;; Automatically generated from source file:
4887 ;; " idlwave-xml-routine-info-file
"
4888 ;; on " (current-time-string) "
4890 (insert (format "\n(setq idlwave-xml-routine-info-file \n \"%s\")"
4891 idlwave-xml-routine-info-file
))
4892 (insert "\n(setq idlwave-system-routines\n '")
4893 (prin1 idlwave-system-routines
(current-buffer))
4895 (insert "\n(setq idlwave-system-variables-alist\n '")
4896 (prin1 idlwave-system-variables-alist
(current-buffer))
4898 (insert "\n(setq idlwave-system-class-info\n '")
4899 (prin1 idlwave-system-class-info
(current-buffer))
4901 (insert "\n(setq idlwave-executive-commands-alist\n '")
4902 (prin1 idlwave-executive-commands-alist
(current-buffer))
4904 (insert "\n(setq idlwave-help-special-topic-words\n '")
4905 (prin1 idlwave-help-special-topic-words
(current-buffer))
4908 (defun idlwave-convert-xml-system-routine-info ()
4909 "Convert XML supplied IDL routine info into internal form.
4910 Cache to disk for quick recovery."
4912 (let* ((dir (file-name-as-directory
4913 (expand-file-name "help/online_help" (idlwave-sys-dir))))
4914 (catalog-file (expand-file-name "idl_catalog.xml" dir
))
4916 props rinfo msg-cnt elem type nelem class-result alias
4917 routines routine-aliases statement-aliases sysvar-aliases
4919 (if (not (file-exists-p catalog-file
))
4920 (error "No such XML routine info file: %s" catalog-file
)
4921 (if (not (file-readable-p catalog-file
))
4922 (error "Cannot read XML routine info file: %s" catalog-file
)))
4924 (message "Reading XML routine info...")
4925 (setq rinfo
(xml-parse-file catalog-file
))
4926 (message "Reading XML routine info...done")
4927 (setq rinfo
(assq 'CATALOG rinfo
))
4928 (unless rinfo
(error "Failed to parse XML routine info"))
4929 ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff.
4931 (setq version-string
(cdr (assq 'version
(nth 1 rinfo
)))
4934 (setq nelem
(length rinfo
)
4935 msg-cnt
(/ nelem
20))
4937 (setq idlwave-xml-routine-info-file nil
)
4938 (message "Converting XML routine info...")
4939 (setq idlwave-system-routines nil
4940 idlwave-system-variables-alist nil
4941 idlwave-system-class-info nil
4942 idlwave-executive-commands-alist nil
4943 idlwave-help-special-topic-words nil
)
4946 (setq elem
(car rinfo
)
4950 (setq type
(car elem
)
4951 props
(car (cdr elem
)))
4952 (if (= (mod elem-cnt msg-cnt
) 0)
4953 (message "Converting XML routine info...%2d%%"
4954 (/ (* elem-cnt
100) nelem
)))
4957 (if (setq alias
(assq 'alias_to props
))
4958 (push (cons (cdr (assq 'name props
)) (cdr alias
))
4960 (setq routines
(idlwave-xml-create-rinfo-list elem
))
4961 (if (listp (cdr routines
))
4962 (setq idlwave-system-routines
4963 (nconc idlwave-system-routines routines
))
4964 ;; a cons cell is an executive commands
4965 (push routines idlwave-executive-commands-alist
))))
4968 (setq class-result
(idlwave-xml-create-class-method-lists elem
))
4969 (push (car class-result
) idlwave-system-class-info
)
4970 (setq idlwave-system-routines
4971 (nconc idlwave-system-routines
(cdr class-result
))))
4973 ((eq type
'STATEMENT
)
4974 (push (cons (cdr (assq 'name props
))
4975 (cdr (assq 'link props
)))
4976 idlwave-help-special-topic-words
)
4977 ;; Save the links to those which are statement aliases (not routines)
4978 (if (setq alias
(assq 'alias_to props
))
4979 (unless (member (cdr alias
) statement-aliases
)
4980 (push (cdr alias
) statement-aliases
))))
4983 (if (setq alias
(cdr (assq 'alias_to props
)))
4984 (push (cons (substring (cdr (assq 'name props
)) 1)
4985 (substring alias
1))
4987 (push (idlwave-xml-create-sysvar-alist elem
)
4988 idlwave-system-variables-alist
)))
4990 (idlwave-convert-xml-clean-routine-aliases routine-aliases
)
4991 (idlwave-convert-xml-clean-statement-aliases statement-aliases
)
4992 (idlwave-convert-xml-clean-sysvar-aliases sysvar-aliases
)
4994 (setq idlwave-xml-routine-info-file catalog-file
)
4995 (idlwave-save-routine-info)
4996 (message "Converting XML routine info...done")))
4999 ;; ("ROUTINE" type class
5000 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
5001 ;; (buffer pro_file dir) | (compiled pro_file dir)
5002 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
5003 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
5006 (defun idlwave-load-rinfo-next-step ()
5007 (let ((inhibit-quit t
)
5008 (arr idlwave-load-rinfo-steps-done
))
5010 (when (not (aref arr
0))
5011 (message "Loading system routine info in idle time...")
5012 (idlwave-load-system-routine-info)
5013 ;;(load "idlw-rinfo" 'noerror 'nomessage)
5014 (message "Loading system routine info in idle time...done")
5018 (when (not (aref arr
1))
5019 (message "Normalizing idlwave-system-routines in idle time...")
5020 (idlwave-reset-sintern t
)
5021 (put 'idlwave-reset-sintern
'done-by-idle t
)
5022 (setq idlwave-system-routines
5023 (idlwave-sintern-rinfo-list idlwave-system-routines
'sys
))
5024 (message "Normalizing idlwave-system-routines in idle time...done")
5028 (when (not (aref arr
2))
5029 (when (and (stringp idlwave-user-catalog-file
)
5030 (file-regular-p idlwave-user-catalog-file
))
5031 (message "Loading user catalog in idle time...")
5033 (load-file idlwave-user-catalog-file
)
5034 (error (throw 'exit nil
)))
5035 ;; Check for the old style catalog and warn
5037 (boundp 'idlwave-library-routines
)
5038 idlwave-library-routines
)
5040 (setq idlwave-library-routines nil
)
5042 (message "Outdated user catalog: %s... recreate"
5043 idlwave-user-catalog-file
))
5044 (message "Loading user catalog in idle time...done")))
5048 (when (not (aref arr
3))
5049 (when idlwave-user-catalog-routines
5050 (message "Normalizing user catalog routines in idle time...")
5051 (setq idlwave-user-catalog-routines
5052 (idlwave-sintern-rinfo-list
5053 idlwave-user-catalog-routines
'sys
))
5055 "Normalizing user catalog routines in idle time...done"))
5059 (when (not (aref arr
4))
5060 (idlwave-scan-library-catalogs
5061 "Loading and normalizing library catalogs in idle time...")
5064 (when (not (aref arr
5))
5065 (message "Finishing initialization in idle time...")
5067 (message "Finishing initialization in idle time...done")
5070 ;; restart the timer
5072 (idlwave-load-rinfo-next-step)
5073 (setq idlwave-load-rinfo-idle-timer
5074 (run-with-idle-timer
5075 idlwave-init-rinfo-when-idle-after
5076 nil
'idlwave-load-rinfo-next-step
))))))
5078 (defun idlwave-load-all-rinfo (&optional force
)
5079 ;; Load and case-treat the system, user catalog, and library routine
5083 (when (or force
(not (aref idlwave-load-rinfo-steps-done
0)))
5084 ;;(load "idlw-rinfo" 'noerror 'nomessage))
5085 (idlwave-load-system-routine-info))
5086 (when (or force
(not (aref idlwave-load-rinfo-steps-done
1)))
5087 (message "Normalizing idlwave-system-routines...")
5088 (setq idlwave-system-routines
5089 (idlwave-sintern-rinfo-list idlwave-system-routines
'sys
))
5090 (message "Normalizing idlwave-system-routines...done"))
5091 (when idlwave-system-routines
5092 (setq idlwave-routines
(copy-sequence idlwave-system-routines
))
5093 (setq idlwave-last-system-routine-info-cons-cell
5094 (nthcdr (1- (length idlwave-routines
)) idlwave-routines
)))
5097 (when (and (stringp idlwave-user-catalog-file
)
5098 (file-regular-p idlwave-user-catalog-file
))
5100 (when (or force
(not (aref idlwave-load-rinfo-steps-done
2)))
5101 (load-file idlwave-user-catalog-file
))
5104 (boundp 'idlwave-library-routines
)
5105 idlwave-library-routines
)
5106 (setq idlwave-library-routines nil
)
5107 (error "Outdated user catalog: %s... recreate"
5108 idlwave-user-catalog-file
))
5109 (setq idlwave-true-path-alist nil
)
5110 (when (or force
(not (aref idlwave-load-rinfo-steps-done
3)))
5111 (message "Normalizing user catalog routines...")
5112 (setq idlwave-user-catalog-routines
5113 (idlwave-sintern-rinfo-list
5114 idlwave-user-catalog-routines
'sys
))
5115 (message "Normalizing user catalog routines...done")))
5118 (when (or force
(not (aref idlwave-load-rinfo-steps-done
4)))
5119 (idlwave-scan-library-catalogs
5120 "Loading and normalizing library catalogs..."))
5121 (run-hooks 'idlwave-after-load-rinfo-hook
))
5124 (defun idlwave-update-buffer-routine-info ()
5127 ((eq idlwave-scan-all-buffers-for-routine-info t
)
5128 ;; Scan all buffers, current buffer last
5129 (message "Scanning all buffers...")
5130 (setq res
(idlwave-get-routine-info-from-buffers
5131 (reverse (buffer-list)))))
5132 ((null idlwave-scan-all-buffers-for-routine-info
)
5133 ;; Don't scan any buffers
5136 ;; Just scan this buffer
5137 (if (eq major-mode
'idlwave-mode
)
5139 (message "Scanning current buffer...")
5140 (setq res
(idlwave-get-routine-info-from-buffers
5141 (list (current-buffer))))))))
5142 ;; Put the result into the correct variable
5143 (setq idlwave-buffer-routines
5144 (idlwave-sintern-rinfo-list res
'set
))))
5146 (defun idlwave-concatenate-rinfo-lists (&optional quiet run-hook
)
5147 "Put the different sources for routine information together."
5148 ;; The sequence here is important because earlier definitions shadow
5149 ;; later ones. We assume that if things in the buffers are newer
5150 ;; then in the shell of the system, they are meant to be different.
5151 (setcdr idlwave-last-system-routine-info-cons-cell
5152 (append idlwave-buffer-routines
5153 idlwave-compiled-routines
5154 idlwave-library-catalog-routines
5155 idlwave-user-catalog-routines
))
5156 (setq idlwave-class-alist nil
)
5158 ;; Give a message with information about the number of routines we have.
5161 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
5162 (length idlwave-buffer-routines
)
5163 (length idlwave-compiled-routines
)
5164 (length idlwave-library-catalog-routines
)
5165 (length idlwave-user-catalog-routines
)
5166 (length idlwave-system-routines
)))
5168 (run-hooks 'idlwave-update-rinfo-hook
)))
5170 (defun idlwave-class-alist ()
5171 "Return the class alist - make it if necessary."
5172 (or idlwave-class-alist
5174 (loop for x in idlwave-routines do
5175 (when (and (setq class
(nth 2 x
))
5176 (not (assq class idlwave-class-alist
)))
5177 (push (list class
) idlwave-class-alist
)))
5178 idlwave-class-alist
)))
5180 ;; Three functions for the hooks
5181 (defun idlwave-save-buffer-update ()
5182 (idlwave-update-current-buffer-info 'save-buffer
))
5183 (defun idlwave-kill-buffer-update ()
5184 (idlwave-update-current-buffer-info 'kill-buffer
))
5185 (defun idlwave-new-buffer-update ()
5186 (idlwave-update-current-buffer-info 'find-file
))
5188 (defun idlwave-update-current-buffer-info (why)
5189 "Update idlwave-routines for current buffer. Can run from after-save-hook."
5190 (when (and (eq major-mode
'idlwave-mode
)
5191 (or (eq t idlwave-auto-routine-info-updates
)
5192 (memq why idlwave-auto-routine-info-updates
))
5193 idlwave-scan-all-buffers-for-routine-info
5197 (idlwave-replace-buffer-routine-info
5199 (if (eq why
'kill-buffer
)
5202 (idlwave-sintern-rinfo-list
5203 (idlwave-get-routine-info-from-buffers
5204 (list (current-buffer))) 'set
))))
5205 (idlwave-concatenate-rinfo-lists 'quiet
)
5209 (defun idlwave-replace-buffer-routine-info (file new
)
5210 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
5211 (let ((list idlwave-buffer-routines
)
5214 ;; The following test uses eq to make sure it works correctly
5215 ;; when two buffers visit the same file. Then the file names
5216 ;; will be equal, but not eq.
5217 (if (eq (idlwave-routine-source-file (nth 3 (car list
))) file
)
5222 ;; End of that section reached. Jump.
5224 (setq list
(cdr list
)))
5225 (setq idlwave-buffer-routines
5226 (append new
(delq nil idlwave-buffer-routines
)))))
5228 ;;----- Scanning buffers -------------------
5230 (defun idlwave-get-routine-info-from-buffers (buffers)
5231 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
5232 (let (buf routine-lists res
)
5234 (while (setq buf
(pop buffers
))
5236 (if (and (eq major-mode
'idlwave-mode
)
5238 ;; yes, this buffer has the right mode.
5239 (progn (setq res
(condition-case nil
5240 (idlwave-get-buffer-routine-info)
5242 (push res routine-lists
)))))
5243 ;; Concatenate the individual lists and return the result
5244 (apply 'nconc routine-lists
)))
5246 (defun idlwave-get-buffer-routine-info ()
5247 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
5248 (let* ((case-fold-search t
)
5249 routine-list string entry
)
5253 (goto-char (point-min))
5254 (while (re-search-forward
5255 "^[ \t]*\\(pro\\|function\\)[ \t]" nil t
)
5256 (setq string
(buffer-substring-no-properties
5259 (idlwave-end-of-statement)
5261 (setq entry
(idlwave-parse-definition string
))
5262 (push entry routine-list
))))
5265 (defvar idlwave-scanning-lib-dir
)
5266 (defun idlwave-parse-definition (string)
5267 "Parse a module definition."
5268 (let ((case-fold-search t
)
5269 start name args type keywords class
)
5271 (while (string-match ";.*" string
)
5272 (setq string
(replace-match "" t t string
)))
5273 ;; Remove the continuation line stuff
5274 (while (string-match "\\([^a-zA-Z0-9$_]\\)\\$[ \t]*\n" string
)
5275 (setq string
(replace-match "\\1 " t nil string
)))
5276 (while (string-match "\n" string
)
5277 (setq string
(replace-match " " t nil string
)))
5278 ;; Match the name and type.
5280 "\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)" string
)
5281 (setq start
(match-end 0))
5282 (setq type
(downcase (match-string 1 string
)))
5283 (if (match-beginning 3)
5284 (setq class
(match-string 3 string
)))
5285 (setq name
(match-string 4 string
)))
5286 ;; Match normal args and keyword args
5287 (while (string-match
5288 ",\\s-*\\([a-zA-Z][a-zA-Z0-9$_]*\\|\\(_ref\\)?_extra\\)\\s-*\\(=\\)?"
5290 (setq start
(match-end 0))
5291 (if (match-beginning 3)
5292 (push (match-string 1 string
) keywords
)
5293 (push (match-string 1 string
) args
)))
5294 ;; Normalize and sort.
5295 (setq args
(nreverse args
))
5296 (setq keywords
(sort keywords
(lambda (a b
)
5297 (string< (downcase a
) (downcase b
)))))
5298 ;; Make and return the entry
5299 ;; We don't know which argument are optional, so this information
5300 ;; will not be contained in the calling sequence.
5302 (if (equal type
"pro") 'pro
'fun
)
5304 (cond ((not (boundp 'idlwave-scanning-lib
))
5305 (list 'buffer
(buffer-file-name)))
5306 ; ((string= (downcase
5307 ; (file-name-sans-extension
5308 ; (file-name-nondirectory (buffer-file-name))))
5311 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
5312 (t (list 'user
(file-name-nondirectory (buffer-file-name))
5313 idlwave-scanning-lib-dir
"UserLib")))
5315 (if (string= type
"function") "Result = " "")
5316 (if class
"Obj ->[%s::]" "")
5320 (if (string= type
"function") "(" ", ")
5321 (mapconcat 'identity args
", ")
5322 (if (string= type
"function") ")" ""))))
5324 (cons nil
(mapcar 'list keywords
)) ;No help file
5328 ;;----- Scanning the user catalog -------------------
5330 (defun idlwave-sys-dir ()
5331 "Return the syslib directory, or a dummy that never matches."
5333 ((and idlwave-system-directory
5334 (not (string= idlwave-system-directory
"")))
5335 idlwave-system-directory
)
5336 ((getenv "IDL_DIR"))
5340 (defun idlwave-create-user-catalog-file (&optional arg
)
5341 "Scan all files on selected dirs of IDL search path for routine information.
5343 A widget checklist will allow you to choose the directories. Write
5344 the result as a file `idlwave-user-catalog-file'. When this file
5345 exists, will be automatically loaded to give routine information about
5346 library routines. With ARG, just rescan the same directories as last
5347 time - so no widget will pop up."
5349 ;; Make sure the file is loaded if it exists.
5350 (if (and (stringp idlwave-user-catalog-file
)
5351 (file-regular-p idlwave-user-catalog-file
))
5353 (load-file idlwave-user-catalog-file
)
5355 ;; Make sure the file name makes sense
5356 (unless (and (stringp idlwave-user-catalog-file
)
5357 (> (length idlwave-user-catalog-file
) 0)
5358 (file-accessible-directory-p
5359 (file-name-directory idlwave-user-catalog-file
))
5360 (not (string= "" (file-name-nondirectory
5361 idlwave-user-catalog-file
))))
5362 (error "`idlwave-user-catalog-file' does not point to a file in an accessible directory"))
5365 ;; Rescan the known directories
5366 ((and arg idlwave-path-alist
5367 (consp (car idlwave-path-alist
)))
5368 (idlwave-scan-user-lib-files idlwave-path-alist
))
5370 ;; Expand the directories from library-path and run the widget
5371 (idlwave-library-path
5372 (idlwave-display-user-catalog-widget
5373 (if idlwave-true-path-alist
5374 ;; Propagate any flags on the existing path-alist
5376 (let ((path-entry (assoc (file-truename x
)
5377 idlwave-true-path-alist
)))
5379 (cons x
(cdr path-entry
))
5381 (idlwave-expand-path idlwave-library-path
))
5382 (mapcar 'list
(idlwave-expand-path idlwave-library-path
)))))
5384 ;; Ask the shell for the path and then run the widget
5386 (message "Asking the shell for IDL path...")
5387 (require 'idlw-shell
)
5388 (idlwave-shell-send-command idlwave-shell-path-query
5389 '(idlwave-user-catalog-command-hook nil
)
5393 ;; Parse shell path information and select among it.
5394 (defun idlwave-user-catalog-command-hook (&optional arg
)
5395 ;; Command hook used by `idlwave-create-user-catalog-file'.
5398 (idlwave-scan-user-lib-files idlwave-path-alist
)
5399 ;; Set the path and display the widget
5400 (idlwave-shell-get-path-info 'no-write
) ; set to something path-alist
5401 (idlwave-scan-library-catalogs "Locating library catalogs..." 'no-load
)
5402 (idlwave-display-user-catalog-widget idlwave-path-alist
)))
5404 (defconst idlwave-user-catalog-widget-help-string
5405 "This is the front-end to the creation of the IDLWAVE user catalog.
5406 Please select the directories on IDL's search path from which you
5407 would like to extract routine information, to be stored in the file:
5411 If this is not the correct file, first set variable
5412 `idlwave-user-catalog-file', and call this command again.
5414 N.B. Many libraries include pre-scanned catalog files
5415 \(\".idlwave_catalog\"). These are marked with \"[LIB]\", and need
5416 not be scanned. You can scan your own libraries off-line using the
5417 perl script `idlwave_catalog'.
5419 After selecting the directories, choose [Scan & Save] to scan the library
5420 directories and save the routine info.
5423 (defvar idlwave-widget
)
5424 (defvar widget-keymap
)
5425 (defun idlwave-display-user-catalog-widget (dirs-list)
5426 "Create the widget to select IDL search path directories for scanning."
5431 (error "Don't know IDL's search path"))
5433 (kill-buffer (get-buffer-create "*IDLWAVE Widget*"))
5434 (switch-to-buffer (get-buffer-create "*IDLWAVE Widget*"))
5435 (kill-all-local-variables)
5436 (make-local-variable 'idlwave-widget
)
5437 (widget-insert (format idlwave-user-catalog-widget-help-string
5438 idlwave-user-catalog-file
))
5440 (widget-create 'push-button
5441 :notify
'idlwave-widget-scan-user-lib-files
5444 (widget-create 'push-button
5445 :notify
'idlwave-delete-user-catalog-file
5448 (widget-create 'push-button
5450 '(lambda (&rest ignore
)
5451 (let ((path-list (widget-get idlwave-widget
:path-dirs
)))
5453 (unless (memq 'lib
(cdr x
))
5454 (idlwave-path-alist-add-flag x
'user
)))
5456 (idlwave-display-user-catalog-widget path-list
)))
5457 "Select All Non-Lib")
5459 (widget-create 'push-button
5461 '(lambda (&rest ignore
)
5462 (let ((path-list (widget-get idlwave-widget
:path-dirs
)))
5464 (idlwave-path-alist-remove-flag x
'user
))
5466 (idlwave-display-user-catalog-widget path-list
)))
5469 (widget-create 'push-button
5470 :notify
(lambda (&rest ignore
)
5471 (kill-buffer (current-buffer)))
5473 (widget-insert "\n\n")
5475 (widget-insert "Select Directories: \n")
5477 (setq idlwave-widget
5478 (apply 'widget-create
5480 :value
(delq nil
(mapcar (lambda (x)
5481 (if (memq 'user
(cdr x
))
5485 :tag
"List of directories"
5488 (if (memq 'lib
(cdr x
))
5489 (concat "[LIB] " (car x
) )
5490 (car x
)))) dirs-list
)))
5491 (widget-put idlwave-widget
:path-dirs dirs-list
)
5492 (widget-insert "\n")
5493 (use-local-map widget-keymap
)
5495 (goto-char (point-min))
5496 (delete-other-windows))
5498 (defun idlwave-delete-user-catalog-file (&rest ignore
)
5500 (format "Delete file %s " idlwave-user-catalog-file
))
5502 (delete-file idlwave-user-catalog-file
)
5503 (message "%s has been deleted" idlwave-user-catalog-file
))))
5505 (defun idlwave-widget-scan-user-lib-files (&rest ignore
)
5506 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
5507 (let* ((widget idlwave-widget
)
5508 (selected-dirs (widget-value widget
))
5509 (path-alist (widget-get widget
:path-dirs
))
5510 (this-path-alist path-alist
)
5512 (while (setq dir-entry
(pop this-path-alist
))
5514 (if (memq 'lib
(cdr dir-entry
))
5515 (concat "[LIB] " (car dir-entry
))
5518 (idlwave-path-alist-add-flag dir-entry
'user
)
5519 (idlwave-path-alist-remove-flag dir-entry
'user
)))
5520 (idlwave-scan-user-lib-files path-alist
)))
5522 (defvar font-lock-mode
)
5523 (defun idlwave-scan-user-lib-files (path-alist)
5524 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5525 (let* ((idlwave-scanning-lib t
)
5526 (idlwave-scanning-lib-dir "")
5527 (idlwave-completion-case nil
)
5528 dirs-alist dir files file
)
5529 (setq idlwave-user-catalog-routines nil
5530 idlwave-path-alist path-alist
; for library-path instead
5531 idlwave-true-path-alist nil
)
5532 (if idlwave-auto-write-paths
(idlwave-write-paths))
5534 (set-buffer (get-buffer-create "*idlwave-scan.pro*"))
5536 (setq dirs-alist
(reverse path-alist
))
5537 (while (setq dir
(pop dirs-alist
))
5538 (when (memq 'user
(cdr dir
)) ; Has it marked for scan?
5539 (setq dir
(car dir
))
5540 (setq idlwave-scanning-lib-dir dir
)
5541 (when (file-directory-p dir
)
5542 (setq files
(directory-files dir
'full
"\\.[pP][rR][oO]\\'"))
5543 (while (setq file
(pop files
))
5544 (when (file-regular-p file
)
5545 (if (not (file-readable-p file
))
5546 (message "Skipping %s (no read permission)" file
)
5547 (message "Scanning %s..." file
)
5549 (insert-file-contents file
'visit
)
5550 (setq idlwave-user-catalog-routines
5551 (append (idlwave-get-routine-info-from-buffers
5552 (list (current-buffer)))
5553 idlwave-user-catalog-routines
)))))))))
5554 (message "Creating user catalog file...")
5555 (kill-buffer "*idlwave-scan.pro*")
5556 (kill-buffer (get-buffer-create "*IDLWAVE Widget*"))
5557 (let ((font-lock-maximum-size 0)
5558 (auto-mode-alist nil
))
5559 (find-file idlwave-user-catalog-file
))
5560 (if (and (boundp 'font-lock-mode
)
5564 (insert ";; IDLWAVE user catalog file\n")
5565 (insert (format ";; Created %s\n\n" (current-time-string)))
5567 ;; Define the routine info list
5568 (insert "\n(setq idlwave-user-catalog-routines\n '(")
5569 (let ((standard-output (current-buffer)))
5573 (goto-char (point-max)))
5574 idlwave-user-catalog-routines
))
5575 (insert (format "))\n\n;;; %s ends here\n"
5576 (file-name-nondirectory idlwave-user-catalog-file
)))
5577 (goto-char (point-min))
5580 (kill-buffer (current-buffer)))
5581 (message "Creating user catalog file...done")
5582 (message "Info for %d routines saved in %s"
5583 (length idlwave-user-catalog-routines
)
5584 idlwave-user-catalog-file
)
5586 (idlwave-update-routine-info t
))
5588 (defun idlwave-read-paths ()
5589 (if (and (stringp idlwave-path-file
)
5590 (file-regular-p idlwave-path-file
))
5592 (load idlwave-path-file t t t
)
5595 (defun idlwave-write-paths ()
5597 (when (and idlwave-path-alist idlwave-system-directory
)
5598 (let ((font-lock-maximum-size 0)
5599 (auto-mode-alist nil
))
5600 (find-file idlwave-path-file
))
5601 (if (and (boundp 'font-lock-mode
)
5605 (insert ";; IDLWAVE paths\n")
5606 (insert (format ";; Created %s\n\n" (current-time-string)))
5607 ;; Define the variable which knows the value of "!DIR"
5608 (insert (format "\n(setq idlwave-system-directory \"%s\")\n"
5609 idlwave-system-directory
))
5611 ;; Define the variable which contains a list of all scanned directories
5612 (insert "\n(setq idlwave-path-alist\n '(")
5613 (let ((standard-output (current-buffer)))
5617 (goto-char (point-max)))
5618 idlwave-path-alist
))
5621 (kill-buffer (current-buffer))))
5624 (defun idlwave-expand-path (path &optional default-dir
)
5625 ;; Expand parts of path starting with '+' recursively into directory list.
5626 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5627 (message "Expanding path...")
5628 (let (path1 dir recursive
)
5629 (while (setq dir
(pop path
))
5630 (if (setq recursive
(string= (substring dir
0 1) "+"))
5631 (setq dir
(substring dir
1)))
5633 (not (file-name-absolute-p dir
)))
5634 (setq dir
(expand-file-name dir default-dir
)))
5636 ;; Expand recursively
5637 (setq path1
(append (idlwave-recursive-directory-list dir
) path1
))
5640 (message "Expanding path...done")
5643 (defun idlwave-recursive-directory-list (dir)
5644 ;; Return a list of all directories below DIR, including DIR itself
5645 (let ((path (list dir
)) path1 file files
)
5646 (while (setq dir
(pop path
))
5647 (when (file-directory-p dir
)
5648 (setq files
(nreverse (directory-files dir t
"[^.]")))
5649 (while (setq file
(pop files
))
5650 (if (file-directory-p file
)
5651 (push (file-name-as-directory file
) path
)))
5656 ;;----- Scanning the library catalogs ------------------
5661 (defun idlwave-scan-library-catalogs (&optional message-base no-load
)
5662 "Scan for library catalog files (.idlwave_catalog) and ingest.
5664 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5665 instead, if present) are searched. Print MESSAGE-BASE along with the
5666 libraries being loaded, if passed, and skip loading/normalizing if
5667 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5668 be set to nil to disable library catalog scanning."
5669 (when idlwave-use-library-catalogs
5671 (if idlwave-library-path
5672 (idlwave-expand-path idlwave-library-path
)
5673 (mapcar 'car idlwave-path-alist
)))
5675 dir-entry dir flags catalog all-routines
)
5676 (if message-base
(message message-base
))
5677 (while (setq dir
(pop dirs
))
5679 (when (file-readable-p
5680 (setq catalog
(expand-file-name ".idlwave_catalog" dir
)))
5682 (setq idlwave-library-catalog-routines nil
)
5683 ;; Load the catalog file
5685 (load catalog t t t
)
5686 (error (throw 'continue t
)))
5689 (not (string= idlwave-library-catalog-libname
5691 (message "%s" (concat message-base
5692 idlwave-library-catalog-libname
))
5693 (setq old-libname idlwave-library-catalog-libname
))
5694 (when idlwave-library-catalog-routines
5697 (idlwave-sintern-rinfo-list
5698 idlwave-library-catalog-routines
'sys dir
)
5701 ;; Add a 'lib flag if on path-alist
5702 (when (and idlwave-path-alist
5703 (setq dir-entry
(assoc dir idlwave-path-alist
)))
5704 (idlwave-path-alist-add-flag dir-entry
'lib
)))))
5705 (unless no-load
(setq idlwave-library-catalog-routines all-routines
))
5706 (if message-base
(message (concat message-base
"done"))))))
5708 ;;----- Communicating with the Shell -------------------
5710 ;; First, here is the idl program which can be used to query IDL for
5711 ;; defined routines.
5712 (defconst idlwave-routine-info.pro
5714 ;; START OF IDLWAVE SUPPORT ROUTINES
5715 pro idlwave_print_safe,item,limit
5717 if err ne 0 then begin
5718 print,'Could not print item.'
5721 if n_elements(item) gt limit then $
5722 print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $
5726 pro idlwave_print_info_entry,name,func=func,separator=sep
5727 ;; See if it's an object method
5728 if name eq '' then return
5729 func = keyword_set(func)
5730 methsep = strpos(name,'::')
5731 meth = methsep ne -1
5734 pars = routine_info(name,/parameters,functions=func)
5735 source = routine_info(name,/source,functions=func)
5736 nargs = pars.num_args
5737 nkw = pars.num_kw_args
5738 if nargs gt 0 then args = pars.args
5739 if nkw gt 0 then kwargs = pars.kw_args
5741 ;; Trim the class, and make the name
5743 class = strmid(name,0,methsep)
5744 name = strmid(name,methsep+2,strlen(name)-1)
5745 if nargs gt 0 then begin
5746 ;; remove the self argument
5747 wh = where(args ne 'SELF',nargs)
5748 if nargs gt 0 then args = args[wh]
5751 ;; No class, just a normal routine.
5757 if func then cs = 'Result = '
5758 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5760 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5761 if nargs gt 0 then begin
5762 for j=0,nargs-1 do begin
5764 if j lt nargs-1 then cs = cs + ', '
5767 if func then cs = cs + ')'
5768 ;; Keyword arguments
5770 if nkw gt 0 then begin
5771 for j=0,nkw-1 do begin
5772 kwstring = kwstring + ' ' + kwargs[j]
5776 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5778 print,ret + ': ' + name + sep + class + sep + source[0].path $
5779 + sep + cs + sep + kwstring
5782 pro idlwave_routine_info,file
5785 print,'>>>BEGIN OF IDLWAVE ROUTINE INFO (\"' + sep + '\" IS THE SEPARATOR)'
5786 all = routine_info()
5787 fileQ=n_elements(file) ne 0
5788 if fileQ then file=strtrim(file,2)
5789 for i=0L,n_elements(all)-1L do begin
5791 if (routine_info(all[i],/SOURCE)).path eq file then $
5792 idlwave_print_info_entry,all[i],separator=sep
5793 endif else idlwave_print_info_entry,all[i],separator=sep
5795 all = routine_info(/functions)
5796 for i=0L,n_elements(all)-1L do begin
5798 if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $
5799 idlwave_print_info_entry,all[i],separator=sep,/FUNC
5800 endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC
5802 print,'>>>END OF IDLWAVE ROUTINE INFO'
5805 pro idlwave_get_sysvars
5808 if error_status ne 0 then begin
5809 print, 'Cannot get info about system variables'
5811 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5812 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5813 v = strsplit(s,' +',/regex,/extract) ; get variables
5814 for i=0L,n_elements(v)-1 do begin
5815 t = [''] ; get tag list
5816 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5817 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5822 pro idlwave_get_class_tags, class
5823 res = execute('tags=tag_names({'+class+'})')
5824 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5826 ;; END OF IDLWAVE SUPPORT ROUTINES
5828 "The idl programs to get info from the shell.")
5830 (defvar idlwave-idlwave_routine_info-compiled nil
5831 "Remembers if the routine info procedure is already compiled.")
5833 (defvar idlwave-shell-temp-pro-file
)
5834 (defvar idlwave-shell-temp-rinfo-save-file
)
5836 (defun idlwave-shell-compile-helper-routines (&optional wait
)
5837 (unless (and idlwave-idlwave_routine_info-compiled
5838 (file-readable-p (idlwave-shell-temp-file 'rinfo
)))
5840 (set-buffer (idlwave-find-file-noselect
5841 (idlwave-shell-temp-file 'pro
)))
5843 (insert idlwave-routine-info.pro
)
5845 (idlwave-shell-send-command
5846 (concat ".run \"" idlwave-shell-temp-pro-file
"\"")
5848 (idlwave-shell-send-command
5849 (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5850 (idlwave-shell-temp-file 'rinfo
))
5852 (setq idlwave-idlwave_routine_info-compiled t
))
5854 ;; Restore if necessary. Must use execute to hide lame routine_info
5855 ;; errors on undefinded routine
5856 (idlwave-shell-send-command
5857 (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'"
5858 idlwave-shell-temp-rinfo-save-file
5859 idlwave-shell-temp-rinfo-save-file
)
5863 (defun idlwave-shell-update-routine-info (&optional quiet run-hooks wait file
)
5864 "Query the shell for routine_info of compiled modules and update the lists."
5865 ;; Save and compile the procedure. The compiled procedure is then
5866 ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may
5867 ;; need to test for and possibly RESTORE the procedure each time we
5868 ;; use it, since the user may have killed or redefined it. In
5869 ;; particular, .RESET_SESSION will kill all user procedures. If
5870 ;; FILE is set, only update routine info for routines in that file.
5872 (idlwave-shell-compile-helper-routines wait
)
5873 ; execute the routine_info procedure, and analyze the output
5874 (idlwave-shell-send-command
5875 (format "idlwave_routine_info%s" (if file
(concat ",'" file
"'") ""))
5877 (idlwave-shell-routine-info-filter)
5878 (idlwave-concatenate-rinfo-lists ,quiet
,run-hooks
))
5881 ;; ---------------------------------------------------------------------------
5883 ;; Completion and displaying routine calling sequences
5885 (defvar idlwave-completion-help-info nil
)
5886 (defvar idlwave-completion-help-links nil
)
5887 (defvar idlwave-current-obj_new-class nil
)
5888 (defvar idlwave-complete-special nil
)
5890 (defun idlwave-complete (&optional arg module class
)
5891 "Complete a function, procedure or keyword name at point.
5892 This function is smart and figures out what can be completed
5894 - At the beginning of a statement it completes procedure names.
5895 - In the middle of a statement it completes function names.
5896 - after a `(' or `,' in the argument list of a function or procedure,
5897 it completes a keyword of the relevant function or procedure.
5898 - In the first arg of `OBJ_NEW', it completes a class name.
5900 When several completions are possible, a list will be displayed in the
5901 *Completions* buffer. If this list is too long to fit into the
5902 window, scrolling can be achieved by repeatedly pressing
5903 \\[idlwave-complete].
5905 The function also knows about object methods. When it needs a class
5906 name, the action depends upon `idlwave-query-class', which see. You
5907 can force IDLWAVE to ask you for a class name with a
5908 \\[universal-argument] prefix argument to this command.
5910 See also the variables `idlwave-keyword-completion-adds-equal' and
5911 `idlwave-function-completion-adds-paren'.
5913 The optional ARG can be used to specify the completion type in order
5914 to override IDLWAVE's idea of what should be completed at point.
5915 Possible values are:
5917 0 <=> query for the completion type
5919 2 <=> 'procedure-keyword
5921 4 <=> 'function-keyword
5922 5 <=> 'procedure-method
5923 6 <=> 'procedure-method-keyword
5924 7 <=> 'function-method
5925 8 <=> 'function-method-keyword
5928 As a special case, the universal argument C-u forces completion of
5929 function names in places where the default would be a keyword.
5931 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5934 For Lisp programmers only:
5935 When we force a keyword, optional argument MODULE can contain the module name.
5936 When we force a method or a method keyword, CLASS can specify the class."
5941 (or (and (integerp arg
) (not (equal arg
'(16))))
5943 (idlwave-make-force-complete-where-list arg module class
)
5945 (what (nth 2 where-list
))
5946 (idlwave-force-class-query (equal arg
'(4)))
5947 (completion-regexp-list
5948 (if (equal arg
'(16))
5949 (list (read-string (concat "Completion Regexp: "))))))
5951 (if (and module
(string-match "::" module
))
5952 (setq class
(substring module
0 (match-beginning 0))
5953 module
(substring module
(match-end 0))))
5958 (eq (car-safe last-command
) 'idlwave-display-completion-list
)
5959 (get-buffer-window "*Completions*"))
5960 (setq this-command last-command
)
5961 (idlwave-scroll-completions))
5963 ;; Complete a filename in quotes
5964 ((and (idlwave-in-quote)
5965 (not (eq what
'class
)))
5966 (idlwave-complete-filename))
5968 ;; Check for any special completion functions
5969 ((and idlwave-complete-special
5970 (idlwave-call-special idlwave-complete-special
)))
5973 (error "Nothing to complete here"))
5977 (setq idlwave-completion-help-info
'(class))
5978 (idlwave-complete-class))
5980 ((eq what
'procedure
)
5981 ;; Complete a procedure name
5982 (let* ((cw-list (nth 3 where-list
))
5983 (class-selector (idlwave-determine-class cw-list
'pro
))
5984 (super-classes (unless (idlwave-explicit-class-listed cw-list
)
5985 (idlwave-all-class-inherits class-selector
)))
5986 (isa (concat "procedure" (if class-selector
"-method" "")))
5987 (type-selector 'pro
))
5988 (setq idlwave-completion-help-info
5989 (list 'routine nil type-selector class-selector nil super-classes
))
5990 (idlwave-complete-in-buffer
5991 'procedure
(if class-selector
'method
'routine
)
5992 (idlwave-routines) 'idlwave-selector
5993 (format "Select a %s name%s"
5996 (format " (class is %s)"
5997 (if (eq class-selector t
)
5998 "unknown" class-selector
))
6001 'idlwave-attach-method-classes
'idlwave-add-file-link-selector
)))
6003 ((eq what
'function
)
6004 ;; Complete a function name
6005 (let* ((cw-list (nth 3 where-list
))
6006 (class-selector (idlwave-determine-class cw-list
'fun
))
6007 (super-classes (unless (idlwave-explicit-class-listed cw-list
)
6008 (idlwave-all-class-inherits class-selector
)))
6009 (isa (concat "function" (if class-selector
"-method" "")))
6010 (type-selector 'fun
))
6011 (setq idlwave-completion-help-info
6012 (list 'routine nil type-selector class-selector nil super-classes
))
6013 (idlwave-complete-in-buffer
6014 'function
(if class-selector
'method
'routine
)
6015 (idlwave-routines) 'idlwave-selector
6016 (format "Select a %s name%s"
6019 (format " (class is %s)"
6020 (if (eq class-selector t
)
6021 "unknown" class-selector
))
6024 'idlwave-attach-method-classes
'idlwave-add-file-link-selector
)))
6026 ((and (memq what
'(procedure-keyword function-keyword
)) ; Special Case
6028 (idlwave-complete 3))
6030 ((eq what
'procedure-keyword
)
6031 ;; Complete a procedure keyword
6032 (let* ((where (nth 3 where-list
))
6034 (method-selector name
)
6035 (type-selector 'pro
)
6036 (class (idlwave-determine-class where
'pro
))
6037 (class-selector class
)
6038 (super-classes (idlwave-all-class-inherits class-selector
))
6039 (isa (format "procedure%s-keyword" (if class
"-method" "")))
6040 (entry (idlwave-best-rinfo-assq
6041 name
'pro class
(idlwave-routines)))
6042 (system (if entry
(eq (car (nth 3 entry
)) 'system
)))
6043 (list (idlwave-entry-keywords entry
'do-link
)))
6044 (unless (or entry
(eq class t
))
6045 (error "Nothing known about procedure %s"
6046 (idlwave-make-full-name class name
)))
6047 (setq list
(idlwave-fix-keywords name
'pro class list
6048 super-classes system
))
6049 (unless list
(error "No keywords available for procedure %s"
6050 (idlwave-make-full-name class name
)))
6051 (setq idlwave-completion-help-info
6052 (list 'keyword name type-selector class-selector entry super-classes
))
6053 (idlwave-complete-in-buffer
6054 'keyword
'keyword list nil
6055 (format "Select keyword for procedure %s%s"
6056 (idlwave-make-full-name class name
)
6057 (if (or (member '("_EXTRA") list
)
6058 (member '("_REF_EXTRA") list
))
6059 " (note _EXTRA)" ""))
6061 'idlwave-attach-keyword-classes
)))
6063 ((eq what
'function-keyword
)
6064 ;; Complete a function keyword
6065 (let* ((where (nth 3 where-list
))
6067 (method-selector name
)
6068 (type-selector 'fun
)
6069 (class (idlwave-determine-class where
'fun
))
6070 (class-selector class
)
6071 (super-classes (idlwave-all-class-inherits class-selector
))
6072 (isa (format "function%s-keyword" (if class
"-method" "")))
6073 (entry (idlwave-best-rinfo-assq
6074 name
'fun class
(idlwave-routines)))
6075 (system (if entry
(eq (car (nth 3 entry
)) 'system
)))
6076 (list (idlwave-entry-keywords entry
'do-link
))
6078 (unless (or entry
(eq class t
))
6079 (error "Nothing known about function %s"
6080 (idlwave-make-full-name class name
)))
6081 (setq list
(idlwave-fix-keywords name
'fun class list
6082 super-classes system
))
6083 ;; OBJ_NEW: Messages mention the proper Init method
6084 (setq msg-name
(if (and (null class
)
6085 (string= (upcase name
) "OBJ_NEW"))
6086 (concat idlwave-current-obj_new-class
6087 "::Init (via OBJ_NEW)")
6088 (idlwave-make-full-name class name
)))
6089 (unless list
(error "No keywords available for function %s"
6091 (setq idlwave-completion-help-info
6092 (list 'keyword name type-selector class-selector nil super-classes
))
6093 (idlwave-complete-in-buffer
6094 'keyword
'keyword list nil
6095 (format "Select keyword for function %s%s" msg-name
6096 (if (or (member '("_EXTRA") list
)
6097 (member '("_REF_EXTRA") list
))
6098 " (note _EXTRA)" ""))
6100 'idlwave-attach-keyword-classes
)))
6102 (t (error "This should not happen (idlwave-complete)")))))
6104 (defvar idlwave-complete-special nil
6105 "List of special completion functions.
6106 These functions are called for each completion. Each function must
6107 check if its own special completion context is present. If yes, it
6108 should use `idlwave-complete-in-buffer' to do some completion and
6109 return t. If such a function returns t, *no further* attempts to
6110 complete other contexts will be done. If the function returns nil,
6111 other completions will be tried.")
6113 (defun idlwave-call-special (functions &rest args
)
6114 (let ((funcs functions
)
6117 (while (setq fun
(pop funcs
))
6118 (if (setq ret
(apply fun args
))
6122 (defun idlwave-make-force-complete-where-list (what &optional module class
)
6123 ;; Return an artificial WHERE specification to force the completion
6124 ;; routine to complete a specific item independent of context.
6125 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
6126 ;; MODULE and CLASS can be used to specify the routine name and class.
6127 ;; The class name will also be found in MODULE if that is like "class::mod".
6128 (let* ((what-list '(("procedure") ("procedure-keyword")
6129 ("function") ("function-keyword")
6130 ("procedure-method") ("procedure-method-keyword")
6131 ("function-method") ("function-method-keyword")
6133 (module (idlwave-sintern-routine-or-method module class
))
6134 (class (idlwave-sintern-class class
))
6138 (intern (completing-read
6139 "Complete what? " what-list nil t
))))
6141 (setq what
(intern (car (nth (1- what
) what-list
)))))
6144 (assoc (symbol-name what
) what-list
))
6146 (t (error "Invalid WHAT"))))
6147 (nil-list '(nil nil nil nil
))
6148 (class-list (list nil nil
(or class t
) nil
)))
6152 ((eq what
'procedure
)
6153 (list nil-list nil-list
'procedure nil-list nil
))
6155 ((eq what
'procedure-keyword
)
6156 (let* ((class-selector nil
)
6158 (type-selector 'pro
)
6160 (idlwave-completing-read
6161 "Procedure: " (idlwave-routines) 'idlwave-selector
))))
6162 (setq pro
(idlwave-sintern-routine pro
))
6163 (list nil-list nil-list
'procedure-keyword
6164 (list pro nil nil nil
) nil
)))
6166 ((eq what
'function
)
6167 (list nil-list nil-list
'function nil-list nil
))
6169 ((eq what
'function-keyword
)
6170 (let* ((class-selector nil
)
6172 (type-selector 'fun
)
6174 (idlwave-completing-read
6175 "Function: " (idlwave-routines) 'idlwave-selector
))))
6176 (setq func
(idlwave-sintern-routine func
))
6177 (list nil-list nil-list
'function-keyword
6178 (list func nil nil nil
) nil
)))
6180 ((eq what
'procedure-method
)
6181 (list nil-list nil-list
'procedure class-list nil
))
6183 ((eq what
'procedure-method-keyword
)
6184 (let* ((class (idlwave-determine-class class-list
'pro
))
6185 (class-selector class
)
6186 (super-classes (idlwave-all-class-inherits class-selector
))
6187 (type-selector 'pro
)
6189 (idlwave-completing-read
6190 (format "Procedure in %s class: " class-selector
)
6191 (idlwave-routines) 'idlwave-selector
))))
6192 (setq pro
(idlwave-sintern-method pro
))
6193 (list nil-list nil-list
'procedure-keyword
6194 (list pro nil class nil
) nil
)))
6196 ((eq what
'function-method
)
6197 (list nil-list nil-list
'function class-list nil
))
6199 ((eq what
'function-method-keyword
)
6200 (let* ((class (idlwave-determine-class class-list
'fun
))
6201 (class-selector class
)
6202 (super-classes (idlwave-all-class-inherits class-selector
))
6203 (type-selector 'fun
)
6205 (idlwave-completing-read
6206 (format "Function in %s class: " class-selector
)
6207 (idlwave-routines) 'idlwave-selector
))))
6208 (setq func
(idlwave-sintern-method func
))
6209 (list nil-list nil-list
'function-keyword
6210 (list func nil class nil
) nil
)))
6213 (list nil-list nil-list
'class nil-list nil
))
6215 (t (error "Invalid value for WHAT")))))
6217 (defun idlwave-completing-read (&rest args
)
6218 ;; Completing read, case insensitive
6219 (let ((old-value (default-value 'completion-ignore-case
)))
6222 (setq-default completion-ignore-case t
)
6223 (apply 'completing-read args
))
6224 (setq-default completion-ignore-case old-value
))))
6226 (defvar idlwave-shell-default-directory
)
6227 (defun idlwave-complete-filename ()
6228 "Use the comint stuff to complete a file name."
6230 (let* ((comint-file-name-chars "~/A-Za-z0-9+@:_.$#%={}\\-")
6231 (comint-completion-addsuffix nil
)
6233 (if (and (boundp 'idlwave-shell-default-directory
)
6234 (stringp idlwave-shell-default-directory
)
6235 (file-directory-p idlwave-shell-default-directory
))
6236 idlwave-shell-default-directory
6237 default-directory
)))
6238 (comint-dynamic-complete-filename)))
6240 (defun idlwave-make-full-name (class name
)
6241 ;; Make a fully qualified module name including the class name
6242 (concat (if class
(format "%s::" class
) "") name
))
6244 (defun idlwave-rinfo-assoc (name type class list
)
6245 "Like `idlwave-rinfo-assq', but sintern strings first."
6247 (idlwave-sintern-routine-or-method name class
)
6248 type
(idlwave-sintern-class class
) list
))
6250 (defun idlwave-rinfo-assq (name type class list
)
6251 ;; Works like assq, but also checks type and class
6254 (while (setq match
(assq name list
))
6255 (and (or (eq type t
)
6256 (eq (nth 1 match
) type
))
6257 (eq (nth 2 match
) class
)
6258 (throw 'exit match
))
6259 (setq list
(cdr (memq match list
)))))))
6261 (defun idlwave-rinfo-assq-any-class (name type class list
)
6262 ;; Return the first matching method on the inheritance list
6263 (let* ((classes (cons class
(idlwave-all-class-inherits class
)))
6266 (if (setq rtn
(idlwave-rinfo-assq name type
(pop classes
) list
))
6267 (setq classes nil
)))
6270 (defun idlwave-best-rinfo-assq (name type class list
&optional with-file
6272 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
6273 If WITH-FILE is passed, find the best rinfo entry with a file
6274 included. If KEEP-SYSTEM is set, don't prune system for compiled
6276 (let ((twins (idlwave-routine-twins
6277 (idlwave-rinfo-assq-any-class name type class list
)
6280 (when (> (length twins
) 1)
6281 (setq twins
(sort twins
'idlwave-routine-entry-compare-twins
))
6282 (if (and (null keep-system
)
6283 (eq 'system
(car (nth 3 (car twins
))))
6284 (setq syslibp
(idlwave-any-syslib (cdr twins
)))
6285 (not (equal 1 syslibp
)))
6286 ;; Its a compiled syslib, so we need to remove the system entry
6287 (setq twins
(cdr twins
)))
6289 (setq twins
(delq nil
6291 (if (nth 1 (nth 3 x
)) x
))
6295 (defun idlwave-best-rinfo-assoc (name type class list
&optional with-file
6297 "Like `idlwave-best-rinfo-assq', but sintern strings first."
6298 (idlwave-best-rinfo-assq
6299 (idlwave-sintern-routine-or-method name class
)
6300 type
(idlwave-sintern-class class
) list with-file keep-system
))
6302 (defun idlwave-any-syslib (entries)
6303 "Does the entry list ENTRIES contain a syslib entry?
6304 If yes, return the index (>=1)."
6309 (setq file
(idlwave-routine-source-file (nth 3 (car entries
))))
6310 (if (and file
(idlwave-syslib-p file
))
6312 (setq entries
(cdr entries
))))
6315 (defun idlwave-all-assq (key list
)
6316 "Return a list of all associations of Key in LIST."
6318 (while (setq elt
(assq key list
))
6320 (setq list
(cdr (memq elt list
))))
6323 (defun idlwave-all-method-classes (method &optional type
)
6324 "Return all classes which have a method METHOD. TYPE is 'fun or 'pro.
6325 When TYPE is not specified, both procedures and functions will be considered."
6327 (mapcar 'car
(idlwave-class-alist))
6332 (eq type
(nth 1 x
)))
6333 (push (nth 2 x
) rtn
)))
6334 (idlwave-all-assq method
(idlwave-routines)))
6335 (idlwave-uniquify rtn
))))
6337 (defun idlwave-all-method-keyword-classes (method keyword
&optional type
)
6338 "Return all classes which have a method METHOD with keyword KEYWORD.
6339 TYPE is 'fun or 'pro.
6340 When TYPE is not specified, both procedures and functions will be considered."
6341 (if (or (null method
)
6346 (and (nth 2 x
) ; non-nil class
6347 (or (not type
) ; correct or unspecified type
6348 (eq type
(nth 1 x
)))
6349 (assoc keyword
(idlwave-entry-keywords x
))
6350 (push (nth 2 x
) rtn
)))
6351 (idlwave-all-assq method
(idlwave-routines)))
6352 (idlwave-uniquify rtn
))))
6354 (defun idlwave-members-only (list club
)
6355 "Return list of all elements in LIST which are also in CLUB."
6358 (if (member (car list
) club
)
6359 (setq rtn
(cons (car list
) rtn
)))
6360 (setq list
(cdr list
)))
6363 (defun idlwave-nonmembers-only (list club
)
6364 "Return list of all elements in LIST which are not in CLUB."
6367 (if (member (car list
) club
)
6369 (setq rtn
(cons (car list
) rtn
)))
6370 (setq list
(cdr list
)))
6373 (defun idlwave-explicit-class-listed (info)
6374 "Return whether or not the class is listed explicitly, ala a->b::c.
6375 INFO is as returned by idlwave-what-function or -procedure."
6376 (let ((apos (nth 3 info
)))
6378 (save-excursion (goto-char apos
)
6379 (looking-at "->[a-zA-Z][a-zA-Z0-9$_]*::")))))
6381 (defvar idlwave-determine-class-special nil
6382 "List of special functions for determining class.
6383 Must accept two arguments: `apos' and `info'")
6385 (defun idlwave-determine-class (info type
)
6386 ;; Determine the class of a routine call.
6387 ;; INFO is the `cw-list' structure as returned by idlwave-where.
6388 ;; The second element in this structure is the class. When nil, we
6389 ;; return nil. When t, try to get the class from text properties at
6390 ;; the arrow. When the object is "self", we use the class of the
6391 ;; current routine. otherwise prompt the user for a class name.
6392 ;; Also stores the selected class as a text property at the arrow.
6393 ;; TYPE is 'fun or 'pro.
6394 (let* ((class (nth 2 info
))
6396 (nassoc (assoc (if (stringp (car info
))
6399 idlwave-query-class
))
6400 (dassoc (assq (if (car info
) 'keyword-default
'method-default
)
6401 idlwave-query-class
))
6402 (query (cond (nassoc (cdr nassoc
))
6403 (dassoc (cdr dassoc
))
6405 (arrow (and apos
(string= (buffer-substring apos
(+ 2 apos
)) "->")))
6408 (save-excursion (goto-char apos
)
6410 (let ((case-fold-search t
))
6411 (looking-at "self\\>")))))
6412 (force-query idlwave-force-class-query
)
6413 store special-class class-alist
)
6417 ;; There is an object which would like to know its class
6418 (if (and arrow
(get-text-property apos
'idlwave-class
)
6419 idlwave-store-inquired-class
6421 (setq class
(get-text-property apos
'idlwave-class
)
6422 class
(idlwave-sintern-class class
)))
6423 (if (and (eq t class
) is-self
)
6424 (setq class
(or (nth 2 (idlwave-current-routine)) class
)))
6426 ;; Before prompting, try any special class determination routines
6427 (when (and (eq t class
)
6428 idlwave-determine-class-special
6431 (idlwave-call-special idlwave-determine-class-special apos
))
6433 (setq class
(idlwave-sintern-class special-class
)
6434 store idlwave-store-inquired-class
)))
6436 ;; Prompt for a class, if we need to
6437 (when (and (eq class t
)
6438 (or force-query query
))
6440 (mapcar 'list
(idlwave-all-method-classes (car info
) type
)))
6442 (idlwave-sintern-class
6444 ((and (= (length class-alist
) 0) (not force-query
))
6445 (error "No classes available with method %s" (car info
)))
6446 ((and (= (length class-alist
) 1) (not force-query
))
6447 (car (car class-alist
)))
6449 (setq store idlwave-store-inquired-class
)
6450 (idlwave-completing-read
6451 (format "Class%s: " (if (stringp (car info
))
6452 (format " for %s method %s"
6455 class-alist nil nil nil
'idlwave-class-history
))))))
6457 ;; Store it, if requested
6458 (when (and class
(not (eq t class
)))
6459 ;; We have a real class here
6460 (when (and store arrow
)
6462 (add-text-properties
6464 `(idlwave-class ,class face
,idlwave-class-arrow-face
6467 (setf (nth 2 info
) class
))
6470 ;; Default as fallback
6473 (defvar type-selector
)
6474 (defvar class-selector
)
6475 (defvar method-selector
)
6476 (defvar super-classes
)
6477 (defun idlwave-selector (a)
6478 (and (eq (nth 1 a
) type-selector
)
6479 (or (and (nth 2 a
) (eq class-selector t
))
6480 (eq (nth 2 a
) class-selector
)
6481 (memq (nth 2 a
) super-classes
))))
6483 (defun idlwave-add-file-link-selector (a)
6484 ;; Record a file link, if any, for the tested names during selection.
6485 (let ((sel (idlwave-selector a
)) file
)
6486 (if (and sel
(setq file
(idlwave-entry-has-help a
)))
6487 (push (cons (car a
) file
) idlwave-completion-help-links
))
6491 (defun idlwave-where ()
6492 "Find out where we are.
6493 The return value is a list with the following stuff:
6494 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
6496 PRO-LIST (PRO POINT CLASS ARROW)
6497 FUNC-LIST (FUNC POINT CLASS ARROW)
6498 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
6499 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
6501 LAST-CHAR last relevant character before point (non-white non-comment,
6502 not part of current identifier or leading slash).
6504 In the lists, we have these meanings:
6507 POINT: Where is this
6508 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
6509 ARROW: Location of the arrow"
6511 (let* (;(bos (save-excursion (idlwave-beginning-of-statement) (point)))
6512 (bos (save-excursion (idlwave-start-of-substatement 'pre
) (point)))
6513 (func-entry (idlwave-what-function bos
))
6514 (func (car func-entry
))
6515 (func-class (nth 1 func-entry
))
6516 (func-arrow (nth 2 func-entry
))
6517 (func-point (or (nth 3 func-entry
) 0))
6518 (func-level (or (nth 4 func-entry
) 0))
6519 (pro-entry (idlwave-what-procedure bos
))
6520 (pro (car pro-entry
))
6521 (pro-class (nth 1 pro-entry
))
6522 (pro-arrow (nth 2 pro-entry
))
6523 (pro-point (or (nth 3 pro-entry
) 0))
6524 (last-char (idlwave-last-valid-char))
6525 (case-fold-search t
)
6526 (match-string (buffer-substring bos
(point)))
6527 cw cw-mod cw-arrow cw-class cw-point
)
6528 (if (< func-point pro-point
) (setq func nil
))
6530 ((string-match "\\`[ \t]*\\(pro\\|function\\)[ \t]+[a-zA-Z0-9_]*\\'"
6534 "\\`[ \t]*\\([a-zA-Z][a-zA-Z0-9$_]*\\)?\\'"
6536 (buffer-substring pro-point
(point))
6538 (setq cw
'procedure cw-class pro-class cw-point pro-point
6539 cw-arrow pro-arrow
))
6540 ((string-match "\\`[ \t]*\\(pro\\|function\\)\\>"
6543 ((string-match "OBJ_NEW([ \t]*['\"]\\([a-zA-Z0-9$_]*\\)?\\'"
6546 ((string-match "\\<inherits\\s-+\\([a-zA-Z0-9$_]*\\)?\\'"
6550 (> func-point pro-point
)
6552 (memq last-char
'(?\
( ?
,)))
6553 (setq cw
'function-keyword cw-mod func cw-point func-point
6554 cw-class func-class cw-arrow func-arrow
))
6555 ((and pro
(eq last-char ?
,))
6556 (setq cw
'procedure-keyword cw-mod pro cw-point pro-point
6557 cw-class pro-class cw-arrow pro-arrow
))
6558 ; ((member last-char '(?\' ?\) ?\] ?!))
6559 ; ;; after these chars, a function makes no sense
6560 ; ;; FIXME: I am sure there can be more in this list
6561 ; ;; FIXME: Do we want to do this at all?
6563 ;; Everywhere else we try a function.
6567 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t
)
6568 (setq cw-arrow
(copy-marker (match-beginning 0))
6569 cw-class
(if (match-end 4)
6570 (idlwave-sintern-class (match-string 4))
6572 (list (list pro pro-point pro-class pro-arrow
)
6573 (list func func-point func-class func-arrow
)
6575 (list cw-mod cw-point cw-class cw-arrow
)
6578 (defun idlwave-this-word (&optional class
)
6579 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6580 (setq class
(or class
"a-zA-Z0-9$_."))
6583 (progn (skip-chars-backward class
) (point))
6584 (progn (skip-chars-forward class
) (point)))))
6586 (defun idlwave-what-function (&optional bound
)
6587 ;; Find out if point is within the argument list of a function.
6588 ;; The return value is ("function-name" class arrow-start (point) level).
6589 ;; Level is 1 on the top level parentheses, higher further down.
6591 ;; If the optional BOUND is an integer, bound backwards directed
6592 ;; searches to this point.
6598 func arrow-start class
)
6599 (idlwave-with-special-syntax
6602 (narrow-to-region (max 1 (or bound
0)) (point-max))
6603 ;; move back out of the current parenthesis
6604 (while (condition-case nil
6605 (progn (up-list -
1) t
)
6609 (when (and (= (following-char) ?\
()
6611 "\\(::\\|\\<\\)\\([a-zA-Z][a-zA-Z0-9$_]*\\)[ \t]*\\="
6613 (setq func
(match-string 2)
6614 func-point
(goto-char (match-beginning 2))
6616 (if (re-search-backward
6617 "->[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\=" bound t
)
6618 (setq arrow-start
(copy-marker (match-beginning 0))
6619 class
(or (match-string 2) t
)))
6623 (idlwave-sintern-routine-or-method func class
)
6624 (idlwave-sintern-class class
)
6625 arrow-start func-point cnt
)))
6627 (throw 'exit nil
)))))))
6629 (defun idlwave-what-procedure (&optional bound
)
6630 ;; Find out if point is within the argument list of a procedure.
6631 ;; The return value is ("procedure-name" class arrow-pos (point)).
6633 ;; If the optional BOUND is an integer, bound backwards directed
6634 ;; searches to this point.
6635 (let ((pos (point)) pro-point
6636 pro class arrow-start string
)
6638 ;;(idlwave-beginning-of-statement)
6639 (idlwave-start-of-substatement 'pre
)
6640 (setq string
(buffer-substring (point) pos
))
6642 "\\`[ \t]*\\([a-zA-Z][a-zA-Z0-9$_]*\\)[ \t]*\\(,\\|\\'\\)" string
)
6643 (setq pro
(match-string 1 string
)
6644 pro-point
(+ (point) (match-beginning 1)))
6645 (if (and (idlwave-skip-object)
6646 (setq string
(buffer-substring (point) pos
))
6648 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6650 (setq pro
(if (match-beginning 4)
6651 (match-string 4 string
))
6652 pro-point
(if (match-beginning 4)
6653 (+ (point) (match-beginning 4))
6655 arrow-start
(copy-marker (+ (point) (match-beginning 1)))
6656 class
(or (match-string 3 string
) t
)))))
6657 (list (idlwave-sintern-routine-or-method pro class
)
6658 (idlwave-sintern-class class
)
6662 (defun idlwave-skip-object ()
6663 ;; If there is an object at point, move over it and return t.
6664 (let ((pos (point)))
6667 (skip-chars-forward " ") ; white space
6668 (skip-chars-forward "*") ; de-reference
6670 ((looking-at idlwave-identifier
)
6671 (goto-char (match-end 0)))
6672 ((eq (following-char) ?\
()
6674 (t (throw 'exit nil
)))
6677 (cond ((eq (following-char) ?.
)
6679 (if (not (looking-at idlwave-identifier
))
6681 (goto-char (match-end 0)))
6682 ((memq (following-char) '(?\
( ?\
[))
6685 (error (throw 'exit nil
))))
6686 (t (throw 'endwhile t
)))))
6687 (if (looking-at "[ \t]*->")
6688 (throw 'exit
(setq pos
(match-beginning 0)))
6689 (throw 'exit nil
))))
6693 (defun idlwave-last-valid-char ()
6694 "Return the last character before point which is not white or a comment
6695 and also not part of the current identifier. Since we do this in
6696 order to identify places where keywords are, we consider the initial
6697 `/' of a keyword as part of the identifier.
6698 This function is not general, can only be used for completion stuff."
6701 ;; skip the current identifier
6702 (skip-chars-backward "a-zA-Z0-9_$")
6703 ;; also skip a leading slash which might be belong to the keyword
6704 (if (eq (preceding-char) ?
/)
6706 ;; FIXME: does not check if this is a valid identifier
6708 (skip-chars-backward " \t")
6710 ((memq (preceding-char) '(?\
; ?\$)) (throw 'exit nil))
6711 ((eq (preceding-char) ?
\n)
6712 (beginning-of-line 0)
6713 (if (looking-at "\\([^\n]*\\)\\$[ \t]*\\(;[^\n]*\\)?\n")
6714 ;; continuation line
6715 (goto-char (match-end 1))
6717 (t (throw 'exit
(preceding-char))))))))
6719 (defvar idlwave-complete-after-success-form nil
6720 "A form to evaluate after successful completion.")
6721 (defvar idlwave-complete-after-success-form-force nil
6722 "A form to evaluate after completion selection in *Completions* buffer.")
6723 (defconst idlwave-completion-mark
(make-marker)
6724 "A mark pointing to the beginning of the completion string.")
6726 (defun idlwave-complete-in-buffer (type stype list selector prompt isa
6727 &optional prepare-display-function
6729 "Perform TYPE completion of word before point against LIST.
6730 SELECTOR is the PREDICATE argument for the completion function. Show
6731 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6732 'procedure, 'class-tag, 'keyword, 'sysvar, etc.. SPECIAL-SELECTOR is
6733 used only once, for `all-completions', and can be used to, e.g.,
6734 accumulate information on matching completions."
6735 (let* ((completion-ignore-case t
)
6736 beg
(end (point)) slash part spart completion all-completions
6740 (error (concat prompt
": No completions available")))
6742 ;; What is already in the buffer?
6744 (skip-chars-backward "a-zA-Z0-9_$")
6745 (setq slash
(eq (preceding-char) ?
/)
6747 idlwave-complete-after-success-form
6748 (list 'idlwave-after-successful-completion
6749 (list 'quote type
) slash beg
)
6750 idlwave-complete-after-success-form-force
6751 (list 'idlwave-after-successful-completion
6752 (list 'quote type
) slash
(list 'quote
'force
))))
6755 (setq part
(buffer-substring beg end
)
6756 dpart
(downcase part
)
6757 spart
(idlwave-sintern stype part
)
6758 completion
(try-completion part list selector
)
6759 dcompletion
(if (stringp completion
) (downcase completion
))
6760 idlwave-completion-help-links nil
)
6763 ;; nothing available.
6764 (error (concat prompt
": no completion for \"%s\"") part
))
6765 ((and (not (equal dpart dcompletion
))
6766 (not (eq t completion
)))
6767 ;; We can add something
6768 (delete-region beg end
)
6769 (if (and (string= part dpart
)
6770 (or (not (string= part
""))
6771 idlwave-complete-empty-string-as-lower-case
)
6772 (not idlwave-completion-force-default-case
))
6773 (insert dcompletion
)
6774 (insert completion
))
6775 (if (eq t
(try-completion completion list selector
))
6776 ;; Now this is a unique match
6777 (idlwave-after-successful-completion type slash beg
))
6779 ((or (eq completion t
)
6780 (and (= 1 (length (setq all-completions
6782 (all-completions part list
6783 (or special-selector
6785 (equal dpart dcompletion
)))
6786 ;; This is already complete
6787 (idlwave-after-successful-completion type slash beg
)
6788 (message "%s is already the complete %s" part isa
)
6791 ;; We cannot add something - offer a list.
6792 (message "Making completion list...")
6794 (unless idlwave-completion-help-links
; already set somewhere?
6795 (mapc (lambda (x) ; Pass link prop through to highlight-linked
6796 (let ((link (get-text-property 0 'link
(car x
))))
6798 (push (cons (car x
) link
)
6799 idlwave-completion-help-links
))))
6801 (let* ((list all-completions
)
6802 ;; "complete" means, this is already a valid completion
6803 (complete (memq spart all-completions
))
6804 (completion-highlight-first-word-only t
)) ; XEmacs
6805 ; (completion-fixup-function ; Emacs
6806 ; (lambda () (and (eq (preceding-char) ?>)
6807 ; (re-search-backward " <" beg t)))))
6809 (setq list
(sort list
(lambda (a b
)
6810 (string< (downcase a
) (downcase b
)))))
6811 (if prepare-display-function
6812 (setq list
(funcall prepare-display-function list
)))
6813 (if (and (string= part dpart
)
6814 (or (not (string= part
""))
6815 idlwave-complete-empty-string-as-lower-case
)
6816 (not idlwave-completion-force-default-case
))
6817 (setq list
(mapcar (lambda (x)
6819 (setcar x
(downcase (car x
)))
6820 (setq x
(downcase x
)))
6823 (idlwave-display-completion-list list prompt beg complete
))
6826 (defun idlwave-complete-class ()
6827 "Complete a class at point."
6829 ;; Call `idlwave-routines' to make sure the class list will be available
6831 ;; Check for the special case of completing empty string after pro/function
6832 (if (let ((case-fold-search t
))
6835 (re-search-backward "\\<\\(pro\\|function\\)[ \t]+\\="
6837 (goto-char (point-min))
6839 "^[ \t]*\\(pro\\|function\\)[ \t]+\\([a-zA-Z0-9_]+::\\)" nil t
))))
6840 ;; Yank the full class specification
6841 (insert (match-string 2))
6842 ;; Do the completion, using list gathered from `idlwave-routines'
6843 (idlwave-complete-in-buffer
6844 'class
'class
(idlwave-class-alist) nil
6845 "Select a class" "class"
6846 '(lambda (list) ;; Push it to help-links if system help available
6848 (let* ((entry (idlwave-class-info x
))
6849 (link (nth 1 (assq 'link entry
))))
6850 (if link
(push (cons x link
)
6851 idlwave-completion-help-links
))
6855 (defun idlwave-attach-classes (list type show-classes
)
6856 ;; Attach the proper class list to a LIST of completion items.
6857 ;; TYPE, when 'kwd, shows classes for method keywords, when
6858 ;; 'class-tag, for class tags, and otherwise for methods.
6859 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6860 (if (or (null show-classes
) ; don't want to see classes
6861 (null class-selector
) ; not a method call
6863 (stringp class-selector
) ; the class is already known
6864 (not super-classes
))) ; no possibilities for inheritance
6865 ;; In these cases, we do not have to do anything
6867 (let* ((do-prop (and (>= show-classes
0)
6868 (>= emacs-major-version
21)))
6869 (do-buf (not (= show-classes
0)))
6870 ;; (do-dots (featurep 'xemacs))
6872 (inherit (if (and (not (eq type
'class-tag
)) super-classes
)
6873 (cons class-selector super-classes
)))
6874 (max (abs show-classes
))
6875 (lmax (if do-dots
(apply 'max
(mapcar 'length list
))))
6876 classes nclasses class-info space
)
6880 (if (eq type
'class-tag
)
6881 ;; Just one class for tags
6884 (idlwave-class-or-superclass-with-tag class-selector x
)))
6885 ;; Multiple classes for method or method-keyword
6888 (idlwave-all-method-keyword-classes
6889 method-selector x type-selector
)
6890 (idlwave-all-method-classes x type-selector
)))
6894 (mapcar (lambda (x) (if (memq x inherit
) x nil
))
6896 (setq nclasses
(length classes
))
6897 ;; Make the separator between item and class-info
6899 (setq space
(concat " " (make-string (- lmax
(length x
)) ?.
)))
6902 ;; We do want info in the buffer
6903 (if (<= nclasses max
)
6904 (setq class-info
(concat
6906 "<" (mapconcat 'identity classes
",") ">"))
6907 (setq class-info
(format "%s<%d classes>" space nclasses
)))
6908 (setq class-info nil
))
6910 ;; We do want properties
6911 (setq x
(copy-sequence x
))
6912 (put-text-property 0 (length x
)
6913 'help-echo
(mapconcat 'identity classes
" ")
6920 (defun idlwave-attach-method-classes (list)
6921 ;; Call idlwave-attach-classes with method parameters
6922 (idlwave-attach-classes list
'method idlwave-completion-show-classes
))
6923 (defun idlwave-attach-keyword-classes (list)
6924 ;; Call idlwave-attach-classes with keyword parameters
6925 (idlwave-attach-classes list
'kwd idlwave-completion-show-classes
))
6926 (defun idlwave-attach-class-tag-classes (list)
6927 ;; Call idlwave-attach-classes with class structure tags
6928 (idlwave-attach-classes list
'class-tag idlwave-completion-show-classes
))
6931 ;;----------------------------------------------------------------------
6932 ;;----------------------------------------------------------------------
6933 ;;----------------------------------------------------------------------
6934 ;;----------------------------------------------------------------------
6935 ;;----------------------------------------------------------------------
6937 (defun idlwave-pset (item)
6940 (defun idlwave-popup-select (ev list title
&optional sort
)
6941 "Select an item in LIST with a popup menu.
6942 TITLE is the title to put atop the popup. If SORT is non-nil,
6943 sort the list before displaying"
6944 (let ((maxpopup idlwave-max-popup-menu-items
)
6947 ((= 1 (length list
))
6948 (setq rtn
(car list
)))
6950 (if sort
(setq list
(sort list
(lambda (a b
)
6951 (string< (upcase a
) (upcase b
))))))
6953 (append (list title
)
6954 (mapcar (lambda (x) (vector x
(list 'idlwave-pset
6957 (setq menu
(idlwave-split-menu-xemacs menu maxpopup
))
6958 (setq resp
(get-popup-menu-response menu
))
6959 (funcall (event-function resp
) (event-object resp
)))
6961 (if sort
(setq list
(sort list
(lambda (a b
)
6962 (string< (upcase a
) (upcase b
))))))
6963 (setq menu
(cons title
6966 (mapcar (lambda(x) (cons x x
)) list
)))))
6967 (setq menu
(idlwave-split-menu-emacs menu maxpopup
))
6968 (setq rtn
(x-popup-menu ev menu
))))
6971 (defun idlwave-split-menu-xemacs (menu N
)
6972 "Split the MENU into submenus of maximum length N."
6973 (if (<= (length menu
) (1+ N
))
6974 ;; No splitting needed
6976 (let* ((title (car menu
))
6977 (entries (cdr menu
))
6982 (while (and entries
(< cnt N
))
6984 nextmenu
(cons (car entries
) nextmenu
)
6985 entries
(cdr entries
)))
6986 (setq nextmenu
(nreverse nextmenu
))
6987 (setq nextmenu
(cons (format "%s...%s"
6988 (aref (car nextmenu
) 0)
6989 (aref (nth (1- cnt
) nextmenu
) 0))
6991 (setq menu
(cons nextmenu menu
)
6996 (defun idlwave-split-menu-emacs (menu N
)
6997 "Split the MENU into submenus of maximum length N."
6998 (if (<= (length (nth 1 menu
)) (1+ N
))
6999 ;; No splitting needed
7001 (let* ((title (car menu
))
7002 (entries (cdr (nth 1 menu
)))
7007 (while (and entries
(< cnt N
))
7009 nextmenu
(cons (car entries
) nextmenu
)
7010 entries
(cdr entries
)))
7011 (setq nextmenu
(nreverse nextmenu
))
7013 (setq nextmenu
(cons (format "%s...%s"
7014 (car (car nextmenu
))
7015 (car (nth (1- cnt
) nextmenu
)))
7017 (setq menu
(cons nextmenu menu
)
7020 (setq menu
(nreverse menu
))
7021 (setq menu
(cons title menu
))
7024 (defvar idlwave-completion-setup-hook nil
)
7026 (defun idlwave-scroll-completions (&optional message
)
7027 "Scroll the completion window on this frame."
7028 (let ((cwin (get-buffer-window "*Completions*" 'visible
))
7029 (win (selected-window)))
7032 (select-window cwin
)
7035 (error (if (and (listp last-command
)
7036 (nth 2 last-command
))
7039 (eval idlwave-complete-after-success-form
))
7040 (set-window-start cwin
(point-min)))))
7041 (and message
(message "%s" message
)))
7042 (select-window win
))))
7044 (defun idlwave-display-completion-list (list &optional message beg complete
)
7045 "Display the completions in LIST in the completions buffer and echo MESSAGE."
7046 (unless (and (get-buffer-window "*Completions*")
7047 (idlwave-local-value 'idlwave-completion-p
"*Completions*"))
7048 (move-marker idlwave-completion-mark beg
)
7049 (setq idlwave-before-completion-wconf
(current-window-configuration)))
7051 (if (featurep 'xemacs
)
7052 (idlwave-display-completion-list-xemacs
7054 (idlwave-display-completion-list-emacs list
))
7056 ;; Store a special value in `this-command'. When `idlwave-complete'
7057 ;; finds this in `last-command', it will scroll the *Completions* buffer.
7058 (setq this-command
(list 'idlwave-display-completion-list message complete
))
7060 ;; Mark the completions buffer as created by cib
7061 (idlwave-set-local 'idlwave-completion-p t
"*Completions*")
7063 ;; Fontify the classes
7064 (if (and idlwave-completion-fontify-classes
7066 (idlwave-completion-fontify-classes))
7069 (run-hooks 'idlwave-completion-setup-hook
)
7071 ;; Display the message
7072 (message "%s" (or message
"Making completion list...done")))
7074 (defun idlwave-choose (function &rest args
)
7075 "Call FUNCTION as a completion chooser and pass ARGS to it."
7076 (let ((completion-ignore-case t
)) ; install correct value
7077 (apply function args
))
7078 (if (and (eq major-mode
'idlwave-shell-mode
)
7079 (boundp 'font-lock-mode
)
7080 (not font-lock-mode
))
7081 ;; For the shell, remove the fontification of the word before point
7082 (let ((beg (save-excursion
7083 (skip-chars-backward "a-zA-Z0-9_")
7085 (remove-text-properties beg
(point) '(face nil
))))
7086 (eval idlwave-complete-after-success-form-force
))
7088 (defun idlwave-keyboard-quit ()
7091 (if (eq (car-safe last-command
) 'idlwave-display-completion-list
)
7092 (idlwave-restore-wconf-after-completion))
7095 (defun idlwave-restore-wconf-after-completion ()
7096 "Restore the old (before completion) window configuration."
7097 (and idlwave-completion-restore-window-configuration
7098 idlwave-before-completion-wconf
7099 (set-window-configuration idlwave-before-completion-wconf
)))
7101 (defun idlwave-one-key-select (sym prompt delay
)
7102 "Make the user select an element from the alist in the variable SYM.
7103 The keys of the alist are expected to be strings. The function returns the
7104 car of the selected association.
7105 To do this, PROMPT is displayed and the user must hit a letter key to
7106 select an entry. If the user does not reply within DELAY seconds, a help
7107 window with the options is displayed automatically.
7108 The key which is associated with each option is generated automatically.
7109 First, the strings are checked for preselected keys, like in \"[P]rint\".
7110 If these don't exist, a letter in the string is automatically selected."
7111 (let* ((alist (symbol-value sym
))
7112 (temp-buffer-show-hook (if (fboundp 'fit-window-to-buffer
)
7113 '(fit-window-to-buffer)))
7115 ;; First check the cache
7116 (if (and (eq (symbol-value sym
) (get sym
:one-key-alist-last
)))
7117 (setq keys-alist
(get sym
:one-key-alist-cache
))
7118 ;; Need to make new list
7119 (setq keys-alist
(idlwave-make-one-key-alist alist
))
7120 (put sym
:one-key-alist-cache keys-alist
)
7121 (put sym
:one-key-alist-last alist
))
7122 ;; Display prompt and wait for quick reply
7123 (message "%s[%s]" prompt
7124 (mapconcat (lambda(x) (char-to-string (car x
)))
7127 ;; No quick reply: Show help
7128 (save-window-excursion
7129 (with-output-to-temp-buffer "*Completions*"
7134 (setq char
(read-char)))
7135 (setq char
(read-char)))
7137 ;; Return the selected result
7138 (nth 2 (assoc char keys-alist
))))
7140 ;; Used for, e.g., electric debug super-examine.
7141 (defun idlwave-make-one-key-alist (alist)
7142 "Make an alist for single key selection."
7143 (let ((l alist
) keys-alist name start char help
7145 (case-fold-search nil
))
7147 (setq name
(car (car l
))
7150 ;; First check if the configuration predetermined a key
7151 (if (string-match "\\[\\(.\\)\\]" name
)
7153 (setq char
(string-to-char (downcase (match-string 1 name
)))
7154 help
(format "%c: %s" char name
)
7155 keys-alist
(cons (list char help name
) keys-alist
))
7157 ;; Then check for capital letters
7159 (while (string-match "[A-Z]" name start
)
7160 (setq start
(match-end 0)
7161 char
(string-to-char (downcase (match-string 0 name
))))
7162 (if (not (assoc char keys-alist
))
7164 (setq help
(format "%c: %s" char
7166 (concat "[" (match-string 0 name
) "]")
7168 keys-alist
(cons (list char help name
) keys-alist
))
7170 ;; Now check for lowercase letters
7172 (while (string-match "[a-z]" name start
)
7173 (setq start
(match-end 0)
7174 char
(string-to-char (match-string 0 name
)))
7175 (if (not (assoc char keys-alist
))
7177 (setq help
(format "%c: %s" char
7179 (concat "[" (match-string 0 name
) "]")
7181 keys-alist
(cons (list char help name
) keys-alist
))
7183 ;; Bummer, nothing found! Use a stupid number
7184 (setq char
(string-to-char (int-to-string (setq cnt
(1+ cnt
))))
7185 help
(format "%c: %s" char name
)
7186 keys-alist
(cons (list char help name
) keys-alist
))))
7187 (nreverse keys-alist
)))
7189 (defun idlwave-set-local (var value
&optional buffer
)
7190 "Set the buffer-local value of VAR in BUFFER to VALUE."
7192 (set-buffer (or buffer
(current-buffer)))
7193 (set (make-local-variable var
) value
)))
7195 (defun idlwave-local-value (var &optional buffer
)
7196 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
7198 (set-buffer (or buffer
(current-buffer)))
7199 (and (local-variable-p var
(current-buffer))
7200 (symbol-value var
))))
7202 ;; In XEmacs, we can use :activate-callback directly to advice the
7203 ;; choose functions. We use the private keymap only for the online
7206 (defvar idlwave-completion-map nil
7207 "Keymap for completion-list-mode with idlwave-complete.")
7209 (defun idlwave-display-completion-list-xemacs (list &rest cl-args
)
7210 (with-output-to-temp-buffer "*Completions*"
7211 (apply 'display-completion-list list
7212 ':activate-callback
'idlwave-default-choose-completion
7215 (set-buffer "*Completions*")
7217 (or idlwave-completion-map
7218 (setq idlwave-completion-map
7219 (idlwave-make-modified-completion-map-xemacs
7220 (current-local-map)))))))
7222 (defun idlwave-default-choose-completion (&rest args
)
7223 "Execute `default-choose-completion' and then restore the win-conf."
7224 (apply 'idlwave-choose
'default-choose-completion args
))
7226 (defun idlwave-make-modified-completion-map-xemacs (old-map)
7227 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7228 (let ((new-map (copy-keymap old-map
)))
7229 (define-key new-map
[button3up] 'idlwave-mouse-completion-help)
7230 (define-key new-map [button3] (lambda ()
7232 (setq this-command last-command)))
7235 ;; In Emacs we also replace keybindings in the completion
7236 ;; map in order to install our wrappers.
7238 (defun idlwave-display-completion-list-emacs (list)
7239 "Display completion list and install the choose wrappers."
7240 (with-output-to-temp-buffer "*Completions*"
7241 (display-completion-list list))
7243 (set-buffer "*Completions*")
7245 (or idlwave-completion-map
7246 (setq idlwave-completion-map
7247 (idlwave-make-modified-completion-map-emacs
7248 (current-local-map)))))))
7250 (defun idlwave-make-modified-completion-map-emacs (old-map)
7251 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7252 (let ((new-map (copy-keymap old-map)))
7253 (substitute-key-definition
7254 'choose-completion 'idlwave-choose-completion new-map)
7255 (substitute-key-definition
7256 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
7257 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
7260 (defun idlwave-choose-completion (&rest args)
7261 "Choose the completion that point is in or next to."
7263 (apply 'idlwave-choose 'choose-completion args))
7265 (defun idlwave-mouse-choose-completion (&rest args)
7266 "Click on an alternative in the `*Completions*' buffer to choose it."
7268 (apply 'idlwave-choose 'mouse-choose-completion args))
7270 ;;----------------------------------------------------------------------
7271 ;;----------------------------------------------------------------------
7273 ;;; ------------------------------------------------------------------------
7274 ;;; Stucture parsing code, and code to manage class info
7277 ;; - Go again over the documentation how to write a completion
7278 ;; plugin. It is in self.el, but currently still very bad.
7279 ;; This could be in a separate file in the distribution, or
7280 ;; in an appendix for the manual.
7282 (defvar idlwave-struct-skip
7283 "[ \t]*\\(\\$.*\n\\(^[ \t]*\\(\\$[ \t]*\\)?\\(;.*\\)?\n\\)*\\)?[ \t]*"
7284 "Regexp for skipping continued blank or comment-only lines in
7287 (defvar idlwave-struct-tag-regexp
7288 (concat "[{,]" ;leading comma/brace
7289 idlwave-struct-skip ; 4 groups
7290 "\\([a-zA-Z][a-zA-Z0-9_]*\\)" ;the tag itself, group 5
7291 "[ \t]*:") ; the final colon
7292 "Regexp for structure tags.")
7294 (defun idlwave-struct-tags ()
7295 "Return a list of all tags in the structure defined at point.
7296 Point is expected just before the opening `{' of the struct definition."
7298 (let* ((borders (idlwave-struct-borders))
7304 (narrow-to-region beg end)
7305 (while (re-search-forward idlwave-struct-tag-regexp end t)
7306 ;; Check if we are still on the top level of the structure.
7307 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7309 (push (match-string-no-properties 5) tags))
7310 (goto-char (match-end 0))))
7313 (defun idlwave-find-struct-tag (tag)
7314 "Find a given TAG in the structure defined at point."
7315 (let* ((borders (idlwave-struct-borders))
7318 (case-fold-search t))
7319 (re-search-forward (concat "\\(^[ \t]*\\|[,{][ \t]*\\)" tag "[ \t]*:")
7322 (defun idlwave-struct-inherits ()
7323 "Return a list of all `inherits' names in the struct at point.
7324 Point is expected just before the opening `{' of the struct definition."
7326 (let* ((borders (idlwave-struct-borders))
7329 (case-fold-search t)
7333 (narrow-to-region beg end)
7334 (while (re-search-forward
7335 (concat "[{,]" ;leading comma/brace
7336 idlwave-struct-skip ; 4 groups
7337 "inherits" ; The INHERITS tag
7338 idlwave-struct-skip ; 4 more
7339 "\\([a-zA-Z][a-zA-Z0-9_]*\\)") ; The super-group, #9
7341 ;; Check if we are still on the top level of the structure.
7342 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7344 (push (match-string-no-properties 9) names))
7345 (goto-char (match-end 0))))
7348 (defun idlwave-in-structure ()
7349 "Return t if point is inside an IDL structure definition."
7350 (let ((beg (point)))
7352 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
7353 (if (idlwave-find-structure-definition nil nil 'back)
7354 (let ((borders (idlwave-struct-borders)))
7355 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
7356 (and (> beg (car borders)) (< beg (cdr borders))))))))))
7358 (defun idlwave-struct-borders ()
7359 "Return the borders of the {...} after point as a cons cell."
7362 (skip-chars-forward "^{")
7364 (condition-case nil (forward-list 1)
7365 (error (goto-char beg)))
7366 (cons beg (point)))))
7368 (defun idlwave-find-structure-definition (&optional var name bound)
7369 "Search forward for a structure definition. If VAR is non-nil,
7370 search for a structure assigned to variable VAR. If NAME is non-nil,
7371 search for a named structure NAME, if a string, or a generic named
7372 structure otherwise. If BOUND is an integer, limit the search. If
7373 BOUND is the symbol `all', we search first back and then forward
7374 through the entire file. If BOUND is the symbol `back' we search only
7376 (let* ((ws "[ \t]*\\(\\$.*\n[ \t]*\\)*")
7377 (case-fold-search t)
7378 (lim (if (integerp bound) bound nil))
7381 (concat "\\<" (regexp-quote (downcase var)) "\\>" ws)
7386 (concat ws "\\(\\<" (downcase name) "\\)[^a-zA-Z0-9_$]")
7387 ;; Just a generic name
7388 (concat ws "\\<\\([a-zA-Z_0-9$]+\\)" ws ","))
7390 (if (or (and (or (eq bound 'all) (eq bound 'back))
7391 (re-search-backward re nil t))
7392 (and (not (eq bound 'back)) (re-search-forward re lim t)))
7394 (goto-char (match-beginning 3))
7395 (match-string-no-properties 5)))))
7397 (defvar idlwave-class-info nil)
7398 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
7400 (add-hook 'idlwave-update-rinfo-hook
7401 (lambda () (setq idlwave-class-reset t)))
7402 (add-hook 'idlwave-after-load-rinfo-hook
7403 (lambda () (setq idlwave-class-info nil)))
7405 (defun idlwave-class-info (class)
7407 (if idlwave-class-info
7408 (if idlwave-class-reset
7410 idlwave-class-reset nil
7411 idlwave-class-info ; Remove any visited in a buffer
7415 (idlwave-class-file-or-buffer
7416 (or (cdr (assq 'found-in x)) (car x)))))
7420 idlwave-class-info))))
7421 ;; Info is nil, put in the system stuff to start.
7422 (setq idlwave-class-info idlwave-system-class-info)
7423 (setq list idlwave-class-info)
7424 (while (setq entry (pop list))
7425 (idlwave-sintern-class-info entry)))
7426 (setq class (idlwave-sintern-class class))
7427 (or (assq class idlwave-class-info)
7428 (progn (idlwave-scan-class-info class)
7429 (assq class idlwave-class-info)))))
7431 (defun idlwave-sintern-class-info (entry)
7432 "Sintern the class names in a class-info entry."
7433 (let ((taglist (assq 'tags entry))
7434 (inherits (assq 'inherits entry)))
7435 (setcar entry (idlwave-sintern-class (car entry) 'set))
7437 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
7440 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
7441 "Find class structure definition(s)
7442 If ALL-HOOK is set, find all named structure definitions in a given
7443 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
7444 set, look for the name__define pro, and inside of it, for the ALT-CLASS
7445 class/struct definition"
7446 (let ((case-fold-search t) end-lim list name)
7447 (when (re-search-forward
7448 (concat "^[ \t]*pro[ \t]+" (downcase class) "__define" "\\>") nil t)
7451 ;; For everything there
7452 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
7454 (idlwave-find-structure-definition nil t end-lim))
7455 (funcall all-hook name)))
7456 (idlwave-find-structure-definition nil (or alt-class class))))))
7459 (defun idlwave-class-file-or-buffer (class)
7460 "Find buffer visiting CLASS definition"
7461 (let* ((pro (concat (downcase class) "__define"))
7462 (file (idlwave-routine-source-file
7463 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
7464 (idlwave-routines))))))
7465 (cons file (if file (idlwave-get-buffer-visiting file)))))
7468 (defun idlwave-scan-class-info (class)
7469 "Scan all class and named structure info in the class__define pro"
7470 (let* ((idlwave-auto-routine-info-updates nil)
7471 (filebuf (idlwave-class-file-or-buffer class))
7472 (file (car filebuf))
7474 (class (idlwave-sintern-class class)))
7477 (and ;; neither a regular file nor a visited buffer
7479 (not (file-regular-p file))))
7480 nil ; Cannot find the file/buffer to get any info
7482 (if buf (set-buffer buf)
7483 ;; Read the file in temporarily
7484 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
7486 (unless (eq major-mode 'idlwave-mode)
7488 (insert-file-contents file))
7491 (idlwave-find-class-definition class
7492 ;; Scan all of the structures found there
7494 (let* ((this-class (idlwave-sintern-class name))
7497 (cons 'tags (idlwave-struct-tags))
7498 (cons 'inherits (idlwave-struct-inherits)))))
7499 (if (not (eq this-class class))
7500 (setq entry (nconc entry (list (cons 'found-in class)))))
7501 (idlwave-sintern-class-info entry)
7502 (push entry idlwave-class-info)))))))))
7504 (defun idlwave-class-found-in (class)
7505 "Return the FOUND-IN property of the class."
7506 (cdr (assq 'found-in (idlwave-class-info class))))
7507 (defun idlwave-class-tags (class)
7508 "Return the native tags in CLASS."
7509 (cdr (assq 'tags (idlwave-class-info class))))
7510 (defun idlwave-class-inherits (class)
7511 "Return the direct superclasses of CLASS."
7512 (cdr (assq 'inherits (idlwave-class-info class))))
7515 (defun idlwave-all-class-tags (class)
7516 "Return a list of native and inherited tags in CLASS."
7518 (apply 'append (mapcar 'idlwave-class-tags
7519 (cons class (idlwave-all-class-inherits class))))
7521 (idlwave-class-tag-reset)
7522 (error "%s" (error-message-string err)))))
7525 (defun idlwave-all-class-inherits (class)
7526 "Return a list of all superclasses of CLASS (recursively expanded).
7527 The list is cached in `idlwave-class-info' for faster access."
7529 ((not idlwave-support-inheritance) nil)
7530 ((eq class nil) nil)
7533 (let ((info (idlwave-class-info class))
7535 (if (setq entry (assq 'all-inherits info))
7537 ;; Save the depth of inheritance scan to check for circular references
7538 (let ((inherits (mapcar (lambda (x) (cons x 0))
7539 (idlwave-class-inherits class)))
7540 rtn all-inherits cl)
7542 (setq cl (pop inherits)
7543 rtn (cons (car cl) rtn)
7544 inherits (append (mapcar (lambda (x)
7545 (cons x (1+ (cdr cl))))
7546 (idlwave-class-inherits (car cl)))
7548 (if (> (cdr cl) 999)
7550 "Class scan: inheritance depth exceeded. Circular inheritance?")
7552 (setq all-inherits (nreverse rtn))
7553 (nconc info (list (cons 'all-inherits all-inherits)))
7556 (defun idlwave-entry-keywords (entry &optional record-link)
7557 "Return the flat entry keywords alist from routine-info entry.
7558 If RECORD-LINK is non-nil, the keyword text is copied and a text
7559 property indicating the link is added."
7563 (let ((file (car key-list)))
7564 (mapcar (lambda (key-cons)
7565 (let ((key (car key-cons))
7566 (link (cdr key-cons)))
7567 (when (and record-link file)
7568 (setq key (copy-sequence key))
7575 (concat idlwave-html-link-sep
7576 (number-to-string link))))
7578 (push (list key) kwds)))
7583 (defun idlwave-entry-find-keyword (entry keyword)
7584 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set"
7588 (let ((file (car key-list))
7589 (kwd (assoc keyword (cdr key-list))))
7591 (setq kwd (cons (car kwd)
7592 (if (and file (cdr kwd))
7594 idlwave-html-link-sep
7595 (number-to-string (cdr kwd)))
7597 (throw 'exit kwd))))
7600 ;;==========================================================================
7602 ;; Completing class structure tags. This is a completion plugin.
7603 ;; The necessary taglist is constructed dynamically
7605 (defvar idlwave-current-tags-class nil)
7606 (defvar idlwave-current-class-tags nil)
7607 (defvar idlwave-current-native-class-tags nil)
7608 (defvar idlwave-sint-class-tags nil)
7609 (declare-function idlwave-sintern-class-tag "idlwave" t t)
7610 (idlwave-new-sintern-type 'class-tag)
7611 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7612 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7614 (defun idlwave-complete-class-structure-tag ()
7615 "Complete a structure tag on a `self' argument in an object method."
7618 (case-fold-search t))
7620 ;; Check if the context is right
7621 (skip-chars-backward "a-zA-Z0-9._$")
7622 (and (< (point) (- pos 4))
7623 (looking-at "self\\.")))
7624 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7625 (super-classes (idlwave-all-class-inherits class-selector)))
7626 ;; Check if we are in a class routine
7627 (unless class-selector
7628 (error "Not in a method procedure or function"))
7629 ;; Check if we need to update the "current" class
7630 (if (not (equal class-selector idlwave-current-tags-class))
7631 (idlwave-prepare-class-tag-completion class-selector))
7632 (setq idlwave-completion-help-info
7633 (list 'idlwave-complete-class-structure-tag-help
7634 (idlwave-sintern-routine
7635 (concat class-selector "__define"))
7637 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7638 (idlwave-complete-in-buffer
7639 'class-tag 'class-tag
7640 idlwave-current-class-tags nil
7641 (format "Select a tag of class %s" class-selector)
7643 'idlwave-attach-class-tag-classes))
7644 t) ; return t to skip other completions
7647 (defun idlwave-class-tag-reset ()
7648 (setq idlwave-current-tags-class nil))
7650 (defun idlwave-prepare-class-tag-completion (class)
7651 "Find and parse the necessary class definitions for class structure tags."
7652 (setq idlwave-sint-class-tags nil)
7653 (setq idlwave-current-tags-class class)
7654 (setq idlwave-current-class-tags
7656 (list (idlwave-sintern-class-tag x 'set)))
7657 (idlwave-all-class-tags class)))
7658 (setq idlwave-current-native-class-tags
7659 (mapcar 'downcase (idlwave-class-tags class))))
7661 ;===========================================================================
7663 ;; Completing system variables and their structure fields
7664 ;; This is also a plugin.
7666 (defvar idlwave-sint-sysvars nil)
7667 (defvar idlwave-sint-sysvartags nil)
7668 (declare-function idlwave-sintern-sysvar "idlwave" t t)
7669 (declare-function idlwave-sintern-sysvartag "idlwave" t t)
7670 (idlwave-new-sintern-type 'sysvar)
7671 (idlwave-new-sintern-type 'sysvartag)
7672 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7673 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7674 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7677 (defun idlwave-complete-sysvar-or-tag ()
7678 "Complete a system variable."
7681 (case-fold-search t))
7682 (cond ((save-excursion
7683 ;; Check if the context is right for system variable
7684 (skip-chars-backward "[a-zA-Z0-9_$]")
7685 (equal (char-before) ?!))
7686 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7687 (idlwave-complete-in-buffer 'sysvar 'sysvar
7688 idlwave-system-variables-alist nil
7689 "Select a system variable"
7691 t) ; return t to skip other completions
7693 ;; Check if the context is right for sysvar tag
7694 (skip-chars-backward "a-zA-Z0-9_$.")
7695 (and (equal (char-before) ?!)
7696 (looking-at "\\([a-zA-Z][a-zA-Z0-9_$]*\\)\\.")
7697 (<= (match-end 0) pos)))
7698 ;; Complete a system variable tag
7699 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7700 (entry (assq var idlwave-system-variables-alist))
7701 (tags (cdr (assq 'tags entry))))
7702 (or entry (error "!%s is not a known system variable" var))
7703 (or tags (error "System variable !%s is not a structure" var))
7704 (setq idlwave-completion-help-info
7705 (list 'idlwave-complete-sysvar-tag-help var))
7706 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7708 "Select a system variable tag"
7709 "system variable tag")
7710 t)) ; return t to skip other completions
7713 (defvar link) ;dynamic variables set by help callback
7715 (defun idlwave-complete-sysvar-help (mode word)
7716 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7717 (entry (assoc word idlwave-system-variables-alist)))
7720 (and (stringp word) entry (nth 1 (assq 'link entry))))
7722 (if entry (setq link (nth 1 (assq 'link entry))))) ;; setting dynamic!!!
7723 (t (error "This should not happen")))))
7725 (defun idlwave-complete-sysvar-tag-help (mode word)
7726 (let* ((var (nth 1 idlwave-completion-help-info))
7727 (entry (assoc var idlwave-system-variables-alist))
7728 (tags (cdr (assq 'tags entry)))
7729 (main (nth 1 (assq 'link entry)))
7732 ((eq mode 'test) ; we can at least link the main
7733 (and (stringp word) entry main))
7737 (if (setq target (cdr (assoc-string word tags t)))
7738 (idlwave-substitute-link-target main target)
7739 main)))) ;; setting dynamic!!!
7740 (t (error "This should not happen")))))
7742 (defun idlwave-split-link-target (link)
7743 "Split a given link into link file and anchor."
7744 (if (string-match idlwave-html-link-sep link)
7745 (cons (substring link 0 (match-beginning 0))
7746 (string-to-number (substring link (match-end 0))))))
7748 (defun idlwave-substitute-link-target (link target)
7749 "Substitute the target anchor for the given link."
7751 (setq main-base (if (string-match "#" link)
7752 (substring link 0 (match-beginning 0))
7755 (concat main-base idlwave-html-link-sep (number-to-string target))
7758 ;; Fake help in the source buffer for class structure tags.
7759 ;; KWD AND NAME ARE GLOBAL-VARIABLES HERE.
7762 (defvar idlwave-help-do-class-struct-tag nil)
7763 (defun idlwave-complete-class-structure-tag-help (mode word)
7765 ((eq mode 'test) ; nothing gets fontified for class tags
7768 (let (class-with found-in)
7769 (when (setq class-with
7770 (idlwave-class-or-superclass-with-tag
7771 idlwave-current-tags-class
7773 (if (assq (idlwave-sintern-class class-with)
7774 idlwave-system-class-info)
7775 (error "No help available for system class tags"))
7776 (if (setq found-in (idlwave-class-found-in class-with))
7777 (setq name (cons (concat found-in "__define") class-with))
7778 (setq name (concat class-with "__define")))))
7780 idlwave-help-do-class-struct-tag t))
7781 (t (error "This should not happen"))))
7783 (defun idlwave-class-or-superclass-with-tag (class tag)
7784 "Find and return the CLASS or one of its superclass with the
7785 associated TAG, if any."
7786 (let ((sclasses (cons class (idlwave-all-class-inherits class)))
7790 (setq cl (pop sclasses))
7791 (let ((tags (idlwave-class-tags cl)))
7793 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7795 (setq tags (cdr tags))))))))
7798 (defun idlwave-sysvars-reset ()
7799 (if (and (fboundp 'idlwave-shell-is-running)
7800 (idlwave-shell-is-running)
7801 idlwave-idlwave_routine_info-compiled)
7802 (idlwave-shell-send-command "idlwave_get_sysvars"
7803 'idlwave-process-sysvars 'hide)))
7805 (defun idlwave-process-sysvars ()
7806 (idlwave-shell-filter-sysvars)
7807 (setq idlwave-sint-sysvars nil
7808 idlwave-sint-sysvartags nil)
7809 (idlwave-sintern-sysvar-alist))
7811 (defun idlwave-sintern-sysvar-alist ()
7812 (let ((list idlwave-system-variables-alist) entry tags)
7813 (while (setq entry (pop list))
7814 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7815 (setq tags (assq 'tags entry))
7819 (cons (idlwave-sintern-sysvartag (car x) 'set)
7823 (defvar idlwave-shell-command-output)
7824 (defun idlwave-shell-filter-sysvars ()
7825 "Get any new system variables and tags."
7826 (let ((text idlwave-shell-command-output)
7828 (old idlwave-system-variables-alist)
7829 var tags type name class link old-entry)
7830 (setq idlwave-system-variables-alist nil)
7831 (while (string-match "^IDLWAVE-SYSVAR: !\\([a-zA-Z0-9_$]+\\)\\( \\(.*\\)\\)?"
7833 (setq start (match-end 0)
7834 var (match-string 1 text)
7835 tags (if (match-end 3)
7836 (idlwave-split-string (match-string 3 text))))
7837 ;; Maintain old links, if present
7838 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7839 (setq link (assq 'link old-entry))
7840 (setq idlwave-system-variables-alist
7847 (idlwave-sintern-sysvartag x)
7848 (cdr (assq 'tags old-entry))))))
7850 idlwave-system-variables-alist)))
7851 ;; Keep the old value if query was not successful
7852 (setq idlwave-system-variables-alist
7853 (or idlwave-system-variables-alist old))))
7855 (defun idlwave-completion-fontify-classes ()
7856 "Goto the *Completions* buffer and fontify the class info."
7857 (when (featurep 'font-lock)
7859 (set-buffer "*Completions*")
7861 (goto-char (point-min))
7862 (let ((buffer-read-only nil))
7863 (while (re-search-forward "\\.*<[^>]+>" nil t)
7864 (put-text-property (match-beginning 0) (match-end 0)
7865 'face 'font-lock-string-face)))))))
7867 (defun idlwave-uniquify (list)
7868 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7871 (unless (gethash x ht)
7876 (defun idlwave-after-successful-completion (type slash &optional verify)
7877 "Add `=' or `(' after successful completion of keyword and function.
7878 Restore the pre-completion window configuration if possible."
7880 ((eq type 'procedure)
7882 ((eq type 'function)
7884 ((equal idlwave-function-completion-adds-paren nil) nil)
7885 ((or (equal idlwave-function-completion-adds-paren t)
7886 (equal idlwave-function-completion-adds-paren 1))
7888 ((equal idlwave-function-completion-adds-paren 2)
7893 (if (and idlwave-keyword-completion-adds-equal
7895 (progn (insert "=") t)
7898 ;; Restore the pre-completion window configuration if this is safe.
7900 (if (or (eq verify 'force) ; force
7902 (get-buffer-window "*Completions*") ; visible
7903 (idlwave-local-value 'idlwave-completion-p
7904 "*Completions*") ; cib-buffer
7905 (eq (marker-buffer idlwave-completion-mark)
7906 (current-buffer)) ; buffer OK
7907 (equal (marker-position idlwave-completion-mark)
7909 (idlwave-restore-wconf-after-completion))
7910 (move-marker idlwave-completion-mark nil)
7911 (setq idlwave-before-completion-wconf nil))
7913 (defun idlwave-mouse-context-help (ev &optional arg)
7914 "Call `idlwave-context-help' on the clicked location."
7916 (mouse-set-point ev)
7917 (idlwave-context-help arg))
7919 (defvar idlwave-last-context-help-pos nil)
7920 (defun idlwave-context-help (&optional arg)
7921 "Display IDL Online Help on context.
7922 If point is on a keyword, help for that keyword will be shown. If
7923 point is on a routine name or in the argument list of a routine, help
7924 for that routine will be displayed. Works for system routines and
7925 keywords, it pulls up text help. For other routies and keywords,
7926 visits the source file, finding help in the header (if
7927 `idlwave-help-source-try-header' is non-nil) or the routine definition
7930 (idlwave-do-context-help arg))
7932 (defun idlwave-mouse-completion-help (ev)
7933 "Display online help about the completion at point."
7935 ;; Restore last-command for next command, to make
7936 ;; scrolling/cancelling of completions work.
7937 (setq this-command last-command)
7938 (idlwave-do-mouse-completion-help ev))
7940 (defun idlwave-routine-info (&optional arg external)
7941 "Display a routines calling sequence and list of keywords. When
7942 point is on the name a function or procedure, or in the argument list
7943 of a function or procedure, this command displays a help buffer with
7944 the information. When called with prefix arg, enforce class query.
7946 When point is on an object operator `->', display the class stored in
7947 this arrow, if any (see `idlwave-store-inquired-class'). With a
7948 prefix arg, the class property is cleared out."
7952 (if (string-match "->" (buffer-substring
7953 (max (point-min) (1- (point)))
7954 (min (+ 2 (point)) (point-max))))
7955 ;; Cursor is on an arrow
7956 (if (get-text-property (point) 'idlwave-class)
7957 ;; arrow has class property
7962 (when (looking-at ".?\\(->\\)")
7963 (remove-text-properties (match-beginning 1) (match-end 1)
7964 '(idlwave-class nil face nil))
7965 (message "Class property removed from arrow")))
7966 ;; Echo class property
7967 (message "Arrow has text property identifying object to be class %s"
7968 (get-text-property (point) 'idlwave-class)))
7969 ;; No property found
7970 (message "Arrow has no class text property"))
7972 ;; Not on an arrow...
7973 (let* ((idlwave-query-class nil)
7974 (idlwave-force-class-query (equal arg '(4)))
7975 (module (idlwave-what-module)))
7977 (apply 'idlwave-display-calling-sequence
7978 (idlwave-fix-module-if-obj_new module))
7979 (error "Don't know which calling sequence to show")))))
7981 (defun idlwave-resolve (&optional arg)
7982 "Call RESOLVE_ROUTINE on the module name at point.
7983 Like `idlwave-routine-info', this looks for a routine call at point.
7984 After confirmation in the minibuffer, it will use the shell to issue
7985 a RESOLVE call for this routine, to attempt to make it defined and its
7986 routine info available for IDLWAVE. If the routine is a method call,
7987 both `class__method' and `class__define' will be tried.
7988 With ARG, enforce query for the class of object methods."
7990 (let* ((idlwave-query-class nil)
7991 (idlwave-force-class-query (equal arg '(4)))
7992 (module (idlwave-what-module))
7993 (name (idlwave-make-full-name (nth 2 module) (car module)))
7994 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7995 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7998 (if (string-match "\\(pro\\|function\\)[ \t]+\\(\\(.*\\)::\\)?\\(.*\\)"
8000 (setq type (match-string 1 resolve)
8001 class (if (match-beginning 2)
8002 (match-string 3 resolve)
8004 name (match-string 4 resolve)))
8005 (if (string= (downcase type) "function")
8006 (setq kwd ",/is_function"))
8010 (idlwave-shell-send-command
8011 (format "resolve_routine,'%s'%s" (downcase name) kwd)
8012 'idlwave-update-routine-info
8015 (idlwave-shell-send-command
8016 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
8017 (list 'idlwave-shell-send-command
8018 (format "resolve_routine,'%s__%s'%s"
8019 (downcase class) (downcase name) kwd)
8020 '(idlwave-update-routine-info)
8023 (defun idlwave-find-module-this-file ()
8025 (idlwave-find-module '(4)))
8027 (defun idlwave-find-module (&optional arg)
8028 "Find the source code of an IDL module.
8029 Works for modules for which IDLWAVE has routine info available. The
8030 function offers as default the module name `idlwave-routine-info'
8031 would use. With ARG limit to this buffer. With two prefix ARG's
8032 force class query for object methods."
8034 (let* ((idlwave-query-class nil)
8035 (idlwave-force-class-query (equal arg '(16)))
8036 (this-buffer (equal arg '(4)))
8037 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
8039 (concat (idlwave-make-full-name
8040 (nth 2 module) (car module))
8041 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
8047 (if (eq 'system (car-safe (nth 3 x)))
8048 ;; Take out system routines with no source.
8051 (concat (idlwave-make-full-name
8053 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
8055 (idlwave-save-buffer-update)
8056 (idlwave-routines))))))
8057 (name (idlwave-completing-read
8058 (if (or (not this-buffer)
8059 (assoc default list))
8060 (format "Module (Default %s): " default)
8061 (format "Module in this file: "))
8064 (if (string-match "\\`\\s-*\\'" name)
8065 ;; Nothing, use the default.
8066 (setq name default))
8067 (if (string-match "<[fp]>" name)
8068 (setq type (substring name -2 -1)
8069 name (substring name 0 -3)))
8070 (if (string-match "\\(.*\\)::\\(.*\\)" name)
8071 (setq class (match-string 1 name)
8072 name (match-string 2 name)))
8073 (setq name (idlwave-sintern-routine-or-method name class)
8074 class (idlwave-sintern-class class)
8075 type (cond ((equal type "f") 'fun)
8076 ((equal type "p") 'pro)
8078 (idlwave-do-find-module name type class nil this-buffer)))
8080 (defun idlwave-do-find-module (name type class
8081 &optional force-source this-buffer)
8082 (let ((name1 (idlwave-make-full-name class name))
8084 (buf (current-buffer))
8087 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
8089 source (or force-source (nth 3 entry))
8090 name2 (if (nth 2 entry)
8091 (idlwave-make-full-name (nth 2 entry) name)
8094 (setq file (idlwave-routine-source-file source)))
8095 (unless file ; Try to find it on the path.
8097 (idlwave-expand-lib-file-name
8099 (format "%s__define.pro" (downcase class))
8100 (format "%s.pro" (downcase name))))))
8102 ((or (null name) (equal name ""))
8104 ((eq (car source) 'system)
8105 (error "Source code for system routine %s is not available"
8107 ((or (not file) (not (file-regular-p file)))
8108 (error "Source code for routine %s is not available"
8111 (when (not this-buffer)
8113 (idlwave-find-file-noselect file 'find))
8114 (pop-to-buffer buf1 t))
8115 (goto-char (point-max))
8116 (let ((case-fold-search t))
8117 (if (re-search-backward
8118 (concat "^[ \t]*\\<"
8119 (cond ((eq type 'fun) "function")
8120 ((eq type 'pro) "pro")
8121 (t "\\(pro\\|function\\)"))
8123 (regexp-quote (downcase name2))
8126 (goto-char (match-beginning 0))
8129 (error "Could not find routine %s" name2)))))))
8131 (defun idlwave-what-module ()
8132 "Return a default module for stuff near point.
8133 Used by `idlwave-routine-info' and `idlwave-find-module'."
8135 (if (let ((case-fold-search t))
8137 (idlwave-beginning-of-statement)
8138 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
8139 ;; This is a function or procedure definition statement
8140 ;; We return the defined routine as module.
8142 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
8143 (match-string-no-properties 2))
8144 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
8145 (idlwave-sintern-class (match-string 3)))
8147 ;; Not a definition statement - analyze precise position.
8148 (let* ((where (idlwave-where))
8150 (pro (car (nth 0 where)))
8151 (func (car (nth 1 where)))
8152 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
8153 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
8157 ((and (eq cw 'procedure)
8158 (not (equal this-word "")))
8159 (setq this-word (idlwave-sintern-routine-or-method
8160 this-word (nth 2 (nth 3 where))))
8161 (list this-word 'pro
8162 (idlwave-determine-class
8163 (cons this-word (cdr (nth 3 where)))
8165 ((and (eq cw 'function)
8166 (not (equal this-word ""))
8167 (or (eq next-char ?\() ; exclude arrays, vars.
8168 (looking-at "[a-zA-Z0-9_]*[ \t]*(")))
8169 (setq this-word (idlwave-sintern-routine-or-method
8170 this-word (nth 2 (nth 3 where))))
8171 (list this-word 'fun
8172 (idlwave-determine-class
8173 (cons this-word (cdr (nth 3 where)))
8175 ((and (memq cw '(function-keyword procedure-keyword))
8176 (not (equal this-word ""))
8177 (eq next-char ?\()) ; A function!
8178 (setq this-word (idlwave-sintern-routine this-word))
8179 (list this-word 'fun nil))
8181 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
8183 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
8186 (defun idlwave-what-module-find-class ()
8187 "Call idlwave-what-module and find the inherited class if necessary."
8188 (let* ((module (idlwave-what-module))
8189 (class (nth 2 module))
8191 (if (and (= (length module) 3)
8195 (apply 'idlwave-find-inherited-class module))
8198 (defun idlwave-find-inherited-class (name type class)
8199 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
8200 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
8205 (defun idlwave-fix-module-if-obj_new (module)
8206 "Check if MODULE points to obj_new.
8207 If yes, and if the cursor is in the keyword region, change to the
8208 appropriate Init method."
8209 (let* ((name (car module))
8211 (case-fold-search t)
8213 (if (and (stringp name)
8214 (equal (downcase name) "obj_new")
8216 (idlwave-beginning-of-statement)
8217 (setq string (buffer-substring (point) pos))
8218 (string-match "obj_new([^'\"]*['\"]\\([a-zA-Z0-9_]+\\)"
8221 (class (match-string 1 string)))
8222 (setq module (list (idlwave-sintern-method "Init")
8224 (idlwave-sintern-class class)))))
8227 (defun idlwave-fix-keywords (name type class keywords
8228 &optional super-classes system)
8229 "Update a list of keywords.
8230 Translate OBJ_NEW, adding all super-class keywords, or all keywords
8231 from all classes if class equals t. If SYSTEM is non-nil, don't
8232 demand _EXTRA in the keyword list."
8233 (let ((case-fold-search t))
8235 ;; If this is the OBJ_NEW function, try to figure out the class and use
8236 ;; the keywords from the corresponding INIT method.
8237 (if (and (equal (upcase name) "OBJ_NEW")
8238 (or (eq major-mode 'idlwave-mode)
8239 (eq major-mode 'idlwave-shell-mode)))
8240 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
8241 (string (buffer-substring bos (point)))
8242 (case-fold-search t)
8244 (and (string-match "obj_new([^'\"]*['\"]\\([a-zA-Z0-9_]+\\)"
8246 (setq class (idlwave-sintern-class (match-string 1 string)))
8247 (setq idlwave-current-obj_new-class class)
8250 (idlwave-entry-keywords
8252 (idlwave-sintern-method "INIT")
8255 (idlwave-routines)) 'do-link))))))
8257 ;; If the class is `t', combine all keywords of all methods NAME
8259 (mapc (lambda (entry)
8261 (nth 2 entry) ; non-nil class
8262 (eq (nth 1 entry) type) ; correct type
8265 (idlwave-entry-keywords entry 'do-link)))))
8266 (idlwave-all-assq name (idlwave-routines)))
8267 (setq keywords (idlwave-uniquify keywords)))
8269 ;; If we have inheritance, add all keywords from superclasses, if
8270 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
8273 idlwave-keyword-class-inheritance
8277 (assq (idlwave-sintern-keyword "_extra") keywords)
8278 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
8279 ;; Check if one of the keyword-class regexps matches the name
8280 (let ((regexps idlwave-keyword-class-inheritance) re)
8282 (while (setq re (pop regexps))
8283 (if (string-match re name) (throw 'exit t))))))
8285 (loop for entry in (idlwave-routines) do
8286 (and (nth 2 entry) ; non-nil class
8287 (memq (nth 2 entry) super-classes) ; an inherited class
8288 (eq (nth 1 entry) type) ; correct type
8289 (eq (car entry) name) ; correct name
8290 (mapc (lambda (k) (add-to-list 'keywords k))
8291 (idlwave-entry-keywords entry 'do-link))))
8292 (setq keywords (idlwave-uniquify keywords)))
8294 ;; Return the final list
8297 (defun idlwave-expand-keyword (keyword module)
8298 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
8299 KEYWORD may be an exact match or an abbreviation of a keyword.
8300 If the match is exact, KEYWORD itself is returned, even if there may be other
8301 keywords of which KEYWORD is an abbreviation. This is necessary because some
8302 system routines have keywords which are prefixes of other keywords.
8303 If KEYWORD is an abbreviation of several keywords, a list of all possible
8304 completions is returned.
8305 If the abbreviation was unique, the correct keyword is returned.
8306 If it cannot be a keyword, the function return nil.
8307 If we do not know about MODULE, just return KEYWORD literally."
8308 (let* ((name (car module))
8309 (type (nth 1 module))
8310 (class (nth 2 module))
8311 (kwd (idlwave-sintern-keyword keyword))
8312 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
8313 (kwd-alist (idlwave-entry-keywords entry))
8314 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
8315 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
8316 (completion-ignore-case t)
8318 (cond ((assq kwd kwd-alist)
8320 ((setq candidates (all-completions kwd kwd-alist))
8321 (if (= (length candidates) 1)
8325 ;; Inheritance may cause this keyword to be correct
8328 ;; We do know the function, which does not have the keyword.
8331 ;; We do not know the function, so this just might be a correct
8332 ;; keyword - return it as it is.
8335 (defvar idlwave-rinfo-mouse-map (make-sparse-keymap))
8336 (defvar idlwave-rinfo-map (make-sparse-keymap))
8337 (define-key idlwave-rinfo-mouse-map
8338 (if (featurep 'xemacs) [button2] [mouse-2])
8339 'idlwave-mouse-active-rinfo)
8340 (define-key idlwave-rinfo-mouse-map
8341 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
8342 'idlwave-mouse-active-rinfo-shift)
8343 (define-key idlwave-rinfo-mouse-map
8344 (if (featurep 'xemacs) [button3] [mouse-3])
8345 'idlwave-mouse-active-rinfo-right)
8346 (define-key idlwave-rinfo-mouse-map " " 'idlwave-active-rinfo-space)
8347 (define-key idlwave-rinfo-map "q" 'idlwave-quit-help)
8348 (define-key idlwave-rinfo-mouse-map "q" 'idlwave-quit-help)
8349 (defvar idlwave-popup-source nil)
8350 (defvar idlwave-rinfo-marker (make-marker))
8352 (defun idlwave-quit-help ()
8354 (let ((ri-window (get-buffer-window "*Help*"))
8355 (olh-window (get-buffer-window "*IDLWAVE Help*")))
8356 (when (and olh-window
8357 (fboundp 'idlwave-help-quit))
8358 (select-window olh-window)
8359 (idlwave-help-quit))
8360 (when (window-live-p ri-window)
8361 (delete-window ri-window))))
8363 (defun idlwave-display-calling-sequence (name type class
8364 &optional initial-class)
8365 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
8366 (let* ((initial-class (or initial-class class))
8367 (entry (or (idlwave-best-rinfo-assq name type class
8369 (idlwave-rinfo-assq name type class
8370 idlwave-unresolved-routines)))
8371 (name (or (car entry) name))
8372 (class (or (nth 2 entry) class))
8373 (superclasses (idlwave-all-class-inherits initial-class))
8374 (twins (idlwave-routine-twins entry))
8375 (dtwins (idlwave-study-twins twins))
8377 (system (eq (car (nth 3 entry)) 'system))
8378 (calling-seq (nth 4 entry))
8379 (keywords (idlwave-entry-keywords entry 'do-link))
8380 (html-file (car (nth 5 entry)))
8382 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
8384 "Button2/3: Online Help")
8386 "Button2: Jump to source and back | Button3: Source in Help window.")
8388 "Button2: Display info about same method in superclass")
8390 (data (list name type class (current-buffer) nil initial-class))
8391 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8392 (face 'idlwave-help-link)
8393 beg props win cnt total)
8394 ;; Fix keywords, but don't add chained super-classes, since these
8395 ;; are shown separately for that super-class
8396 (setq keywords (idlwave-fix-keywords name type class keywords))
8399 (error "No %s %s known %s" type name
8400 (if initial-class (concat "in class " initial-class) "")))
8401 ((or (null name) (equal name ""))
8402 (error "No function or procedure call at point"))
8404 (error "Calling sequence of %s %s not available" type name))
8407 (move-marker idlwave-rinfo-marker (point))
8408 (set-buffer (get-buffer-create "*Help*"))
8409 (use-local-map idlwave-rinfo-map)
8410 (setq buffer-read-only nil)
8412 (set (make-local-variable 'idlwave-popup-source) nil)
8413 (set (make-local-variable 'idlwave-current-obj_new-class)
8414 idlwave-current-obj_new-class)
8416 (setq props (list 'mouse-face 'highlight
8417 km-prop idlwave-rinfo-mouse-map
8418 'help-echo help-echo-class
8419 'data (cons 'class data)))
8420 (let ((classes (cons initial-class superclasses)) c)
8421 (insert "Classes: ")
8422 (while (setq c (pop classes))
8426 (if (equal (downcase c) (downcase class))
8427 (add-text-properties beg (point) (list 'face 'bold))
8428 ;; If Method exists in a different class link it
8429 (if (idlwave-rinfo-assq name type c (idlwave-routines))
8430 (add-text-properties beg (point) props))))
8432 (setq props (list 'mouse-face 'highlight
8433 km-prop idlwave-rinfo-mouse-map
8434 'help-echo help-echo-use
8435 'data (cons 'usage data)))
8436 (if html-file (setq props (append (list 'face face 'link html-file)
8441 (format calling-seq class name class name class name)
8442 (format calling-seq name name name name))
8444 (add-text-properties beg (point) props)
8446 (insert "Keywords:")
8448 (insert " No keywords accepted.")
8452 (if (>= (+ col 1 (length (car x)))
8459 ;; Relevant keywords already have link property attached
8460 props (list 'mouse-face 'highlight
8461 km-prop idlwave-rinfo-mouse-map
8462 'data (cons 'keyword data)
8463 'help-echo help-echo-kwd
8465 (if system (setq props (append (list 'face face) props)))
8467 (add-text-properties beg (point) props)
8468 (setq col (+ col 1 (length (car x)))))
8471 (setq cnt 1 total (length all))
8472 ;; Here entry is (key file (list of type-conses))
8473 (while (setq entry (pop all))
8474 (setq props (list 'mouse-face 'highlight
8475 km-prop idlwave-rinfo-mouse-map
8476 'help-echo help-echo-src
8477 'source (list (car (car (nth 2 entry))) ;type
8480 (cdr (car (nth 2 entry))))
8481 'data (cons 'source data)))
8482 (idlwave-insert-source-location
8485 (if (> total 1) "Sources:" "Source:")
8487 (if (> total 1) "- " ""))
8490 (when (and all (> cnt idlwave-rinfo-max-source-lines))
8491 ;; No more source lines, please
8493 "\n Source information truncated to %d entries."
8494 idlwave-rinfo-max-source-lines))
8496 (goto-char (point-min))
8497 (setq buffer-read-only t))
8498 (display-buffer "*Help*")
8499 (if (and (setq win (get-buffer-window "*Help*"))
8500 idlwave-resize-routine-help-window)
8502 (let ((ww (selected-window)))
8506 (enlarge-window (- (/ (frame-height) 2)
8508 (shrink-window-if-larger-than-buffer))
8509 (select-window ww)))))))))
8511 (defun idlwave-insert-source-location (prefix entry &optional file-props)
8512 "Insert a source location into the routine info buffer.
8513 Start line with PREFIX. If a file name is inserted, add FILE-PROPS to
8515 (let* ((key (car entry))
8516 (file (nth 1 entry))
8517 (types (nth 2 entry))
8518 (shell-flag (assq 'compiled types))
8519 (buffer-flag (assq 'buffer types))
8520 (user-flag (assq 'user types))
8521 (lib-flag (assq 'lib types))
8522 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
8523 (and user-flag (idlwave-count-memq 'user types))
8524 (and lib-flag (idlwave-count-memq 'lib types))
8538 (insert "Builtin "))
8540 ((and (not file) shell-flag)
8541 (insert "Unresolved"))
8546 ((idlwave-syslib-p file)
8547 (if (string-match "obsolete" (file-name-directory file))
8548 (insert "Obsolete ")
8549 (insert "SystemLib ")))
8551 ;; New special syntax: taken directly from routine-info for
8552 ;; library catalog routines
8553 ((setq special (or (cdr lib-flag) (cdr user-flag)))
8554 (insert (format "%-10s" special)))
8556 ;; Old special syntax: a matching regexp
8557 ((setq special (idlwave-special-lib-test file))
8558 (insert (format "%-10s" special)))
8560 ;; Catch-all with file
8561 ((idlwave-lib-p file) (insert "Library "))
8564 (t (insert "Other ")))
8569 (if lib-flag "L" "-")
8570 (if user-flag "C" "-")
8571 (if shell-flag "S" "-")
8572 (if buffer-flag "B" "-")
8576 (insert (format "(%dx) " ndupl))
8577 (add-text-properties beg (point) (list 'face 'bold)))
8578 (when (and file (not (equal file "")))
8580 (insert (apply 'abbreviate-file-name
8581 (if (featurep 'xemacs) (list file t) (list file))))
8583 (add-text-properties beg (point) file-props)))))
8585 (defun idlwave-special-lib-test (file)
8586 "Check the path of FILE against the regexps which define special libs.
8587 Return the name of the special lib if there is a match."
8588 (let ((alist idlwave-special-lib-alist)
8592 (while (setq entry (pop alist))
8593 (if (string-match (car entry) file)
8594 (setq rtn (cdr entry)
8599 (defun idlwave-mouse-active-rinfo-right (ev)
8601 (idlwave-mouse-active-rinfo ev 'right))
8603 (defun idlwave-mouse-active-rinfo-shift (ev)
8605 (idlwave-mouse-active-rinfo ev nil 'shift))
8607 (defun idlwave-active-rinfo-space ()
8609 (idlwave-mouse-active-rinfo nil 'right))
8611 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8612 "Does the mouse actions in the routine info buffer.
8613 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8616 (if ev (mouse-set-point ev))
8617 (let (data id name type class buf bufwin source link keyword
8619 (setq data (get-text-property (point) 'data)
8620 source (get-text-property (point) 'source)
8621 keyword (get-text-property (point) 'keyword)
8622 link (get-text-property (point) 'link)
8624 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8626 initial-class (nth 6 data)
8627 word (idlwave-this-word)
8628 bufwin (get-buffer-window buf t))
8630 (cond ((eq id 'class) ; Switch class being displayed
8631 (if (window-live-p bufwin) (select-window bufwin))
8632 (idlwave-display-calling-sequence
8633 (idlwave-sintern-method name)
8634 type (idlwave-sintern-class word)
8636 ((eq id 'usage) ; Online help on this routine
8637 (idlwave-online-help link name type class))
8638 ((eq id 'source) ; Source in help or buffer
8640 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8641 (idlwave-help-source-try-header nil)
8642 ;; Fake idlwave-routines so help will find the right entry
8644 (list (list name type class source ""))))
8645 (idlwave-help-get-special-help name type class nil))
8646 ;; Otherwise just pop to the source
8647 (setq idlwave-popup-source (not idlwave-popup-source))
8648 (if idlwave-popup-source
8650 (idlwave-do-find-module name type class source)
8652 (setq idlwave-popup-source nil)
8653 (if (window-live-p bufwin) (select-window bufwin))
8654 (error (nth 1 err))))
8656 (select-window bufwin)
8657 (pop-to-buffer buf))
8658 (goto-char (marker-position idlwave-rinfo-marker)))))
8661 (idlwave-online-help link name type class keyword)
8662 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8664 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8665 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8666 (let ((bwin (get-buffer-window buffer)))
8667 (if idlwave-complete-empty-string-as-lower-case
8668 (setq keyword (downcase keyword)))
8670 (select-window bwin)
8671 (pop-to-buffer buffer)
8672 (setq bwin (get-buffer-window buffer)))
8673 (if (eq (preceding-char) ?/)
8675 (unless (save-excursion
8677 "[(,][ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\)?[ \t]*\\="
8678 (min (- (point) 100) (point-min)) t))
8680 (if shift (insert "/"))
8682 (if (and (not shift)
8683 idlwave-keyword-completion-adds-equal)
8686 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8687 "List the load path shadows of all routines defined in current buffer."
8690 (if (eq major-mode 'idlwave-mode)
8691 (idlwave-list-load-path-shadows
8692 nil (idlwave-update-current-buffer-info 'save-buffer)
8693 "in current buffer")
8694 (error "Current buffer is not in idlwave-mode")))
8696 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8697 "List the load path shadows of all routines compiled under the shell.
8698 This is very useful for checking an IDL application. Just compile the
8699 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8700 routines and update IDLWAVE internal info. Then check for shadowing
8704 ((or (not (fboundp 'idlwave-shell-is-running))
8705 (not (idlwave-shell-is-running)))
8706 (error "Shell is not running"))
8707 ((null idlwave-compiled-routines)
8708 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8710 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8713 (defun idlwave-list-all-load-path-shadows (&optional arg)
8714 "List the load path shadows of all routines known to IDLWAVE."
8716 (idlwave-list-load-path-shadows nil nil "globally"))
8718 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8719 "List the routines which are defined multiple times.
8720 Search the information IDLWAVE has about IDL routines for multiple
8722 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8724 When IDL hits a routine call which is not defined, it will search on
8725 the load path in order to find a definition. The output of this
8726 command can be used to detect possible name clashes during this process."
8727 (idlwave-routines) ; Make sure everything is loaded.
8728 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8730 "You don't have any user or library catalogs. Continue anyway? ")
8732 (let* ((routines (append idlwave-system-routines
8733 idlwave-compiled-routines
8734 idlwave-library-catalog-routines
8735 idlwave-user-catalog-routines
8736 idlwave-buffer-routines
8738 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8739 (keymap (make-sparse-keymap))
8740 (props (list 'mouse-face 'highlight
8742 'help-echo "Mouse2: Find source"))
8743 (nroutines (length (or special-routines routines)))
8744 (step (/ nroutines 100))
8747 (idlwave-sort-prefer-buffer-info nil)
8748 routine twins dtwins twin done props1 lroutines)
8750 (if special-routines
8751 ;; Just looking for shadows of a few special routines
8752 (setq lroutines routines
8753 routines special-routines))
8755 (message "Sorting routines...")
8756 (setq routines (sort routines
8758 (string< (downcase (idlwave-make-full-name
8760 (downcase (idlwave-make-full-name
8761 (nth 2 b) (car b)))))))
8762 (message "Sorting routines...done")
8764 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8767 (mouse-set-point ev)
8768 (apply 'idlwave-do-find-module
8769 (get-text-property (point) 'find-args))))
8770 (define-key keymap [(return)]
8773 (apply 'idlwave-do-find-module
8774 (get-text-property (point) 'find-args))))
8775 (message "Compiling list...( 0%%)")
8777 (set-buffer (get-buffer-create "*Shadows*"))
8778 (setq buffer-read-only nil)
8780 (while (setq routine (pop routines))
8781 (if (= (mod (setq n (1+ n)) step) 0)
8782 (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines)))
8784 ;; Get a list of all twins
8785 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8786 (if (memq routine done)
8788 (setq dtwins (idlwave-study-twins twins)))
8789 ;; Mark all twins as dealt with
8790 (setq done (append twins done))
8791 (when (or (> (length dtwins) 1)
8792 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8793 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8794 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8796 (insert (format "\n%s%s"
8797 (idlwave-make-full-name (nth 2 routine)
8799 (if (eq (nth 1 routine) 'fun) "()" "")))
8800 (while (setq twin (pop dtwins))
8801 (setq props1 (append (list 'find-args
8802 (list (nth 0 routine)
8806 (idlwave-insert-source-location "\n - " twin props1))))
8807 (goto-char (point-min))
8808 (setq buffer-read-only t))
8809 (setq loc (or loc ""))
8812 (display-buffer (get-buffer "*Shadows*"))
8813 (message "%d case%s of shadowing found %s"
8814 cnt (if (= cnt 1) "" "s") loc))
8815 (message "No shadowing conflicts found %s" loc))))
8817 (defun idlwave-print-source (routine)
8818 (let* ((source (nth 3 routine))
8819 (stype (car source))
8820 (sfile (idlwave-routine-source-file source)))
8821 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8822 (if (and (eq stype 'compiled)
8823 (or (not (stringp sfile))
8824 (not (string-match "\\S-" sfile))))
8825 (setq stype 'unresolved))
8826 (princ (format " %-10s %s\n"
8828 (if sfile sfile "No source code available")))))
8830 (defun idlwave-routine-twins (entry &optional list)
8831 "Return all twin entries of ENTRY in LIST.
8832 LIST defaults to `idlwave-routines'.
8833 Twin entries are those which have the same name, type, and class.
8834 ENTRY will also be returned, as the first item of this list."
8835 (let* ((name (car entry))
8836 (type (nth 1 entry))
8837 (class (nth 2 entry))
8838 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8840 (while (setq candidate (pop candidates))
8841 (if (and (not (eq candidate entry))
8842 (eq type (nth 1 candidate))
8843 (eq class (nth 2 candidate)))
8844 (push candidate twins)))
8845 (if (setq candidate (idlwave-rinfo-assq name type class
8846 idlwave-unresolved-routines))
8847 (push candidate twins))
8848 (cons entry (nreverse twins))))
8850 (defun idlwave-study-twins (entries)
8851 "Return dangerous twins of first entry in ENTRIES.
8852 Dangerous twins are routines with same name, but in different files on
8853 the load path. If a file is in the system library and has an entry in
8854 the `idlwave-system-routines' list, we omit the latter as
8855 non-dangerous because many IDL routines are implemented as library
8856 routines, and may have been scanned."
8857 (let* ((entry (car entries))
8858 (name (car entry)) ;
8859 (type (nth 1 entry)) ; Must be bound for
8860 (class (nth 2 entry)) ; idlwave-routine-twin-compare
8862 source type type-cons file alist syslibp key)
8863 (while (setq entry (pop entries))
8865 (setq source (nth 3 entry)
8867 type-cons (cons type (nth 3 source))
8868 file (idlwave-routine-source-file source))
8870 ;; Make KEY to index entry properly
8871 (setq key (cond ((eq type 'system) type)
8872 (file (file-truename file))
8875 ;; Check for an entry in the system library
8878 (idlwave-syslib-p file))
8881 ;; If there's more than one matching entry for the same file, just
8882 ;; append the type-cons to the type list.
8883 (if (setq entry (assoc key alist))
8884 (push type-cons (nth 2 entry))
8885 (push (list key file (list type-cons)) alist)))
8887 (setq alist (nreverse alist))
8890 ;; File is in system *library* - remove any 'system entry
8891 (setq alist (delq (assq 'system alist) alist)))
8893 ;; If 'system remains and we've scanned the syslib, it's a builtin
8894 ;; (rather than a !DIR/lib/.pro file bundled as source).
8895 (when (and (idlwave-syslib-scanned-p)
8896 (setq entry (assoc 'system alist)))
8897 (setcar entry 'builtin))
8898 (sort alist 'idlwave-routine-twin-compare)))
8902 (defvar idlwave-sort-prefer-buffer-info t
8903 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8905 (defmacro idlwave-xor (a b)
8909 (defun idlwave-routine-entry-compare (a b)
8910 "Compare two routine info entries for sortiung. This is the general case.
8911 It first compates class, names, and type. If it turns out that A and B
8912 are twins (same name, class, and type), calls another routine which
8913 compares twins on the basis of their file names and path locations."
8914 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8916 ((not (equal (idlwave-downcase-safe class)
8917 (idlwave-downcase-safe (nth 2 b))))
8919 (cond ((null (nth 2 b)) nil)
8921 (t (string< (downcase class) (downcase (nth 2 b))))))
8922 ((not (equal (downcase name) (downcase (car b))))
8924 (string< (downcase name) (downcase (car b))))
8925 ((not (eq type (nth 1 b)))
8927 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8929 ;; A and B are twins - so the decision is more complicated.
8930 ;; Call twin-compare with the proper arguments.
8931 (idlwave-routine-entry-compare-twins a b)))))
8933 (defun idlwave-routine-entry-compare-twins (a b)
8934 "Compare two routine entries, under the assumption that they are
8935 twins. This basically calls `idlwave-routine-twin-compare' with the
8937 (let* ((name (car a)) (type (nth 1 a)) (class (nth 2 a)) ; needed outside
8942 (afile (idlwave-routine-source-file asrc))
8943 (bfile (idlwave-routine-source-file bsrc)))
8944 (idlwave-routine-twin-compare
8946 (list (file-truename afile) afile (list atype))
8947 (list atype afile (list atype)))
8949 (list (file-truename bfile) bfile (list btype))
8950 (list btype bfile (list btype))))
8953 (defun idlwave-routine-twin-compare (a b)
8954 "Compare two routine twin entries for sorting.
8955 In here, A and B are not normal routine info entries, but special
8956 lists (KEY FILENAME (TYPES...)).
8957 This expects NAME TYPE CLASS to be bound to the right values."
8958 (let* (;; Dis-assemble entries
8959 (akey (car a)) (bkey (car b))
8960 (afile (nth 1 a)) (bfile (nth 1 b))
8961 (atypes (nth 2 a)) (btypes (nth 2 b))
8963 (asysp (memq akey '(builtin system)))
8964 (bsysp (memq bkey '(builtin system)))
8965 ;; Compiled routines?
8966 (acompp (memq 'compiled atypes))
8967 (bcompp (memq 'compiled btypes))
8969 (aunresp (or (eq akey 'unresolved)
8970 (and acompp (not afile))))
8971 (bunresp (or (eq bkey 'unresolved)
8972 (and bcompp (not bfile))))
8973 ;; Buffer info available?
8974 (abufp (memq 'buffer atypes))
8975 (bbufp (memq 'buffer btypes))
8977 (tpath-alist (idlwave-true-path-alist))
8978 (apathp (and (stringp akey)
8979 (assoc (file-name-directory akey) tpath-alist)))
8980 (bpathp (and (stringp bkey)
8981 (assoc (file-name-directory bkey) tpath-alist)))
8982 ;; How early on search path? High number means early since we
8983 ;; measure the tail of the path list
8984 (anpath (length (memq apathp tpath-alist)))
8985 (bnpath (length (memq bpathp tpath-alist)))
8986 ;; Look at file names
8987 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8988 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8989 (fname-re (if class (format "\\`%s__\\(%s\\|define\\)\\.pro\\'"
8990 (regexp-quote (downcase class))
8991 (regexp-quote (downcase name)))
8992 (format "\\`%s\\.pro" (regexp-quote (downcase name)))))
8993 ;; Is file name derived from the routine name?
8994 ;; Method file or class definition file?
8995 (anamep (string-match fname-re aname))
8996 (adefp (and class anamep (string= "define" (match-string 1 aname))))
8997 (bnamep (string-match fname-re bname))
8998 (bdefp (and class bnamep (string= "define" (match-string 1 bname)))))
9000 ;; Now: follow JD's ideas about sorting. Looks really simple now,
9001 ;; doesn't it? The difficult stuff is hidden above...
9003 ((idlwave-xor asysp bsysp) asysp) ; System entries first
9004 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
9005 ((and idlwave-sort-prefer-buffer-info
9006 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
9007 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
9008 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
9009 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
9010 ((and class anamep bnamep ; both file names match ->
9011 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
9012 ((> anpath bnpath) t) ; Who is first on path?
9013 (t nil)))) ; Default
9015 (defun idlwave-routine-source-file (source)
9017 (expand-file-name (nth 1 source) (nth 2 source))
9020 (defun idlwave-downcase-safe (string)
9021 "Donwcase if string, else return unchanged."
9022 (if (stringp string)
9026 (defun idlwave-count-eq (elt list)
9027 "How often is ELT in LIST?"
9028 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
9030 (defun idlwave-count-memq (elt alist)
9031 "How often is ELT a key in ALIST?"
9032 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
9034 (defun idlwave-syslib-p (file)
9035 "Non-nil if FILE is in the system library."
9036 (let* ((true-syslib (file-name-as-directory
9038 (expand-file-name "lib" (idlwave-sys-dir)))))
9039 (true-file (file-truename file)))
9040 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
9042 (defun idlwave-lib-p (file)
9043 "Non-nil if file is in the library"
9044 (let ((true-dir (file-name-directory (file-truename file))))
9045 (assoc true-dir (idlwave-true-path-alist))))
9047 (defun idlwave-path-alist-add-flag (list-entry flag)
9048 "Add a flag to the path list entry, if not set."
9049 (let ((flags (cdr list-entry)))
9050 (add-to-list 'flags flag)
9051 (setcdr list-entry flags)))
9053 (defun idlwave-path-alist-remove-flag (list-entry flag)
9054 "Remove a flag to the path list entry, if set."
9055 (let ((flags (delq flag (cdr list-entry))))
9056 (setcdr list-entry flags)))
9058 (defun idlwave-true-path-alist ()
9059 "Return `idlwave-path-alist' alist with true-names.
9060 Info is cached, but relies on the functions setting `idlwave-path-alist'
9061 to reset the variable `idlwave-true-path-alist' to nil."
9062 (or idlwave-true-path-alist
9063 (setq idlwave-true-path-alist
9064 (mapcar (lambda(x) (cons
9065 (file-name-as-directory
9067 (directory-file-name
9070 idlwave-path-alist))))
9072 (defun idlwave-syslib-scanned-p ()
9073 "Non-nil if the system lib file !DIR/lib has been scanned."
9074 (let* ((true-syslib (file-name-as-directory
9076 (expand-file-name "lib" (idlwave-sys-dir))))))
9077 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
9079 ;; ----------------------------------------------------------------------------
9081 ;; Online Help display
9084 ;; ----------------------------------------------------------------------------
9086 ;; Additions for use with imenu.el and func-menu.el
9087 ;; (pop-up a list of IDL units in the current file).
9090 (defun idlwave-prev-index-position ()
9091 "Search for the previous procedure or function.
9092 Return nil if not found. For use with imenu.el."
9095 ((idlwave-find-key "\\<\\(pro\\|function\\)\\>" -1 'nomark))
9096 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
9099 (defun idlwave-unit-name ()
9100 "Return the unit name.
9101 Assumes that point is at the beginning of the unit as found by
9102 `idlwave-prev-index-position'."
9105 (let ((begin (point)))
9107 "[a-zA-Z_][a-zA-Z0-9$_]+\\(::[a-zA-Z_][a-zA-Z0-9$_]+\\)?")
9108 (if (fboundp 'buffer-substring-no-properties)
9109 (buffer-substring-no-properties begin (point))
9110 (buffer-substring begin (point)))))
9112 (defalias 'idlwave-function-menu
9115 (require 'func-menu)
9117 (error (condition-case nil
9123 ;; Here we hack func-menu.el in order to support this new mode.
9124 ;; The latest versions of func-menu.el already have this stuff in, so
9125 ;; we hack only if it is not already there.
9126 (when (fboundp 'eval-after-load)
9127 (eval-after-load "func-menu"
9129 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
9130 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
9131 (setq fume-function-name-regexp-alist
9132 (cons '(idlwave-mode . fume-function-name-regexp-idl)
9133 fume-function-name-regexp-alist)))
9134 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
9135 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
9136 (setq fume-find-function-name-method-alist
9137 (cons '(idlwave-mode . fume-find-next-idl-function-name)
9138 fume-find-function-name-method-alist))))))
9140 (defun idlwave-edit-in-idlde ()
9141 "Edit the current file in IDL Development environment."
9143 (start-process "idldeclient" nil
9144 idlwave-shell-explicit-file-name "-c" "-e"
9145 (buffer-file-name)))
9147 (defvar idlwave-help-use-assistant)
9148 (defun idlwave-launch-idlhelp ()
9149 "Start the IDLhelp application."
9151 (if idlwave-help-use-assistant
9152 (idlwave-help-assistant-raise)
9153 (start-process "idlhelp" nil idlwave-help-application)))
9155 ;; Menus - using easymenu.el
9156 (defvar idlwave-mode-menu-def
9158 ["PRO/FUNC menu" idlwave-function-menu t]
9160 ["Subprogram Start" idlwave-beginning-of-subprogram t]
9161 ["Subprogram End" idlwave-end-of-subprogram t]
9162 ["Block Start" idlwave-beginning-of-block t]
9163 ["Block End" idlwave-end-of-block t]
9164 ["Up Block" idlwave-backward-up-block t]
9165 ["Down Block" idlwave-down-block t]
9166 ["Skip Block Backward" idlwave-backward-block t]
9167 ["Skip Block Forward" idlwave-forward-block t])
9169 ["Subprogram" idlwave-mark-subprogram t]
9170 ["Block" idlwave-mark-block t]
9171 ["Header" idlwave-mark-doclib t])
9173 ["Indent Entire Statement" idlwave-indent-statement
9174 :active t :keys "C-u \\[indent-for-tab-command]" ]
9175 ["Indent Subprogram" idlwave-indent-subprogram t]
9176 ["(Un)Comment Region" idlwave-toggle-comment-region t]
9177 ["Continue/Split line" idlwave-split-line t]
9179 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
9180 :selected (symbol-value idlwave-fill-function)])
9182 ["Procedure" idlwave-procedure t]
9183 ["Function" idlwave-function t]
9184 ["Doc Header" idlwave-doc-header t]
9185 ["Log" idlwave-doc-modification t]
9187 ["Case" idlwave-case t]
9188 ["For" idlwave-for t]
9189 ["Repeat" idlwave-repeat t]
9190 ["While" idlwave-while t]
9192 ["Close Block" idlwave-close-block t])
9194 ["Complete" idlwave-complete t]
9195 ("Complete Specific"
9196 ["1 Procedure Name" (idlwave-complete 'procedure) t]
9197 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
9199 ["3 Function Name" (idlwave-complete 'function) t]
9200 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
9202 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
9203 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
9205 ["7 Function Method Name" (idlwave-complete 'function-method) t]
9206 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
9208 ["9 Class Name" idlwave-complete-class t]))
9210 ["Show Routine Info" idlwave-routine-info t]
9211 ["Online Context Help" idlwave-context-help t]
9213 ["Find Routine Source" idlwave-find-module t]
9214 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
9216 ["Update Routine Info" idlwave-update-routine-info t]
9217 ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t]
9220 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
9221 ["Scan Directories" (idlwave-update-routine-info '(16))
9222 (and idlwave-path-alist (not idlwave-catalog-process))]
9223 ["Scan Directories &" (idlwave-update-routine-info '(64))
9224 (and idlwave-path-alist (not idlwave-catalog-process))]
9227 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
9228 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
9229 ["Check Everything" idlwave-list-all-load-path-shadows t])
9231 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
9233 ["Insert TAB character" idlwave-hard-tab t])
9236 ["Start IDL shell" idlwave-shell t]
9237 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
9238 ["Launch IDL Help" idlwave-launch-idlhelp t])
9241 ["Browse IDLWAVE Group" idlwave-customize t]
9243 ["Build Full Customize Menu" idlwave-create-customize-menu
9244 (fboundp 'customize-menu-create)])
9246 ["Describe Mode" describe-mode t]
9247 ["Abbreviation List" idlwave-list-abbrevs t]
9249 ["Commentary in idlwave.el" idlwave-show-commentary t]
9250 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
9252 ["Info" idlwave-info t]
9254 ["Help with Topic" idlwave-help-assistant-help-with-topic
9255 idlwave-help-use-assistant]
9256 ["Launch IDL Help" idlwave-launch-idlhelp t])))
9258 (defvar idlwave-mode-debug-menu-def
9260 ["Start IDL shell" idlwave-shell t]
9261 ["Save and .RUN buffer" idlwave-shell-save-and-run
9262 (and (boundp 'idlwave-shell-automatic-start)
9263 idlwave-shell-automatic-start)]))
9265 (if (or (featurep 'easymenu) (load "easymenu" t))
9267 (easy-menu-define idlwave-mode-menu idlwave-mode-map
9268 "IDL and WAVE CL editing menu"
9269 idlwave-mode-menu-def)
9270 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
9271 "IDL and WAVE CL editing menu"
9272 idlwave-mode-debug-menu-def)))
9274 (defun idlwave-customize ()
9275 "Call the customize function with idlwave as argument."
9277 ;; Try to load the code for the shell, so that we can customize it
9279 (or (featurep 'idlw-shell)
9280 (load "idlw-shell" t))
9281 (customize-browse 'idlwave))
9283 (defun idlwave-create-customize-menu ()
9284 "Create a full customization menu for IDLWAVE, insert it into the menu."
9286 (if (fboundp 'customize-menu-create)
9288 ;; Try to load the code for the shell, so that we can customize it
9290 (or (featurep 'idlw-shell)
9291 (load "idlw-shell" t))
9293 '("IDLWAVE") "Customize"
9294 `(["Browse IDLWAVE group" idlwave-customize t]
9296 ,(customize-menu-create 'idlwave)
9297 ["Set" Custom-set t]
9298 ["Save" Custom-save t]
9299 ["Reset to Current" Custom-reset-current t]
9300 ["Reset to Saved" Custom-reset-saved t]
9301 ["Reset to Standard Settings" Custom-reset-standard t]))
9302 (message "\"IDLWAVE\"-menu now contains full customization menu"))
9303 (error "Cannot expand menu (outdated version of cus-edit.el)")))
9305 (defun idlwave-show-commentary ()
9306 "Use the finder to view the file documentation from `idlwave.el'."
9309 (finder-commentary "idlwave.el"))
9311 (defun idlwave-shell-show-commentary ()
9312 "Use the finder to view the file documentation from `idlw-shell.el'."
9315 (finder-commentary "idlw-shell.el"))
9317 (defun idlwave-info ()
9318 "Read documentation for IDLWAVE in the info system."
9321 (Info-goto-node "(idlwave)"))
9323 (defun idlwave-list-abbrevs (arg)
9324 "Show the code abbreviations define in IDLWAVE mode.
9325 This lists all abbrevs where the replacement text differs from the input text.
9326 These are the ones the users want to learn to speed up their writing.
9328 The function does *not* list abbrevs which replace a word with itself
9329 to call a hook. These hooks are used to change the case of words or
9330 to blink the matching `begin', and the user does not need to know them.
9332 With arg, list all abbrevs with the corresponding hook.
9334 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
9337 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
9339 str rpl func fmt (len-str 0) (len-rpl 0))
9342 (if (symbol-value sym)
9344 (setq str (symbol-name sym)
9345 rpl (symbol-value sym)
9346 func (symbol-function sym))
9348 (setq func (prin1-to-string func))
9349 (if (and (listp func) (stringp (nth 2 func)))
9350 (setq rpl (concat "EVAL: " (nth 2 func))
9353 (if (or arg (not (string= rpl str)))
9355 (setq len-str (max len-str (length str)))
9356 (setq len-rpl (max len-rpl (length rpl)))
9357 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
9360 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
9362 (setq fmt (format "%%-%ds %%-%ds %%s\n" len-str len-rpl))
9363 (with-output-to-temp-buffer "*Help*"
9366 (princ "Abbreviations and Actions in IDLWAVE-Mode\n")
9367 (princ "=========================================\n\n")
9368 (princ (format fmt "KEY" "REPLACE" "HOOK"))
9369 (princ (format fmt "---" "-------" "----")))
9370 (princ "Code Abbreviations and Templates in IDLWAVE-Mode\n")
9371 (princ "================================================\n\n")
9372 (princ (format fmt "KEY" "ACTION" ""))
9373 (princ (format fmt "---" "------" "")))
9376 (setq str (car list)
9379 (princ (format fmt str rpl func)))
9381 ;; Make sure each abbreviation uses only one display line
9383 (set-buffer "*Help*")
9384 (setq truncate-lines t)))
9386 ;; Add .pro files to speedbar for support, if it's loaded
9387 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
9389 ;; Set an idle timer to load the routine info.
9390 ;; Will only work on systems which support this.
9391 (or idlwave-routines (idlwave-start-load-rinfo-timer))
9393 ;;;###autoload (add-to-list 'auto-mode-alist '("\\.[Pp][Rr][Oo]\\'" . idlwave-mode))
9396 (run-hooks 'idlwave-load-hook)
9400 ;; arch-tag: f77f3b0c-c37c-424f-a328-0886fd42b6fb
9401 ;;; idlwave.el ends here