| blob | 7e269cb60f0625d96fbf859ea62dce18f573498d |
1 ;; idlwave.el --- IDL editing mode for GNU Emacs
3 ;; Copyright (C) 1999-2015 Free Software Foundation, Inc.
5 ;; Authors: J.D. Smith <jdsmith@as.arizona.edu>
6 ;; Carsten Dominik <dominik@science.uva.nl>
7 ;; Chris Chase <chase@att.com>
8 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
9 ;; Version: 6.1.22
10 ;; Keywords: languages
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; IDLWAVE enables feature-rich development and interaction with IDL,
30 ;; the Interactive Data Language. It provides a compelling,
31 ;; full-featured alternative to the IDLDE development environment
32 ;; bundled with IDL.
34 ;; In the remotely distant past, based on pascal.el, though bears
35 ;; little resemblance to it now.
36 ;;
37 ;; Incorporates many ideas, such as abbrevs, action routines, and
38 ;; continuation line indenting, from wave.el.
39 ;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder.
40 ;;
41 ;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode")
42 ;; for features, key bindings, and info.
43 ;; Also, Info format documentation is available with `M-x idlwave-info'
44 ;;
45 ;; New versions of IDLWAVE, documentation, and more information
46 ;; available from:
47 ;; http://github.com/jdtsmith/idlwave
48 ;;
49 ;; INSTALLATION
50 ;; ============
51 ;;
52 ;; Follow the instructions in the INSTALL file of the distribution.
53 ;; In short, put this file on your load path and add the following
54 ;; lines to your init file:
55 ;;
56 ;; (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
57 ;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
58 ;; (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
59 ;;
60 ;;
61 ;; SOURCE
62 ;; ======
63 ;;
64 ;; The newest version of this file is available from the maintainer's
65 ;; Webpage:
66 ;;
67 ;; http://github.com/jdtsmith/idlwave
68 ;;
69 ;; DOCUMENTATION
70 ;; =============
71 ;;
72 ;; IDLWAVE is documented online in info format. A printable version
73 ;; of the documentation is available from the maintainers webpage (see
74 ;; SOURCE).
75 ;;
76 ;;
77 ;; ACKNOWLEDGMENTS
78 ;; ===============
79 ;;
80 ;; Thanks to the following people for their contributions and comments:
81 ;;
82 ;; Ulrik Dickow <dickow_at_nbi.dk>
83 ;; Eric E. Dors <edors_at_lanl.gov>
84 ;; Stein Vidar H. Haugan <s.v.h.haugan_at_astro.uio.no>
85 ;; David Huenemoerder <dph_at_space.mit.edu>
86 ;; Kevin Ivory <Kevin.Ivory_at_linmpi.mpg.de>
87 ;; Dick Jackson <dick_at_d-jackson.com>
88 ;; Xuyong Liu <liu_at_stsci.edu>
89 ;; Simon Marshall <Simon.Marshall_at_esrin.esa.it>
90 ;; Laurent Mugnier <mugnier_at_onera.fr>
91 ;; Lubos Pochman <lubos_at_rsinc.com>
92 ;; Bob Portmann <portmann_at_al.noaa.gov>
93 ;; Patrick M. Ryan <pat_at_jaameri.gsfc.nasa.gov>
94 ;; Marty Ryba <ryba_at_ll.mit.edu>
95 ;; Paul Sorenson <aardvark62_at_msn.com>
96 ;; Phil Sterne <sterne_at_dublin.llnl.gov>
97 ;; Phil Williams <williams_at_irc.chmcc.org>
98 ;;
99 ;; CUSTOMIZATION:
100 ;; =============
101 ;;
102 ;; IDLWAVE has extensive customize support; to learn about the
103 ;; variables which control the mode's behavior, use `M-x
104 ;; idlwave-customize'.
105 ;;
106 ;; You can set your own preferred values with Customize, or with Lisp
107 ;; code in .emacs. For an example of what to put into .emacs, check
108 ;; the TexInfo documentation or see a complete .emacs available at the
109 ;; website.
110 ;;
111 ;; KNOWN PROBLEMS:
112 ;; ==============
113 ;;
114 ;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual
115 ;; Numerics, Inc. is growing less and less complete as the two
116 ;; languages grow increasingly apart. The mode probably shouldn't
117 ;; even have "WAVE" in its title, but it's catchy, and was required
118 ;; to avoid conflict with the CORBA idl.el mode. Caveat WAVEor.
119 ;;
120 ;; Moving the point backwards in conjunction with abbrev expansion
121 ;; does not work as I would like it, but this is a problem with
122 ;; emacs abbrev expansion done by the self-insert-command. It ends
123 ;; up inserting the character that expanded the abbrev after moving
124 ;; point backward, e.g., "\cl" expanded with a space becomes
125 ;; "LONG( )" with point before the close paren. This is solved by
126 ;; using a temporary function in `post-command-hook' - not pretty,
127 ;; but it works.
128 ;;
129 ;; Tabs and spaces are treated equally as whitespace when filling a
130 ;; comment paragraph. To accomplish this, tabs are permanently
131 ;; replaced by spaces in the text surrounding the paragraph, which
132 ;; may be an undesirable side-effect. Replacing tabs with spaces is
133 ;; limited to comments only and occurs only when a comment
134 ;; paragraph is filled via `idlwave-fill-paragraph'.
135 ;;
136 ;; Muti-statement lines (using "&") on block begin and end lines can
137 ;; ruin the formatting. For example, multiple end statements on a
138 ;; line: endif & endif. Using "&" outside of block begin/end lines
139 ;; should be okay.
140 ;;
141 ;; Determining the expression at point for printing and other
142 ;; examination commands is somewhat rough: currently only fairly
143 ;; simple entities are found. You can always drag-select or examine
144 ;; a pre-selected region.
145 ;;
146 ;; When forcing completion of method keywords, the initial
147 ;; query for a method has multiple entries for some methods. Would
148 ;; be too difficult to fix this hardly used case.
149 ;;
150 \f
151 ;;; Code:
157 ;; For XEmacs
179 "Major mode for editing IDL .pro files."
191 ;;; Variables for indentation behavior ---------------------------------------
194 "Indentation and formatting options for IDLWAVE mode."
198 "Extra indentation for the main block of code.
199 That is the block between the FUNCTION/PRO statement and the END
200 statement for that program unit."
205 "Extra indentation applied to block lines.
206 If you change this, you probably also want to change `idlwave-end-offset'."
211 "Extra indentation applied to block END lines.
212 A value equal to negative `idlwave-block-indent' will make END lines
213 line up with the block BEGIN lines."
218 "Extra indentation applied to continuation lines.
219 This extra offset applies to the first of a set of continuation lines.
220 The following lines receive the same indentation as the first."
225 "Maximum additional indentation for special continuation indent.
226 Several special indentations are tried to help line up continuation
227 lines in routine calls or definitions, other statements with
228 parentheses, or assignment statements. This variable specifies a
229 maximum amount by which this special indentation can exceed the
230 standard continuation indentation, otherwise defaulting to a fixed
231 offset. Set to 0 to effectively disable all special continuation
232 indentation, or to a large number (like 100) to enable it in all
233 cases. See also `idlwave-indent-to-open-paren', which can override
234 this variable."
239 "Non-nil means, indent continuation lines to innermost open parenthesis.
240 This indentation occurs even if otherwise disallowed by
241 `idlwave-max-extra-continuation-indent'. Matching parens and the
242 interleaving args are lined up. Example:
244 x = function_a(function_b(function_c( a, b, [1,2,3, $
245 4,5,6 $
246 ], $
247 c, d $
248 )))
250 When this variable is nil, paren alignment may still occur, based on
251 the value of `idlwave-max-extra-continuation-indent', which, if zero,
252 would yield:
254 x = function_a(function_b(function_c( a, b, [1,2,3, $
255 4,5,6 $
256 ], $
257 c, d $
258 )))"
263 "Non-nil means, indent continuation lines with parens by nesting
264 lines at consecutively deeper levels."
270 "If set non-nil then comment paragraphs are indented under the
271 hanging indent given by `idlwave-hang-indent-regexp' match in the first line
272 of the paragraph."
277 "Regular expression matching the position of the hanging indent
278 in the first line of a comment paragraph. The size of the indent
279 extends to the end of the match for the regular expression."
284 "If non-nil then use last match on line for `idlwave-indent-regexp'."
289 "If non-nil then auto fill will only operate on comment lines."
294 "If non-nil then auto fill will split strings with the IDL `+' operator.
295 When the line end falls within a string, string concatenation with the
296 '+' operator will be used to distribute a long string over lines.
297 If nil and a string is split then a terminal beep and warning are issued.
299 This variable is ignored when `idlwave-fill-comment-line-only' is
300 non-nil, since in this case code is not auto-filled."
305 "If non-nil then `idlwave-split-line' will split strings with `+'.
306 When the splitting point of a line falls inside a string, split the string
307 using the `+' string concatenation operator. If nil and a string is
308 split then a terminal beep and warning are issued."
313 "The indentation of a comment that starts with this regular
314 expression will not be changed. Note that the indentation of a comment
315 at the beginning of a line is never changed."
320 "A comment anchored at the beginning of line.
321 A comment matching this regular expression will not have its
330 "A comment that starts with this regular expression on a line by
331 itself is indented as if it is a part of IDL code. As a result if
332 the comment is not preceded by whitespace it is unchanged."
336 ;; Comments not matching any of the above will be indented as a
337 ;; right-margin comment, i.e., to a minimum of `comment-column'.
339 ;;; Routine Info and Completion ---------------------------------------
342 "Routine Info options for IDLWAVE mode."
346 "Non-nil means search the IDL path for library catalog files.
348 These files, named .idlwave_catalog, document routine information for
349 individual directories and libraries of IDL .pro files. Many popular
350 libraries come with catalog files by default, so leaving this on is
351 usually a good idea."
356 "Seconds of idle time before routine info is automatically initialized.
357 Initializing the routine info can take a long time, in particular if a
358 large number of library catalogs are involved. When Emacs is idle for
359 more than the number of seconds specified by this variable, it starts
360 the initialization. The process is split into five steps, in order to
361 keep work interruption as short as possible. If one of the steps
362 finishes, and no user input has arrived in the mean time, initialization
363 proceeds immediately to the next step. A good value for this variable
364 is about 1/3 of the time initialization take in your setup. So if you
365 have a fast machine and no problems with a slow network connection,
366 don't hesitate to set this to 2 seconds. A value of 0 means, don't
367 initialize automatically, but instead wait until routine information is
368 needed, and initialize then."
373 "Non-nil means, scan buffers for IDL programs when updating info.
374 The scanning is done by the command `idlwave-update-routine-info'.
375 The following values are allowed:
377 nil Don't scan any buffers.
378 t Scan all `idlwave-mode' buffers in the current editing session.
379 current Scan only the current buffer, but no other buffers."
387 "Non-nil means query the shell for info about compiled routines.
388 Querying the shell is useful to get information about compiled modules,
389 and it is turned on by default. However, when you have a complete library
390 scan, this is not necessary."
396 "Controls under what circumstances routine info is updated automatically.
397 Possible values:
398 nil Never
399 t All available
400 \(...) A list of circumstances. Allowed members are:
401 find-file Add info for new IDLWAVE buffers.
402 save-buffer Update buffer info when buffer is saved
403 kill-buffer Remove buffer info when buffer gets killed
404 compile-buffer Update shell info after `idlwave-shell-save-and...'"
416 "Maximum number of source files displayed in the Routine Info window.
417 When an integer, it is the maximum number of source files displayed.
418 A value of t means to show all source files."
423 "Library path for Windows and MacOS (OS9). Not needed under UNIX.
424 When selecting the directories to scan for IDL user catalog routine
425 info, IDLWAVE can, under UNIX, query the shell for the exact search
426 path \(the value of !PATH). However, under Windows and MacOS
427 \(pre-OSX), the IDLWAVE shell does not work. In this case, this
428 variable can be set to specify the paths where IDLWAVE can find PRO
429 files. The shell will only be asked for a list of paths when this
430 variable is nil. The value is a list of directories. A directory
431 preceded by a `+' will be searched recursively. If you set this
432 variable on a UNIX system, the shell will not be queried. See also
433 `idlwave-system-directory'."
438 "The IDL system directory for Windows and MacOS. Not needed under
439 UNIX. Set this to the value of the `!DIR' system variable in IDL.
440 IDLWAVE uses this to find out which of the library routines belong to
441 the official system library. All files inside the `lib' subdirectory
442 are considered system library files - so don't install private stuff
443 in this directory. On UNIX systems, IDLWAVE queries the shell for the
444 value of `!DIR'. See also `idlwave-library-path'."
448 ;; Configuration files
451 "Directory for configuration files and user-library catalog."
461 "Alist of regular expressions matching special library directories.
462 When listing routine source locations, IDLWAVE gives a short hint where
463 the file defining the routine is located. By default it lists `SystemLib'
464 for routines in the system library `!DIR/lib' and `Library' for anything
465 else. This variable can define additional types. The car of each entry
466 is a regular expression matching the file name (they normally will match
467 on the path). The cdr is the string to be used as identifier. Max 10
468 chars are allowed."
474 "Write out path (!PATH) and system directory (!DIR) info automatically.
475 Path info is needed to locate library catalog files. If non-nil,
476 whenever the path-list changes as a result of shell-query, etc., it is
478 used to force a write."
483 "Completion options for IDLWAVE mode."
500 "Association list setting the case of completed words.
502 This variable determines the case (UPPER/lower/Capitalized...) of
503 words inserted into the buffer by completion. The preferred case can
504 be specified separately for routine names, keywords, classes and
505 methods.
506 This alist should therefore have entries for `routine' (normal
507 functions and procedures, i.e. non-methods), `keyword', `class', and
508 `method'. Plausible values are
510 upcase upcase whole word, like `BOX_CURSOR'
511 downcase downcase whole word, like `read_ppm'
512 capitalize capitalize each part, like `Widget_Control'
513 preserve preserve case as is, like `IDLgrView'
515 The value can also be any Emacs Lisp function which transforms the
516 case of characters in a string.
518 A value of `preserve' means that the case of the completed word is
519 identical to the way it was written in the definition statement of the
520 routine. This was implemented to allow for mixed-case completion, in
521 particular of object classes and methods.
522 If a completable word is defined in multiple locations, the meaning of
523 `preserve' is not unique since the different definitions might be
524 cased differently. Therefore IDLWAVE always takes the case of the
525 *first* definition it encounters during routine info collection and
526 uses the case derived from it consistently.
528 Note that a lowercase-only string in the buffer will always be completed in
529 lower case (but see the variable `idlwave-completion-force-default-case').
531 After changing this variable, you need to either restart Emacs or press
532 `C-u C-c C-i' to update the internal lists."
539 "Non-nil means, completion will always honor `idlwave-completion-case'.
540 When nil, only the completion of a mixed case or upper case string
541 will honor the default settings in `idlwave-completion-case', while
542 the completion of lower case strings will be completed entirely in
543 lower case."
548 "Non-nil means, the empty string is considered downcase for completion.
549 The case of what is already in the buffer determines the case of completions.
550 When this variable is non-nil, the empty string is considered to be downcase.
551 Completing on the empty string then offers downcase versions of the possible
552 completions."
557 "Non-nil means, the case of tokens in buffers dominates over system stuff.
558 To make this possible, we need to re-case everything each time we update
559 the routine info from the buffers. This is slow.
560 The default is to consider the case given in the system and library files
561 first which makes updating much faster."
566 "Non-nil means, highlight completions for which system help is available.
567 Help can then be accessed with mouse-3.
568 This option is only effective when the online help system is installed."
573 "Non-nil means, treat inheritance with completion, online help etc.
574 When nil, IDLWAVE only knows about the native methods and tags of a class,
575 not about inherited ones."
580 "List of regular expressions for class-driven keyword inheritance.
582 up the class tree. While it cannot be assumed that the presence of an
583 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
584 certain methods this assumption is almost always true. The methods
585 for which to assume this can be set here."
591 "Number of classes to show when completing object methods and keywords.
592 When completing methods or keywords for an object with unknown class,
593 the *Completions* buffer will show the valid classes for each completion
594 like this:
596 MyMethod <Class1,Class2,Class3>
598 The value of this variable may be nil to inhibit display, or an integer to
599 indicate the maximum number of classes to display.
601 On XEmacs, a full list of classes will also be placed into a `help-echo'
602 property on the completion items, so that the list of classes for the current
603 item is displayed in the echo area. If the value of this variable is a
604 negative integer, the `help-echo' property will be suppressed."
610 "Non-nil means, fontify the classes in completions buffer.
611 This makes it easier to distinguish the completion items from the extra
612 class info listed. See `idlwave-completion-show-classes'."
618 "Association list governing specification of object classes for completion.
620 When IDLWAVE tries to complete object-oriented methods, it usually
621 cannot determine the class of a given object from context. In order
622 to provide the user with a correct list of methods or keywords, it
623 needs to determine the appropriate class. IDLWAVE has two ways of
624 doing this (well, three ways if you count the shell... see
625 `idlwave-shell-query-for-class'):
627 1. Combine the items of all available classes which contain this
628 method for the purpose of completion. So when completing a method,
629 all methods of all known classes are available, and when completing
630 a keyword, all keywords allowed for this method in any class are
631 shown. This behavior is very much like normal completion and is
632 therefore the default. It works much better than one might think -
633 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
634 become uncomfortably long. See also
635 `idlwave-completion-show-classes'.
637 2. The second possibility is to ask the user on each occasion. To
638 make this less interruptive, IDLWAVE can store the class as a text
639 property on the object operator `->'. For a given object in the
640 source code, class selection will then be needed only once
641 - for example to complete the method. Keywords to the method can
642 then be completed directly, because the class is already known.
643 You will have to turn on the storage of the selected class
644 explicitly with the variable `idlwave-store-inquired-class'.
646 This variable allows you to configure IDLWAVE's method and
647 method-keyword completion behavior. Its value is an alist, which
648 should contain at least two elements: (method-default . VALUE) and
649 \(keyword-default . VALUE), where VALUE is either t or nil. These
650 specify if the class should be found during method and keyword
651 completion, respectively.
653 The alist may have additional entries specifying exceptions from the
654 keyword completion rule for specific methods, like INIT or
655 GETPROPERTY. In order to turn on class specification for the INIT
665 :inline t
670 "Non-nil means, store class of a method call as text property on `->'.
671 IDLWAVE sometimes has to ask the user for the class associated with a
672 particular object method call. This happens during the commands
673 `idlwave-routine-info' and `idlwave-complete', depending upon the
674 value of the variable `idlwave-query-class'.
676 When you specify a class, this information can be stored as a text
677 property on the `->' arrow in the source code, so that during the same
678 editing session, IDLWAVE will not have to ask again. When this
679 variable is non-nil, IDLWAVE will store and reuse the class information.
681 on the arrow.
683 The default of this variable is nil, since the result of commands then
684 is more predictable. However, if you know what you are doing, it can
685 be nice to turn this on.
687 An arrow which knows the class will be highlighted with
689 displays (with prefix arg: deletes) the class stored on the arrow
690 at point."
695 "Face to highlight object operator arrows `->' which carry a class property.
696 When IDLWAVE stores a class name as text property on an object arrow
697 \(see variable `idlwave-store-inquired-class', it highlights the arrow
698 with this font in order to remind the user that this arrow is special."
703 "Non-nil means, resize the Routine-info *Help* window to fit the content."
708 "Non-nil means, completion automatically adds `=' after completed keywords."
713 "Non-nil means, completion automatically adds `(' after completed function.
714 nil means, don't add anything.
715 A value of `2' means, also add the closing parenthesis and position cursor
716 between the two."
723 "Non-nil means, try to restore the window configuration after completion.
724 When completion is not unique, Emacs displays a list of completions.
725 This messes up your window configuration. With this variable set, IDLWAVE
726 restores the old configuration after successful completion."
730 ;;; Variables for abbrev and action behavior -----------------------------
733 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
734 The variables in this group govern this."
738 "Non-nil means performs actions when indenting.
739 The actions that can be performed are listed in `idlwave-indent-action-table'."
744 "A single character string used to start abbreviations in abbrev mode.
745 Possible characters to chose from: ~`\%
746 or even '?'. '.' is not a good choice because it can make structure
747 field names act like abbrevs in certain circumstances.
749 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
750 must set it directly using `setq' in the init file before idlwave.el
751 is loaded."
756 "Non-nil means, enable `idlwave-surround'.
757 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
758 `idlwave-surround'.
759 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
761 Also see the default key bindings for keys using `idlwave-surround'.
762 Keys are bound and made into actions calling `idlwave-surround' with
763 `idlwave-action-and-binding'.
764 See help for `idlwave-action-and-binding' for examples.
766 Also see help for `idlwave-surround'."
771 "Non-nil means pad '=' in keywords (routine calls or defs) like assignment.
772 Whenever `idlwave-surround' is non-nil then this affects how '=' is
773 padded for keywords and for variables. If t, pad the same as for
774 assignments. If nil then spaces are removed. With any other value,
775 spaces are left unchanged."
783 "Non-nil means point blinks to block beginning for `idlwave-show-begin'."
788 "Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
793 "Non-nil means re-indent line after END was typed."
798 "Non-nil means the abbrev hook can move point.
799 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
800 definitions, use the command `list-abbrevs', for abbrevs that move
801 point. Moving point is useful, for example, to place point between
802 parentheses of expanded functions.
804 See `idlwave-check-abbrev'."
809 "Non-nil means all abbrevs will be forced to either upper or lower case.
810 If the value t, all expanded abbrevs will be upper case.
811 If the value is 'down then abbrevs will be forced to lower case.
812 If nil, the case will not change.
813 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
814 upper case, regardless of this variable."
819 "Non-nil means, reserved words will be made upper case via abbrev expansion.
820 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
821 Has effect only if in abbrev-mode."
825 ;;; Action/Expand Tables.
826 ;;
827 ;; The average user may have difficulty modifying this directly. It
828 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
829 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
830 ;; examples of how to add an action.
831 ;;
832 ;; The action table is used by `idlwave-indent-line' whereas both the
833 ;; action and expand tables are used by `idlwave-indent-and-action'. In
834 ;; general, the expand table is only used when a line is explicitly
835 ;; indented. Whereas, in addition to being used when the expand table
836 ;; is used, the action table is used when a line is indirectly
837 ;; indented via line splitting, auto-filling or a new line creation.
838 ;;
839 ;; Example actions:
840 ;;
841 ;; Capitalize system vars
842 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
843 ;;
844 ;; Capitalize procedure name
845 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
846 ;; '(capitalize-word 1) t)
847 ;;
848 ;; Capitalize common block name
849 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
850 ;; '(capitalize-word 1) t)
851 ;; Capitalize label
852 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
853 ;; '(capitalize-word -1) t)
856 "Associated array containing action lists of search string (car),
857 and function as a cdr. This table is used by `idlwave-indent-line'.
858 See documentation for `idlwave-do-action' for a complete description of
859 the action lists.
861 Additions to the table are made with `idlwave-action-and-binding' when a
862 binding is not requested.
866 "Associated array containing action lists of search string (car),
867 and function as a cdr. The table is used by the
868 `idlwave-indent-and-action' function. See documentation for
869 `idlwave-do-action' for a complete description of the action lists.
871 Additions to the table are made with `idlwave-action-and-binding' when a
872 binding is requested.
875 ;;; Documentation header and history keyword ---------------------------------
878 "Options for documenting IDLWAVE files."
881 ;; FIXME: make defcustom?
884 ";+
885 ; NAME:
886 ;
887 ;
888 ;
889 ; PURPOSE:
890 ;
891 ;
892 ;
893 ; CATEGORY:
894 ;
895 ;
896 ;
897 ; CALLING SEQUENCE:
898 ;
899 ;
900 ;
901 ; INPUTS:
902 ;
903 ;
904 ;
905 ; OPTIONAL INPUTS:
906 ;
907 ;
908 ;
909 ; KEYWORD PARAMETERS:
910 ;
911 ;
912 ;
913 ; OUTPUTS:
914 ;
915 ;
916 ;
917 ; OPTIONAL OUTPUTS:
918 ;
919 ;
920 ;
921 ; COMMON BLOCKS:
922 ;
923 ;
924 ;
925 ; SIDE EFFECTS:
926 ;
927 ;
928 ;
929 ; RESTRICTIONS:
930 ;
931 ;
932 ;
933 ; PROCEDURE:
934 ;
935 ;
936 ;
937 ; EXAMPLE:
938 ;
939 ;
940 ;
941 ; MODIFICATION HISTORY:
942 ;
943 ;-
945 "A list (PATHNAME STRING) specifying the doc-header template to use for
946 summarizing a file. If PATHNAME is non-nil then this file will be included.
947 Otherwise STRING is used. If nil, the file summary will be omitted.
948 For example you might set PATHNAME to the path for the
952 "Non-nil means, the documentation header will always be at start of file.
953 When nil, the header is positioned between the PRO/FUNCTION line of
954 the current routine and the code, allowing several routine headers in
955 a file."
960 "The hook function used to update the timestamp of a function."
965 "The modifications keyword to use with the log documentation commands.
966 A ':' is added to the keyword end.
967 Inserted by doc-header and used to position logs by doc-modification.
968 If nil it will not be inserted."
973 "Regexp matching the start of a document library header."
978 "Regexp matching the end of a document library header."
982 ;;; External Programs -------------------------------------------------------
985 "Path locations of external commands used by IDLWAVE."
989 "If non-nil, this is the command to run IDL.
990 Should be an absolute file path or path relative to the current environment
991 execution search path. If you want to specify command line switches
992 for the IDL program, use `idlwave-shell-command-line-options'.
994 I know the name of this variable is badly chosen, but I cannot change
995 it without compromising backwards-compatibility."
1000 "A list of command line options for calling the IDL program.
1001 Since IDL is executed directly without going through a shell like /bin/sh,
1003 string for each argument. But you may also give a single string which
1004 contains the options whitespace-separated. Emacs will be kind enough to
1005 split it for you."
1007 string
1012 "The external application providing reference help for programming.
1013 Obsolete, if the IDL Assistant is being used for help."
1017 ;;; Some Shell variables which must be defined here.-----------------------
1020 "List of modifiers to be used for the debugging commands.
1021 Will be used to bind debugging commands in the shell buffer and in all
1022 source buffers. These are additional convenience bindings, the debugging
1023 commands are always available with the `C-c C-d' prefix.
1024 If you set this to '(control shift), this means setting a breakpoint will
1025 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1026 are `control', `meta', `super', `hyper', `alt', and `shift'."
1037 "If non-nil attempt invoke `idlwave-shell' if not already running.
1038 This is checked when an attempt to send a command to an
1039 IDL process is made."
1043 ;;; Miscellaneous variables -------------------------------------------------
1046 "Miscellaneous options for IDLWAVE mode."
1051 "Non-nil displays a startup message when `idlwave-mode' is first called."
1057 common-blocks class-arrows)
1058 "Items which should be fontified on the default fontification level 2.
1059 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1060 is everything and level 2 is specified by this list.
1061 This variable must be set before IDLWAVE gets loaded.
1062 It is a list of symbols; the following symbols are allowed:
1064 pros-and-functions Procedure and Function definitions
1065 batch-files Batch Files
1066 idlwave-idl-keywords IDL Keywords
1067 label Statement Labels
1068 goto Goto Statements
1069 common-blocks Common Blocks
1070 keyword-parameters Keyword Parameters in routine definitions and calls
1071 system-variables System Variables
1072 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1073 class-arrows Object Arrows with class property"
1091 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1096 "Normal hook. Executed when idlwave.el is loaded."
1101 "Non-nil means turn on a few experimental features.
1102 This variable is only for the maintainer, to test difficult stuff,
1103 while still distributing stable releases.
1106 ;;;
1107 ;;; End customization variables section
1108 ;;;
1110 ;;; Non customization variables
1112 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1113 ;;; Simon Marshall <simon_at_gnu.ai.mit.edu>
1114 ;;; and Carsten Dominik...
1116 ;; The following are the reserved words in IDL. Maybe we should
1117 ;; highlight some more stuff as well?
1118 ;; Procedure declarations. Fontify keyword plus procedure name.
1120 ;; To update this regexp, update the list of keywords and
1121 ;; evaluate the form.
1122 ;; (insert
1123 ;; (prin1-to-string
1124 ;; (concat
1125 ;; "\\<\\("
1126 ;; (regexp-opt
1127 ;; '("||" "&&" "and" "or" "xor" "not"
1128 ;; "eq" "ge" "gt" "le" "lt" "ne"
1129 ;; "for" "do" "endfor"
1130 ;; "if" "then" "endif" "else" "endelse"
1131 ;; "case" "of" "endcase"
1132 ;; "switch" "break" "continue" "endswitch"
1133 ;; "begin" "end"
1134 ;; "repeat" "until" "endrep"
1135 ;; "while" "endwhile"
1136 ;; "goto" "return"
1137 ;; "inherits" "mod"
1138 ;; "compile_opt" "forward_function"
1139 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1140 ;; "\\)\\>")))
1141 "\\<\\(&&\\|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\\|||\\)\\>")
1145 ;; Function declarations. Fontify keyword plus function name.
1151 ;; Common blocks
1157 ;; Start with point after block name and comma
1159 nil
1161 )))
1163 ;; Batch files
1167 ;; FIXME warning.
1171 ;; Labels
1175 ;; The goto statement and its label
1181 ;; Tags in structure definitions. Note that this definition
1182 ;; actually collides with labels, so we have to use the same
1183 ;; face. It also matches named subscript ranges,
1184 ;; e.g. vec{bottom:top]. No good way around this.
1188 ;; Structure names
1193 ;; Keyword parameters, like /xlog or ,xrange=[]
1194 ;; This is anchored to the comma preceding the keyword.
1195 ;; Treats continuation lines, works only during whole buffer
1196 ;; fontification. Slow, use it only in fancy fontification.
1198 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\([ \t]*\\(;.*\\)?\n\\)*[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1201 ;; System variables start with a bang.
1206 ;; Special and unusual operators (not used because too noisy)
1207 ;; (special-operators
1208 ;; '("[<>#]" (0 font-lock-keyword-face)))
1210 ;; All operators (not used because too noisy)
1211 ;; (all-operators
1212 ;; '("[-*^#+<>/]" (0 font-lock-keyword-face)))
1214 ;; Arrows with text property `idlwave-class'
1228 batch-files
1229 idlwave-idl-keywords
1230 label goto
1231 structtag
1232 structname
1233 common-blocks
1234 keyword-parameters
1235 system-variables
1236 class-arrows)
1240 ;; Match an object arrow with class property
1250 idlwave-font-lock-keywords-1
1251 idlwave-font-lock-keywords-2
1252 idlwave-font-lock-keywords-3)
1253 nil t
1255 beginning-of-line))
1261 "Regexp to match the start of a full-line comment.
1262 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1267 "Regular expression to find the beginning of a block.
1271 "Regular expression to find the beginning of a unit.
1275 "Regular expression to find the line that indicates the end of unit.
1276 This line is the end of buffer or the start of another unit.
1284 "Regular expression to find the end of a block.
1297 "Matches between statements and the corresponding END variant.
1298 The cars are the reserved words starting a block. If the block really
1299 begins with BEGIN, the cars are the reserved words before the begin
1300 which can be used to identify the block type.
1301 This is used to check for the correct END type, to close blocks and
1306 "Regular expression matching reserved words which can stand before
1307 blocks starting with a BEGIN statement. The matches must have associations
1324 ))
1328 ;; "endif else" is the only possible "end" that can be
1329 ;; followed by a statement on the same line.
1331 ;; all other "end"s can not be followed by a statement.
1344 idlwave-identifier
1348 idlwave-identifier
1353 "Associated list of statement matching regular expressions.
1354 Each regular expression matches the start of an IDL statement.
1355 The first element of each association is a symbol giving the statement
1356 type. The associated value is a list. The first element of this list
1357 is a regular expression matching the start of an IDL statement for
1358 identifying the statement type. The second element of this list is a
1359 regular expression for finding a substatement for the type. The
1360 substatement starts after the end of the found match modulo
1361 whitespace. If it is nil then the statement has no substatement. The
1362 list order matters since matching an assignment statement exactly is
1363 not possible without parsing. Thus assignment statement become just
1366 ;; FIXME: This var seems to only ever be set, but never actually used!
1373 ;; Note that this is documented in the v18 manuals as being a string
1374 ;; of length one rather than a single character.
1375 ;; The code in this file accepts either format for compatibility.
1377 "Character to be inserted for IDL comment indentation.
1381 "Character which is inserted as a last character on previous line by
1387 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1391 ;; If I take the time I can replace idlwave-keyword-abbrev with
1392 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1393 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1394 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1395 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1398 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1399 Specifically, if the abbrev is in a comment or string it is unexpanded.
1400 Otherwise ARGS forms a list that is evaluated."
1401 ;; FIXME: it would probably be better to rely on the new :enable-function
1402 ;; to enforce the "don't expand in comments or strings".
1427 ;;(define-key map "\C-c\C- " 'idlwave-hard-tab)
1446 ;; (define-key map "\r" 'idlwave-newline)
1447 ;; (define-key map "\t" 'idlwave-indent-line)
1458 ;; Bind the debug commands also with the special modifiers.
1475 ;; (define-key map "\C-c\C-f" 'idlwave-function)
1476 ;; (define-key map "\C-c\C-p" 'idlwave-procedure)
1489 ;; Pickup both forms of Esc/Meta binding
1498 map)
1524 st)
1533 st)
1537 "Execute BODY with a different syntax table."
1545 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1546 ; "Execute BODY with a different syntax table."
1547 ; `(let ((saved-syntax (syntax-table)))
1548 ; (unwind-protect
1549 ; (progn
1550 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1551 ; ,@body)
1552 ; (set-syntax-table saved-syntax))))
1555 "KEY and CMD are made into a key binding and an indent action.
1556 KEY is a string - same as for the `define-key' function. CMD is a
1557 function of no arguments or a list to be evaluated. CMD is bound to
1558 KEY in `idlwave-mode-map' by defining an anonymous function calling
1559 `self-insert-command' followed by CMD. If KEY contains more than one
1560 character a binding will only be set if SELECT is 'both.
1562 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1563 replacing any previous value for KEY. If a binding is not set then it
1564 will instead be placed in `idlwave-indent-action-table'.
1566 If the optional argument SELECT is nil then an action and binding are
1567 created. If SELECT is 'noaction, then a binding is always set and no
1568 action is created. If SELECT is 'both then an action and binding
1569 will both be created even if KEY contains more than one character.
1570 Otherwise, if SELECT is non-nil then only an action is created.
1572 Some examples:
1573 No spaces before and 1 after a comma
1575 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1577 Capitalize system variables - action only
1578 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1580 ;; Add action
1586 ;; Replace action command
1588 ;; New action
1590 ;; Make key binding for action
1600 ;; Set action and key bindings.
1601 ;; See description of the function `idlwave-action-and-binding'.
1602 ;; Automatically add spaces for the following characters
1604 ;; Actions for & are complicated by &&
1607 ;; Automatically add spaces to equal sign if not keyword. This needs
1608 ;; to go ahead of > and <, so >= and <= will be treated correctly
1611 ;; Actions for > and < are complicated by >=, <=, and ->...
1618 ;;;
1619 ;;; Abbrev Section
1620 ;;;
1621 ;;; When expanding abbrevs and the abbrev hook moves backward, an extra
1622 ;;; space is inserted (this is the space typed by the user to expanded
1623 ;;; the abbrev).
1624 ;;;
1630 "Define-abbrev with backward compatibility.
1632 If NOPREFIX is non-nil, don't prepend prefix character. Installs into
1633 `idlwave-mode-abbrev-table' unless TABLE is non-nil."
1637 expansion
1638 hook)))
1648 ;;
1649 ;; Templates
1650 ;;
1660 ;;
1661 ;; Keywords, system functions, conversion routines
1662 ;;
1720 ;; This section is reserved words only. (From IDL user manual)
1721 ;;
1767 ;; defined later - so just make the compiler hush
1771 ;;;###autoload
1773 "Major mode for editing IDL source files (version 6.1_em22).
1775 The main features of this mode are
1777 1. Indentation and Formatting
1778 --------------------------
1779 Like other Emacs programming modes, C-j inserts a newline and indents.
1780 TAB is used for explicit indentation of the current line.
1783 function can also be used in the middle of a line to split the line
1784 at that point. When used inside a long constant string, the string
1785 is split at that point with the `+' concatenation operator.
1787 Comments are indented as follows:
1789 `;;;' Indentation remains unchanged.
1790 `;;' Indent like the surrounding code
1791 `;' Indent to a minimum column.
1793 The indentation of comments starting in column 0 is never changed.
1796 comment. The indentation of the second line of the paragraph
1797 relative to the first will be retained. Use
1799 comments. When the variable `idlwave-fill-comment-line-only' is
1800 nil, code can also be auto-filled and auto-indented.
1802 To convert pre-existing IDL code to your formatting style, mark the
1807 2. Routine Info
1808 ------------
1809 IDLWAVE displays information about the calling sequence and the
1810 accepted keyword parameters of a procedure or function with
1812 source file of a module. These commands know about system
1813 routines, all routines in idlwave-mode buffers and (when the
1814 idlwave-shell is active) about all modules currently compiled under
1815 this shell. It also makes use of pre-compiled or custom-scanned
1816 user and library catalogs many popular libraries ship with by
1818 information, which is also used for completion (see item 4).
1820 3. Online IDL Help
1821 ---------------
1824 for the system variable, keyword, or routines at point. A single
1825 key stroke gets you directly to the right place in the docs. See
1826 the manual to configure where and how the HTML help is displayed.
1828 4. Completion
1829 ----------
1831 class names, keyword parameters, system variables and tags, class
1832 tags, structure tags, filenames and much more. It is context
1833 sensitive and figures out what is expected at point. Lower case
1834 strings are completed in lower case, other strings in mixed or
1835 upper case.
1837 5. Code Templates and Abbreviations
1838 --------------------------------
1839 Many Abbreviations are predefined to expand to code fragments and templates.
1854 have direct keybindings - see the list of keybindings below.
1857 beginning of the current program unit (pro, function or main).
1858 Change log entries can be added to the current program unit with
1861 6. Automatic Case Conversion
1862 -------------------------
1863 The case of reserved words and some abbrevs is controlled by
1864 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1866 7. Automatic END completion
1867 ------------------------
1868 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1869 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1871 8. Hooks
1872 -----
1873 Loading idlwave.el runs `idlwave-load-hook'.
1874 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1876 9. Documentation and Customization
1877 -------------------------------
1878 Info documentation for this package is available. Use
1880 not work). For Postscript, PDF, and HTML versions of the
1881 documentation, check IDLWAVE's homepage at URL
1882 `http://github.com/jdtsmith/idlwave'.
1883 IDLWAVE has customize support - see the group `idlwave'.
1885 10.Keybindings
1886 -----------
1887 Here is a list of all keybindings of this mode.
1889 followed by the key sequence to see what the key sequence does.
1892 :abbrev-table idlwave-mode-abbrev-table
1924 ;; ChangeLog
1928 ;; Set tag table list to use IDLTAGS as file name.
1932 ;; Font-lock additions
1933 ;; Following line is for Emacs - XEmacs uses the corresponding property
1934 ;; on the `idlwave-mode' symbol.
1941 ;; Imenu setup
1949 ;; HideShow setup
1952 idlwave-begin-block-reg
1953 idlwave-end-block-reg
1954 ";"
1957 ;; Make a local post-command-hook and add our hook to it
1958 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1959 ;; (make-local-hook 'post-command-hook)
1962 ;; Make local hooks for buffer updates
1963 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1964 ;; (make-local-hook 'kill-buffer-hook)
1966 ;; (make-local-hook 'after-save-hook)
1970 ;; Setup directories and file, if necessary
1973 ;; Update the routine info with info about current buffer?
1976 ;; Check help location
1986 idlwave-user-catalog-file
1987 idlwave-config-directory)
1988 idlwave-xml-system-rinfo-converted-file
1990 idlwave-xml-system-rinfo-converted-file
1991 idlwave-config-directory)
1993 idlwave-path-file
1994 idlwave-config-directory))
1999 "Fontify continuation lines correctly."
2010 ;;
2011 ;; Code Formatting ----------------------------------------------------
2012 ;;
2015 "Insert TAB in buffer in current position."
2019 ;;; This stuff is experimental
2022 "If non-nil, a list that can be evaluated using `eval'.
2023 It is evaluated in the lisp function `idlwave-command-hook' which is
2027 "Command run after every command.
2028 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
2029 sets the variable to zero afterwards."
2037 ;;; End experiment
2039 ;; It would be better to use expand.el for better abbrev handling and
2040 ;; versatility.
2043 "Reverse abbrev expansion if in comment or string.
2044 Argument ARG is the number of characters to move point
2045 backward if `idlwave-abbrev-move' is non-nil.
2046 If optional argument RESERVED is non-nil then the expansion
2047 consists of reserved words, which will be capitalized if
2048 `idlwave-reserved-word-upcase' is non-nil.
2049 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2050 is non-nil, unless its value is \`down in which case the abbrev will be
2051 made into all lowercase.
2052 Returns non-nil if abbrev is left expanded."
2055 nil)
2067 t))
2070 "Return t if point is inside a comment, nil otherwise."
2076 "Move to start of comment delimiter on current line.
2077 Moves to end of line if there is no comment delimiter.
2078 Ignores comment delimiters in strings.
2079 Returns point if comment found and nil otherwise."
2082 found)
2083 ;; Look for first comment delimiter not in a string
2095 "Should we operate on an active region?"
2101 "Insert quote and show matching quote if this is end of a string."
2112 ;; Not the end of a string
2116 "Ensure that the previous word was a token before `idlwave-show-begin'.
2117 An END token must be preceded by whitespace."
2127 "Find the start of current block and blinks to it for a second.
2128 Also checks if the correct END statement has been used."
2129 ;; All end statements are reserved words
2130 ;; Re-indent end line
2131 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2132 ;;(backward-char 1)
2136 begin-pos end-pos end end1 )
2140 idlwave-show-block)
2142 ;; Move inside current block
2155 end-pos))
2163 ;; A generic end
2174 end1 end)
2176 ;;(delete-char 1))
2190 ;; seems to be a case thing
2194 idlwave-block-matches))
2196 ;; Just a normal block
2201 "Terminate the current block with the correct END statement."
2203 ;; Start new line if we are not in a new line
2214 "Surround &, leaving room for && (which surround as well)."
2224 "Surround > and < by blanks, leaving room for >= and <=, and considering ->."
2230 ;; Key binding: pad only on left, to save for possible >=/<=
2234 "Surround the LENGTH characters before point with blanks.
2235 LENGTH defaults to 1.
2236 Optional arguments BEFORE and AFTER affect the behavior before and
2237 after the characters (see also description of `idlwave-make-space'):
2239 nil do nothing
2240 0 force no spaces
2241 integer > 0 force exactly n spaces
2242 integer < 0 at least |n| spaces
2244 The function does nothing if any of the following conditions is true:
2245 - `idlwave-surround-by-blank' is nil
2246 - the character before point is inside a string or comment"
2254 ;; avoid clobbering indent
2264 ;; Check to see if the line should auto wrap
2270 "Make space at point.
2271 The space affected is all the spaces and tabs around point.
2272 If n is non-nil then point is left abs(n) spaces from the beginning of
2273 the contiguous space.
2274 The amount of space at point is determined by N.
2275 If the value of N is:
2276 nil - do nothing.
2277 > 0 - exactly N spaces.
2278 < 0 - a minimum of -N spaces, i.e., do not change if there are
2279 already -N spaces.
2280 0 - no spaces (i.e. remove any existing space)."
2294 ;; n = 0, done
2295 ))))
2298 "Insert a newline and indent the current and previous line."
2300 ;;
2301 ;; Handle unterminated single and double quotes
2302 ;; If not in a comment and in a string then insertion of a newline
2303 ;; will mean unbalanced quotes.
2304 ;;
2309 ;;
2310 ;; The current line is being split, the cursor should be at the
2311 ;; beginning of the new line skipping the leading indentation.
2312 ;;
2313 ;; The reason we insert the new line before indenting is that the
2314 ;; indenting could be confused by keywords (e.g. END) on the line
2315 ;; after the split point. This prevents us from just using
2316 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2317 ;;
2323 ;;
2324 ;; Use global variable 'comment-column' to set parallel comment
2325 ;;
2326 ;; Modeled on lisp.el
2327 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2329 "Compute indent for the beginning of the IDL comment delimiter."
2335 ;; On line by itself, indent as code
2338 ;; after code - do not change
2342 comment-column))))
2345 "Continue line by breaking line at point and indent the lines.
2346 For a code line insert continuation marker. If the line is a line comment
2347 then the new line will contain a comment with the same indentation.
2348 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2349 non-nil."
2351 ;; Expand abbreviation, just like normal RET would.
2355 ;; For code line add continuation.
2356 ;; Check if splitting a string.
2360 ;; Split the string.
2362 idlwave-continuation-char beg)
2366 ;; Do not split the string.
2370 ;; Not splitting a string.
2376 ;; Indent previous line
2381 ;; Reindent new line
2385 "Move point to the beginning of the current program unit.
2386 If NOMARK is non-nil, do not push mark."
2391 "Move point to the start of the next program unit.
2392 If NOMARK is non-nil, do not push mark."
2398 "Mark current IDL statement."
2406 "Mark containing block."
2418 "Put mark at beginning of program, point at end.
2419 The marks are pushed."
2429 "Move to beginning of enclosing block if prefix ARG >= 0.
2430 If prefix ARG < 0 then move forward to enclosing block end."
2435 "Go to the beginning of the current block."
2441 "Go to the beginning of the current block."
2447 "Move across next nested block."
2454 "Move backward across previous nested block."
2460 "Go down a block.
2461 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2462 Returns non-nil if successful."
2466 ;; Backward
2474 ;; Forward
2482 status))
2485 "Put point at beginning of doc library header, mark at end.
2486 The marks are pushed."
2507 "Return (NAME TYPE CLASS) of current routine."
2511 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2520 "Move to beginning of the current statement.
2521 Skips back past statement continuations.
2522 Point is placed at the beginning of the line whether or not this is an
2523 actual statement."
2535 "Move point to beginning of the previous statement.
2536 Returns t if the current line before moving is the beginning of
2537 the first non-comment statement in the file, and nil otherwise."
2541 ;; first line in file
2542 t
2543 ;; skip blank lines, label lines, include lines and line comments
2545 ;; The current statement is the first statement until we
2546 ;; reach another statement.
2554 ;; skip continuation lines
2560 first-statement)))
2563 "Move point to the end of the current IDL statement.
2564 If not in a statement just moves to end of line. Returns position."
2574 "Move point to the end of the current IDL statement.
2575 If not in a statement just moves to end of line. Returns position."
2583 "Move point to beginning of the next IDL statement.
2584 Returns t if that statement is the last non-comment IDL statement
2585 in the file, and nil otherwise."
2589 ;; skip blank lines, label lines, include lines and line comments
2591 ;; The current statement is the last statement until
2592 ;; we reach a new statement.
2599 last-statement))
2602 "Skip past multiple commands on a line (with `&')."
2612 "Skip label or case statement element.
2613 Returns position after label.
2614 If there is no label point is not moved and nil is returned."
2615 ;; Case expressions and labels are terminated by a colon.
2616 ;; So we find the first colon in the line and make sure
2617 ;; - no `?' is before it (might be a ? b : c)
2618 ;; - it is not in a comment
2619 ;; - not in a string constant
2620 ;; - not in parenthesis (like a[0:3])
2621 ;; - not followed by another ":" in explicit class, ala a->b::c
2622 ;; As many in this mode, this function is heuristic and not an exact
2623 ;; parser.
2635 nil)))
2638 "Move to start of next IDL substatement after point.
2639 Uses the type of the current IDL statement to determine if the next
2640 statement is on a new line or is a subpart of the current statement.
2641 Returns point at start of substatement modulo whitespace.
2642 If optional argument is non-nil move to beginning of current
2643 substatement."
2647 st nst last)
2653 ;; Continue looking for substatements until we are past orig
2667 ;; If a continuation line starts here, move to next line
2673 "Return the type of the current IDL statement.
2674 Uses `idlwave-statement-match' to return a cons of (type . point) with
2675 point the ending position where the type was determined. Type is the
2676 association from `idlwave-statement-match', i.e. the cons cell from the
2677 list not just the type symbol. Returns nil if not an identifiable
2678 statement."
2680 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2681 ;; and possibly comments
2693 "Pad '=' with spaces.
2694 Two cases: Assignment statement, and keyword assignment.
2695 Which case is determined using `idlwave-start-of-substatement' and
2696 `idlwave-statement-type'. The equal sign will be surrounded by BEFORE
2697 and AFTER blanks. If `idlwave-pad-keyword' is t then keyword assignment
2698 is treated just like assignment statements. When nil, spaces are
2699 removed for keyword assignment. Any other value keeps the current space
2700 around the `='. Limits in for loops are treated as keyword assignment.
2702 Starting with IDL 6.0, a number of op= assignments are available.
2703 Since ambiguities of the form:
2705 r and= b
2706 rand= b
2708 can occur, alphanumeric operator assignment will never be pre-padded,
2709 only post-padded. You must use a space before these to disambiguate
2710 \(not just for padding, but for proper parsing by IDL too!). Other
2711 operators, such as ##=, ^=, etc., will be pre-padded.
2713 IS-ACTION is ignored.
2715 See `idlwave-surround'."
2728 ;; Why doesn't ##? work for both?
2732 ;(setq begin nil) ; won't modify begin
2736 ;; Everything gets padded equally
2738 ;; Treating keywords/for variables specially...
2756 "Call `idlwave-indent-line' and do expand actions.
2757 With prefix ARG non-nil, indent the entire sub-statement."
2765 ;;Expand the END abbreviation, just as RET or Space would have.
2776 "Indent current IDL line as code or as a comment.
2777 The actions in `idlwave-indent-action-table' are performed.
2778 If the optional argument EXPAND is non-nil then the actions in
2779 `idlwave-indent-expand-table' are performed."
2781 ;; Move point out of left margin.
2790 ;; Indentation for a line comment
2794 ;;
2795 ;; Code Line
2796 ;;
2797 ;; Before indenting, run action routines.
2798 ;;
2801 ;;
2804 ;;
2805 ;; No longer expand abbrevs on the line. The user can do this
2806 ;; manually using expand-region-abbrevs.
2807 ;;
2808 ;; Indent for code line
2809 ;;
2812 ;; a label line
2814 ;; a batch command
2816 ;; leave flush left
2817 nil
2818 ;; indent the line
2820 ;; Adjust parallel comment
2823 ;; Emacs 21 is too smart with fill-column on comment indent
2826 fill-column)))
2829 ;; Get rid of marker
2833 "Perform an action repeatedly on a line.
2834 ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is
2835 either a function name to be called with `funcall' or a list to be
2836 evaluated with `eval'. The action performed by FUNC should leave
2837 point after the match for REG - otherwise an infinite loop may be
2838 entered. FUNC is always passed a final argument of 'is-action, so it
2839 can discriminate between being run as an action, or a key binding."
2849 "Indent from point with spaces until column COL.
2850 Inserts space before markers at point."
2856 "Indent the current line to column COL.
2857 Indents such that first non-whitespace character is at column COL
2858 Inserts spaces before markers at point."
2865 "Indent program unit which contains point."
2877 "Indent current statement, including all continuation lines."
2886 "Return appropriate indentation for current line as IDL code."
2890 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2891 ;; function
2894 ;; Check for continuation line
2899 ;; calculate indent based on previous and current statements
2902 ;; calculate indent based on previous statement
2905 ;; Beginning of file
2910 ;; Main block
2913 idlwave-main-block-indent))
2914 ;; Begin block
2917 idlwave-block-indent))
2918 ;; End Block
2921 ;; Match to the *beginning* of the block opener
2925 ;; idlwave-end-offset
2926 ;; idlwave-block-indent))
2928 ;; Default to current indent
2930 ;; adjust the indentation based on the current statement
2932 ;; End block
2937 ;;
2938 ;; Parentheses indent
2939 ;;
2942 "Calculate the continuation indent inside a paren group.
2943 Returns a cons-cell with (open . indent), where open is the
2944 location of the open paren."
2946 ;; Found an innermost open paren.
2949 ;; Line up with next word unless this is a closing paren.
2952 ;; Plain Kernighan-style nested indent
2956 ;; This is a closed paren - line up under open paren.
2960 ;; Empty (or just comment) follows -- revert to basic indent
2962 ;; Skip paren
2965 nil)
2967 ;; Line up with first word after any blank space
2973 "Calculates the IDL continuation indent column from the previous statement.
2974 Note that here previous statement usually means the beginning of the
2975 current statement if this statement is a continuation of the previous
2976 line. Various special types of continuations, including assignments,
2977 routine definitions, and parenthetical groupings, are treated separately."
2988 idlwave-continuation-indent))
2989 fancy-nonparen-indent fancy-paren-indent)
2991 ;; Align then with its matching if, etc.
2998 match cont-re)
3013 ;; Indent in from the previous line for continuing statements
3018 match)
3030 ;; Parenthetical indent, either traditional or Kernighan style
3037 indent-cons)
3040 beg-reg end-reg close-exp))
3041 ;; First permitted containing paren
3043 idlwave-indent-to-open-paren
3044 idlwave-indent-parens-nested
3047 idlwave-max-extra-continuation-indent))
3050 fancy-paren-indent)
3052 ;; A continued assignment, or procedure call/definition
3060 ;; A continued Procedure call or definition
3063 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3065 ;; Comment only, or blank line with "$"? Basic indent.
3067 nil
3070 ;; Continued assignment (with =):
3084 idlwave-max-extra-continuation-indent))
3087 fancy-nonparen-indent))
3089 ;; Basic indent, by default
3095 "Move to next match of the regular expression KEY-RE.
3096 Matches inside comments or string constants will be ignored.
3097 If DIR is negative, the search will be backwards.
3098 At a successful match, the mark is pushed unless NOMARK is non-nil.
3099 Searches are limited to LIMIT.
3100 Searches are case-insensitive and use a special syntax table which
3101 treats `$' and `_' as word characters.
3102 Return value is the beginning of the match or (in case of failure) nil."
3106 found)
3120 found)
3121 nil)))
3124 "When optional argument DIR is non-negative, move forward to end of
3125 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3126 regular expressions. When DIR is negative, move backwards to block beginning.
3127 Recursively calls itself to skip over nested blocks. DIR defaults to
3128 forward. Calls `push-mark' unless the optional argument NOMARK is
3129 non-nil. Movement is limited by the start of program units because of
3130 possibility of unbalanced blocks."
3137 idlwave-begin-block-reg
3138 idlwave-end-block-reg))
3139 found
3141 idlwave-end-block-reg))
3145 idlwave-begin-unit-reg dir t limit)
3148 idlwave-end-unit-reg dir t limit)))
3149 limit)))
3161 "The minimum indent in the current statement."
3172 min
3176 "Return indentation of the current statement.
3177 If in a statement, moves to beginning of statement before finding indent."
3184 "Return the column of the indentation of the current line.
3185 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3189 ;; if we are at the end of blank line return 0
3194 "Test if current line is continuation line.
3195 Blank or comment-only lines following regular continuation lines (with
3196 `$') count as continuations too."
3207 "Test if the current line is a comment line."
3213 "Test if the current line is a comment line."
3219 "Search current line from current point for REGEXP.
3220 If optional argument CONT is non-nil, searches to the end of
3221 the current statement.
3222 If optional arg BEG is non-nil, search starts from the beginning of the
3223 current statement.
3224 Ignores matches that end in a comment or inside a string expression.
3225 Returns point if successful, nil otherwise.
3226 This function produces unexpected results if REGEXP contains quotes or
3227 a comment delimiter. The search is case insensitive.
3228 If successful leaves point after the match, otherwise, does not move point."
3234 found)
3240 found))
3243 "Fill paragraphs in comments.
3244 A paragraph is made up of all contiguous lines having the same comment
3245 leader (the leading whitespace before the comment delimiter and the
3246 comment delimiter). In addition, paragraphs are separated by blank
3247 line comments. The indentation is given by the hanging indent of the
3248 first line, otherwise by the minimum indentation of the lines after
3249 the first line. The indentation of the first line does not change.
3250 Does not effect code lines. Does not fill comments on the same line
3251 with code. The hanging indent is given by the end of the first match
3252 matching `idlwave-hang-indent-regexp' on the paragraph's first line.
3253 If the optional argument NOHANG is non-nil then the hanging indent is
3254 ignored."
3256 ;; check if this is a line comment
3263 pre here diff fill-prefix-reg bcl first-indent
3264 hang start end)
3265 ;; Change tabs to spaces in the surrounding paragraph.
3266 ;; The surrounding paragraph will be the largest containing block of
3267 ;; contiguous line comments. Thus, we may be changing tabs in
3268 ;; a much larger area than is needed, but this is the easiest
3269 ;; brute force way to do it.
3270 ;;
3271 ;; This has the undesirable side effect of replacing the tabs
3272 ;; permanently without the user's request or knowledge.
3280 ;;
3286 ;; Get the comment leader on the line and its length
3288 ;; the comment leader is the indentation plus exactly the
3289 ;; number of consecutive ";".
3296 ;; Mark the beginning and end of the paragraph
3302 ;; Move to first line of paragraph
3316 ;; if at end of buffer add a newline (need this because
3317 ;; fill-region needs END to be at the beginning of line after
3318 ;; the paragraph or it will add a line).
3321 ;; Set END to the beginning of line after the paragraph
3322 ;; END is calculated as distance from end of buffer
3324 ;;
3325 ;; Calculate the indentation for the paragraph.
3326 ;;
3327 ;; In the following while statements, after one iteration
3328 ;; point will be at the beginning of a line in which case
3329 ;; the while will not be executed for the
3330 ;; the first paragraph line and thus will not affect the
3331 ;; indentation.
3332 ;;
3333 ;; First check to see if indentation is based on hanging indent.
3339 ;; Adjust lines of paragraph by inserting spaces so that
3340 ;; each line's indent is at least as great as the hanging
3341 ;; indent. This is needed for fill-paragraph to work with
3342 ;; a fill-prefix.
3351 ;; adjust the original location for the
3352 ;; inserted text.
3356 )
3358 ;; No hang. Instead find minimum indentation of paragraph
3359 ;; after first line.
3360 ;; For the following while statement, since START is at the
3361 ;; beginning of line and END is at the end of line
3362 ;; point is greater than START at least once (which would
3363 ;; be the case for a single line paragraph).
3374 ?\ )))
3375 ;; first-line indent
3381 indent))
3383 ;; try to keep point at its original place
3386 ;; In place of the more modern fill-region-as-paragraph, a hack
3387 ;; to keep whitespace untouched on the first line within the
3388 ;; indent length and to preserve any indent on the first line
3389 ;; (first indent).
3395 start
3398 nil)
3402 ;; When we want the point at the beginning of the comment
3403 ;; body fill-region will put it at the beginning of the line.
3408 "Calculate the position of the hanging indent for the comment paragraph.
3409 The hanging indent position is given by the first match with the
3410 `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3411 non-nil then use last occurrence matching `idlwave-hang-indent-regexp'
3412 on the line.
3413 If not found returns nil."
3425 "Called to break lines in auto fill mode.
3426 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3427 non-nil. Places a continuation character at the end of the line if
3428 not in a comment. Splits strings with IDL concatenation operator `+'
3429 if `idlwave-auto-fill-split-string' is non-nil."
3431 nil ; do not to fill
3434 ;; Check for comment line
3439 ;; Prevent actions do-auto-fill which calls indent-line-function.
3444 idlwave-auto-fill-split-string)
3447 ))))
3451 ;; Indent the split line
3456 ;; A continued line comment
3457 ;; We treat continued line comments as part of a comment
3458 ;; paragraph. So we check for a hanging indent.
3466 ;; Remove whitespace between comment delimiter and
3467 ;; text, insert spaces for appropriate indentation.
3473 ;; Split code or comment?
3477 ;; Splitting a non-full-line comment.
3478 ;; Insert the comment delimiter from split line
3483 ;; Insert blank to keep off beginning of line
3492 ;; Split code line - add continuation character
3495 ;; Check to see if we split a string
3497 idlwave-auto-fill-split-string)
3498 ;; Split the string and concatenate.
3499 ;; The first extra space is for the space
3500 ;; the line was split. That space was removed.
3505 ;; Make the second part of continued string
3510 ;; Warning
3513 ;; Although do-auto-fill (via indent-new-comment-line) calls
3514 ;; idlwave-indent-line for the new line, re-indent again
3515 ;; because of the addition of the continuation character.
3517 )))))
3520 "Toggle auto-fill mode for IDL mode.
3521 With arg, turn auto-fill mode on if arg is positive.
3522 In auto-fill mode, inserting a space at a column beyond `fill-column'
3523 automatically breaks the line at a previous space."
3529 'idlwave-auto-fill
3530 nil))
3531 ;; update mode-line
3534 ;(defun idlwave-fill-routine-call ()
3535 ; "Fill a routine definition or statement, indenting appropriately."
3536 ; (let ((where (idlwave-where)))))
3540 "Insert a documentation header at the beginning of the unit.
3541 Inserts the value of the variable `idlwave-file-header'. Sets mark
3542 before moving to do insertion unless the optional prefix argument
3543 NOMARK is non-nil."
3546 ;; make sure we catch the current line if it begins the unit
3552 ;; skip function or procedure line
3566 "Default timestamp insertion function."
3572 ;; Remove extra spaces from line
3574 ;; Insert a blank line comment to separate from the date entry -
3575 ;; will keep the entry from flowing onto date line if re-filled.
3579 "Insert a brief modification log at the beginning of the current program.
3580 Looks for an occurrence of the value of user variable
3581 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user
3582 name and places the point for the user to add a log. Before moving, saves
3583 location on mark ring so that the user can return to previous point."
3598 end t)
3609 ;; CJC 3/16/93
3610 ;; Interface to expand-region-abbrevs which did not work when the
3611 ;; abbrev hook associated with an abbrev moves point backwards
3612 ;; after abbrev expansion, e.g., as with the abbrev '.n'.
3613 ;; The original would enter an infinite loop in attempting to expand
3614 ;; .n (it would continually expand and unexpand the abbrev without expanding
3615 ;; because the point would keep going back to the beginning of the
3616 ;; abbrev instead of to the end of the abbrev). We now keep the
3617 ;; abbrev hook from moving backwards.
3618 ;;;
3620 "Expand each abbrev occurrence in the region.
3621 Calling from a program, arguments are START END."
3630 "Return t if point is in a comment or quoted string.
3631 Returns nil otherwise."
3635 "Return location of the opening quote
3636 if point is in a IDL string constant, nil otherwise.
3637 Ignores comment delimiters on the current line.
3638 Properly handles nested quotation marks and octal
3639 constants - a double quote followed by an octal digit."
3640 ;; Treat an octal inside an apostrophe to be a normal string. Treat a
3641 ;; double quote followed by an octal digit to be an octal constant
3642 ;; rather than a string. Therefore, there is no terminating double
3643 ;; quote.
3645 ;; Because single and double quotes can quote each other we must
3646 ;; search for the string start from the beginning of line.
3652 delim
3653 found)
3655 ;; Find string start
3656 ;; Don't find an octal constant beginning with a double quote
3658 ;; Find the string end.
3659 ;; In IDL, two consecutive delimiters after the start of a
3660 ;; string act as an
3661 ;; escape for the delimiter in the string.
3662 ;; Two consecutive delimiters alone (i.e., not after the
3663 ;; start of a string) is the null string.
3665 ;; Move to position after quote
3668 ;; Get the string delimiter
3670 ;; Check for null string
3673 ;; Look for next unpaired delimiter
3679 ))
3682 ;; return string beginning position or nil
3686 "Determine if the character after point is a pointer dereference *."
3696 ;; Statement templates
3698 ;; Replace these with a general template function, something like
3699 ;; expand.el (I think there was also something with a name similar to
3700 ;; dmacro.el)
3703 "Build a template with optional prompt expression.
3705 Opens a line if point is not followed by a newline modulo intervening
3706 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3707 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3708 adjusted according to `idlwave-abbrev-change-case'. If optional
3709 argument PROMPT is a string then it is displayed as a message in the
3710 minibuffer. The PROMPT serves as a reminder to the user of an
3711 expression to enter.
3713 The lines containing S1 and S2 are reindented using `indent-region'
3714 unless the optional second argument NOINDENT is non-nil."
3716 ;; This is a gross hack to avoid template abbrev expansion
3717 ;; in the shell. FIXME: This is a dirty hack.
3727 end)
3740 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3743 string))
3746 "Build skeleton IDL if-else block."
3754 "Build skeleton IDL case statement."
3762 "Build skeleton IDL switch statement."
3770 "Build skeleton IDL loop statement."
3778 "Build skeleton IDL if statement."
3814 "Return a list of substrings of STRING which are separated by PATTERN.
3828 end)
3836 ;; Return the buffer currently visiting FILE
3846 "List of buffers pulled up by IDLWAVE for special reasons.
3850 ;; Return a buffer visiting file.
3854 buf)))
3857 "Kill buffers created automatically by IDLWAVE.
3858 Function prompts for a letter to identify the buffers to kill.
3859 Possible letters are:
3862 clicks in the routine info window.
3863 s Buffers created by the IDLWAVE Shell to display where execution
3864 stopped or an error was found.
3865 a Both of the above.
3867 Buffers containing unsaved changes require confirmation before they are killed."
3871 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3885 "How many outlawed buffers have tag TAG?"
3889 idlwave-outlawed-buffers))))
3892 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3895 entry)
3909 "Remove BUFFER from the buffers which may be killed.
3910 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3911 Intended for `after-save-hook'."
3914 ;; Revoke license
3918 ;; Remove this function from the hook.
3923 ;; Find FILE on the scanned lib path and return a buffer visiting it
3925 dir efile)
3933 ;; Find FILE on the scanned lib path and return a buffer visiting it
3934 ;; This is for, e.g., finding source with no user catalog
3941 "Create the IDL tags file IDLTAGS in the current directory from
3942 the list of directories specified in the minibuffer. Directories may be
3943 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
3944 specified top directories are searched if the directory name is prefixed
3945 by @. Specify @ directories with care, it may take a long, long time if
3946 you specify /."
3949 buffer save_buffer files numfiles item errbuf)
3951 ;;
3952 ;; Read list of directories
3955 ;;
3956 ;; Set etags command, vars
3962 ;;
3963 ;; For each directory
3967 ;;
3968 ;; Find the subdirectories
3990 ;;
3991 ;; For each subdirectory
3995 ;;
3996 ;; Call etags
4005 0
4007 ;;
4008 ;; Append additional tags
4015 )))
4027 ))
4030 "Comment the lines in the region if the first non-blank line is
4031 commented, and conversely, uncomment region. If optional prefix arg
4032 N is non-nil, then for N positive, add N comment delimiters or for N
4033 negative, remove N comment delimiters.
4034 Uses `comment-region' which does not place comment delimiters on
4035 blank lines."
4042 ;; skip blank lines
4054 ;; ----------------------------------------------------------------------------
4055 ;; ----------------------------------------------------------------------------
4056 ;; ----------------------------------------------------------------------------
4057 ;; ----------------------------------------------------------------------------
4058 ;;
4059 ;; Completion and Routine Info
4060 ;;
4062 ;; String "intern" functions
4064 ;; For the completion and routine info function, we want to normalize
4065 ;; the case of procedure names etc. We do this by "interning" these
4066 ;; string is a hand-crafted way. Hashes are used to map the downcase
4067 ;; version of the strings to the cased versions. Most *-sint-*
4068 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4069 ;; system hash. The former is re-scanned, and the latter takes case
4070 ;; precedence.
4071 ;;
4072 ;; Since these cased versions are really lisp objects, we can use `eq'
4073 ;; to search, which is a large performance boost. All new strings
4074 ;; need to be "sinterned". We do this as early as possible after
4075 ;; getting these strings from completion or buffer substrings. So
4076 ;; most of the code can simply assume to deal with "sinterned"
4077 ;; strings. The only exception is that the functions which scan whole
4078 ;; buffers for routine information do not intern the grabbed strings.
4079 ;; This is only done afterwards. Therefore in these functions it is
4080 ;; *not* safe to assume the strings can be compared with `eq' and be
4081 ;; fed into the routine assq functions.
4083 ;; Here we define the hashing functions.
4085 ;; The variables which hold the hashes.
4094 "Reset all sintern hashes."
4095 ;; Make sure the hash functions are accessible.
4106 ;; Make sure these are lists
4111 ;; Reset the system & library hash
4119 idlwave-sint-libnames nil))
4121 ;; Reset the buffer & shell hash
4137 ;;(defmacro idlwave-sintern (type var)
4138 ;; `(cond ((not (stringp name)) name)
4139 ;; ((gethash (downcase name) (cdr ,var)))
4140 ;; ((gethash (downcase name) (car ,var)))
4141 ;; (set (idlwave-sintern-set name ,type ,var set))
4142 ;; (name)))
4182 iname))
4185 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4189 kwd-list)
4192 "Sintern all strings in the rinfo LIST.
4193 With optional parameter SET: also set new patterns. Probably this
4194 will always have to be t. If DEFAULT-DIR is passed, it is used as
4195 the base of the directory."
4207 ;; The class and name
4215 ;; The source
4228 ;; The keywords
4231 kwds))
4233 ;; Build a canonicalized list
4238 ;; Creating new sintern tables
4241 "Define a variable and a function to sintern the new type TAG.
4242 This defines the function `idlwave-sintern-TAG' and the variable
4243 `idlwave-sint-TAGs'."
4255 name)
4259 "Reset the sintern variable associated with TAG."
4262 ;;---------------------------------------------------------------------------
4265 ;; The variables which hold the information
4281 "Alist with !PATH directories and zero or more flags if the dir has
4282 been scanned in a user catalog ('user) or discovered in a library
4298 ;;
4299 ;; The code to get routine info from different sources.
4306 "Provide a list of IDL routines.
4307 This routine loads the builtin routines on the first call.
4308 Later it only returns the value of the variable."
4318 ;; Keep it running...
4319 )
4321 ;; Something is wrong, get rid of the process
4330 ;; return the current value
4331 idlwave-routines)))
4334 "List of functions which should run after a global rinfo update.
4338 "Rescan the previously selected directories. For batch processing."
4342 "Dispatch another Emacs instance to update the idlwave catalog.
4343 After the process finishes normally, the first access to routine info
4344 will re-read the catalog."
4368 nil emacs args)))
4371 process
4375 idlwave-system-routines nil
4376 idlwave-catalog-process nil)
4382 ;; Format for all routine info user catalog, library catalogs, etc.:
4383 ;;
4384 ;; ("ROUTINE" type class
4385 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4386 ;; (buffer pro_file dir) | (compiled pro_file dir)
4387 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4388 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4389 ;;
4390 ;; DIR will be supplied dynamically while loading library catalogs,
4391 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4392 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4393 ;; be nil, as can LINK1, etc., if no HTML help is available.
4400 "Update the internal routine-info lists.
4403 about individual routines.
4405 The information can come from 4 sources:
4406 1. IDL programs in the current editing session
4407 2. Compiled modules in an IDL shell running as Emacs subprocess
4408 3. A list which covers the IDL system routines.
4409 4. A list which covers the prescanned library files.
4411 Scans all IDLWAVE-mode buffers of the current editing session (see
4412 `idlwave-scan-all-buffers-for-routine-info').
4413 When an IDL shell is running, this command also queries the IDL program
4414 for currently compiled routines.
4416 With prefix ARG, also reload the system and library lists.
4417 With two prefix ARG's, also rescans the chosen user catalog tree.
4418 With three prefix args, dispatch asynchronous process to do the update.
4420 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4421 lists, but instead wait for the shell query to complete and
4422 asynchronously finish updating routine info. This is set
4423 automatically when called interactively. When you need routine
4424 information updated immediately, leave NO-CONCATENATE nil."
4426 ;; Stop any idle processing
4434 ;; Start a background process which updates the catalog.
4437 ;; Update the user catalog now, and wait for them.
4441 idlwave-buffer-case-takes-precedence
4443 ;; The override-idle means, even if the idle timer has done some
4444 ;; preparing work, load and renormalize everything anyway.
4448 idlwave-compiled-routines nil
4449 idlwave-unresolved-routines nil)
4450 ;; Reset the appropriate hashes
4452 ;; reset was already done in idle time, so skip this step now once
4459 ;; We can safely scan the buffer stuff first
4463 ;; We first do the system info, and then the buffers
4467 ;; Let's see if there is a shell
4471 idlwave-query-shell-for-routine-info)))
4473 ;; Load the library catalogs again, first re-scanning the path
4485 ;; 1. If we are not going to ask the shell, we need to do the
4486 ;; concatenation now.
4487 ;; 2. When this function is called non-interactively, it
4488 ;; means that someone needs routine info *now*. The
4489 ;; shell update causes the concatenation to be
4490 ;; *delayed*, so not in time for the current command.
4491 ;; Therefore, we do a concatenation now, even though
4492 ;; the shell might do it again.
4496 ;; Ask the shell about the routines it knows of.
4519 idlwave-init-rinfo-when-idle-after
4523 ;;------ XML Help routine info system
4525 ;; Load the system routine info from the cached routine info file,
4526 ;; which, if necessary, will be re-created from the XML file on
4527 ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo
4528 ;; file distributed with older IDLWAVE versions (<6.0)
4532 ;; See if we can create it from XML source
4552 idlwave-xml-system-rinfo-converted-file
4553 catalog-file)))
4557 "Alist of system variables and the associated structure tags.
4565 ;; From a list of syntax statements, shorten with %s and group with "or"
4574 x)
4579 ;; Create a class list entry from the xml parsed list., returning a
4580 ;; cons of form (class-entry method-entries).
4586 class-entry
4587 method methods-entry extra-kwds
4588 props get-props set-props init-props inherits
4589 pelem ptype)
4619 init-props)
4622 get-props)
4625 set-props)
4629 methods-entry)))
4632 ;;(unless (get 'init-props 'matched)
4633 ;; (message "Failed to match Init in class %s" class))
4634 ;;(unless (get 'get-props 'matched)
4635 ;; (message "Failed to match GetProperty in class %s" class))
4636 ;;(unless (get 'set-props 'matched)
4637 ;; (message "Failed to match SetProperty in class %s" class))
4645 ;; Create correctly structured list elements from ROUTINE or METHOD
4646 ;; XML list structures. Return a list of list elements, with more
4647 ;; than one sub-list possible if a routine can serve as both
4648 ;; procedure and function (e.g. call_method).
4655 syntax kwd klink pref-list kwds pelem ptype props result type)
4690 ;; Debug
4691 ;; (if (and (null (aref syntax-vec 0))
4692 ;; (null (aref syntax-vec 1))
4693 ;; (null (aref syntax-vec 2)))
4694 ;; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints")
4695 ;; (if class
4696 ;; (insert (format "Missing SYNTAX entry for %s::%s\n" class name))
4697 ;; (insert (message "Missing SYNTAX entry for %s\n" name)))))
4699 ;; Executive commands are treated specially
4711 result)))
4715 ;; Group keywords by link file, as a list with elements
4716 ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2))
4728 ;; Ensure the master link is there
4731 linkfiles
4736 ;; Clean up the syntax of routines which are actually aliases by
4737 ;; removing the "OR" from the statements
4746 ;; Duplicate and trim original routine aliases from rinfo list
4747 ;; This if for, e.g. OPENR/OPENW/OPENU
4757 ;; Add any missing aliases (separate by slashes)
4772 ;; Duplicate and trim original routine aliases from rinfo list
4773 ;; This if for, e.g. !X, !Y, !Z.
4786 ;; Create a sysvar list entry from the xml parsed list.
4794 pelem ptype props tags)
4805 tags))))
4819 ;; Automatically generated from source file:
4824 idlwave-xml-routine-info-file))
4842 "Convert XML supplied IDL routine info into internal form.
4843 Cache to disk for quick recovery."
4849 props rinfo msg-cnt elem type nelem class-result alias
4850 routines routine-aliases statement-aliases sysvar-aliases)
4860 ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff.
4870 idlwave-system-variables-alist nil
4871 idlwave-system-class-info nil
4872 idlwave-executive-commands-alist nil
4873 idlwave-help-special-topic-words nil)
4889 routine-aliases)
4894 ;; a cons cell is an executive commands
4906 idlwave-help-special-topic-words)
4907 ;; Save the links to those which are statement aliases (not routines)
4916 sysvar-aliases)
4918 idlwave-system-variables-alist)))
4929 ;; ("ROUTINE" type class
4930 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4931 ;; (buffer pro_file dir) | (compiled pro_file dir)
4932 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4933 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4943 ;;(load "idlw-rinfo" 'noerror 'nomessage)
4965 ;; Check for the old style catalog and warn
4968 idlwave-library-routines)
4973 idlwave-user-catalog-file))
5000 ;; restart the timer
5005 idlwave-init-rinfo-when-idle-after
5011 ;; Load and case-treat the system, user catalog, and library routine
5012 ;; info files.
5014 ;; System
5016 ;;(load "idlw-rinfo" 'noerror 'nomessage))
5028 ;; User catalog
5037 idlwave-library-routines)
5040 idlwave-user-catalog-file))
5049 ;; Library catalog
5060 ;; Scan all buffers, current buffer last
5065 ;; Don't scan any buffers
5068 ;; Just scan this buffer
5074 ;; Put the result into the correct variable
5079 "Put the different sources for routine information together."
5080 ;; The sequence here is important because earlier definitions shadow
5081 ;; later ones. We assume that if things in the buffers are newer
5082 ;; then in the shell of the system, they are meant to be different.
5084 idlwave-compiled-routines
5085 idlwave-library-catalog-routines
5086 idlwave-user-catalog-routines)))
5087 ;; Not actually used for anything?
5093 ;; Give a message with information about the number of routines we have.
5096 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
5106 "Return the class alist - make it if necessary."
5113 idlwave-class-alist)))
5115 ;; Three functions for the hooks
5124 "Update `idlwave-routines' for current buffer.
5125 Can run from `after-save-hook'."
5129 idlwave-scan-all-buffers-for-routine-info
5130 idlwave-routines)
5136 nil
5142 routines)
5146 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
5148 found)
5150 ;; The following test uses eq to make sure it works correctly
5151 ;; when two buffers visit the same file. Then the file names
5152 ;; will be equal, but not eq.
5158 ;; End of that section reached. Jump.
5164 ;;----- Scanning buffers -------------------
5167 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
5173 buffer-file-name)
5174 ;; yes, this buffer has the right mode.
5179 ;; Concatenate the individual lists and return the result
5183 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
5185 routine-list string entry)
5199 routine-list))
5204 "Parse a module definition."
5206 start name args type keywords class)
5207 ;; Remove comments
5210 ;; Remove the continuation line stuff
5215 ;; Match the name and type.
5223 ;; Match normal args and keyword args
5226 string start)
5231 ;; Normalize and sort.
5235 ;; Make and return the entry
5236 ;; We don't know which argument are optional, so this information
5237 ;; will not be contained in the calling sequence.
5240 class
5243 ; ((string= (downcase (file-name-base))
5244 ; (downcase name))
5245 ; (list 'lib))
5246 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
5252 "%s"
5260 nil))))
5263 ;;----- Scanning the user catalog -------------------
5266 "Return the syslib directory, or a dummy that never matches."
5270 idlwave-system-directory)
5276 "Scan all files on selected dirs of IDL search path for routine information.
5278 A widget checklist will allow you to choose the directories. Write
5279 the result as a file `idlwave-user-catalog-file'. When this file
5280 exists, it will be automatically loaded to give routine information
5281 about library routines. With ARG, just rescan the same directories
5282 as last time - so no widget will pop up."
5284 ;; Make sure the file is loaded if it exists.
5290 ;; Make sure the file name makes sense
5296 idlwave-user-catalog-file))))
5300 ;; Rescan the known directories
5305 ;; Expand the directories from library-path and run the widget
5309 ;; Propagate any flags on the existing path-alist
5312 idlwave-true-path-alist)))
5319 ;; Ask the shell for the path and then run the widget
5328 ;; Parse shell path information and select among it.
5330 ;; Command hook used by `idlwave-create-user-catalog-file'.
5332 ;; Scan immediately
5334 ;; Set the path and display the widget
5340 "This is the front-end to the creation of the IDLWAVE user catalog.
5341 Please select the directories on IDL's search path from which you
5342 would like to extract routine information, to be stored in the file:
5344 %s
5346 If this is not the correct file, first set variable
5347 `idlwave-user-catalog-file', and call this command again.
5349 N.B. Many libraries include pre-scanned catalog files
5351 not be scanned. You can scan your own libraries off-line using the
5352 perl script `idlwave_catalog'.
5354 After selecting the directories, choose [Scan & Save] to scan the library
5355 directories and save the routine info.
5361 "Create the widget to select IDL search path directories for scanning."
5373 idlwave-user-catalog-file))
5384 :notify
5394 :notify
5412 'checklist
5416 dirs-list))
5417 :greedy t
5439 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
5444 dir-entry)
5450 selected-dirs)
5457 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5461 dirs-alist dir files file)
5463 idlwave-path-alist path-alist ; for library-path instead
5464 idlwave-true-path-alist nil)
5485 idlwave-user-catalog-routines)))))))))
5493 ;; Define the routine info list
5500 idlwave-user-catalog-routines))
5507 idlwave-user-catalog-file)
5524 ;; Define the variable which knows the value of "!DIR"
5526 idlwave-system-directory))
5528 ;; Define the variable which contains a list of all scanned directories
5535 idlwave-path-alist))
5540 ;; Expand parts of path starting with '+' recursively into directory list.
5541 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5551 ;; Expand recursively
5553 ;; Keep unchanged
5559 ;; Return a list of all directories below DIR, including DIR itself
5568 path1))
5571 ;;----- Scanning the library catalogs ------------------
5577 "Scan for library catalog files (.idlwave_catalog) and ingest.
5579 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5580 instead, if present) are searched. Print MESSAGE-BASE along with the
5581 libraries being loaded, if passed, and skip loading/normalizing if
5582 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5583 be set to nil to disable library catalog scanning."
5590 dir-entry dir catalog all-routines)
5598 ;; Load the catalog file
5603 message-base
5605 old-libname)))
5607 idlwave-library-catalog-libname))
5614 all-routines))))
5616 ;; Add a 'lib flag if on path-alist
5623 ;;----- Communicating with the Shell -------------------
5625 ;; First, here is the idl program which can be used to query IDL for
5626 ;; defined routines.
5628 "
5629 ;; START OF IDLWAVE SUPPORT ROUTINES
5630 pro idlwave_print_safe,item,limit
5631 catch,err
5632 if err ne 0 then begin
5633 print,'Could not print item.'
5634 return
5635 endif
5636 if n_elements(item) gt limit then $
5637 print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $
5638 else print,item
5639 end
5641 pro idlwave_print_info_entry,name,func=func,separator=sep
5642 ;; See if it's an object method
5643 if name eq '' then return
5644 func = keyword_set(func)
5645 methsep = strpos(name,'::')
5646 meth = methsep ne -1
5648 ;; Get routine info
5649 pars = routine_info(name,/parameters,functions=func)
5650 source = routine_info(name,/source,functions=func)
5651 nargs = pars.num_args
5652 nkw = pars.num_kw_args
5653 if nargs gt 0 then args = pars.args
5654 if nkw gt 0 then kwargs = pars.kw_args
5656 ;; Trim the class, and make the name
5657 if meth then begin
5658 class = strmid(name,0,methsep)
5659 name = strmid(name,methsep+2,strlen(name)-1)
5660 if nargs gt 0 then begin
5661 ;; remove the self argument
5662 wh = where(args ne 'SELF',nargs)
5663 if nargs gt 0 then args = args[wh]
5664 endif
5665 endif else begin
5666 ;; No class, just a normal routine.
5668 endelse
5670 ;; Calling sequence
5672 if func then cs = 'Result = '
5673 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5674 cs = cs + '%s'
5675 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5676 if nargs gt 0 then begin
5677 for j=0,nargs-1 do begin
5678 cs = cs + args[j]
5679 if j lt nargs-1 then cs = cs + ', '
5680 endfor
5681 end
5682 if func then cs = cs + ')'
5683 ;; Keyword arguments
5684 kwstring = ''
5685 if nkw gt 0 then begin
5686 for j=0,nkw-1 do begin
5687 kwstring = kwstring + ' ' + kwargs[j]
5688 endfor
5689 endif
5691 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5693 print,ret + ': ' + name + sep + class + sep + source[0].path $
5694 + sep + cs + sep + kwstring
5695 end
5697 pro idlwave_routine_info,file
5698 on_error,1
5699 sep = '<@>'
5701 all = routine_info()
5702 fileQ=n_elements(file) ne 0
5703 if fileQ then file=strtrim(file,2)
5704 for i=0L,n_elements(all)-1L do begin
5705 if fileQ then begin
5706 if (routine_info(all[i],/SOURCE)).path eq file then $
5707 idlwave_print_info_entry,all[i],separator=sep
5708 endif else idlwave_print_info_entry,all[i],separator=sep
5709 endfor
5710 all = routine_info(/functions)
5711 for i=0L,n_elements(all)-1L do begin
5712 if fileQ then begin
5713 if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $
5714 idlwave_print_info_entry,all[i],separator=sep,/FUNC
5715 endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC
5716 endfor
5717 print,'>>>END OF IDLWAVE ROUTINE INFO'
5718 end
5720 pro idlwave_get_sysvars
5721 on_error,1
5722 catch,error_status
5723 if error_status ne 0 then begin
5724 print, 'Cannot get info about system variables'
5725 endif else begin
5726 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5727 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5728 v = strsplit(s,' +',/regex,/extract) ; get variables
5729 for i=0L,n_elements(v)-1 do begin
5730 t = [''] ; get tag list
5731 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5732 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5733 endfor
5734 endelse
5735 end
5737 pro idlwave_get_class_tags, class
5738 res = execute('tags=tag_names({'+class+'})')
5739 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5740 end
5741 ;; END OF IDLWAVE SUPPORT ROUTINES
5742 "
5763 (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5768 ;; Restore if necessary. Must use execute to hide lame routine_info
5769 ;; errors on undefined routine
5771 (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'"
5772 idlwave-shell-temp-rinfo-save-file
5773 idlwave-shell-temp-rinfo-save-file)
5778 "Query the shell for routine_info of compiled modules and update the lists."
5779 ;; Save and compile the procedure. The compiled procedure is then
5780 ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may
5781 ;; need to test for and possibly RESTORE the procedure each time we
5782 ;; use it, since the user may have killed or redefined it. In
5783 ;; particular, .RESET_SESSION will kill all user procedures. If
5784 ;; FILE is set, only update routine info for routines in that file.
5787 ; execute the routine_info procedure, and analyze the output
5795 ;; ---------------------------------------------------------------------------
5796 ;;
5797 ;; Completion and displaying routine calling sequences
5809 "Complete a function, procedure or keyword name at point.
5810 This function is smart and figures out what can be completed
5811 at this point.
5812 - At the beginning of a statement it completes procedure names.
5813 - In the middle of a statement it completes function names.
5814 - After a `(' or `,' in the argument list of a function or procedure,
5815 it completes a keyword of the relevant function or procedure.
5816 - In the first arg of `OBJ_NEW', it completes a class name.
5818 When several completions are possible, a list will be displayed in
5819 the *Completions* buffer. If this list is too long to fit into the
5820 window, scrolling can be achieved by repeatedly pressing
5823 The function also knows about object methods. When it needs a class
5824 name, the action depends upon `idlwave-query-class', which see. You
5825 can force IDLWAVE to ask you for a class name with a
5828 See also the variables `idlwave-keyword-completion-adds-equal' and
5829 `idlwave-function-completion-adds-paren'.
5831 The optional ARG can be used to specify the completion type in order
5832 to override IDLWAVE's idea of what should be completed at point.
5833 Possible values are:
5835 0 <=> query for the completion type
5836 1 <=> 'procedure
5837 2 <=> 'procedure-keyword
5838 3 <=> 'function
5839 4 <=> 'function-keyword
5840 5 <=> 'procedure-method
5841 6 <=> 'procedure-method-keyword
5842 7 <=> 'function-method
5843 8 <=> 'function-method-keyword
5844 9 <=> 'class
5846 As a special case, the universal argument C-u forces completion of
5847 function names in places where the default would be a keyword.
5849 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5850 completion.
5852 For Lisp programmers only:
5853 When we force a keyword, optional argument MODULE can contain the module name.
5854 When we force a method or a method keyword, CLASS can specify the class."
5881 ;; Complete a filename in quotes
5886 ;; Check for any special completion functions
5893 ;; Complete a class
5899 ;; Complete a procedure name
5912 isa
5918 isa
5922 ;; Complete a function name
5935 isa
5941 isa
5949 ;; Complete a procedure keyword
5966 super-classes system))
5978 isa
5982 ;; Complete a function keyword
5995 msg-name)
6000 super-classes system))
6001 ;; OBJ_NEW: Messages mention the proper Init method
6008 msg-name))
6017 isa
6023 "List of special completion functions.
6024 These functions are called for each completion. Each function must
6025 check if its own special completion context is present. If yes, it
6026 should use `idlwave-complete-in-buffer' to do some completion and
6027 return t. If such a function returns t, *no further* attempts to
6028 complete other contexts will be done. If the function returns nil,
6033 fun ret)
6038 nil)))
6041 ;; Return an artificial WHERE specification to force the completion
6042 ;; routine to complete a specific item independent of context.
6043 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
6044 ;; MODULE and CLASS can be used to specify the routine name and class.
6045 ;; The class name will also be found in MODULE if that is like "class::mod".
6063 what)
6136 ;; Completing read, case insensitive
6146 "Use the comint stuff to complete a file name."
6154 idlwave-shell-default-directory
6155 default-directory)))
6159 ;; Make a fully qualified module name including the class name
6163 "Like `idlwave-rinfo-assq', but sintern strings first."
6169 ;; Works like assq, but also checks type and class
6180 ;; Return the first matching method on the inheritance list
6182 class rtn)
6186 rtn))
6189 keep-system)
6190 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
6191 If WITH-FILE is passed, find the best rinfo entry with a file
6192 included. If KEEP-SYSTEM is set, don't prune system for compiled
6193 syslib files."
6196 list))
6197 syslibp)
6204 ;; Its a compiled syslib, so we need to remove the system entry
6210 twins)))))
6214 keep-system)
6215 "Like `idlwave-best-rinfo-assq', but sintern strings first."
6221 "Does the entry list ENTRIES contain a syslib entry?
6222 If yes, return the index (>=1)."
6231 nil)))
6234 "Return a list of all associations of Key in LIST."
6242 "Return all classes which have a method METHOD.
6243 TYPE is 'fun or 'pro.
6244 When TYPE is not specified, both procedures and functions will be considered."
6257 "Return all classes which have a method METHOD with keyword KEYWORD.
6258 TYPE is 'fun or 'pro.
6259 When TYPE is not specified, both procedures and functions will be considered."
6262 nil
6274 "Return list of all elements in LIST which are also in CLUB."
6283 "Return list of all elements in LIST which are not in CLUB."
6287 nil
6293 "Return whether or not the class is listed explicitly, ala a->b::c.
6294 INFO is as returned by `idlwave-what-function' or `-procedure'."
6301 "List of special functions for determining class.
6305 ;; Determine the class of a routine call.
6306 ;; INFO is the `cw-list' structure as returned by idlwave-where.
6307 ;; The second element in this structure is the class. When nil, we
6308 ;; return nil. When t, try to get the class from text properties at
6309 ;; the arrow. When the object is "self", we use the class of the
6310 ;; current routine. otherwise prompt the user for a class name.
6311 ;; Also stores the selected class as a text property at the arrow.
6312 ;; TYPE is 'fun or 'pro.
6318 idlwave-query-class))
6320 idlwave-query-class))
6332 store special-class class-alist)
6336 ;; There is an object which would like to know its class
6338 idlwave-store-inquired-class
6345 ;; Before prompting, try any special class determination routines
6347 idlwave-determine-class-special
6353 store idlwave-store-inquired-class)))
6355 ;; Prompt for a class, if we need to
6376 ;; Store it, if requested
6378 ;; We have a real class here
6384 rear-nonsticky t))
6387 ;; Return the class
6388 class)
6389 ;; Default as fallback
6399 ;; Record a file link, if any, for the tested names during selection.
6403 sel))
6407 "Find out where we are.
6408 The return value is a list with the following stuff:
6409 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
6411 PRO-LIST (PRO POINT CLASS ARROW)
6412 FUNC-LIST (FUNC POINT CLASS ARROW)
6413 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
6414 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
6415 be completed here.
6416 LAST-CHAR last relevant character before point (non-white non-comment,
6417 not part of current identifier or leading slash).
6419 In the lists, we have these meanings:
6420 PRO: Procedure name
6421 FUNC: Function name
6422 POINT: Where is this
6423 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
6424 ARROW: Location of the arrow"
6442 cw cw-mod cw-arrow cw-class cw-point)
6446 match-string)
6452 match-string))
6454 cw-arrow pro-arrow))
6456 match-string)
6457 nil)
6459 match-string)
6462 match-string)
6469 cw-class func-class cw-arrow func-arrow))
6472 cw-class pro-class cw-arrow pro-arrow))
6473 ; ((member last-char '(?\' ?\) ?\] ?!))
6474 ; ;; after these chars, a function makes no sense
6475 ; ;; FIXME: I am sure there can be more in this list
6476 ; ;; FIXME: Do we want to do this at all?
6477 ; nil)
6478 ;; Everywhere else we try a function.
6482 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t)
6486 t))))))
6489 cw
6491 last-char)))
6494 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6502 ;; Find out if point is within the argument list of a function.
6503 ;; The return value is ("function-name" class arrow-start (point) level).
6504 ;; Level is 1 on the top level parentheses, higher further down.
6506 ;; If the optional BOUND is an integer, bound backwards directed
6507 ;; searches to this point.
6511 func-point
6513 func arrow-start class)
6518 ;; move back out of the current parenthesis
6527 bound t))
6530 pos func-point)
6536 'exit
6540 arrow-start func-point cnt)))
6545 ;; Find out if point is within the argument list of a procedure.
6546 ;; The return value is ("procedure-name" class arrow-pos (point)).
6548 ;; If the optional BOUND is an integer, bound backwards directed
6549 ;; searches to this point.
6551 pro class arrow-start string)
6553 ;;(idlwave-beginning-of-statement)
6563 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6564 string))
6569 pos)
6574 arrow-start
6575 pro-point)))
6578 ;; If there is an object at point, move over it and return t.
6588 nil)
6606 nil)))
6609 "Return the last character before point which is not white or a comment
6610 and also not part of the current identifier. Since we do this in
6611 order to identify places where keywords are, we consider the initial
6612 `/' of a keyword as part of the identifier.
6613 This function is not general, can only be used for completion stuff."
6616 ;; skip the current identifier
6618 ;; also skip a leading slash which might be belong to the keyword
6621 ;; FIXME: does not check if this is a valid identifier
6629 ;; continuation line
6643 &optional prepare-display-function
6644 special-selector)
6645 "Perform TYPE completion of word before point against LIST.
6646 SELECTOR is the PREDICATE argument for the completion function. Show
6647 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6648 'procedure, 'class-tag, 'keyword, 'sysvar, etc. SPECIAL-SELECTOR is
6649 used only once, for `all-completions', and can be used to, e.g.,
6650 accumulate information on matching completions."
6653 dpart dcompletion)
6658 ;; What is already in the buffer?
6663 idlwave-complete-after-success-form
6666 idlwave-complete-after-success-form-force
6670 ;; Try a completion
6676 idlwave-completion-help-links nil)
6679 ;; nothing available.
6683 ;; We can add something
6687 idlwave-complete-empty-string-as-lower-case)
6689 dcompletion
6690 completion))
6692 ;; Now this is a unique match
6694 t)
6700 selector))))))
6702 ;; This is already complete
6705 nil)
6707 ;; We cannot add something - offer a list.
6715 idlwave-completion-help-links))))
6716 list))
6718 ;; "complete" means, this is already a valid completion
6721 ;; (completion-fixup-function ; Emacs
6722 ;; (lambda () (and (eq (preceding-char) ?>)
6723 ;; (re-search-backward " <" beg t)))))
6731 idlwave-complete-empty-string-as-lower-case)
6737 x)
6738 list)))
6740 t))))
6743 "Complete a class at point."
6745 ;; Call `idlwave-routines' to make sure the class list will be available
6747 ;; Check for the special case of completing empty string after pro/function
6756 ;; Yank the full class specification
6758 ;; Do the completion, using list gathered from `idlwave-routines'
6767 idlwave-completion-help-links))
6768 x))
6769 list)))))
6772 ;; Attach the proper class list to a LIST of completion items.
6773 ;; TYPE, when 'kwd, shows classes for method keywords, when
6774 ;; 'class-tag, for class tags, and otherwise for methods.
6775 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6781 ;; In these cases, we do not have to do anything
6782 list
6786 ;; (do-dots (featurep 'xemacs))
6792 classes nclasses class-info space)
6795 ;; get the classes
6797 ;; Just one class for tags
6801 ;; Multiple classes for method or method-keyword
6805 method-selector x type-selector)
6811 classes)))))
6813 ;; Make the separator between item and class-info
6818 ;; We do want info in the buffer
6821 space
6826 ;; We do want properties
6830 x))
6833 x))
6834 list))))
6837 ;; Call idlwave-attach-classes with method parameters
6840 ;; Call idlwave-attach-classes with keyword parameters
6843 ;; Call idlwave-attach-classes with class structure tags
6847 ;;----------------------------------------------------------------------
6848 ;;----------------------------------------------------------------------
6849 ;;----------------------------------------------------------------------
6850 ;;----------------------------------------------------------------------
6851 ;;----------------------------------------------------------------------
6858 "Select an item in LIST with a popup menu.
6859 TITLE is the title to put atop the popup. If SORT is non-nil,
6860 sort the list before displaying."
6862 rtn menu)
6872 x)))
6873 list)))
6886 rtn))
6889 "Split the MENU into submenus of maximum length N."
6891 ;; No splitting needed
6892 menu
6907 nextmenu))
6909 nextmenu nil
6914 "Split the MENU into submenus of maximum length N."
6916 ;; No splitting needed
6917 menu
6933 nextmenu))
6935 nextmenu nil
6939 menu)))
6944 "Scroll the completion window on this frame."
6962 "Display the completions in LIST in the completions buffer and echo MESSAGE."
6970 list)
6973 ;; Store a special value in `this-command'. When `idlwave-complete'
6974 ;; finds this in `last-command', it will scroll the *Completions* buffer.
6977 ;; Mark the completions buffer as created by cib
6980 ;; Fontify the classes
6985 ;; Run the hook
6988 ;; Display the message
6992 "Call FUNCTION as a completion chooser and pass ARGS to it."
6998 ;; For the shell, remove the fontification of the word before point
7013 "Restore the old (before completion) window configuration."
7015 idlwave-before-completion-wconf
7019 "Make the user select an element from the alist in the variable SYM.
7020 The keys of the alist are expected to be strings. The function returns the
7021 car of the selected association.
7022 To do this, PROMPT is displayed and the user must hit a letter key to
7023 select an entry. If the user does not reply within DELAY seconds, a help
7024 window with the options is displayed automatically.
7025 The key which is associated with each option is generated automatically.
7027 If these don't exist, a letter in the string is automatically selected."
7031 keys-alist char)
7032 ;; First check the cache
7035 ;; Need to make new list
7039 ;; Display prompt and wait for quick reply
7044 ;; No quick reply: Show help
7053 ;; Return the selected result
7056 ;; Used for, e.g., electric debug super-examine.
7058 "Make an alist for single key selection."
7066 ;; First check if the configuration predetermined a key
7073 ;; Then check for capital letters
7083 t t name))
7086 ;; Now check for lowercase letters
7096 t t name))
7099 ;; Bummer, nothing found! Use a stupid number
7106 "Set the buffer-local value of VAR in BUFFER to VALUE."
7111 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
7116 ;; In XEmacs, we can use :activate-callback directly to advice the
7117 ;; choose functions. We use the private keymap only for the online
7118 ;; help feature.
7127 cl-args))
7136 "Execute `default-choose-completion' and then restore the win-conf."
7140 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7143 (define-key new-map [button3] (lambda ()
7144 (interactive)
7145 (setq this-command last-command)))
7146 new-map))
7148 ;; In Emacs we also replace keybindings in the completion
7149 ;; map in order to install our wrappers.
7151 (defun idlwave-display-completion-list-emacs (list)
7152 "Display completion list and install the choose wrappers."
7153 (with-output-to-temp-buffer "*Completions*"
7154 (display-completion-list list))
7155 (with-current-buffer "*Completions*"
7156 (use-local-map
7157 (or idlwave-completion-map
7158 (setq idlwave-completion-map
7159 (idlwave-make-modified-completion-map-emacs
7160 (current-local-map)))))))
7162 (defun idlwave-make-modified-completion-map-emacs (old-map)
7163 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7164 (let ((new-map (copy-keymap old-map)))
7165 (substitute-key-definition
7166 'choose-completion 'idlwave-choose-completion new-map)
7167 (substitute-key-definition
7168 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
7169 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
7170 new-map))
7172 (defun idlwave-choose-completion (&rest args)
7173 "Choose the completion that point is in or next to."
7174 (interactive (list last-nonmenu-event))
7175 (apply 'idlwave-choose 'choose-completion args))
7177 (defun idlwave-mouse-choose-completion (&rest args)
7178 "Click on an alternative in the `*Completions*' buffer to choose it."
7179 (interactive "e")
7180 (apply 'idlwave-choose 'mouse-choose-completion args))
7182 ;;----------------------------------------------------------------------
7183 ;;----------------------------------------------------------------------
7185 ;;; ------------------------------------------------------------------------
7186 ;;; Structure parsing code, and code to manage class info
7188 ;;
7189 ;; - Go again over the documentation how to write a completion
7190 ;; plugin. It is in self.el, but currently still very bad.
7191 ;; This could be in a separate file in the distribution, or
7192 ;; in an appendix for the manual.
7194 (defvar idlwave-struct-skip
7196 "Regexp for skipping continued blank or comment-only lines in structures.")
7198 (defvar idlwave-struct-tag-regexp
7199 (concat "[{,]" ;leading comma/brace
7200 idlwave-struct-skip ; 4 groups
7203 "Regexp for structure tags.")
7205 (defun idlwave-struct-tags ()
7206 "Return a list of all tags in the structure defined at point.
7207 Point is expected just before the opening `{' of the struct definition."
7208 (save-excursion
7209 (let* ((borders (idlwave-struct-borders))
7210 (beg (car borders))
7211 (end (cdr borders))
7212 tags)
7213 (goto-char beg)
7214 (save-restriction
7215 (narrow-to-region beg end)
7216 (while (re-search-forward idlwave-struct-tag-regexp end t)
7217 ;; Check if we are still on the top level of the structure.
7218 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7219 (= (point) beg))
7220 (push (match-string-no-properties 5) tags))
7221 (goto-char (match-end 0))))
7222 (nreverse tags))))
7224 (defun idlwave-find-struct-tag (tag)
7225 "Find a given TAG in the structure defined at point."
7226 (let* ((borders (idlwave-struct-borders))
7227 (end (cdr borders))
7228 (case-fold-search t))
7230 end t)))
7232 (defun idlwave-struct-inherits ()
7233 "Return a list of all `inherits' names in the struct at point.
7234 Point is expected just before the opening `{' of the struct definition."
7235 (save-excursion
7236 (let* ((borders (idlwave-struct-borders))
7237 (beg (car borders))
7238 (end (cdr borders))
7239 (case-fold-search t)
7240 names)
7241 (goto-char beg)
7242 (save-restriction
7243 (narrow-to-region beg end)
7244 (while (re-search-forward
7245 (concat "[{,]" ;leading comma/brace
7246 idlwave-struct-skip ; 4 groups
7247 "inherits" ; The INHERITS tag
7248 idlwave-struct-skip ; 4 more
7250 end t)
7251 ;; Check if we are still on the top level of the structure.
7252 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7253 (= (point) beg))
7254 (push (match-string-no-properties 9) names))
7255 (goto-char (match-end 0))))
7256 (nreverse names))))
7258 (defun idlwave-in-structure ()
7259 "Return t if point is inside an IDL structure definition."
7260 (let ((beg (point)))
7261 (save-excursion
7262 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
7263 (if (idlwave-find-structure-definition nil nil 'back)
7264 (let ((borders (idlwave-struct-borders)))
7265 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
7266 (and (> beg (car borders)) (< beg (cdr borders))))))))))
7268 (defun idlwave-struct-borders ()
7269 "Return the borders of the {...} after point as a cons cell."
7270 (let (beg)
7271 (save-excursion
7272 (skip-chars-forward "^{")
7273 (setq beg (point))
7274 (condition-case nil (forward-list 1)
7275 (error (goto-char beg)))
7276 (cons beg (point)))))
7278 (defun idlwave-find-structure-definition (&optional var name bound)
7279 "Search forward for a structure definition.
7280 If VAR is non-nil, search for a structure assigned to variable VAR.
7281 If NAME is non-nil, search for a named structure NAME, if a string,
7282 or a generic named structure otherwise. If BOUND is an integer, limit
7283 the search. If BOUND is the symbol `all', we search first back and
7284 then forward through the entire file. If BOUND is the symbol `back'
7285 we search only backward."
7287 (case-fold-search t)
7288 (lim (if (integerp bound) bound nil))
7289 (re (concat
7290 (if var
7294 (if name
7295 (if (stringp name)
7297 ;; Just a generic name
7299 ""))))
7300 (if (or (and (or (eq bound 'all) (eq bound 'back))
7301 (re-search-backward re nil t))
7302 (and (not (eq bound 'back)) (re-search-forward re lim t)))
7303 (progn
7304 (goto-char (match-beginning 3))
7305 (match-string-no-properties 5)))))
7307 (defvar idlwave-class-info nil)
7308 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
7310 (add-hook 'idlwave-update-rinfo-hook
7311 (lambda () (setq idlwave-class-reset t)))
7312 (add-hook 'idlwave-after-load-rinfo-hook
7313 (lambda () (setq idlwave-class-info nil)))
7315 (defun idlwave-class-info (class)
7316 (let (list entry)
7317 (if idlwave-class-info
7318 (if idlwave-class-reset
7319 (setq
7320 idlwave-class-reset nil
7321 idlwave-class-info ; Remove any visited in a buffer
7322 (delq nil (mapcar
7323 (lambda (x)
7324 (let ((filebuf
7325 (idlwave-class-file-or-buffer
7326 (or (cdr (assq 'found-in x)) (car x)))))
7327 (if (cdr filebuf)
7328 nil
7329 x)))
7330 idlwave-class-info))))
7331 ;; Info is nil, put in the system stuff to start.
7332 (setq idlwave-class-info idlwave-system-class-info)
7333 (setq list idlwave-class-info)
7334 (while (setq entry (pop list))
7335 (idlwave-sintern-class-info entry)))
7336 (setq class (idlwave-sintern-class class))
7337 (or (assq class idlwave-class-info)
7338 (progn (idlwave-scan-class-info class)
7339 (assq class idlwave-class-info)))))
7341 (defun idlwave-sintern-class-info (entry)
7342 "Sintern the class names in a class-info entry."
7343 (let ((inherits (assq 'inherits entry)))
7344 (setcar entry (idlwave-sintern-class (car entry) 'set))
7345 (if inherits
7346 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
7347 (cdr inherits))))))
7349 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
7350 "Find class structure definition(s).
7351 If ALL-HOOK is set, find all named structure definitions in a given
7352 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
7353 set, look for the name__define pro, and inside of it, for the ALT-CLASS
7354 class/struct definition."
7355 (let ((case-fold-search t) end-lim name)
7356 (when (re-search-forward
7358 (if all-hook
7359 (progn
7360 ;; For everything there
7361 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
7362 (while (setq name
7363 (idlwave-find-structure-definition nil t end-lim))
7364 (funcall all-hook name)))
7365 (idlwave-find-structure-definition nil (or alt-class class))))))
7368 (defun idlwave-class-file-or-buffer (class)
7369 "Find buffer visiting CLASS definition."
7370 (let* ((pro (concat (downcase class) "__define"))
7371 (file (idlwave-routine-source-file
7372 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
7373 (idlwave-routines))))))
7374 (cons file (if file (idlwave-get-buffer-visiting file)))))
7377 (defun idlwave-scan-class-info (class)
7378 "Scan all class and named structure info in the class__define pro."
7379 (let* ((idlwave-auto-routine-info-updates nil)
7380 (filebuf (idlwave-class-file-or-buffer class))
7381 (file (car filebuf))
7382 (buf (cdr filebuf))
7383 (class (idlwave-sintern-class class)))
7384 (if (or
7385 (not file)
7386 (and ;; neither a regular file nor a visited buffer
7387 (not buf)
7388 (not (file-regular-p file))))
7389 nil ; Cannot find the file/buffer to get any info
7390 (save-excursion
7391 (if buf (set-buffer buf)
7392 ;; Read the file in temporarily
7393 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
7394 (erase-buffer)
7395 (unless (derived-mode-p 'idlwave-mode)
7396 (idlwave-mode))
7397 (insert-file-contents file))
7398 (save-excursion
7399 (goto-char 1)
7400 (idlwave-find-class-definition class
7401 ;; Scan all of the structures found there
7402 (lambda (name)
7403 (let* ((this-class (idlwave-sintern-class name))
7404 (entry
7405 (list this-class
7406 (cons 'tags (idlwave-struct-tags))
7407 (cons 'inherits (idlwave-struct-inherits)))))
7408 (if (not (eq this-class class))
7409 (setq entry (nconc entry (list (cons 'found-in class)))))
7410 (idlwave-sintern-class-info entry)
7411 (push entry idlwave-class-info)))))))))
7413 (defun idlwave-class-found-in (class)
7414 "Return the FOUND-IN property of the CLASS."
7415 (cdr (assq 'found-in (idlwave-class-info class))))
7416 (defun idlwave-class-tags (class)
7417 "Return the native tags in CLASS."
7418 (cdr (assq 'tags (idlwave-class-info class))))
7419 (defun idlwave-class-inherits (class)
7420 "Return the direct superclasses of CLASS."
7421 (cdr (assq 'inherits (idlwave-class-info class))))
7424 (defun idlwave-all-class-tags (class)
7425 "Return a list of native and inherited tags in CLASS."
7426 (condition-case err
7427 (apply 'append (mapcar 'idlwave-class-tags
7428 (cons class (idlwave-all-class-inherits class))))
7429 (error
7430 (idlwave-class-tag-reset)
7431 (error "%s" (error-message-string err)))))
7434 (defun idlwave-all-class-inherits (class)
7435 "Return a list of all superclasses of CLASS (recursively expanded).
7436 The list is cached in `idlwave-class-info' for faster access."
7437 (cond
7438 ((not idlwave-support-inheritance) nil)
7439 ((eq class nil) nil)
7440 ((eq class t) nil)
7441 (t
7442 (let ((info (idlwave-class-info class))
7443 entry)
7444 (if (setq entry (assq 'all-inherits info))
7445 (cdr entry)
7446 ;; Save the depth of inheritance scan to check for circular references
7447 (let ((inherits (mapcar (lambda (x) (cons x 0))
7448 (idlwave-class-inherits class)))
7449 rtn all-inherits cl)
7450 (while inherits
7451 (setq cl (pop inherits)
7452 rtn (cons (car cl) rtn)
7453 inherits (append (mapcar (lambda (x)
7454 (cons x (1+ (cdr cl))))
7455 (idlwave-class-inherits (car cl)))
7456 inherits))
7457 (if (> (cdr cl) 999)
7458 (error
7459 "Class scan: inheritance depth exceeded. Circular inheritance?")
7460 ))
7461 (setq all-inherits (nreverse rtn))
7462 (nconc info (list (cons 'all-inherits all-inherits)))
7463 all-inherits))))))
7465 (defun idlwave-entry-keywords (entry &optional record-link)
7466 "Return the flat entry keywords alist from routine-info entry.
7467 If RECORD-LINK is non-nil, the keyword text is copied and a text
7468 property indicating the link is added."
7469 (let (kwds)
7470 (mapc
7471 (lambda (key-list)
7472 (let ((file (car key-list)))
7473 (mapcar (lambda (key-cons)
7474 (let ((key (car key-cons))
7475 (link (cdr key-cons)))
7476 (when (and record-link file)
7477 (setq key (copy-sequence key))
7478 (put-text-property
7479 0 (length key)
7480 'link
7481 (concat
7482 file
7483 (if link
7484 (concat idlwave-html-link-sep
7485 (number-to-string link))))
7486 key))
7487 (push (list key) kwds)))
7488 (cdr key-list))))
7489 (nthcdr 5 entry))
7490 (nreverse kwds)))
7492 (defun idlwave-entry-find-keyword (entry keyword)
7493 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set."
7494 (catch 'exit
7495 (mapc
7496 (lambda (key-list)
7497 (let ((file (car key-list))
7498 (kwd (assoc keyword (cdr key-list))))
7499 (when kwd
7500 (setq kwd (cons (car kwd)
7501 (if (and file (cdr kwd))
7502 (concat file
7503 idlwave-html-link-sep
7504 (number-to-string (cdr kwd)))
7505 (cdr kwd))))
7506 (throw 'exit kwd))))
7507 (nthcdr 5 entry))))
7509 ;;==========================================================================
7510 ;;
7511 ;; Completing class structure tags. This is a completion plugin.
7512 ;; The necessary taglist is constructed dynamically
7514 (defvar idlwave-current-tags-class nil)
7515 (defvar idlwave-current-class-tags nil)
7516 (defvar idlwave-current-native-class-tags nil)
7517 (defvar idlwave-sint-class-tags nil)
7518 (declare-function idlwave-sintern-class-tag "idlwave" t t)
7519 (idlwave-new-sintern-type 'class-tag)
7520 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7521 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7523 (defun idlwave-complete-class-structure-tag ()
7524 "Complete a structure tag on a `self' argument in an object method."
7525 (interactive)
7526 (let ((pos (point))
7527 (case-fold-search t))
7528 (if (save-excursion
7529 ;; Check if the context is right
7530 (skip-chars-backward "a-zA-Z0-9._$")
7531 (and (< (point) (- pos 4))
7533 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7534 (super-classes (idlwave-all-class-inherits class-selector)))
7535 ;; Check if we are in a class routine
7536 (unless class-selector
7537 (error "Not in a method procedure or function"))
7538 ;; Check if we need to update the "current" class
7539 (if (not (equal class-selector idlwave-current-tags-class))
7540 (idlwave-prepare-class-tag-completion class-selector))
7541 (setq idlwave-completion-help-info
7542 (list 'idlwave-complete-class-structure-tag-help
7543 (idlwave-sintern-routine
7544 (concat class-selector "__define"))
7545 nil))
7546 ;; FIXME: idlwave-cpl-bold doesn't seem used anywhere.
7547 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7548 (idlwave-complete-in-buffer
7549 'class-tag 'class-tag
7550 idlwave-current-class-tags nil
7551 (format "Select a tag of class %s" class-selector)
7552 "class tag"
7553 'idlwave-attach-class-tag-classes))
7554 t) ; return t to skip other completions
7555 nil)))
7557 (defun idlwave-class-tag-reset ()
7558 (setq idlwave-current-tags-class nil))
7560 (defun idlwave-prepare-class-tag-completion (class)
7561 "Find and parse the necessary class definitions for class structure tags."
7562 (setq idlwave-sint-class-tags nil)
7563 (setq idlwave-current-tags-class class)
7564 (setq idlwave-current-class-tags
7565 (mapcar (lambda (x)
7566 (list (idlwave-sintern-class-tag x 'set)))
7567 (idlwave-all-class-tags class)))
7568 (setq idlwave-current-native-class-tags
7569 (mapcar 'downcase (idlwave-class-tags class))))
7571 ;===========================================================================
7572 ;;
7573 ;; Completing system variables and their structure fields
7574 ;; This is also a plugin.
7576 (defvar idlwave-sint-sysvars nil)
7577 (defvar idlwave-sint-sysvartags nil)
7578 (declare-function idlwave-sintern-sysvar "idlwave" t t)
7579 (declare-function idlwave-sintern-sysvartag "idlwave" t t)
7580 (idlwave-new-sintern-type 'sysvar)
7581 (idlwave-new-sintern-type 'sysvartag)
7582 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7583 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7584 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7587 (defun idlwave-complete-sysvar-or-tag ()
7588 "Complete a system variable."
7589 (interactive)
7590 (let ((pos (point))
7591 (case-fold-search t))
7592 (cond ((save-excursion
7593 ;; Check if the context is right for system variable
7594 (skip-chars-backward "[a-zA-Z0-9_$]")
7595 (equal (char-before) ?!))
7596 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7597 (idlwave-complete-in-buffer 'sysvar 'sysvar
7598 idlwave-system-variables-alist nil
7599 "Select a system variable"
7600 "system variable")
7601 t) ; return t to skip other completions
7602 ((save-excursion
7603 ;; Check if the context is right for sysvar tag
7604 (skip-chars-backward "a-zA-Z0-9_$.")
7605 (and (equal (char-before) ?!)
7607 (<= (match-end 0) pos)))
7608 ;; Complete a system variable tag
7609 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7610 (entry (assq var idlwave-system-variables-alist))
7611 (tags (cdr (assq 'tags entry))))
7612 (or entry (error "!%s is not a known system variable" var))
7613 (or tags (error "System variable !%s is not a structure" var))
7614 (setq idlwave-completion-help-info
7615 (list 'idlwave-complete-sysvar-tag-help var))
7616 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7617 tags nil
7618 "Select a system variable tag"
7619 "system variable tag")
7620 t)) ; return t to skip other completions
7621 (t nil))))
7623 (defvar idlw-help-link) ;dynamic variables set by help callback
7624 (defun idlwave-complete-sysvar-help (mode word)
7625 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7626 (entry (assoc word idlwave-system-variables-alist)))
7627 (cond
7628 ((eq mode 'test)
7629 (and (stringp word) entry (nth 1 (assq 'link entry))))
7630 ((eq mode 'set)
7631 ;; Setting dynamic!!!
7632 (if entry (setq idlw-help-link (nth 1 (assq 'link entry)))))
7633 (t (error "This should not happen")))))
7635 (defun idlwave-complete-sysvar-tag-help (mode word)
7636 (let* ((var (nth 1 idlwave-completion-help-info))
7637 (entry (assoc var idlwave-system-variables-alist))
7638 (tags (cdr (assq 'tags entry)))
7639 (main (nth 1 (assq 'link entry)))
7640 target)
7641 (cond
7642 ((eq mode 'test) ; we can at least link the main
7643 (and (stringp word) entry main))
7644 ((eq mode 'set)
7645 (if entry
7646 (setq idlw-help-link
7647 (if (setq target (cdr (assoc-string word tags t)))
7648 (idlwave-substitute-link-target main target)
7649 main)))) ;; setting dynamic!!!
7650 (t (error "This should not happen")))))
7652 (defun idlwave-split-link-target (link)
7653 "Split a given LINK into link file and anchor."
7654 (if (string-match idlwave-html-link-sep link)
7655 (cons (substring link 0 (match-beginning 0))
7656 (string-to-number (substring link (match-end 0))))))
7658 (defun idlwave-substitute-link-target (link target)
7659 "Substitute the TARGET anchor for the given LINK."
7660 (let (main-base)
7661 (setq main-base (if (string-match "#" link)
7662 (substring link 0 (match-beginning 0))
7663 link))
7664 (if target
7665 (concat main-base idlwave-html-link-sep (number-to-string target))
7666 link)))
7668 ;; Fake help in the source buffer for class structure tags.
7669 ;; IDLW-HELP-LINK AND IDLW-HELP-NAME ARE GLOBAL-VARIABLES HERE.
7670 ;; (from idlwave-do-mouse-completion-help)
7671 (defvar idlw-help-name)
7672 (defvar idlw-help-link)
7673 (defvar idlwave-help-do-class-struct-tag nil)
7674 (defun idlwave-complete-class-structure-tag-help (mode word)
7675 (cond
7676 ((eq mode 'test) ; nothing gets fontified for class tags
7677 nil)
7678 ((eq mode 'set)
7679 (let (class-with found-in)
7680 (when (setq class-with
7681 (idlwave-class-or-superclass-with-tag
7682 idlwave-current-tags-class
7683 word))
7684 (if (assq (idlwave-sintern-class class-with)
7685 idlwave-system-class-info)
7686 (error "No help available for system class tags"))
7687 (if (setq found-in (idlwave-class-found-in class-with))
7688 (setq idlw-help-name (cons (concat found-in "__define") class-with))
7689 (setq idlw-help-name (concat class-with "__define")))))
7690 (setq idlw-help-link word
7691 idlwave-help-do-class-struct-tag t))
7692 (t (error "This should not happen"))))
7694 (defun idlwave-class-or-superclass-with-tag (class tag)
7695 "Find and return the CLASS or one of its superclass with the
7696 associated TAG, if any."
7697 (let ((sclasses (cons class (idlwave-all-class-inherits class)))
7698 cl)
7699 (catch 'exit
7700 (while sclasses
7701 (setq cl (pop sclasses))
7702 (let ((tags (idlwave-class-tags cl)))
7703 (while tags
7704 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7705 (throw 'exit cl))
7706 (setq tags (cdr tags))))))))
7709 (defun idlwave-sysvars-reset ()
7710 (if (and (fboundp 'idlwave-shell-is-running)
7711 (idlwave-shell-is-running)
7712 idlwave-idlwave_routine_info-compiled)
7713 (idlwave-shell-send-command "idlwave_get_sysvars"
7714 'idlwave-process-sysvars 'hide)))
7716 (defun idlwave-process-sysvars ()
7717 (idlwave-shell-filter-sysvars)
7718 (setq idlwave-sint-sysvars nil
7719 idlwave-sint-sysvartags nil)
7720 (idlwave-sintern-sysvar-alist))
7722 (defun idlwave-sintern-sysvar-alist ()
7723 (let ((list idlwave-system-variables-alist) entry tags)
7724 (while (setq entry (pop list))
7725 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7726 (setq tags (assq 'tags entry))
7727 (if tags
7728 (setcdr tags
7729 (mapcar (lambda (x)
7730 (cons (idlwave-sintern-sysvartag (car x) 'set)
7731 (cdr x)))
7732 (cdr tags)))))))
7734 (defvar idlwave-shell-command-output)
7735 (defun idlwave-shell-filter-sysvars ()
7736 "Get any new system variables and tags."
7737 (let ((text idlwave-shell-command-output)
7738 (start 0)
7739 (old idlwave-system-variables-alist)
7740 var tags type name class link old-entry)
7741 (setq idlwave-system-variables-alist nil)
7743 text start)
7744 (setq start (match-end 0)
7745 var (match-string 1 text)
7746 tags (if (match-end 3)
7747 (idlwave-split-string (match-string 3 text))))
7748 ;; Maintain old links, if present
7749 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7750 (setq link (assq 'link old-entry))
7751 (setq idlwave-system-variables-alist
7752 (cons (list var
7753 (cons
7754 'tags
7755 (mapcar (lambda (x)
7756 (cons x
7757 (cdr (assq
7758 (idlwave-sintern-sysvartag x)
7759 (cdr (assq 'tags old-entry))))))
7760 tags)) link)
7761 idlwave-system-variables-alist)))
7762 ;; Keep the old value if query was not successful
7763 (setq idlwave-system-variables-alist
7764 (or idlwave-system-variables-alist old))))
7766 (defun idlwave-completion-fontify-classes ()
7767 "Goto the *Completions* buffer and fontify the class info."
7768 (when (featurep 'font-lock)
7769 (with-current-buffer "*Completions*"
7770 (save-excursion
7771 (goto-char (point-min))
7772 (let ((buffer-read-only nil))
7774 (put-text-property (match-beginning 0) (match-end 0)
7775 'face 'font-lock-string-face)))))))
7777 (defun idlwave-uniquify (list)
7778 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7779 (delq nil
7780 (mapcar (lambda (x)
7781 (unless (gethash x ht)
7782 (puthash x t ht)
7783 x))
7784 list))))
7786 (defun idlwave-after-successful-completion (type slash &optional verify)
7787 "Add `=' or `(' after successful completion of keyword and function.
7788 Restore the pre-completion window configuration if possible."
7789 (cond
7790 ((eq type 'procedure)
7791 nil)
7792 ((eq type 'function)
7793 (cond
7794 ((equal idlwave-function-completion-adds-paren nil) nil)
7795 ((or (equal idlwave-function-completion-adds-paren t)
7796 (equal idlwave-function-completion-adds-paren 1))
7797 (insert "("))
7798 ((equal idlwave-function-completion-adds-paren 2)
7799 (insert "()")
7800 (backward-char 1))
7801 (t nil)))
7802 ((eq type 'keyword)
7803 (if (and idlwave-keyword-completion-adds-equal
7804 (not slash))
7805 (progn (insert "=") t)
7806 nil)))
7808 ;; Restore the pre-completion window configuration if this is safe.
7810 (if (or (eq verify 'force) ; force
7811 (and
7812 (get-buffer-window "*Completions*") ; visible
7813 (idlwave-local-value 'idlwave-completion-p
7814 "*Completions*") ; cib-buffer
7815 (eq (marker-buffer idlwave-completion-mark)
7816 (current-buffer)) ; buffer OK
7817 (equal (marker-position idlwave-completion-mark)
7818 verify))) ; pos OK
7819 (idlwave-restore-wconf-after-completion))
7820 (move-marker idlwave-completion-mark nil)
7821 (setq idlwave-before-completion-wconf nil))
7823 (defun idlwave-mouse-context-help (ev &optional arg)
7824 "Call `idlwave-context-help' on the clicked location."
7825 (interactive "eP")
7826 (mouse-set-point ev)
7827 (idlwave-context-help arg))
7829 (defvar idlwave-last-context-help-pos nil)
7830 (defun idlwave-context-help (&optional arg)
7831 "Display IDL Online Help on context.
7832 If point is on a keyword, help for that keyword will be shown. If
7833 point is on a routine name or in the argument list of a routine, help
7834 for that routine will be displayed. Works for system routines and
7835 keywords, it pulls up text help. For other routines and keywords,
7836 visits the source file, finding help in the header (if
7837 `idlwave-help-source-try-header' is non-nil) or the routine definition
7838 itself."
7839 (interactive "P")
7840 (idlwave-do-context-help arg))
7842 (defun idlwave-mouse-completion-help (ev)
7843 "Display online help about the completion at point."
7844 (interactive "eP")
7845 ;; Restore last-command for next command, to make
7846 ;; scrolling/canceling of completions work.
7847 (setq this-command last-command)
7848 (idlwave-do-mouse-completion-help ev))
7850 (defun idlwave-routine-info (&optional arg external)
7851 "Display a routines calling sequence and list of keywords.
7852 When point is on the name a function or procedure, or in the argument
7853 list of a function or procedure, this command displays a help buffer with
7854 the information. When called with prefix arg, enforce class query.
7856 When point is on an object operator `->', display the class stored in
7857 this arrow, if any (see `idlwave-store-inquired-class'). With a prefix
7858 arg, the class property is cleared out."
7860 (interactive "P")
7861 (idlwave-routines)
7862 (if (string-match "->" (buffer-substring
7863 (max (point-min) (1- (point)))
7864 (min (+ 2 (point)) (point-max))))
7865 ;; Cursor is on an arrow
7866 (if (get-text-property (point) 'idlwave-class)
7867 ;; arrow has class property
7868 (if arg
7869 ;; Remove property
7870 (save-excursion
7871 (backward-char 1)
7873 (remove-text-properties (match-beginning 1) (match-end 1)
7874 '(idlwave-class nil face nil))
7875 (message "Class property removed from arrow")))
7876 ;; Echo class property
7877 (message "Arrow has text property identifying object to be class %s"
7878 (get-text-property (point) 'idlwave-class)))
7879 ;; No property found
7880 (message "Arrow has no class text property"))
7882 ;; Not on an arrow...
7883 (let* ((idlwave-query-class nil)
7884 (idlwave-force-class-query (equal arg '(4)))
7885 (module (idlwave-what-module)))
7886 (if (car module)
7887 (apply 'idlwave-display-calling-sequence
7888 (idlwave-fix-module-if-obj_new module))
7889 (error "Don't know which calling sequence to show")))))
7891 (defun idlwave-resolve (&optional arg)
7892 "Call RESOLVE_ROUTINE on the module name at point.
7893 Like `idlwave-routine-info', this looks for a routine call at point.
7894 After confirmation in the minibuffer, it will use the shell to issue
7895 a RESOLVE call for this routine, to attempt to make it defined and its
7896 routine info available for IDLWAVE. If the routine is a method call,
7897 both `class__method' and `class__define' will be tried.
7898 With ARG, enforce query for the class of object methods."
7899 (interactive "P")
7900 (let* ((idlwave-query-class nil)
7901 (idlwave-force-class-query (equal arg '(4)))
7902 (module (idlwave-what-module))
7903 (name (idlwave-make-full-name (nth 2 module) (car module)))
7904 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7905 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7906 (kwd "")
7907 class)
7909 resolve)
7910 (setq type (match-string 1 resolve)
7911 class (if (match-beginning 2)
7912 (match-string 3 resolve)
7913 nil)
7914 name (match-string 4 resolve)))
7915 (if (string= (downcase type) "function")
7916 (setq kwd ",/is_function"))
7918 (cond
7919 ((null class)
7920 (idlwave-shell-send-command
7921 (format "resolve_routine,'%s'%s" (downcase name) kwd)
7922 'idlwave-update-routine-info
7923 nil t))
7924 (t
7925 (idlwave-shell-send-command
7926 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
7927 (list 'idlwave-shell-send-command
7928 (format "resolve_routine,'%s__%s'%s"
7929 (downcase class) (downcase name) kwd)
7930 '(idlwave-update-routine-info)
7931 nil t))))))
7933 (defun idlwave-find-module-this-file ()
7934 (interactive)
7935 (idlwave-find-module '(4)))
7937 (defun idlwave-find-module (&optional arg)
7938 "Find the source code of an IDL module.
7939 Works for modules for which IDLWAVE has routine info available.
7940 The function offers as default the module name `idlwave-routine-info'
7941 would use. With ARG limit to this buffer. With two prefix ARG's
7942 force class query for object methods."
7943 (interactive "P")
7944 (let* ((idlwave-query-class nil)
7945 (idlwave-force-class-query (equal arg '(16)))
7946 (this-buffer (equal arg '(4)))
7947 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
7948 (default (if module
7949 (concat (idlwave-make-full-name
7950 (nth 2 module) (car module))
7951 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
7952 "none"))
7953 (list
7954 (idlwave-uniquify
7955 (delq nil
7956 (mapcar (lambda (x)
7957 (if (eq 'system (car-safe (nth 3 x)))
7958 ;; Take out system routines with no source.
7959 nil
7960 (list
7961 (concat (idlwave-make-full-name
7962 (nth 2 x) (car x))
7963 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
7964 (if this-buffer
7965 (idlwave-save-buffer-update)
7966 (idlwave-routines))))))
7967 (name (idlwave-completing-read
7968 (if (or (not this-buffer)
7969 (assoc default list))
7970 (format "Module (Default %s): " default)
7971 (format "Module in this file: "))
7972 list))
7973 type class)
7975 ;; Nothing, use the default.
7976 (setq name default))
7977 (if (string-match "<[fp]>" name)
7978 (setq type (substring name -2 -1)
7979 name (substring name 0 -3)))
7981 (setq class (match-string 1 name)
7982 name (match-string 2 name)))
7983 (setq name (idlwave-sintern-routine-or-method name class)
7984 class (idlwave-sintern-class class)
7985 type (cond ((equal type "f") 'fun)
7986 ((equal type "p") 'pro)
7987 (t t)))
7988 (idlwave-do-find-module name type class nil this-buffer)))
7990 (defun idlwave-do-find-module (name type class
7991 &optional force-source this-buffer)
7992 (let ((name1 (idlwave-make-full-name class name))
7993 source buf1 entry
7994 (buf (current-buffer))
7995 (pos (point))
7996 file name2)
7997 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
7998 'WITH-FILE)
7999 source (or force-source (nth 3 entry))
8000 name2 (if (nth 2 entry)
8001 (idlwave-make-full-name (nth 2 entry) name)
8002 name1))
8003 (if source
8004 (setq file (idlwave-routine-source-file source)))
8005 (unless file ; Try to find it on the path.
8006 (setq file
8007 (idlwave-expand-lib-file-name
8008 (if class
8009 (format "%s__define.pro" (downcase class))
8010 (format "%s.pro" (downcase name))))))
8011 (cond
8012 ((or (null name) (equal name ""))
8013 (error "Abort"))
8014 ((eq (car source) 'system)
8015 (error "Source code for system routine %s is not available"
8016 name2))
8017 ((or (not file) (not (file-regular-p file)))
8018 (error "Source code for routine %s is not available"
8019 name2))
8020 (t
8021 (when (not this-buffer)
8022 (setq buf1
8023 (idlwave-find-file-noselect file 'find))
8024 (pop-to-buffer buf1 t))
8025 (goto-char (point-max))
8026 (let ((case-fold-search t))
8027 (if (re-search-backward
8029 (cond ((eq type 'fun) "function")
8030 ((eq type 'pro) "pro")
8033 (regexp-quote (downcase name2))
8034 "[^a-zA-Z0-9_$]")
8035 nil t)
8036 (goto-char (match-beginning 0))
8037 (pop-to-buffer buf)
8038 (goto-char pos)
8039 (error "Could not find routine %s" name2)))))))
8041 (defun idlwave-what-module ()
8042 "Return a default module for stuff near point.
8043 Used by `idlwave-routine-info' and `idlwave-find-module'."
8044 (idlwave-routines)
8045 (if (let ((case-fold-search t))
8046 (save-excursion
8047 (idlwave-beginning-of-statement)
8048 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
8049 ;; This is a function or procedure definition statement
8050 ;; We return the defined routine as module.
8051 (list
8052 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
8053 (match-string-no-properties 2))
8054 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
8055 (idlwave-sintern-class (match-string 3)))
8057 ;; Not a definition statement - analyze precise position.
8058 (let* ((where (idlwave-where))
8059 (cw (nth 2 where))
8060 (pro (car (nth 0 where)))
8061 (func (car (nth 1 where)))
8062 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
8063 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
8064 (following-char)))
8065 )
8066 (cond
8067 ((and (eq cw 'procedure)
8068 (not (equal this-word "")))
8069 (setq this-word (idlwave-sintern-routine-or-method
8070 this-word (nth 2 (nth 3 where))))
8071 (list this-word 'pro
8072 (idlwave-determine-class
8073 (cons this-word (cdr (nth 3 where)))
8074 'pro)))
8075 ((and (eq cw 'function)
8076 (not (equal this-word ""))
8077 (or (eq next-char ?\() ; exclude arrays, vars.
8079 (setq this-word (idlwave-sintern-routine-or-method
8080 this-word (nth 2 (nth 3 where))))
8081 (list this-word 'fun
8082 (idlwave-determine-class
8083 (cons this-word (cdr (nth 3 where)))
8084 'fun)))
8085 ((and (memq cw '(function-keyword procedure-keyword))
8086 (not (equal this-word ""))
8087 (eq next-char ?\()) ; A function!
8088 (setq this-word (idlwave-sintern-routine this-word))
8089 (list this-word 'fun nil))
8090 (func
8091 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
8092 (pro
8093 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
8094 (t nil)))))
8096 (defun idlwave-what-module-find-class ()
8097 "Call `idlwave-what-module' and find the inherited class if necessary."
8098 (let* ((module (idlwave-what-module))
8099 (class (nth 2 module)))
8100 (if (and (= (length module) 3)
8101 (stringp class))
8102 (list (car module)
8103 (nth 1 module)
8104 (apply 'idlwave-find-inherited-class module))
8105 module)))
8107 (defun idlwave-find-inherited-class (name type class)
8108 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
8109 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
8110 (if entry
8111 (nth 2 entry)
8112 class)))
8114 (defun idlwave-fix-module-if-obj_new (module)
8115 "Check if MODULE points to obj_new.
8116 If yes, and if the cursor is in the keyword region, change to the
8117 appropriate Init method."
8118 (let* ((name (car module))
8119 (pos (point))
8120 (case-fold-search t)
8121 string)
8122 (if (and (stringp name)
8123 (equal (downcase name) "obj_new")
8124 (save-excursion
8125 (idlwave-beginning-of-statement)
8126 (setq string (buffer-substring (point) pos))
8128 string)))
8129 (let ((name "Init")
8130 (class (match-string 1 string)))
8131 (setq module (list (idlwave-sintern-method "Init")
8132 'fun
8133 (idlwave-sintern-class class)))))
8134 module))
8136 (defun idlwave-fix-keywords (name type class keywords
8137 &optional super-classes system)
8138 "Update a list of keywords.
8139 Translate OBJ_NEW, adding all super-class keywords, or all keywords
8140 from all classes if CLASS equals t. If SYSTEM is non-nil, don't
8141 demand _EXTRA in the keyword list."
8142 (let ((case-fold-search t))
8144 ;; If this is the OBJ_NEW function, try to figure out the class and use
8145 ;; the keywords from the corresponding INIT method.
8146 (if (and (equal (upcase name) "OBJ_NEW")
8147 (derived-mode-p 'idlwave-mode 'idlwave-shell-mode))
8148 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
8149 (string (buffer-substring bos (point)))
8150 (case-fold-search t)
8151 class)
8153 string)
8154 (setq class (idlwave-sintern-class (match-string 1 string)))
8155 (setq idlwave-current-obj_new-class class)
8156 (setq keywords
8157 (append keywords
8158 (idlwave-entry-keywords
8159 (idlwave-rinfo-assq
8160 (idlwave-sintern-method "INIT")
8161 'fun
8162 class
8163 (idlwave-routines)) 'do-link))))))
8165 ;; If the class is `t', combine all keywords of all methods NAME
8166 (when (eq class t)
8167 (mapc (lambda (entry)
8168 (and
8169 (nth 2 entry) ; non-nil class
8170 (eq (nth 1 entry) type) ; correct type
8171 (setq keywords
8172 (append keywords
8173 (idlwave-entry-keywords entry 'do-link)))))
8174 (idlwave-all-assq name (idlwave-routines)))
8175 (setq keywords (idlwave-uniquify keywords)))
8177 ;; If we have inheritance, add all keywords from superclasses, if
8178 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
8179 (when (and
8180 super-classes
8181 idlwave-keyword-class-inheritance
8182 (stringp class)
8183 (or
8184 system
8185 (assq (idlwave-sintern-keyword "_extra") keywords)
8186 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
8187 ;; Check if one of the keyword-class regexps matches the name
8188 (let ((regexps idlwave-keyword-class-inheritance) re)
8189 (catch 'exit
8190 (while (setq re (pop regexps))
8191 (if (string-match re name) (throw 'exit t))))))
8193 (loop for entry in (idlwave-routines) do
8194 (and (nth 2 entry) ; non-nil class
8195 (memq (nth 2 entry) super-classes) ; an inherited class
8196 (eq (nth 1 entry) type) ; correct type
8197 (eq (car entry) name) ; correct name
8198 (mapc (lambda (k) (add-to-list 'keywords k))
8199 (idlwave-entry-keywords entry 'do-link))))
8200 (setq keywords (idlwave-uniquify keywords)))
8202 ;; Return the final list
8203 keywords))
8205 (defun idlwave-expand-keyword (keyword module)
8206 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
8207 KEYWORD may be an exact match or an abbreviation of a keyword.
8208 If the match is exact, KEYWORD itself is returned, even if there may be other
8209 keywords of which KEYWORD is an abbreviation. This is necessary because some
8210 system routines have keywords which are prefixes of other keywords.
8211 If KEYWORD is an abbreviation of several keywords, a list of all possible
8212 completions is returned.
8213 If the abbreviation was unique, the correct keyword is returned.
8214 If it cannot be a keyword, the function return nil.
8215 If we do not know about MODULE, just return KEYWORD literally."
8216 (let* ((name (car module))
8217 (type (nth 1 module))
8218 (class (nth 2 module))
8219 (kwd (idlwave-sintern-keyword keyword))
8220 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
8221 (kwd-alist (idlwave-entry-keywords entry))
8222 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
8223 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
8224 (completion-ignore-case t)
8225 candidates)
8226 (cond ((assq kwd kwd-alist)
8227 kwd)
8228 ((setq candidates (all-completions kwd kwd-alist))
8229 (if (= (length candidates) 1)
8230 (car candidates)
8231 candidates))
8232 ((and entry extra)
8233 ;; Inheritance may cause this keyword to be correct
8234 keyword)
8235 (entry
8236 ;; We do know the function, which does not have the keyword.
8237 nil)
8238 (t
8239 ;; We do not know the function, so this just might be a correct
8240 ;; keyword - return it as it is.
8241 keyword))))
8243 (defvar idlwave-rinfo-mouse-map
8244 (let ((map (make-sparse-keymap)))
8245 (define-key map
8246 (if (featurep 'xemacs) [button2] [mouse-2])
8247 'idlwave-mouse-active-rinfo)
8248 (define-key map
8249 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
8250 'idlwave-mouse-active-rinfo-shift)
8251 (define-key map
8252 (if (featurep 'xemacs) [button3] [mouse-3])
8253 'idlwave-mouse-active-rinfo-right)
8254 (define-key map " " 'idlwave-active-rinfo-space)
8255 (define-key map "q" 'idlwave-quit-help)
8256 map))
8258 (defvar idlwave-rinfo-map
8259 (let ((map (make-sparse-keymap)))
8260 (define-key map "q" 'idlwave-quit-help)
8261 map))
8263 (defvar idlwave-popup-source nil)
8264 (defvar idlwave-rinfo-marker (make-marker))
8266 (defun idlwave-quit-help ()
8267 (interactive)
8268 (let ((ri-window (get-buffer-window "*Help*"))
8269 (olh-window (get-buffer-window "*IDLWAVE Help*")))
8270 (when (and olh-window
8271 (fboundp 'idlwave-help-quit))
8272 (select-window olh-window)
8273 (idlwave-help-quit))
8274 (when (window-live-p ri-window)
8275 (delete-window ri-window))))
8277 (defun idlwave-display-calling-sequence (name type class
8278 &optional initial-class)
8279 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
8280 (let* ((initial-class (or initial-class class))
8281 (entry (or (idlwave-best-rinfo-assq name type class
8282 (idlwave-routines))
8283 (idlwave-rinfo-assq name type class
8284 idlwave-unresolved-routines)))
8285 (name (or (car entry) name))
8286 (class (or (nth 2 entry) class))
8287 (superclasses (idlwave-all-class-inherits initial-class))
8288 (twins (idlwave-routine-twins entry))
8289 (dtwins (idlwave-study-twins twins))
8290 (all dtwins)
8291 (system (eq (car (nth 3 entry)) 'system))
8292 (calling-seq (nth 4 entry))
8293 (keywords (idlwave-entry-keywords entry 'do-link))
8294 (html-file (car (nth 5 entry)))
8295 (help-echo-kwd
8296 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
8297 (help-echo-use
8298 "Button2/3: Online Help")
8299 (help-echo-src
8300 "Button2: Jump to source and back | Button3: Source in Help window.")
8301 (help-echo-class
8302 "Button2: Display info about same method in superclass")
8303 (col 0)
8304 (data (list name type class (current-buffer) nil initial-class))
8305 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8306 (face 'idlwave-help-link)
8307 beg props win cnt total)
8308 ;; Fix keywords, but don't add chained super-classes, since these
8309 ;; are shown separately for that super-class
8310 (setq keywords (idlwave-fix-keywords name type class keywords))
8311 (cond
8312 ((null entry)
8313 (error "No %s %s known %s" type name
8314 (if initial-class (concat "in class " initial-class) "")))
8315 ((or (null name) (equal name ""))
8316 (error "No function or procedure call at point"))
8317 ((null calling-seq)
8318 (error "Calling sequence of %s %s not available" type name))
8319 (t
8320 (move-marker idlwave-rinfo-marker (point))
8321 (with-current-buffer (get-buffer-create "*Help*")
8322 (use-local-map idlwave-rinfo-map)
8323 (setq buffer-read-only nil)
8324 (erase-buffer)
8325 (set (make-local-variable 'idlwave-popup-source) nil)
8326 (set (make-local-variable 'idlwave-current-obj_new-class)
8327 idlwave-current-obj_new-class)
8328 (when superclasses
8329 (setq props (list 'mouse-face 'highlight
8330 km-prop idlwave-rinfo-mouse-map
8331 'help-echo help-echo-class
8332 'data (cons 'class data)))
8333 (let ((classes (cons initial-class superclasses)) c)
8334 (insert "Classes: ")
8335 (while (setq c (pop classes))
8336 (insert " ")
8337 (setq beg (point))
8338 (insert c)
8339 (if (equal (downcase c) (downcase class))
8340 (add-text-properties beg (point) (list 'face 'bold))
8341 ;; If Method exists in a different class link it
8342 (if (idlwave-rinfo-assq name type c (idlwave-routines))
8343 (add-text-properties beg (point) props))))
8345 (setq props (list 'mouse-face 'highlight
8346 km-prop idlwave-rinfo-mouse-map
8347 'help-echo help-echo-use
8348 'data (cons 'usage data)))
8349 (if html-file (setq props (append (list 'face face 'link html-file)
8350 props)))
8351 (insert "Usage: ")
8352 (setq beg (point))
8353 (insert (if class
8354 (format calling-seq class name class name class name)
8355 (format calling-seq name name name name))
8357 (add-text-properties beg (point) props)
8359 (insert "Keywords:")
8360 (if (null keywords)
8361 (insert " No keywords accepted.")
8362 (setq col 9)
8363 (mapc
8364 (lambda (x)
8365 (if (>= (+ col 1 (length (car x)))
8366 (window-width))
8367 (progn
8369 (setq col 9)))
8370 (insert " ")
8371 (setq beg (point)
8372 ;; Relevant keywords already have link property attached
8373 props (list 'mouse-face 'highlight
8374 km-prop idlwave-rinfo-mouse-map
8375 'data (cons 'keyword data)
8376 'help-echo help-echo-kwd
8377 'keyword (car x)))
8378 (if system (setq props (append (list 'face face) props)))
8379 (insert (car x))
8380 (add-text-properties beg (point) props)
8381 (setq col (+ col 1 (length (car x)))))
8382 keywords))
8384 (setq cnt 1 total (length all))
8385 ;; Here entry is (key file (list of type-conses))
8386 (while (setq entry (pop all))
8387 (setq props (list 'mouse-face 'highlight
8388 km-prop idlwave-rinfo-mouse-map
8389 'help-echo help-echo-src
8390 'source (list (car (car (nth 2 entry))) ;type
8391 (nth 1 entry)
8392 nil
8393 (cdr (car (nth 2 entry))))
8394 'data (cons 'source data)))
8395 (idlwave-insert-source-location
8397 (if (equal cnt 1)
8398 (if (> total 1) "Sources:" "Source:")
8399 "")
8400 (if (> total 1) "- " ""))
8401 entry props)
8402 (incf cnt)
8403 (when (and all (> cnt idlwave-rinfo-max-source-lines))
8404 ;; No more source lines, please
8405 (insert (format
8407 idlwave-rinfo-max-source-lines))
8408 (setq all nil)))
8409 (goto-char (point-min))
8410 (setq buffer-read-only t))
8411 (display-buffer "*Help*")
8412 (if (and (setq win (get-buffer-window "*Help*"))
8413 idlwave-resize-routine-help-window)
8414 (progn
8415 (let ((ww (selected-window)))
8416 (unwind-protect
8417 (progn
8418 (select-window win)
8419 (enlarge-window (- (/ (frame-height) 2)
8420 (window-height)))
8421 (shrink-window-if-larger-than-buffer))
8422 (select-window ww)))))))))
8424 (defun idlwave-insert-source-location (prefix entry &optional file-props)
8425 "Insert a source location into the routine info buffer.
8426 Start line with PREFIX. If a file name is inserted, add FILE-PROPS
8427 to it."
8428 (let* ((key (car entry))
8429 (file (nth 1 entry))
8430 (types (nth 2 entry))
8431 (shell-flag (assq 'compiled types))
8432 (buffer-flag (assq 'buffer types))
8433 (user-flag (assq 'user types))
8434 (lib-flag (assq 'lib types))
8435 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
8436 (and user-flag (idlwave-count-memq 'user types))
8437 (and lib-flag (idlwave-count-memq 'lib types))
8438 1))
8439 (doflags t)
8440 beg special)
8442 (insert prefix)
8444 (cond
8445 ((eq key 'system)
8446 (setq doflags nil)
8447 (insert "System "))
8449 ((eq key 'builtin)
8450 (setq doflags nil)
8451 (insert "Builtin "))
8453 ((and (not file) shell-flag)
8454 (insert "Unresolved"))
8456 ((null file)
8457 (insert "ERROR"))
8459 ((idlwave-syslib-p file)
8460 (if (string-match "obsolete" (file-name-directory file))
8461 (insert "Obsolete ")
8462 (insert "SystemLib ")))
8464 ;; New special syntax: taken directly from routine-info for
8465 ;; library catalog routines
8466 ((setq special (or (cdr lib-flag) (cdr user-flag)))
8467 (insert (format "%-10s" special)))
8469 ;; Old special syntax: a matching regexp
8470 ((setq special (idlwave-special-lib-test file))
8471 (insert (format "%-10s" special)))
8473 ;; Catch-all with file
8474 ((idlwave-lib-p file) (insert "Library "))
8476 ;; Sanity catch all
8477 (t (insert "Other ")))
8479 (when doflags
8480 (insert (concat
8481 " ["
8482 (if lib-flag "L" "-")
8483 (if user-flag "C" "-")
8484 (if shell-flag "S" "-")
8485 (if buffer-flag "B" "-")
8486 "] ")))
8487 (when (> ndupl 1)
8488 (setq beg (point))
8489 (insert (format "(%dx) " ndupl))
8490 (add-text-properties beg (point) (list 'face 'bold)))
8491 (when (and file (not (equal file "")))
8492 (setq beg (point))
8493 (insert (apply 'abbreviate-file-name
8494 (if (featurep 'xemacs) (list file t) (list file))))
8495 (if file-props
8496 (add-text-properties beg (point) file-props)))))
8498 (defun idlwave-special-lib-test (file)
8499 "Check the path of FILE against the regexps which define special libs.
8500 Return the name of the special lib if there is a match."
8501 (let ((alist idlwave-special-lib-alist)
8502 entry rtn)
8503 (cond
8504 ((stringp file)
8505 (while (setq entry (pop alist))
8506 (if (string-match (car entry) file)
8507 (setq rtn (cdr entry)
8508 alist nil)))
8509 rtn)
8510 (t nil))))
8512 (defun idlwave-mouse-active-rinfo-right (ev)
8513 (interactive "e")
8514 (idlwave-mouse-active-rinfo ev 'right))
8516 (defun idlwave-mouse-active-rinfo-shift (ev)
8517 (interactive "e")
8518 (idlwave-mouse-active-rinfo ev nil 'shift))
8520 (defun idlwave-active-rinfo-space ()
8521 (interactive)
8522 (idlwave-mouse-active-rinfo nil 'right))
8524 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8525 "Do the mouse actions in the routine info buffer.
8526 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8527 was pressed."
8528 (interactive "e")
8529 (if ev (mouse-set-point ev))
8530 (let (data id name type class buf bufwin source link keyword
8531 word initial-class)
8532 (setq data (get-text-property (point) 'data)
8533 source (get-text-property (point) 'source)
8534 keyword (get-text-property (point) 'keyword)
8535 link (get-text-property (point) 'link)
8536 id (car data)
8537 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8538 buf (nth 4 data)
8539 initial-class (nth 6 data)
8540 word (idlwave-this-word)
8541 bufwin (get-buffer-window buf t))
8543 (cond ((eq id 'class) ; Switch class being displayed
8544 (if (window-live-p bufwin) (select-window bufwin))
8545 (idlwave-display-calling-sequence
8546 (idlwave-sintern-method name)
8547 type (idlwave-sintern-class word)
8548 initial-class))
8549 ((eq id 'usage) ; Online help on this routine
8550 (idlwave-online-help link name type class))
8551 ((eq id 'source) ; Source in help or buffer
8552 (if right ; In help
8553 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8554 (idlwave-help-source-try-header nil)
8555 ;; Fake idlwave-routines so help will find the right entry
8556 (idlwave-routines
8557 (list (list name type class source ""))))
8558 (idlwave-help-get-special-help name type class nil))
8559 ;; Otherwise just pop to the source
8560 (setq idlwave-popup-source (not idlwave-popup-source))
8561 (if idlwave-popup-source
8562 (condition-case err
8563 (idlwave-do-find-module name type class source)
8564 (error
8565 (setq idlwave-popup-source nil)
8566 (if (window-live-p bufwin) (select-window bufwin))
8567 (error (nth 1 err))))
8568 (if bufwin
8569 (select-window bufwin)
8570 (pop-to-buffer buf))
8571 (goto-char (marker-position idlwave-rinfo-marker)))))
8572 ((eq id 'keyword)
8573 (if right
8574 (idlwave-online-help link name type class keyword)
8575 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8577 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8578 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8579 (let ((bwin (get-buffer-window buffer)))
8580 (if idlwave-complete-empty-string-as-lower-case
8581 (setq keyword (downcase keyword)))
8582 (if bwin
8583 (select-window bwin)
8584 (pop-to-buffer buffer)
8585 (setq bwin (get-buffer-window buffer)))
8586 (if (eq (preceding-char) ?/)
8587 (insert keyword)
8588 (unless (save-excursion
8589 (re-search-backward
8591 (min (- (point) 100) (point-min)) t))
8592 (insert ", "))
8593 (if shift (insert "/"))
8594 (insert keyword)
8595 (if (and (not shift)
8596 idlwave-keyword-completion-adds-equal)
8597 (insert "=")))))
8599 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8600 "List the load path shadows of all routines defined in current buffer."
8601 (interactive "P")
8602 (idlwave-routines)
8603 (if (derived-mode-p 'idlwave-mode)
8604 (idlwave-list-load-path-shadows
8605 nil (idlwave-update-current-buffer-info 'save-buffer)
8606 "in current buffer")
8607 (error "Current buffer is not in idlwave-mode")))
8609 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8610 "List the load path shadows of all routines compiled under the shell.
8611 This is very useful for checking an IDL application. Just compile the
8612 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8613 routines and update IDLWAVE internal info. Then check for shadowing
8614 with this command."
8615 (interactive "P")
8616 (cond
8617 ((or (not (fboundp 'idlwave-shell-is-running))
8618 (not (idlwave-shell-is-running)))
8619 (error "Shell is not running"))
8620 ((null idlwave-compiled-routines)
8621 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8622 (t
8623 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8624 "in the shell"))))
8626 (defun idlwave-list-all-load-path-shadows (&optional arg)
8627 "List the load path shadows of all routines known to IDLWAVE."
8628 (interactive "P")
8629 (idlwave-list-load-path-shadows nil nil "globally"))
8631 (defvar idlwave-sort-prefer-buffer-info t
8632 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8634 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8635 "List the routines which are defined multiple times.
8636 Search the information IDLWAVE has about IDL routines for multiple
8637 definitions.
8638 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8640 When IDL hits a routine call which is not defined, it will search on
8641 the load path in order to find a definition. The output of this command
8642 can be used to detect possible name clashes during this process."
8643 (idlwave-routines) ; Make sure everything is loaded.
8644 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8645 (or (y-or-n-p
8646 "You don't have any user or library catalogs. Continue anyway? ")
8647 (error "Abort")))
8648 (let* ((routines (append idlwave-system-routines
8649 idlwave-compiled-routines
8650 idlwave-library-catalog-routines
8651 idlwave-user-catalog-routines
8652 idlwave-buffer-routines
8653 nil))
8654 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8655 (keymap (make-sparse-keymap))
8656 (props (list 'mouse-face 'highlight
8657 km-prop keymap
8658 'help-echo "Mouse2: Find source"))
8659 (nroutines (length (or special-routines routines)))
8660 (step (/ nroutines 100))
8661 (n 0)
8662 (cnt 0)
8663 (idlwave-sort-prefer-buffer-info nil)
8664 routine twins dtwins twin done props1 lroutines)
8666 (if special-routines
8667 ;; Just looking for shadows of a few special routines
8668 (setq lroutines routines
8669 routines special-routines))
8671 (message "Sorting routines...")
8672 (setq routines (sort routines
8673 (lambda (a b)
8674 (string< (downcase (idlwave-make-full-name
8675 (nth 2 a) (car a)))
8676 (downcase (idlwave-make-full-name
8677 (nth 2 b) (car b)))))))
8678 (message "Sorting routines...done")
8680 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8681 (lambda (ev)
8682 (interactive "e")
8683 (mouse-set-point ev)
8684 (apply 'idlwave-do-find-module
8685 (get-text-property (point) 'find-args))))
8686 (define-key keymap [(return)]
8687 (lambda ()
8688 (interactive)
8689 (apply 'idlwave-do-find-module
8690 (get-text-property (point) 'find-args))))
8691 (message "Compiling list...( 0%%)")
8692 (with-current-buffer (get-buffer-create "*Shadows*")
8693 (setq buffer-read-only nil)
8694 (erase-buffer)
8695 (while (setq routine (pop routines))
8696 (if (= (mod (setq n (1+ n)) step) 0)
8697 (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines)))
8699 ;; Get a list of all twins
8700 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8701 (if (memq routine done)
8702 (setq dtwins nil)
8703 (setq dtwins (idlwave-study-twins twins)))
8704 ;; Mark all twins as dealt with
8705 (setq done (append twins done))
8706 (when (or (> (length dtwins) 1)
8707 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8708 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8709 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8710 (incf cnt)
8712 (idlwave-make-full-name (nth 2 routine)
8713 (car routine))
8714 (if (eq (nth 1 routine) 'fun) "()" "")))
8715 (while (setq twin (pop dtwins))
8716 (setq props1 (append (list 'find-args
8717 (list (nth 0 routine)
8718 (nth 1 routine)
8719 (nth 2 routine)))
8720 props))
8722 (goto-char (point-min))
8723 (setq buffer-read-only t))
8724 (setq loc (or loc ""))
8725 (if (> cnt 0)
8726 (progn
8727 (display-buffer (get-buffer "*Shadows*"))
8728 (message "%d case%s of shadowing found %s"
8729 cnt (if (= cnt 1) "" "s") loc))
8730 (message "No shadowing conflicts found %s" loc))))
8732 (defun idlwave-print-source (routine)
8733 (let* ((source (nth 3 routine))
8734 (stype (car source))
8735 (sfile (idlwave-routine-source-file source)))
8736 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8737 (if (and (eq stype 'compiled)
8738 (or (not (stringp sfile))
8740 (setq stype 'unresolved))
8742 stype
8743 (if sfile sfile "No source code available")))))
8745 (defun idlwave-routine-twins (entry &optional list)
8746 "Return all twin entries of ENTRY in LIST.
8747 LIST defaults to `idlwave-routines'.
8748 Twin entries are those which have the same name, type, and class.
8749 ENTRY will also be returned, as the first item of this list."
8750 (let* ((name (car entry))
8751 (type (nth 1 entry))
8752 (class (nth 2 entry))
8753 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8754 twins candidate)
8755 (while (setq candidate (pop candidates))
8756 (if (and (not (eq candidate entry))
8757 (eq type (nth 1 candidate))
8758 (eq class (nth 2 candidate)))
8759 (push candidate twins)))
8760 (if (setq candidate (idlwave-rinfo-assq name type class
8761 idlwave-unresolved-routines))
8762 (push candidate twins))
8763 (cons entry (nreverse twins))))
8765 (defun idlwave-study-twins (entries)
8766 "Return dangerous twins of first entry in ENTRIES.
8767 Dangerous twins are routines with same name, but in different files on
8768 the load path. If a file is in the system library and has an entry in
8769 the `idlwave-system-routines' list, we omit the latter as
8770 non-dangerous because many IDL routines are implemented as library
8771 routines, and may have been scanned."
8772 (let* ((entry (car entries))
8773 (idlwave-twin-name (car entry)) ;
8774 (type (nth 1 entry)) ; Must be bound for
8775 (idlwave-twin-class (nth 2 entry)) ; idlwave-routine-twin-compare
8776 (cnt 0)
8777 source type type-cons file alist syslibp key)
8778 (while (setq entry (pop entries))
8779 (incf cnt)
8780 (setq source (nth 3 entry)
8781 type (car source)
8782 type-cons (cons type (nth 3 source))
8783 file (idlwave-routine-source-file source))
8785 ;; Make KEY to index entry properly
8786 (setq key (cond ((eq type 'system) type)
8787 (file (file-truename file))
8788 (t 'unresolved)))
8790 ;; Check for an entry in the system library
8791 (if (and file
8792 (not syslibp)
8793 (idlwave-syslib-p file))
8794 (setq syslibp t))
8796 ;; If there's more than one matching entry for the same file, just
8797 ;; append the type-cons to the type list.
8798 (if (setq entry (assoc key alist))
8799 (push type-cons (nth 2 entry))
8800 (push (list key file (list type-cons)) alist)))
8802 (setq alist (nreverse alist))
8804 (when syslibp
8805 ;; File is in system *library* - remove any 'system entry
8806 (setq alist (delq (assq 'system alist) alist)))
8808 ;; If 'system remains and we've scanned the syslib, it's a builtin
8809 ;; (rather than a !DIR/lib/.pro file bundled as source).
8810 (when (and (idlwave-syslib-scanned-p)
8811 (setq entry (assoc 'system alist)))
8812 (setcar entry 'builtin))
8813 (sort alist 'idlwave-routine-twin-compare)))
8815 ;; FIXME: Dynamically scoped vars need to use the `idlwave-' prefix.
8816 ;; (defvar type)
8817 (defmacro idlwave-xor (a b)
8818 `(and (or ,a ,b)
8819 (not (and ,a ,b))))
8821 (defun idlwave-routine-entry-compare (a b)
8822 "Compare two routine info entries for sorting.
8823 This is the general case. It first compares class, names, and type.
8824 If it turns out that A and B are twins (same name, class, and type),
8825 calls another routine which compares twins on the basis of their file
8826 names and path locations."
8827 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8828 (cond
8829 ((not (equal (idlwave-downcase-safe class)
8830 (idlwave-downcase-safe (nth 2 b))))
8831 ;; Class decides
8832 (cond ((null (nth 2 b)) nil)
8833 ((null class) t)
8834 (t (string< (downcase class) (downcase (nth 2 b))))))
8835 ((not (equal (downcase name) (downcase (car b))))
8836 ;; Name decides
8837 (string< (downcase name) (downcase (car b))))
8838 ((not (eq type (nth 1 b)))
8839 ;; Type decides
8840 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8841 (t
8842 ;; A and B are twins - so the decision is more complicated.
8843 ;; Call twin-compare with the proper arguments.
8844 (idlwave-routine-entry-compare-twins a b)))))
8846 (defun idlwave-routine-entry-compare-twins (a b)
8847 "Compare two routine entries, under the assumption that they are twins.
8848 This basically calls `idlwave-routine-twin-compare' with the correct args."
8849 (let* ((idlwave-twin-name (car a))
8850 (type (nth 1 a))
8851 (idlwave-twin-class (nth 2 a)) ; used in idlwave-routine-twin-compare
8852 (asrc (nth 3 a))
8853 (atype (car asrc))
8854 (bsrc (nth 3 b))
8855 (btype (car bsrc))
8856 (afile (idlwave-routine-source-file asrc))
8857 (bfile (idlwave-routine-source-file bsrc)))
8858 (idlwave-routine-twin-compare
8859 (if (stringp afile)
8860 (list (file-truename afile) afile (list atype))
8861 (list atype afile (list atype)))
8862 (if (stringp bfile)
8863 (list (file-truename bfile) bfile (list btype))
8864 (list btype bfile (list btype))))))
8866 ;; Bound in idlwave-study-twins,idlwave-routine-entry-compare-twins.
8867 (defvar idlwave-twin-class)
8868 (defvar idlwave-twin-name)
8870 (defun idlwave-routine-twin-compare (a b)
8871 "Compare two routine twin entries for sorting.
8872 In here, A and B are not normal routine info entries, but special
8873 lists (KEY FILENAME (TYPES...)).
8874 This expects NAME TYPE IDLWAVE-TWIN-CLASS to be bound to the right values."
8875 (let* (;; Dis-assemble entries
8876 (akey (car a)) (bkey (car b))
8877 (afile (nth 1 a)) (bfile (nth 1 b))
8878 (atypes (nth 2 a)) (btypes (nth 2 b))
8879 ;; System routines?
8880 (asysp (memq akey '(builtin system)))
8881 (bsysp (memq bkey '(builtin system)))
8882 ;; Compiled routines?
8883 (acompp (memq 'compiled atypes))
8884 (bcompp (memq 'compiled btypes))
8885 ;; Unresolved?
8886 (aunresp (or (eq akey 'unresolved)
8887 (and acompp (not afile))))
8888 (bunresp (or (eq bkey 'unresolved)
8889 (and bcompp (not bfile))))
8890 ;; Buffer info available?
8891 (abufp (memq 'buffer atypes))
8892 (bbufp (memq 'buffer btypes))
8893 ;; On search path?
8894 (tpath-alist (idlwave-true-path-alist))
8895 (apathp (and (stringp akey)
8896 (assoc (file-name-directory akey) tpath-alist)))
8897 (bpathp (and (stringp bkey)
8898 (assoc (file-name-directory bkey) tpath-alist)))
8899 ;; How early on search path? High number means early since we
8900 ;; measure the tail of the path list
8901 (anpath (length (memq apathp tpath-alist)))
8902 (bnpath (length (memq bpathp tpath-alist)))
8903 ;; Look at file names
8904 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8905 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8906 (fname-re (if idlwave-twin-class
8908 (regexp-quote (downcase idlwave-twin-class))
8909 (regexp-quote (downcase idlwave-twin-name)))
8911 ;; Is file name derived from the routine name?
8912 ;; Method file or class definition file?
8913 (anamep (string-match fname-re aname))
8914 (adefp (and idlwave-twin-class anamep
8915 (string= "define" (match-string 1 aname))))
8916 (bnamep (string-match fname-re bname))
8917 (bdefp (and idlwave-twin-class bnamep
8918 (string= "define" (match-string 1 bname)))))
8920 ;; Now: follow JD's ideas about sorting. Looks really simple now,
8921 ;; doesn't it? The difficult stuff is hidden above...
8922 (cond
8923 ((idlwave-xor asysp bsysp) asysp) ; System entries first
8924 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
8925 ((and idlwave-sort-prefer-buffer-info
8926 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
8927 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
8928 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
8929 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
8930 ((and idlwave-twin-class anamep bnamep ; both file names match ->
8931 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
8932 ((> anpath bnpath) t) ; Who is first on path?
8933 (t nil)))) ; Default
8935 (defun idlwave-routine-source-file (source)
8936 (if (nth 2 source)
8937 (expand-file-name (nth 1 source) (nth 2 source))
8938 (nth 1 source)))
8940 (defun idlwave-downcase-safe (string)
8941 "Downcase if string, else return unchanged."
8942 (if (stringp string)
8943 (downcase string)
8944 string))
8946 (defun idlwave-count-eq (elt list)
8947 "How often is ELT in LIST?"
8948 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
8950 (defun idlwave-count-memq (elt alist)
8951 "How often is ELT a key in ALIST?"
8952 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
8954 (defun idlwave-syslib-p (file)
8955 "Non-nil if FILE is in the system library."
8956 (let* ((true-syslib (file-name-as-directory
8957 (file-truename
8958 (expand-file-name "lib" (idlwave-sys-dir)))))
8959 (true-file (file-truename file)))
8960 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
8962 (defun idlwave-lib-p (file)
8963 "Non-nil if FILE is in the library."
8964 (let ((true-dir (file-name-directory (file-truename file))))
8965 (assoc true-dir (idlwave-true-path-alist))))
8967 (defun idlwave-path-alist-add-flag (list-entry flag)
8968 "Add a flag to the path list entry, if not set."
8969 (let ((flags (cdr list-entry)))
8970 (add-to-list 'flags flag)
8971 (setcdr list-entry flags)))
8973 (defun idlwave-path-alist-remove-flag (list-entry flag)
8974 "Remove a flag to the path list entry, if set."
8975 (let ((flags (delq flag (cdr list-entry))))
8976 (setcdr list-entry flags)))
8978 (defun idlwave-true-path-alist ()
8979 "Return `idlwave-path-alist' alist with true-names.
8980 Info is cached, but relies on the functions setting `idlwave-path-alist'
8981 to reset the variable `idlwave-true-path-alist' to nil."
8982 (or idlwave-true-path-alist
8983 (setq idlwave-true-path-alist
8984 (mapcar (lambda(x) (cons
8985 (file-name-as-directory
8986 (file-truename
8987 (directory-file-name
8988 (car x))))
8989 (cdr x)))
8990 idlwave-path-alist))))
8992 (defun idlwave-syslib-scanned-p ()
8993 "Non-nil if the system lib file !DIR/lib has been scanned."
8994 (let* ((true-syslib (file-name-as-directory
8995 (file-truename
8996 (expand-file-name "lib" (idlwave-sys-dir))))))
8997 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
8999 ;; ----------------------------------------------------------------------------
9000 ;;
9001 ;; Online Help display
9004 ;; ----------------------------------------------------------------------------
9005 ;;
9006 ;; Additions for use with imenu.el and func-menu.el
9007 ;; (pop-up a list of IDL units in the current file).
9008 ;;
9010 (defun idlwave-prev-index-position ()
9011 "Search for the previous procedure or function.
9012 Return nil if not found. For use with imenu.el."
9013 (save-match-data
9014 (cond
9016 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
9017 (t nil))))
9019 (defun idlwave-unit-name ()
9020 "Return the unit name.
9021 Assumes that point is at the beginning of the unit as found by
9022 `idlwave-prev-index-position'."
9023 (forward-sexp 2)
9024 (forward-sexp -1)
9025 (let ((begin (point)))
9026 (re-search-forward
9028 (if (fboundp 'buffer-substring-no-properties)
9029 (buffer-substring-no-properties begin (point))
9030 (buffer-substring begin (point)))))
9032 (defalias 'idlwave-function-menu
9033 (condition-case nil
9034 (progn
9035 (require 'func-menu)
9036 'function-menu)
9037 (error (condition-case nil
9038 (progn
9039 (require 'imenu)
9040 'imenu)
9041 (error nil)))))
9043 ;; Here we hack func-menu.el in order to support this new mode.
9044 ;; The latest versions of func-menu.el already have this stuff in, so
9045 ;; we hack only if it is not already there.
9046 (when (featurep 'xemacs)
9047 (eval-after-load "func-menu"
9048 '(progn
9049 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
9050 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
9051 (setq fume-function-name-regexp-alist
9052 (cons '(idlwave-mode . fume-function-name-regexp-idl)
9053 fume-function-name-regexp-alist)))
9054 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
9055 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
9056 (setq fume-find-function-name-method-alist
9057 (cons '(idlwave-mode . fume-find-next-idl-function-name)
9058 fume-find-function-name-method-alist))))))
9060 (defun idlwave-edit-in-idlde ()
9061 "Edit the current file in IDL Development environment."
9062 (interactive)
9063 (start-process "idldeclient" nil
9064 idlwave-shell-explicit-file-name "-c" "-e"
9065 (buffer-file-name)))
9067 (defvar idlwave-help-use-assistant)
9068 (defun idlwave-launch-idlhelp ()
9069 "Start the IDLhelp application."
9070 (interactive)
9071 (if idlwave-help-use-assistant
9072 (idlwave-help-assistant-raise)
9073 (start-process "idlhelp" nil idlwave-help-application)))
9075 ;; Menus - using easymenu.el
9076 (defvar idlwave-mode-menu-def
9077 `("IDLWAVE"
9078 ["PRO/FUNC menu" idlwave-function-menu t]
9079 ("Motion"
9080 ["Subprogram Start" idlwave-beginning-of-subprogram t]
9081 ["Subprogram End" idlwave-end-of-subprogram t]
9082 ["Block Start" idlwave-beginning-of-block t]
9083 ["Block End" idlwave-end-of-block t]
9084 ["Up Block" idlwave-backward-up-block t]
9085 ["Down Block" idlwave-down-block t]
9086 ["Skip Block Backward" idlwave-backward-block t]
9087 ["Skip Block Forward" idlwave-forward-block t])
9088 ("Mark"
9089 ["Subprogram" idlwave-mark-subprogram t]
9090 ["Block" idlwave-mark-block t]
9091 ["Header" idlwave-mark-doclib t])
9092 ("Format"
9093 ["Indent Entire Statement" idlwave-indent-statement
9095 ["Indent Subprogram" idlwave-indent-subprogram t]
9096 ["(Un)Comment Region" idlwave-toggle-comment-region t]
9097 ["Continue/Split line" idlwave-split-line t]
9098 "--"
9099 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
9100 :selected (symbol-value idlwave-fill-function)])
9101 ("Templates"
9102 ["Procedure" idlwave-procedure t]
9103 ["Function" idlwave-function t]
9104 ["Doc Header" idlwave-doc-header t]
9105 ["Log" idlwave-doc-modification t]
9106 "--"
9107 ["Case" idlwave-case t]
9108 ["For" idlwave-for t]
9109 ["Repeat" idlwave-repeat t]
9110 ["While" idlwave-while t]
9111 "--"
9112 ["Close Block" idlwave-close-block t])
9113 ("Completion"
9114 ["Complete" idlwave-complete t]
9115 ("Complete Specific"
9116 ["1 Procedure Name" (idlwave-complete 'procedure) t]
9117 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
9118 "--"
9119 ["3 Function Name" (idlwave-complete 'function) t]
9120 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
9121 "--"
9122 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
9123 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
9124 "--"
9125 ["7 Function Method Name" (idlwave-complete 'function-method) t]
9126 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
9127 "--"
9128 ["9 Class Name" idlwave-complete-class t]))
9129 ("Routine Info"
9130 ["Show Routine Info" idlwave-routine-info t]
9131 ["Online Context Help" idlwave-context-help t]
9132 "--"
9133 ["Find Routine Source" idlwave-find-module t]
9134 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
9135 "--"
9136 ["Update Routine Info" idlwave-update-routine-info t]
9137 ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t]
9138 "--"
9139 "IDL User Catalog"
9140 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
9141 ["Scan Directories" (idlwave-update-routine-info '(16))
9142 (and idlwave-path-alist (not idlwave-catalog-process))]
9143 ["Scan Directories &" (idlwave-update-routine-info '(64))
9144 (and idlwave-path-alist (not idlwave-catalog-process))]
9145 "--"
9146 "Routine Shadows"
9147 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
9148 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
9149 ["Check Everything" idlwave-list-all-load-path-shadows t])
9150 ("Misc"
9151 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
9152 "--"
9153 ["Insert TAB character" idlwave-hard-tab t])
9154 "--"
9155 ("External"
9156 ["Start IDL shell" idlwave-shell t]
9157 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
9158 ["Launch IDL Help" idlwave-launch-idlhelp t])
9159 "--"
9160 ("Customize"
9161 ["Browse IDLWAVE Group" idlwave-customize t]
9162 "--"
9163 ["Build Full Customize Menu" idlwave-create-customize-menu
9164 (fboundp 'customize-menu-create)])
9165 ("Documentation"
9166 ["Describe Mode" describe-mode t]
9167 ["Abbreviation List" idlwave-list-abbrevs t]
9168 "--"
9169 ["Commentary in idlwave.el" idlwave-show-commentary t]
9170 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
9171 "--"
9172 ["Info" idlwave-info t]
9173 "--"
9174 ["Help with Topic" idlwave-help-assistant-help-with-topic
9175 idlwave-help-use-assistant]
9176 ["Launch IDL Help" idlwave-launch-idlhelp t])))
9178 (defvar idlwave-mode-debug-menu-def
9179 '("Debug"
9180 ["Start IDL shell" idlwave-shell t]
9181 ["Save and .RUN buffer" idlwave-shell-save-and-run
9182 (and (boundp 'idlwave-shell-automatic-start)
9183 idlwave-shell-automatic-start)]))
9185 (if (or (featurep 'easymenu) (load "easymenu" t))
9186 (progn
9187 (easy-menu-define idlwave-mode-menu idlwave-mode-map
9188 "IDL and WAVE CL editing menu"
9189 idlwave-mode-menu-def)
9190 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
9191 "IDL and WAVE CL editing menu"
9192 idlwave-mode-debug-menu-def)))
9194 (defun idlwave-customize ()
9195 "Call the customize function with `idlwave' as argument."
9196 (interactive)
9197 ;; Try to load the code for the shell, so that we can customize it
9198 ;; as well.
9199 (or (featurep 'idlw-shell)
9200 (load "idlw-shell" t))
9201 (customize-browse 'idlwave))
9203 (defun idlwave-create-customize-menu ()
9204 "Create a full customization menu for IDLWAVE, insert it into the menu."
9205 (interactive)
9206 (if (fboundp 'customize-menu-create)
9207 (progn
9208 ;; Try to load the code for the shell, so that we can customize it
9209 ;; as well.
9210 (or (featurep 'idlw-shell)
9211 (load "idlw-shell" t))
9212 (easy-menu-change
9213 '("IDLWAVE") "Customize"
9214 `(["Browse IDLWAVE group" idlwave-customize t]
9215 "--"
9216 ,(customize-menu-create 'idlwave)
9217 ["Set" Custom-set t]
9218 ["Save" Custom-save t]
9219 ["Reset to Current" Custom-reset-current t]
9220 ["Reset to Saved" Custom-reset-saved t]
9221 ["Reset to Standard Settings" Custom-reset-standard t]))
9223 (error "Cannot expand menu (outdated version of cus-edit.el)")))
9225 (defun idlwave-show-commentary ()
9226 "Use the finder to view the file documentation from `idlwave.el'."
9227 (interactive)
9228 (finder-commentary "idlwave.el"))
9230 (defun idlwave-shell-show-commentary ()
9231 "Use the finder to view the file documentation from `idlw-shell.el'."
9232 (interactive)
9233 (finder-commentary "idlw-shell.el"))
9235 (defun idlwave-info ()
9236 "Read documentation for IDLWAVE in the info system."
9237 (interactive)
9238 (info "idlwave"))
9240 (defun idlwave-list-abbrevs (arg)
9241 "Show the code abbreviations define in IDLWAVE mode.
9242 This lists all abbrevs where the replacement text differs from the input text.
9243 These are the ones the users want to learn to speed up their writing.
9245 The function does *not* list abbrevs which replace a word with itself
9246 to call a hook. These hooks are used to change the case of words or
9247 to blink the matching `begin', and the user does not need to know them.
9249 With arg, list all abbrevs with the corresponding hook.
9251 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
9253 (interactive "P")
9254 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
9255 abbrevs
9256 str rpl func fmt (len-str 0) (len-rpl 0))
9257 (mapatoms
9258 (lambda (sym)
9259 (if (symbol-value sym)
9260 (progn
9261 (setq str (symbol-name sym)
9262 rpl (symbol-value sym)
9263 func (symbol-function sym))
9264 (if arg
9265 (setq func (prin1-to-string func))
9266 (if (and (listp func) (stringp (nth 2 func)))
9267 (setq rpl (concat "EVAL: " (nth 2 func))
9268 func "")
9269 (setq func "")))
9270 (if (or arg (not (string= rpl str)))
9271 (progn
9272 (setq len-str (max len-str (length str)))
9273 (setq len-rpl (max len-rpl (length rpl)))
9274 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
9275 table)
9276 ;; sort the list
9277 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
9278 ;; Make the format
9280 (with-output-to-temp-buffer "*Help*"
9281 (if arg
9282 (progn
9285 (princ (format fmt "KEY" "REPLACE" "HOOK"))
9286 (princ (format fmt "---" "-------" "----")))
9289 (princ (format fmt "KEY" "ACTION" ""))
9290 (princ (format fmt "---" "------" "")))
9291 (dolist (list abbrevs)
9292 (setq str (car list)
9293 rpl (nth 1 list)
9294 func (nth 2 list))
9295 (princ (format fmt str rpl func)))))
9296 ;; Make sure each abbreviation uses only one display line
9297 (with-current-buffer "*Help*"
9298 (setq truncate-lines t)))
9300 (declare-function speedbar-add-supported-extension "speedbar" (extension))
9302 ;; Add .pro files to speedbar for support, if it's loaded
9303 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
9305 ;; Set an idle timer to load the routine info.
9306 ;; Will only work on systems which support this.
9307 (or idlwave-routines (idlwave-start-load-rinfo-timer))
9309 ;; Run the hook
9310 (run-hooks 'idlwave-load-hook)
9312 (provide 'idlwave)
9314 ;;; idlwave.el ends here