| blob | 3dcc183345aa67e0b5cde1d431068009d4a91038 |
1 ;; idlwave.el --- IDL editing mode for GNU Emacs
3 ;; Copyright (C) 1999-2014 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://idlwave.org
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://idlwave.org
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."
460 "Alist of regular expressions matching special library directories.
461 When listing routine source locations, IDLWAVE gives a short hint where
462 the file defining the routine is located. By default it lists `SystemLib'
463 for routines in the system library `!DIR/lib' and `Library' for anything
464 else. This variable can define additional types. The car of each entry
465 is a regular expression matching the file name (they normally will match
466 on the path). The cdr is the string to be used as identifier. Max 10
467 chars are allowed."
473 "Write out path (!PATH) and system directory (!DIR) info automatically.
474 Path info is needed to locate library catalog files. If non-nil,
475 whenever the path-list changes as a result of shell-query, etc., it is
477 used to force a write."
482 "Completion options for IDLWAVE mode."
499 "Association list setting the case of completed words.
501 This variable determines the case (UPPER/lower/Capitalized...) of
502 words inserted into the buffer by completion. The preferred case can
503 be specified separately for routine names, keywords, classes and
504 methods.
505 This alist should therefore have entries for `routine' (normal
506 functions and procedures, i.e. non-methods), `keyword', `class', and
507 `method'. Plausible values are
509 upcase upcase whole word, like `BOX_CURSOR'
510 downcase downcase whole word, like `read_ppm'
511 capitalize capitalize each part, like `Widget_Control'
512 preserve preserve case as is, like `IDLgrView'
514 The value can also be any Emacs Lisp function which transforms the
515 case of characters in a string.
517 A value of `preserve' means that the case of the completed word is
518 identical to the way it was written in the definition statement of the
519 routine. This was implemented to allow for mixed-case completion, in
520 particular of object classes and methods.
521 If a completable word is defined in multiple locations, the meaning of
522 `preserve' is not unique since the different definitions might be
523 cased differently. Therefore IDLWAVE always takes the case of the
524 *first* definition it encounters during routine info collection and
525 uses the case derived from it consistently.
527 Note that a lowercase-only string in the buffer will always be completed in
528 lower case (but see the variable `idlwave-completion-force-default-case').
530 After changing this variable, you need to either restart Emacs or press
531 `C-u C-c C-i' to update the internal lists."
538 "Non-nil means, completion will always honor `idlwave-completion-case'.
539 When nil, only the completion of a mixed case or upper case string
540 will honor the default settings in `idlwave-completion-case', while
541 the completion of lower case strings will be completed entirely in
542 lower case."
547 "Non-nil means, the empty string is considered downcase for completion.
548 The case of what is already in the buffer determines the case of completions.
549 When this variable is non-nil, the empty string is considered to be downcase.
550 Completing on the empty string then offers downcase versions of the possible
551 completions."
556 "Non-nil means, the case of tokens in buffers dominates over system stuff.
557 To make this possible, we need to re-case everything each time we update
558 the routine info from the buffers. This is slow.
559 The default is to consider the case given in the system and library files
560 first which makes updating much faster."
565 "Non-nil means, highlight completions for which system help is available.
566 Help can then be accessed with mouse-3.
567 This option is only effective when the online help system is installed."
572 "Non-nil means, treat inheritance with completion, online help etc.
573 When nil, IDLWAVE only knows about the native methods and tags of a class,
574 not about inherited ones."
579 "List of regular expressions for class-driven keyword inheritance.
581 up the class tree. While it cannot be assumed that the presence of an
582 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
583 certain methods this assumption is almost always true. The methods
584 for which to assume this can be set here."
590 "Number of classes to show when completing object methods and keywords.
591 When completing methods or keywords for an object with unknown class,
592 the *Completions* buffer will show the valid classes for each completion
593 like this:
595 MyMethod <Class1,Class2,Class3>
597 The value of this variable may be nil to inhibit display, or an integer to
598 indicate the maximum number of classes to display.
600 On XEmacs, a full list of classes will also be placed into a `help-echo'
601 property on the completion items, so that the list of classes for the current
602 item is displayed in the echo area. If the value of this variable is a
603 negative integer, the `help-echo' property will be suppressed."
609 "Non-nil means, fontify the classes in completions buffer.
610 This makes it easier to distinguish the completion items from the extra
611 class info listed. See `idlwave-completion-show-classes'."
617 "Association list governing specification of object classes for completion.
619 When IDLWAVE tries to complete object-oriented methods, it usually
620 cannot determine the class of a given object from context. In order
621 to provide the user with a correct list of methods or keywords, it
622 needs to determine the appropriate class. IDLWAVE has two ways of
623 doing this (well, three ways if you count the shell... see
624 `idlwave-shell-query-for-class'):
626 1. Combine the items of all available classes which contain this
627 method for the purpose of completion. So when completing a method,
628 all methods of all known classes are available, and when completing
629 a keyword, all keywords allowed for this method in any class are
630 shown. This behavior is very much like normal completion and is
631 therefore the default. It works much better than one might think -
632 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
633 become uncomfortably long. See also
634 `idlwave-completion-show-classes'.
636 2. The second possibility is to ask the user on each occasion. To
637 make this less interruptive, IDLWAVE can store the class as a text
638 property on the object operator `->'. For a given object in the
639 source code, class selection will then be needed only once
640 - for example to complete the method. Keywords to the method can
641 then be completed directly, because the class is already known.
642 You will have to turn on the storage of the selected class
643 explicitly with the variable `idlwave-store-inquired-class'.
645 This variable allows you to configure IDLWAVE's method and
646 method-keyword completion behavior. Its value is an alist, which
647 should contain at least two elements: (method-default . VALUE) and
648 \(keyword-default . VALUE), where VALUE is either t or nil. These
649 specify if the class should be found during method and keyword
650 completion, respectively.
652 The alist may have additional entries specifying exceptions from the
653 keyword completion rule for specific methods, like INIT or
654 GETPROPERTY. In order to turn on class specification for the INIT
664 :inline t
669 "Non-nil means, store class of a method call as text property on `->'.
670 IDLWAVE sometimes has to ask the user for the class associated with a
671 particular object method call. This happens during the commands
672 `idlwave-routine-info' and `idlwave-complete', depending upon the
673 value of the variable `idlwave-query-class'.
675 When you specify a class, this information can be stored as a text
676 property on the `->' arrow in the source code, so that during the same
677 editing session, IDLWAVE will not have to ask again. When this
678 variable is non-nil, IDLWAVE will store and reuse the class information.
680 on the arrow.
682 The default of this variable is nil, since the result of commands then
683 is more predictable. However, if you know what you are doing, it can
684 be nice to turn this on.
686 An arrow which knows the class will be highlighted with
688 displays (with prefix arg: deletes) the class stored on the arrow
689 at point."
694 "Face to highlight object operator arrows `->' which carry a class property.
695 When IDLWAVE stores a class name as text property on an object arrow
696 \(see variable `idlwave-store-inquired-class', it highlights the arrow
697 with this font in order to remind the user that this arrow is special."
702 "Non-nil means, resize the Routine-info *Help* window to fit the content."
707 "Non-nil means, completion automatically adds `=' after completed keywords."
712 "Non-nil means, completion automatically adds `(' after completed function.
713 nil means, don't add anything.
714 A value of `2' means, also add the closing parenthesis and position cursor
715 between the two."
722 "Non-nil means, try to restore the window configuration after completion.
723 When completion is not unique, Emacs displays a list of completions.
724 This messes up your window configuration. With this variable set, IDLWAVE
725 restores the old configuration after successful completion."
729 ;;; Variables for abbrev and action behavior -----------------------------
732 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
733 The variables in this group govern this."
737 "Non-nil means performs actions when indenting.
738 The actions that can be performed are listed in `idlwave-indent-action-table'."
743 "A single character string used to start abbreviations in abbrev mode.
744 Possible characters to chose from: ~`\%
745 or even '?'. '.' is not a good choice because it can make structure
746 field names act like abbrevs in certain circumstances.
748 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
749 must set it directly using `setq' in the init file before idlwave.el
750 is loaded."
755 "Non-nil means, enable `idlwave-surround'.
756 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
757 `idlwave-surround'.
758 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
760 Also see the default key bindings for keys using `idlwave-surround'.
761 Keys are bound and made into actions calling `idlwave-surround' with
762 `idlwave-action-and-binding'.
763 See help for `idlwave-action-and-binding' for examples.
765 Also see help for `idlwave-surround'."
770 "Non-nil means pad '=' in keywords (routine calls or defs) like assignment.
771 Whenever `idlwave-surround' is non-nil then this affects how '=' is
772 padded for keywords and for variables. If t, pad the same as for
773 assignments. If nil then spaces are removed. With any other value,
774 spaces are left unchanged."
782 "Non-nil means point blinks to block beginning for `idlwave-show-begin'."
787 "Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
792 "Non-nil means re-indent line after END was typed."
797 "Non-nil means the abbrev hook can move point.
798 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
799 definitions, use the command `list-abbrevs', for abbrevs that move
800 point. Moving point is useful, for example, to place point between
801 parentheses of expanded functions.
803 See `idlwave-check-abbrev'."
808 "Non-nil means all abbrevs will be forced to either upper or lower case.
809 If the value t, all expanded abbrevs will be upper case.
810 If the value is 'down then abbrevs will be forced to lower case.
811 If nil, the case will not change.
812 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
813 upper case, regardless of this variable."
818 "Non-nil means, reserved words will be made upper case via abbrev expansion.
819 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
820 Has effect only if in abbrev-mode."
824 ;;; Action/Expand Tables.
825 ;;
826 ;; The average user may have difficulty modifying this directly. It
827 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
828 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
829 ;; examples of how to add an action.
830 ;;
831 ;; The action table is used by `idlwave-indent-line' whereas both the
832 ;; action and expand tables are used by `idlwave-indent-and-action'. In
833 ;; general, the expand table is only used when a line is explicitly
834 ;; indented. Whereas, in addition to being used when the expand table
835 ;; is used, the action table is used when a line is indirectly
836 ;; indented via line splitting, auto-filling or a new line creation.
837 ;;
838 ;; Example actions:
839 ;;
840 ;; Capitalize system vars
841 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
842 ;;
843 ;; Capitalize procedure name
844 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
845 ;; '(capitalize-word 1) t)
846 ;;
847 ;; Capitalize common block name
848 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
849 ;; '(capitalize-word 1) t)
850 ;; Capitalize label
851 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
852 ;; '(capitalize-word -1) t)
855 "Associated array containing action lists of search string (car),
856 and function as a cdr. This table is used by `idlwave-indent-line'.
857 See documentation for `idlwave-do-action' for a complete description of
858 the action lists.
860 Additions to the table are made with `idlwave-action-and-binding' when a
861 binding is not requested.
865 "Associated array containing action lists of search string (car),
866 and function as a cdr. The table is used by the
867 `idlwave-indent-and-action' function. See documentation for
868 `idlwave-do-action' for a complete description of the action lists.
870 Additions to the table are made with `idlwave-action-and-binding' when a
871 binding is requested.
874 ;;; Documentation header and history keyword ---------------------------------
877 "Options for documenting IDLWAVE files."
880 ;; FIXME: make defcustom?
883 ";+
884 ; NAME:
885 ;
886 ;
887 ;
888 ; PURPOSE:
889 ;
890 ;
891 ;
892 ; CATEGORY:
893 ;
894 ;
895 ;
896 ; CALLING SEQUENCE:
897 ;
898 ;
899 ;
900 ; INPUTS:
901 ;
902 ;
903 ;
904 ; OPTIONAL INPUTS:
905 ;
906 ;
907 ;
908 ; KEYWORD PARAMETERS:
909 ;
910 ;
911 ;
912 ; OUTPUTS:
913 ;
914 ;
915 ;
916 ; OPTIONAL OUTPUTS:
917 ;
918 ;
919 ;
920 ; COMMON BLOCKS:
921 ;
922 ;
923 ;
924 ; SIDE EFFECTS:
925 ;
926 ;
927 ;
928 ; RESTRICTIONS:
929 ;
930 ;
931 ;
932 ; PROCEDURE:
933 ;
934 ;
935 ;
936 ; EXAMPLE:
937 ;
938 ;
939 ;
940 ; MODIFICATION HISTORY:
941 ;
942 ;-
944 "A list (PATHNAME STRING) specifying the doc-header template to use for
945 summarizing a file. If PATHNAME is non-nil then this file will be included.
946 Otherwise STRING is used. If nil, the file summary will be omitted.
947 For example you might set PATHNAME to the path for the
951 "Non-nil means, the documentation header will always be at start of file.
952 When nil, the header is positioned between the PRO/FUNCTION line of
953 the current routine and the code, allowing several routine headers in
954 a file."
959 "The hook function used to update the timestamp of a function."
964 "The modifications keyword to use with the log documentation commands.
965 A ':' is added to the keyword end.
966 Inserted by doc-header and used to position logs by doc-modification.
967 If nil it will not be inserted."
972 "Regexp matching the start of a document library header."
977 "Regexp matching the end of a document library header."
981 ;;; External Programs -------------------------------------------------------
984 "Path locations of external commands used by IDLWAVE."
988 "If non-nil, this is the command to run IDL.
989 Should be an absolute file path or path relative to the current environment
990 execution search path. If you want to specify command line switches
991 for the IDL program, use `idlwave-shell-command-line-options'.
993 I know the name of this variable is badly chosen, but I cannot change
994 it without compromising backwards-compatibility."
999 "A list of command line options for calling the IDL program.
1000 Since IDL is executed directly without going through a shell like /bin/sh,
1002 string for each argument. But you may also give a single string which
1003 contains the options whitespace-separated. Emacs will be kind enough to
1004 split it for you."
1006 string
1011 "The external application providing reference help for programming.
1012 Obsolete, if the IDL Assistant is being used for help."
1016 ;;; Some Shell variables which must be defined here.-----------------------
1019 "List of modifiers to be used for the debugging commands.
1020 Will be used to bind debugging commands in the shell buffer and in all
1021 source buffers. These are additional convenience bindings, the debugging
1022 commands are always available with the `C-c C-d' prefix.
1023 If you set this to '(control shift), this means setting a breakpoint will
1024 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1025 are `control', `meta', `super', `hyper', `alt', and `shift'."
1036 "If non-nil attempt invoke `idlwave-shell' if not already running.
1037 This is checked when an attempt to send a command to an
1038 IDL process is made."
1042 ;;; Miscellaneous variables -------------------------------------------------
1045 "Miscellaneous options for IDLWAVE mode."
1050 "Non-nil displays a startup message when `idlwave-mode' is first called."
1056 common-blocks class-arrows)
1057 "Items which should be fontified on the default fontification level 2.
1058 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1059 is everything and level 2 is specified by this list.
1060 This variable must be set before IDLWAVE gets loaded.
1061 It is a list of symbols; the following symbols are allowed:
1063 pros-and-functions Procedure and Function definitions
1064 batch-files Batch Files
1065 idlwave-idl-keywords IDL Keywords
1066 label Statement Labels
1067 goto Goto Statements
1068 common-blocks Common Blocks
1069 keyword-parameters Keyword Parameters in routine definitions and calls
1070 system-variables System Variables
1071 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1072 class-arrows Object Arrows with class property"
1090 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1095 "Normal hook. Executed when idlwave.el is loaded."
1100 "Non-nil means turn on a few experimental features.
1101 This variable is only for the maintainer, to test difficult stuff,
1102 while still distributing stable releases.
1105 ;;;
1106 ;;; End customization variables section
1107 ;;;
1109 ;;; Non customization variables
1111 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1112 ;;; Simon Marshall <simon_at_gnu.ai.mit.edu>
1113 ;;; and Carsten Dominik...
1115 ;; The following are the reserved words in IDL. Maybe we should
1116 ;; highlight some more stuff as well?
1117 ;; Procedure declarations. Fontify keyword plus procedure name.
1119 ;; To update this regexp, update the list of keywords and
1120 ;; evaluate the form.
1121 ;; (insert
1122 ;; (prin1-to-string
1123 ;; (concat
1124 ;; "\\<\\("
1125 ;; (regexp-opt
1126 ;; '("||" "&&" "and" "or" "xor" "not"
1127 ;; "eq" "ge" "gt" "le" "lt" "ne"
1128 ;; "for" "do" "endfor"
1129 ;; "if" "then" "endif" "else" "endelse"
1130 ;; "case" "of" "endcase"
1131 ;; "switch" "break" "continue" "endswitch"
1132 ;; "begin" "end"
1133 ;; "repeat" "until" "endrep"
1134 ;; "while" "endwhile"
1135 ;; "goto" "return"
1136 ;; "inherits" "mod"
1137 ;; "compile_opt" "forward_function"
1138 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1139 ;; "\\)\\>")))
1140 "\\<\\(&&\\|and\\|b\\(egin\\|reak\\)\\|c\\(ase\\|o\\(mpile_opt\\|ntinue\\)\\)\\|do\\|e\\(lse\\|nd\\(case\\|else\\|for\\|if\\|rep\\|switch\\|while\\)?\\|q\\)\\|for\\(ward_function\\)?\\|g\\(oto\\|[et]\\)\\|i\\(f\\|nherits\\)\\|l[et]\\|mod\\|n\\(e\\|ot\\)\\|o\\(n_\\(error\\|ioerror\\)\\|[fr]\\)\\|re\\(peat\\|turn\\)\\|switch\\|then\\|until\\|while\\|xor\\|||\\)\\>")
1144 ;; Function declarations. Fontify keyword plus function name.
1150 ;; Common blocks
1156 ;; Start with point after block name and comma
1158 nil
1160 )))
1162 ;; Batch files
1166 ;; FIXME warning.
1170 ;; Labels
1174 ;; The goto statement and its label
1180 ;; Tags in structure definitions. Note that this definition
1181 ;; actually collides with labels, so we have to use the same
1182 ;; face. It also matches named subscript ranges,
1183 ;; e.g. vec{bottom:top]. No good way around this.
1187 ;; Structure names
1192 ;; Keyword parameters, like /xlog or ,xrange=[]
1193 ;; This is anchored to the comma preceding the keyword.
1194 ;; Treats continuation lines, works only during whole buffer
1195 ;; fontification. Slow, use it only in fancy fontification.
1197 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\([ \t]*\\(;.*\\)?\n\\)*[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1200 ;; System variables start with a bang.
1205 ;; Special and unusual operators (not used because too noisy)
1206 ;; (special-operators
1207 ;; '("[<>#]" (0 font-lock-keyword-face)))
1209 ;; All operators (not used because too noisy)
1210 ;; (all-operators
1211 ;; '("[-*^#+<>/]" (0 font-lock-keyword-face)))
1213 ;; Arrows with text property `idlwave-class'
1227 batch-files
1228 idlwave-idl-keywords
1229 label goto
1230 structtag
1231 structname
1232 common-blocks
1233 keyword-parameters
1234 system-variables
1235 class-arrows)
1239 ;; Match an object arrow with class property
1249 idlwave-font-lock-keywords-1
1250 idlwave-font-lock-keywords-2
1251 idlwave-font-lock-keywords-3)
1252 nil t
1254 beginning-of-line))
1260 "Regexp to match the start of a full-line comment.
1261 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1266 "Regular expression to find the beginning of a block.
1270 "Regular expression to find the beginning of a unit.
1274 "Regular expression to find the line that indicates the end of unit.
1275 This line is the end of buffer or the start of another unit.
1283 "Regular expression to find the end of a block.
1296 "Matches between statements and the corresponding END variant.
1297 The cars are the reserved words starting a block. If the block really
1298 begins with BEGIN, the cars are the reserved words before the begin
1299 which can be used to identify the block type.
1300 This is used to check for the correct END type, to close blocks and
1305 "Regular expression matching reserved words which can stand before
1306 blocks starting with a BEGIN statement. The matches must have associations
1323 ))
1327 ;; "endif else" is the only possible "end" that can be
1328 ;; followed by a statement on the same line.
1330 ;; all other "end"s can not be followed by a statement.
1343 idlwave-identifier
1347 idlwave-identifier
1352 "Associated list of statement matching regular expressions.
1353 Each regular expression matches the start of an IDL statement.
1354 The first element of each association is a symbol giving the statement
1355 type. The associated value is a list. The first element of this list
1356 is a regular expression matching the start of an IDL statement for
1357 identifying the statement type. The second element of this list is a
1358 regular expression for finding a substatement for the type. The
1359 substatement starts after the end of the found match modulo
1360 whitespace. If it is nil then the statement has no substatement. The
1361 list order matters since matching an assignment statement exactly is
1362 not possible without parsing. Thus assignment statement become just
1365 ;; FIXME: This var seems to only ever be set, but never actually used!
1372 ;; Note that this is documented in the v18 manuals as being a string
1373 ;; of length one rather than a single character.
1374 ;; The code in this file accepts either format for compatibility.
1376 "Character to be inserted for IDL comment indentation.
1380 "Character which is inserted as a last character on previous line by
1386 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1390 ;; If I take the time I can replace idlwave-keyword-abbrev with
1391 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1392 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1393 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1394 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1397 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1398 Specifically, if the abbrev is in a comment or string it is unexpanded.
1399 Otherwise ARGS forms a list that is evaluated."
1400 ;; FIXME: it would probably be better to rely on the new :enable-function
1401 ;; to enforce the "don't expand in comments or strings".
1426 ;;(define-key map "\C-c\C- " 'idlwave-hard-tab)
1445 ;; (define-key map "\r" 'idlwave-newline)
1446 ;; (define-key map "\t" 'idlwave-indent-line)
1457 ;; Bind the debug commands also with the special modifiers.
1474 ;; (define-key map "\C-c\C-f" 'idlwave-function)
1475 ;; (define-key map "\C-c\C-p" 'idlwave-procedure)
1488 ;; Pickup both forms of Esc/Meta binding
1497 map)
1523 st)
1532 st)
1536 "Execute BODY with a different syntax table."
1544 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1545 ; "Execute BODY with a different syntax table."
1546 ; `(let ((saved-syntax (syntax-table)))
1547 ; (unwind-protect
1548 ; (progn
1549 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1550 ; ,@body)
1551 ; (set-syntax-table saved-syntax))))
1554 "KEY and CMD are made into a key binding and an indent action.
1555 KEY is a string - same as for the `define-key' function. CMD is a
1556 function of no arguments or a list to be evaluated. CMD is bound to
1557 KEY in `idlwave-mode-map' by defining an anonymous function calling
1558 `self-insert-command' followed by CMD. If KEY contains more than one
1559 character a binding will only be set if SELECT is 'both.
1561 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1562 replacing any previous value for KEY. If a binding is not set then it
1563 will instead be placed in `idlwave-indent-action-table'.
1565 If the optional argument SELECT is nil then an action and binding are
1566 created. If SELECT is 'noaction, then a binding is always set and no
1567 action is created. If SELECT is 'both then an action and binding
1568 will both be created even if KEY contains more than one character.
1569 Otherwise, if SELECT is non-nil then only an action is created.
1571 Some examples:
1572 No spaces before and 1 after a comma
1574 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1576 Capitalize system variables - action only
1577 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1579 ;; Add action
1585 ;; Replace action command
1587 ;; New action
1589 ;; Make key binding for action
1599 ;; Set action and key bindings.
1600 ;; See description of the function `idlwave-action-and-binding'.
1601 ;; Automatically add spaces for the following characters
1603 ;; Actions for & are complicated by &&
1606 ;; Automatically add spaces to equal sign if not keyword. This needs
1607 ;; to go ahead of > and <, so >= and <= will be treated correctly
1610 ;; Actions for > and < are complicated by >=, <=, and ->...
1617 ;;;
1618 ;;; Abbrev Section
1619 ;;;
1620 ;;; When expanding abbrevs and the abbrev hook moves backward, an extra
1621 ;;; space is inserted (this is the space typed by the user to expanded
1622 ;;; the abbrev).
1623 ;;;
1629 "Define-abbrev with backward compatibility.
1631 If NOPREFIX is non-nil, don't prepend prefix character. Installs into
1632 `idlwave-mode-abbrev-table' unless TABLE is non-nil."
1636 expansion
1637 hook)))
1647 ;;
1648 ;; Templates
1649 ;;
1659 ;;
1660 ;; Keywords, system functions, conversion routines
1661 ;;
1719 ;; This section is reserved words only. (From IDL user manual)
1720 ;;
1766 ;; defined later - so just make the compiler hush
1770 ;;;###autoload
1772 "Major mode for editing IDL source files (version 6.1_em22).
1774 The main features of this mode are
1776 1. Indentation and Formatting
1777 --------------------------
1778 Like other Emacs programming modes, C-j inserts a newline and indents.
1779 TAB is used for explicit indentation of the current line.
1782 function can also be used in the middle of a line to split the line
1783 at that point. When used inside a long constant string, the string
1784 is split at that point with the `+' concatenation operator.
1786 Comments are indented as follows:
1788 `;;;' Indentation remains unchanged.
1789 `;;' Indent like the surrounding code
1790 `;' Indent to a minimum column.
1792 The indentation of comments starting in column 0 is never changed.
1795 comment. The indentation of the second line of the paragraph
1796 relative to the first will be retained. Use
1798 comments. When the variable `idlwave-fill-comment-line-only' is
1799 nil, code can also be auto-filled and auto-indented.
1801 To convert pre-existing IDL code to your formatting style, mark the
1806 2. Routine Info
1807 ------------
1808 IDLWAVE displays information about the calling sequence and the
1809 accepted keyword parameters of a procedure or function with
1811 source file of a module. These commands know about system
1812 routines, all routines in idlwave-mode buffers and (when the
1813 idlwave-shell is active) about all modules currently compiled under
1814 this shell. It also makes use of pre-compiled or custom-scanned
1815 user and library catalogs many popular libraries ship with by
1817 information, which is also used for completion (see item 4).
1819 3. Online IDL Help
1820 ---------------
1823 for the system variable, keyword, or routines at point. A single
1824 key stroke gets you directly to the right place in the docs. See
1825 the manual to configure where and how the HTML help is displayed.
1827 4. Completion
1828 ----------
1830 class names, keyword parameters, system variables and tags, class
1831 tags, structure tags, filenames and much more. It is context
1832 sensitive and figures out what is expected at point. Lower case
1833 strings are completed in lower case, other strings in mixed or
1834 upper case.
1836 5. Code Templates and Abbreviations
1837 --------------------------------
1838 Many Abbreviations are predefined to expand to code fragments and templates.
1853 have direct keybindings - see the list of keybindings below.
1856 beginning of the current program unit (pro, function or main).
1857 Change log entries can be added to the current program unit with
1860 6. Automatic Case Conversion
1861 -------------------------
1862 The case of reserved words and some abbrevs is controlled by
1863 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1865 7. Automatic END completion
1866 ------------------------
1867 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1868 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1870 8. Hooks
1871 -----
1872 Loading idlwave.el runs `idlwave-load-hook'.
1873 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1875 9. Documentation and Customization
1876 -------------------------------
1877 Info documentation for this package is available. Use
1879 not work). For Postscript, PDF, and HTML versions of the
1880 documentation, check IDLWAVE's homepage at URL `http://idlwave.org'.
1881 IDLWAVE has customize support - see the group `idlwave'.
1883 10.Keybindings
1884 -----------
1885 Here is a list of all keybindings of this mode.
1887 followed by the key sequence to see what the key sequence does.
1890 :abbrev-table idlwave-mode-abbrev-table
1922 ;; ChangeLog
1926 ;; Set tag table list to use IDLTAGS as file name.
1930 ;; Font-lock additions
1931 ;; Following line is for Emacs - XEmacs uses the corresponding property
1932 ;; on the `idlwave-mode' symbol.
1939 ;; Imenu setup
1947 ;; HideShow setup
1950 idlwave-begin-block-reg
1951 idlwave-end-block-reg
1952 ";"
1955 ;; Make a local post-command-hook and add our hook to it
1956 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1957 ;; (make-local-hook 'post-command-hook)
1960 ;; Make local hooks for buffer updates
1961 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1962 ;; (make-local-hook 'kill-buffer-hook)
1964 ;; (make-local-hook 'after-save-hook)
1968 ;; Setup directories and file, if necessary
1971 ;; Update the routine info with info about current buffer?
1974 ;; Check help location
1984 idlwave-user-catalog-file
1985 idlwave-config-directory)
1986 idlwave-xml-system-rinfo-converted-file
1988 idlwave-xml-system-rinfo-converted-file
1989 idlwave-config-directory)
1991 idlwave-path-file
1992 idlwave-config-directory))
1997 "Fontify continuation lines correctly."
2008 ;;
2009 ;; Code Formatting ----------------------------------------------------
2010 ;;
2013 "Insert TAB in buffer in current position."
2017 ;;; This stuff is experimental
2020 "If non-nil, a list that can be evaluated using `eval'.
2021 It is evaluated in the lisp function `idlwave-command-hook' which is
2025 "Command run after every command.
2026 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
2027 sets the variable to zero afterwards."
2035 ;;; End experiment
2037 ;; It would be better to use expand.el for better abbrev handling and
2038 ;; versatility.
2041 "Reverse abbrev expansion if in comment or string.
2042 Argument ARG is the number of characters to move point
2043 backward if `idlwave-abbrev-move' is non-nil.
2044 If optional argument RESERVED is non-nil then the expansion
2045 consists of reserved words, which will be capitalized if
2046 `idlwave-reserved-word-upcase' is non-nil.
2047 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2048 is non-nil, unless its value is \`down in which case the abbrev will be
2049 made into all lowercase.
2050 Returns non-nil if abbrev is left expanded."
2053 nil)
2065 t))
2068 "Return t if point is inside a comment, nil otherwise."
2074 "Move to start of comment delimiter on current line.
2075 Moves to end of line if there is no comment delimiter.
2076 Ignores comment delimiters in strings.
2077 Returns point if comment found and nil otherwise."
2080 found)
2081 ;; Look for first comment delimiter not in a string
2093 "Should we operate on an active region?"
2099 "Insert quote and show matching quote if this is end of a string."
2110 ;; Not the end of a string
2114 "Ensure that the previous word was a token before `idlwave-show-begin'.
2115 An END token must be preceded by whitespace."
2125 "Find the start of current block and blinks to it for a second.
2126 Also checks if the correct END statement has been used."
2127 ;; All end statements are reserved words
2128 ;; Re-indent end line
2129 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2130 ;;(backward-char 1)
2134 begin-pos end-pos end end1 )
2138 idlwave-show-block)
2140 ;; Move inside current block
2153 end-pos))
2161 ;; A generic end
2172 end1 end)
2174 ;;(delete-char 1))
2188 ;; seems to be a case thing
2192 idlwave-block-matches))
2194 ;; Just a normal block
2199 "Terminate the current block with the correct END statement."
2201 ;; Start new line if we are not in a new line
2212 "Surround &, leaving room for && (which surround as well)."
2222 "Surround > and < by blanks, leaving room for >= and <=, and considering ->."
2228 ;; Key binding: pad only on left, to save for possible >=/<=
2232 "Surround the LENGTH characters before point with blanks.
2233 LENGTH defaults to 1.
2234 Optional arguments BEFORE and AFTER affect the behavior before and
2235 after the characters (see also description of `idlwave-make-space'):
2237 nil do nothing
2238 0 force no spaces
2239 integer > 0 force exactly n spaces
2240 integer < 0 at least |n| spaces
2242 The function does nothing if any of the following conditions is true:
2243 - `idlwave-surround-by-blank' is nil
2244 - the character before point is inside a string or comment"
2252 ;; avoid clobbering indent
2262 ;; Check to see if the line should auto wrap
2268 "Make space at point.
2269 The space affected is all the spaces and tabs around point.
2270 If n is non-nil then point is left abs(n) spaces from the beginning of
2271 the contiguous space.
2272 The amount of space at point is determined by N.
2273 If the value of N is:
2274 nil - do nothing.
2275 > 0 - exactly N spaces.
2276 < 0 - a minimum of -N spaces, i.e., do not change if there are
2277 already -N spaces.
2278 0 - no spaces (i.e. remove any existing space)."
2292 ;; n = 0, done
2293 ))))
2296 "Insert a newline and indent the current and previous line."
2298 ;;
2299 ;; Handle unterminated single and double quotes
2300 ;; If not in a comment and in a string then insertion of a newline
2301 ;; will mean unbalanced quotes.
2302 ;;
2307 ;;
2308 ;; The current line is being split, the cursor should be at the
2309 ;; beginning of the new line skipping the leading indentation.
2310 ;;
2311 ;; The reason we insert the new line before indenting is that the
2312 ;; indenting could be confused by keywords (e.g. END) on the line
2313 ;; after the split point. This prevents us from just using
2314 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2315 ;;
2321 ;;
2322 ;; Use global variable 'comment-column' to set parallel comment
2323 ;;
2324 ;; Modeled on lisp.el
2325 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2327 "Compute indent for the beginning of the IDL comment delimiter."
2333 ;; On line by itself, indent as code
2336 ;; after code - do not change
2340 comment-column))))
2343 "Continue line by breaking line at point and indent the lines.
2344 For a code line insert continuation marker. If the line is a line comment
2345 then the new line will contain a comment with the same indentation.
2346 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2347 non-nil."
2349 ;; Expand abbreviation, just like normal RET would.
2353 ;; For code line add continuation.
2354 ;; Check if splitting a string.
2358 ;; Split the string.
2360 idlwave-continuation-char beg)
2364 ;; Do not split the string.
2368 ;; Not splitting a string.
2374 ;; Indent previous line
2379 ;; Reindent new line
2383 "Move point to the beginning of the current program unit.
2384 If NOMARK is non-nil, do not push mark."
2389 "Move point to the start of the next program unit.
2390 If NOMARK is non-nil, do not push mark."
2396 "Mark current IDL statement."
2404 "Mark containing block."
2416 "Put mark at beginning of program, point at end.
2417 The marks are pushed."
2427 "Move to beginning of enclosing block if prefix ARG >= 0.
2428 If prefix ARG < 0 then move forward to enclosing block end."
2433 "Go to the beginning of the current block."
2439 "Go to the beginning of the current block."
2445 "Move across next nested block."
2452 "Move backward across previous nested block."
2458 "Go down a block.
2459 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2460 Returns non-nil if successful."
2464 ;; Backward
2472 ;; Forward
2480 status))
2483 "Put point at beginning of doc library header, mark at end.
2484 The marks are pushed."
2505 "Return (NAME TYPE CLASS) of current routine."
2509 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2518 "Move to beginning of the current statement.
2519 Skips back past statement continuations.
2520 Point is placed at the beginning of the line whether or not this is an
2521 actual statement."
2533 "Move point to beginning of the previous statement.
2534 Returns t if the current line before moving is the beginning of
2535 the first non-comment statement in the file, and nil otherwise."
2539 ;; first line in file
2540 t
2541 ;; skip blank lines, label lines, include lines and line comments
2543 ;; The current statement is the first statement until we
2544 ;; reach another statement.
2552 ;; skip continuation lines
2558 first-statement)))
2561 "Move point to the end of the current IDL statement.
2562 If not in a statement just moves to end of line. Returns position."
2572 "Move point to the end of the current IDL statement.
2573 If not in a statement just moves to end of line. Returns position."
2581 "Move point to beginning of the next IDL statement.
2582 Returns t if that statement is the last non-comment IDL statement
2583 in the file, and nil otherwise."
2587 ;; skip blank lines, label lines, include lines and line comments
2589 ;; The current statement is the last statement until
2590 ;; we reach a new statement.
2597 last-statement))
2600 "Skip past multiple commands on a line (with `&')."
2610 "Skip label or case statement element.
2611 Returns position after label.
2612 If there is no label point is not moved and nil is returned."
2613 ;; Case expressions and labels are terminated by a colon.
2614 ;; So we find the first colon in the line and make sure
2615 ;; - no `?' is before it (might be a ? b : c)
2616 ;; - it is not in a comment
2617 ;; - not in a string constant
2618 ;; - not in parenthesis (like a[0:3])
2619 ;; - not followed by another ":" in explicit class, ala a->b::c
2620 ;; As many in this mode, this function is heuristic and not an exact
2621 ;; parser.
2633 nil)))
2636 "Move to start of next IDL substatement after point.
2637 Uses the type of the current IDL statement to determine if the next
2638 statement is on a new line or is a subpart of the current statement.
2639 Returns point at start of substatement modulo whitespace.
2640 If optional argument is non-nil move to beginning of current
2641 substatement."
2645 st nst last)
2651 ;; Continue looking for substatements until we are past orig
2665 ;; If a continuation line starts here, move to next line
2671 "Return the type of the current IDL statement.
2672 Uses `idlwave-statement-match' to return a cons of (type . point) with
2673 point the ending position where the type was determined. Type is the
2674 association from `idlwave-statement-match', i.e. the cons cell from the
2675 list not just the type symbol. Returns nil if not an identifiable
2676 statement."
2678 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2679 ;; and possibly comments
2691 "Pad '=' with spaces.
2692 Two cases: Assignment statement, and keyword assignment.
2693 Which case is determined using `idlwave-start-of-substatement' and
2694 `idlwave-statement-type'. The equal sign will be surrounded by BEFORE
2695 and AFTER blanks. If `idlwave-pad-keyword' is t then keyword assignment
2696 is treated just like assignment statements. When nil, spaces are
2697 removed for keyword assignment. Any other value keeps the current space
2698 around the `='. Limits in for loops are treated as keyword assignment.
2700 Starting with IDL 6.0, a number of op= assignments are available.
2701 Since ambiguities of the form:
2703 r and= b
2704 rand= b
2706 can occur, alphanumeric operator assignment will never be pre-padded,
2707 only post-padded. You must use a space before these to disambiguate
2708 \(not just for padding, but for proper parsing by IDL too!). Other
2709 operators, such as ##=, ^=, etc., will be pre-padded.
2711 IS-ACTION is ignored.
2713 See `idlwave-surround'."
2726 ;; Why doesn't ##? work for both?
2730 ;(setq begin nil) ; won't modify begin
2734 ;; Everything gets padded equally
2736 ;; Treating keywords/for variables specially...
2754 "Call `idlwave-indent-line' and do expand actions.
2755 With prefix ARG non-nil, indent the entire sub-statement."
2763 ;;Expand the END abbreviation, just as RET or Space would have.
2774 "Indent current IDL line as code or as a comment.
2775 The actions in `idlwave-indent-action-table' are performed.
2776 If the optional argument EXPAND is non-nil then the actions in
2777 `idlwave-indent-expand-table' are performed."
2779 ;; Move point out of left margin.
2788 ;; Indentation for a line comment
2792 ;;
2793 ;; Code Line
2794 ;;
2795 ;; Before indenting, run action routines.
2796 ;;
2799 ;;
2802 ;;
2803 ;; No longer expand abbrevs on the line. The user can do this
2804 ;; manually using expand-region-abbrevs.
2805 ;;
2806 ;; Indent for code line
2807 ;;
2810 ;; a label line
2812 ;; a batch command
2814 ;; leave flush left
2815 nil
2816 ;; indent the line
2818 ;; Adjust parallel comment
2821 ;; Emacs 21 is too smart with fill-column on comment indent
2824 fill-column)))
2827 ;; Get rid of marker
2831 "Perform an action repeatedly on a line.
2832 ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is
2833 either a function name to be called with `funcall' or a list to be
2834 evaluated with `eval'. The action performed by FUNC should leave
2835 point after the match for REG - otherwise an infinite loop may be
2836 entered. FUNC is always passed a final argument of 'is-action, so it
2837 can discriminate between being run as an action, or a key binding."
2847 "Indent from point with spaces until column COL.
2848 Inserts space before markers at point."
2854 "Indent the current line to column COL.
2855 Indents such that first non-whitespace character is at column COL
2856 Inserts spaces before markers at point."
2863 "Indent program unit which contains point."
2875 "Indent current statement, including all continuation lines."
2884 "Return appropriate indentation for current line as IDL code."
2888 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2889 ;; function
2892 ;; Check for continuation line
2897 ;; calculate indent based on previous and current statements
2900 ;; calculate indent based on previous statement
2903 ;; Beginning of file
2908 ;; Main block
2911 idlwave-main-block-indent))
2912 ;; Begin block
2915 idlwave-block-indent))
2916 ;; End Block
2919 ;; Match to the *beginning* of the block opener
2923 ;; idlwave-end-offset
2924 ;; idlwave-block-indent))
2926 ;; Default to current indent
2928 ;; adjust the indentation based on the current statement
2930 ;; End block
2935 ;;
2936 ;; Parentheses indent
2937 ;;
2940 "Calculate the continuation indent inside a paren group.
2941 Returns a cons-cell with (open . indent), where open is the
2942 location of the open paren."
2944 ;; Found an innermost open paren.
2947 ;; Line up with next word unless this is a closing paren.
2950 ;; Plain Kernighan-style nested indent
2954 ;; This is a closed paren - line up under open paren.
2958 ;; Empty (or just comment) follows -- revert to basic indent
2960 ;; Skip paren
2963 nil)
2965 ;; Line up with first word after any blank space
2971 "Calculates the IDL continuation indent column from the previous statement.
2972 Note that here previous statement usually means the beginning of the
2973 current statement if this statement is a continuation of the previous
2974 line. Various special types of continuations, including assignments,
2975 routine definitions, and parenthetical groupings, are treated separately."
2986 idlwave-continuation-indent))
2987 fancy-nonparen-indent fancy-paren-indent)
2989 ;; Align then with its matching if, etc.
2996 match cont-re)
3011 ;; Indent in from the previous line for continuing statements
3016 match)
3028 ;; Parenthetical indent, either traditional or Kernighan style
3035 indent-cons)
3038 beg-reg end-reg close-exp))
3039 ;; First permitted containing paren
3041 idlwave-indent-to-open-paren
3042 idlwave-indent-parens-nested
3045 idlwave-max-extra-continuation-indent))
3048 fancy-paren-indent)
3050 ;; A continued assignment, or procedure call/definition
3058 ;; A continued Procedure call or definition
3061 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3063 ;; Comment only, or blank line with "$"? Basic indent.
3065 nil
3068 ;; Continued assignment (with =):
3082 idlwave-max-extra-continuation-indent))
3085 fancy-nonparen-indent))
3087 ;; Basic indent, by default
3093 "Move to next match of the regular expression KEY-RE.
3094 Matches inside comments or string constants will be ignored.
3095 If DIR is negative, the search will be backwards.
3096 At a successful match, the mark is pushed unless NOMARK is non-nil.
3097 Searches are limited to LIMIT.
3098 Searches are case-insensitive and use a special syntax table which
3099 treats `$' and `_' as word characters.
3100 Return value is the beginning of the match or (in case of failure) nil."
3104 found)
3118 found)
3119 nil)))
3122 "When optional argument DIR is non-negative, move forward to end of
3123 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3124 regular expressions. When DIR is negative, move backwards to block beginning.
3125 Recursively calls itself to skip over nested blocks. DIR defaults to
3126 forward. Calls `push-mark' unless the optional argument NOMARK is
3127 non-nil. Movement is limited by the start of program units because of
3128 possibility of unbalanced blocks."
3135 idlwave-begin-block-reg
3136 idlwave-end-block-reg))
3137 found
3139 idlwave-end-block-reg))
3143 idlwave-begin-unit-reg dir t limit)
3146 idlwave-end-unit-reg dir t limit)))
3147 limit)))
3159 "The minimum indent in the current statement."
3170 min
3174 "Return indentation of the current statement.
3175 If in a statement, moves to beginning of statement before finding indent."
3182 "Return the column of the indentation of the current line.
3183 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3187 ;; if we are at the end of blank line return 0
3192 "Test if current line is continuation line.
3193 Blank or comment-only lines following regular continuation lines (with
3194 `$') count as continuations too."
3205 "Test if the current line is a comment line."
3211 "Test if the current line is a comment line."
3217 "Search current line from current point for REGEXP.
3218 If optional argument CONT is non-nil, searches to the end of
3219 the current statement.
3220 If optional arg BEG is non-nil, search starts from the beginning of the
3221 current statement.
3222 Ignores matches that end in a comment or inside a string expression.
3223 Returns point if successful, nil otherwise.
3224 This function produces unexpected results if REGEXP contains quotes or
3225 a comment delimiter. The search is case insensitive.
3226 If successful leaves point after the match, otherwise, does not move point."
3232 found)
3238 found))
3241 "Fill paragraphs in comments.
3242 A paragraph is made up of all contiguous lines having the same comment
3243 leader (the leading whitespace before the comment delimiter and the
3244 comment delimiter). In addition, paragraphs are separated by blank
3245 line comments. The indentation is given by the hanging indent of the
3246 first line, otherwise by the minimum indentation of the lines after
3247 the first line. The indentation of the first line does not change.
3248 Does not effect code lines. Does not fill comments on the same line
3249 with code. The hanging indent is given by the end of the first match
3250 matching `idlwave-hang-indent-regexp' on the paragraph's first line.
3251 If the optional argument NOHANG is non-nil then the hanging indent is
3252 ignored."
3254 ;; check if this is a line comment
3261 pre here diff fill-prefix-reg bcl first-indent
3262 hang start end)
3263 ;; Change tabs to spaces in the surrounding paragraph.
3264 ;; The surrounding paragraph will be the largest containing block of
3265 ;; contiguous line comments. Thus, we may be changing tabs in
3266 ;; a much larger area than is needed, but this is the easiest
3267 ;; brute force way to do it.
3268 ;;
3269 ;; This has the undesirable side effect of replacing the tabs
3270 ;; permanently without the user's request or knowledge.
3278 ;;
3284 ;; Get the comment leader on the line and its length
3286 ;; the comment leader is the indentation plus exactly the
3287 ;; number of consecutive ";".
3294 ;; Mark the beginning and end of the paragraph
3300 ;; Move to first line of paragraph
3314 ;; if at end of buffer add a newline (need this because
3315 ;; fill-region needs END to be at the beginning of line after
3316 ;; the paragraph or it will add a line).
3319 ;; Set END to the beginning of line after the paragraph
3320 ;; END is calculated as distance from end of buffer
3322 ;;
3323 ;; Calculate the indentation for the paragraph.
3324 ;;
3325 ;; In the following while statements, after one iteration
3326 ;; point will be at the beginning of a line in which case
3327 ;; the while will not be executed for the
3328 ;; the first paragraph line and thus will not affect the
3329 ;; indentation.
3330 ;;
3331 ;; First check to see if indentation is based on hanging indent.
3337 ;; Adjust lines of paragraph by inserting spaces so that
3338 ;; each line's indent is at least as great as the hanging
3339 ;; indent. This is needed for fill-paragraph to work with
3340 ;; a fill-prefix.
3349 ;; adjust the original location for the
3350 ;; inserted text.
3354 )
3356 ;; No hang. Instead find minimum indentation of paragraph
3357 ;; after first line.
3358 ;; For the following while statement, since START is at the
3359 ;; beginning of line and END is at the end of line
3360 ;; point is greater than START at least once (which would
3361 ;; be the case for a single line paragraph).
3372 ?\ )))
3373 ;; first-line indent
3379 indent))
3381 ;; try to keep point at its original place
3384 ;; In place of the more modern fill-region-as-paragraph, a hack
3385 ;; to keep whitespace untouched on the first line within the
3386 ;; indent length and to preserve any indent on the first line
3387 ;; (first indent).
3393 start
3396 nil)
3400 ;; When we want the point at the beginning of the comment
3401 ;; body fill-region will put it at the beginning of the line.
3406 "Calculate the position of the hanging indent for the comment paragraph.
3407 The hanging indent position is given by the first match with the
3408 `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3409 non-nil then use last occurrence matching `idlwave-hang-indent-regexp'
3410 on the line.
3411 If not found returns nil."
3423 "Called to break lines in auto fill mode.
3424 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3425 non-nil. Places a continuation character at the end of the line if
3426 not in a comment. Splits strings with IDL concatenation operator `+'
3427 if `idlwave-auto-fill-split-string' is non-nil."
3429 nil ; do not to fill
3432 ;; Check for comment line
3437 ;; Prevent actions do-auto-fill which calls indent-line-function.
3442 idlwave-auto-fill-split-string)
3445 ))))
3449 ;; Indent the split line
3454 ;; A continued line comment
3455 ;; We treat continued line comments as part of a comment
3456 ;; paragraph. So we check for a hanging indent.
3464 ;; Remove whitespace between comment delimiter and
3465 ;; text, insert spaces for appropriate indentation.
3471 ;; Split code or comment?
3475 ;; Splitting a non-full-line comment.
3476 ;; Insert the comment delimiter from split line
3481 ;; Insert blank to keep off beginning of line
3490 ;; Split code line - add continuation character
3493 ;; Check to see if we split a string
3495 idlwave-auto-fill-split-string)
3496 ;; Split the string and concatenate.
3497 ;; The first extra space is for the space
3498 ;; the line was split. That space was removed.
3503 ;; Make the second part of continued string
3508 ;; Warning
3511 ;; Although do-auto-fill (via indent-new-comment-line) calls
3512 ;; idlwave-indent-line for the new line, re-indent again
3513 ;; because of the addition of the continuation character.
3515 )))))
3518 "Toggle auto-fill mode for IDL mode.
3519 With arg, turn auto-fill mode on if arg is positive.
3520 In auto-fill mode, inserting a space at a column beyond `fill-column'
3521 automatically breaks the line at a previous space."
3527 'idlwave-auto-fill
3528 nil))
3529 ;; update mode-line
3532 ;(defun idlwave-fill-routine-call ()
3533 ; "Fill a routine definition or statement, indenting appropriately."
3534 ; (let ((where (idlwave-where)))))
3538 "Insert a documentation header at the beginning of the unit.
3539 Inserts the value of the variable `idlwave-file-header'. Sets mark
3540 before moving to do insertion unless the optional prefix argument
3541 NOMARK is non-nil."
3544 ;; make sure we catch the current line if it begins the unit
3550 ;; skip function or procedure line
3564 "Default timestamp insertion function."
3570 ;; Remove extra spaces from line
3572 ;; Insert a blank line comment to separate from the date entry -
3573 ;; will keep the entry from flowing onto date line if re-filled.
3577 "Insert a brief modification log at the beginning of the current program.
3578 Looks for an occurrence of the value of user variable
3579 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user
3580 name and places the point for the user to add a log. Before moving, saves
3581 location on mark ring so that the user can return to previous point."
3596 end t)
3607 ;; CJC 3/16/93
3608 ;; Interface to expand-region-abbrevs which did not work when the
3609 ;; abbrev hook associated with an abbrev moves point backwards
3610 ;; after abbrev expansion, e.g., as with the abbrev '.n'.
3611 ;; The original would enter an infinite loop in attempting to expand
3612 ;; .n (it would continually expand and unexpand the abbrev without expanding
3613 ;; because the point would keep going back to the beginning of the
3614 ;; abbrev instead of to the end of the abbrev). We now keep the
3615 ;; abbrev hook from moving backwards.
3616 ;;;
3618 "Expand each abbrev occurrence in the region.
3619 Calling from a program, arguments are START END."
3628 "Return t if point is in a comment or quoted string.
3629 Returns nil otherwise."
3633 "Return location of the opening quote
3634 if point is in a IDL string constant, nil otherwise.
3635 Ignores comment delimiters on the current line.
3636 Properly handles nested quotation marks and octal
3637 constants - a double quote followed by an octal digit."
3638 ;; Treat an octal inside an apostrophe to be a normal string. Treat a
3639 ;; double quote followed by an octal digit to be an octal constant
3640 ;; rather than a string. Therefore, there is no terminating double
3641 ;; quote.
3643 ;; Because single and double quotes can quote each other we must
3644 ;; search for the string start from the beginning of line.
3650 delim
3651 found)
3653 ;; Find string start
3654 ;; Don't find an octal constant beginning with a double quote
3656 ;; Find the string end.
3657 ;; In IDL, two consecutive delimiters after the start of a
3658 ;; string act as an
3659 ;; escape for the delimiter in the string.
3660 ;; Two consecutive delimiters alone (i.e., not after the
3661 ;; start of a string) is the null string.
3663 ;; Move to position after quote
3666 ;; Get the string delimiter
3668 ;; Check for null string
3671 ;; Look for next unpaired delimiter
3677 ))
3680 ;; return string beginning position or nil
3684 "Determine if the character after point is a pointer dereference *."
3694 ;; Statement templates
3696 ;; Replace these with a general template function, something like
3697 ;; expand.el (I think there was also something with a name similar to
3698 ;; dmacro.el)
3701 "Build a template with optional prompt expression.
3703 Opens a line if point is not followed by a newline modulo intervening
3704 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3705 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3706 adjusted according to `idlwave-abbrev-change-case'. If optional
3707 argument PROMPT is a string then it is displayed as a message in the
3708 minibuffer. The PROMPT serves as a reminder to the user of an
3709 expression to enter.
3711 The lines containing S1 and S2 are reindented using `indent-region'
3712 unless the optional second argument NOINDENT is non-nil."
3714 ;; This is a gross hack to avoit template abbrev expansion
3715 ;; in the shell. FIXME: This is a dirty hack.
3725 end)
3738 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3741 string))
3744 "Build skeleton IDL if-else block."
3752 "Build skeleton IDL case statement."
3760 "Build skeleton IDL switch statement."
3768 "Build skeleton IDL loop statement."
3776 "Build skeleton IDL if statement."
3812 "Return a list of substrings of STRING which are separated by PATTERN.
3826 end)
3834 ;; Return the buffer currently visiting FILE
3844 "List of buffers pulled up by IDLWAVE for special reasons.
3848 ;; Return a buffer visiting file.
3852 buf)))
3855 "Kill buffers created automatically by IDLWAVE.
3856 Function prompts for a letter to identify the buffers to kill.
3857 Possible letters are:
3860 clicks in the routine info window.
3861 s Buffers created by the IDLWAVE Shell to display where execution
3862 stopped or an error was found.
3863 a Both of the above.
3865 Buffers containing unsaved changes require confirmation before they are killed."
3869 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3883 "How many outlawed buffers have tag TAG?"
3887 idlwave-outlawed-buffers))))
3890 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3893 entry)
3907 "Remove BUFFER from the buffers which may be killed.
3908 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3909 Intended for `after-save-hook'."
3912 ;; Revoke license
3916 ;; Remove this function from the hook.
3921 ;; Find FILE on the scanned lib path and return a buffer visiting it
3923 dir efile)
3931 ;; Find FILE on the scanned lib path and return a buffer visiting it
3932 ;; This is for, e.g., finding source with no user catalog
3939 "Create the IDL tags file IDLTAGS in the current directory from
3940 the list of directories specified in the minibuffer. Directories may be
3941 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
3942 specified top directories are searched if the directory name is prefixed
3943 by @. Specify @ directories with care, it may take a long, long time if
3944 you specify /."
3947 buffer save_buffer files numfiles item errbuf)
3949 ;;
3950 ;; Read list of directories
3953 ;;
3954 ;; Set etags command, vars
3960 ;;
3961 ;; For each directory
3965 ;;
3966 ;; Find the subdirectories
3988 ;;
3989 ;; For each subdirectory
3993 ;;
3994 ;; Call etags
4003 0
4005 ;;
4006 ;; Append additional tags
4013 )))
4025 ))
4028 "Comment the lines in the region if the first non-blank line is
4029 commented, and conversely, uncomment region. If optional prefix arg
4030 N is non-nil, then for N positive, add N comment delimiters or for N
4031 negative, remove N comment delimiters.
4032 Uses `comment-region' which does not place comment delimiters on
4033 blank lines."
4040 ;; skip blank lines
4052 ;; ----------------------------------------------------------------------------
4053 ;; ----------------------------------------------------------------------------
4054 ;; ----------------------------------------------------------------------------
4055 ;; ----------------------------------------------------------------------------
4056 ;;
4057 ;; Completion and Routine Info
4058 ;;
4060 ;; String "intern" functions
4062 ;; For the completion and routine info function, we want to normalize
4063 ;; the case of procedure names etc. We do this by "interning" these
4064 ;; string is a hand-crafted way. Hashes are used to map the downcase
4065 ;; version of the strings to the cased versions. Most *-sint-*
4066 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4067 ;; system hash. The former is re-scanned, and the latter takes case
4068 ;; precedence.
4069 ;;
4070 ;; Since these cased versions are really lisp objects, we can use `eq'
4071 ;; to search, which is a large performance boost. All new strings
4072 ;; need to be "sinterned". We do this as early as possible after
4073 ;; getting these strings from completion or buffer substrings. So
4074 ;; most of the code can simply assume to deal with "sinterned"
4075 ;; strings. The only exception is that the functions which scan whole
4076 ;; buffers for routine information do not intern the grabbed strings.
4077 ;; This is only done afterwards. Therefore in these functions it is
4078 ;; *not* safe to assume the strings can be compared with `eq' and be
4079 ;; fed into the routine assq functions.
4081 ;; Here we define the hashing functions.
4083 ;; The variables which hold the hashes.
4092 "Reset all sintern hashes."
4093 ;; Make sure the hash functions are accessible.
4104 ;; Make sure these are lists
4109 ;; Reset the system & library hash
4117 idlwave-sint-libnames nil))
4119 ;; Reset the buffer & shell hash
4135 ;;(defmacro idlwave-sintern (type var)
4136 ;; `(cond ((not (stringp name)) name)
4137 ;; ((gethash (downcase name) (cdr ,var)))
4138 ;; ((gethash (downcase name) (car ,var)))
4139 ;; (set (idlwave-sintern-set name ,type ,var set))
4140 ;; (name)))
4180 iname))
4183 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4187 kwd-list)
4190 "Sintern all strings in the rinfo LIST.
4191 With optional parameter SET: also set new patterns. Probably this
4192 will always have to be t. If DEFAULT-DIR is passed, it is used as
4193 the base of the directory."
4205 ;; The class and name
4213 ;; The source
4226 ;; The keywords
4229 kwds))
4231 ;; Build a canonicalized list
4236 ;; Creating new sintern tables
4239 "Define a variable and a function to sintern the new type TAG.
4240 This defines the function `idlwave-sintern-TAG' and the variable
4241 `idlwave-sint-TAGs'."
4253 name)
4257 "Reset the sintern variable associated with TAG."
4260 ;;---------------------------------------------------------------------------
4263 ;; The variables which hold the information
4279 "Alist with !PATH directories and zero or more flags if the dir has
4280 been scanned in a user catalog ('user) or discovered in a library
4296 ;;
4297 ;; The code to get routine info from different sources.
4304 "Provide a list of IDL routines.
4305 This routine loads the builtin routines on the first call.
4306 Later it only returns the value of the variable."
4316 ;; Keep it running...
4317 )
4319 ;; Something is wrong, get rid of the process
4328 ;; return the current value
4329 idlwave-routines)))
4332 "List of functions which should run after a global rinfo update.
4336 "Rescan the previously selected directories. For batch processing."
4340 "Dispatch another Emacs instance to update the idlwave catalog.
4341 After the process finishes normally, the first access to routine info
4342 will re-read the catalog."
4366 nil emacs args)))
4369 process
4373 idlwave-system-routines nil
4374 idlwave-catalog-process nil)
4380 ;; Format for all routine info user catalog, library catalogs, etc.:
4381 ;;
4382 ;; ("ROUTINE" type class
4383 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4384 ;; (buffer pro_file dir) | (compiled pro_file dir)
4385 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4386 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4387 ;;
4388 ;; DIR will be supplied dynamically while loading library catalogs,
4389 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4390 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4391 ;; be nil, as can LINK1, etc., if no HTML help is available.
4398 "Update the internal routine-info lists.
4401 about individual routines.
4403 The information can come from 4 sources:
4404 1. IDL programs in the current editing session
4405 2. Compiled modules in an IDL shell running as Emacs subprocess
4406 3. A list which covers the IDL system routines.
4407 4. A list which covers the prescanned library files.
4409 Scans all IDLWAVE-mode buffers of the current editing session (see
4410 `idlwave-scan-all-buffers-for-routine-info').
4411 When an IDL shell is running, this command also queries the IDL program
4412 for currently compiled routines.
4414 With prefix ARG, also reload the system and library lists.
4415 With two prefix ARG's, also rescans the chosen user catalog tree.
4416 With three prefix args, dispatch asynchronous process to do the update.
4418 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4419 lists, but instead wait for the shell query to complete and
4420 asynchronously finish updating routine info. This is set
4421 automatically when called interactively. When you need routine
4422 information updated immediately, leave NO-CONCATENATE nil."
4424 ;; Stop any idle processing
4432 ;; Start a background process which updates the catalog.
4435 ;; Update the user catalog now, and wait for them.
4439 idlwave-buffer-case-takes-precedence
4441 ;; The override-idle means, even if the idle timer has done some
4442 ;; preparing work, load and renormalize everything anyway.
4446 idlwave-compiled-routines nil
4447 idlwave-unresolved-routines nil)
4448 ;; Reset the appropriate hashes
4450 ;; reset was already done in idle time, so skip this step now once
4457 ;; We can safely scan the buffer stuff first
4461 ;; We first do the system info, and then the buffers
4465 ;; Let's see if there is a shell
4469 idlwave-query-shell-for-routine-info)))
4471 ;; Load the library catalogs again, first re-scanning the path
4483 ;; 1. If we are not going to ask the shell, we need to do the
4484 ;; concatenation now.
4485 ;; 2. When this function is called non-interactively, it
4486 ;; means that someone needs routine info *now*. The
4487 ;; shell update causes the concatenation to be
4488 ;; *delayed*, so not in time for the current command.
4489 ;; Therefore, we do a concatenation now, even though
4490 ;; the shell might do it again.
4494 ;; Ask the shell about the routines it knows of.
4517 idlwave-init-rinfo-when-idle-after
4521 ;;------ XML Help routine info system
4523 ;; Load the system routine info from the cached routine info file,
4524 ;; which, if necessary, will be re-created from the XML file on
4525 ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo
4526 ;; file distributed with older IDLWAVE versions (<6.0)
4530 ;; See if we can create it from XML source
4550 idlwave-xml-system-rinfo-converted-file
4551 catalog-file)))
4555 "Alist of system variables and the associated structure tags.
4563 ;; From a list of syntax statements, shorten with %s and group with "or"
4572 x)
4577 ;; Create a class list entry from the xml parsed list., returning a
4578 ;; cons of form (class-entry method-entries).
4584 class-entry
4585 method methods-entry extra-kwds
4586 props get-props set-props init-props inherits
4587 pelem ptype)
4617 init-props)
4620 get-props)
4623 set-props)
4627 methods-entry)))
4630 ;;(unless (get 'init-props 'matched)
4631 ;; (message "Failed to match Init in class %s" class))
4632 ;;(unless (get 'get-props 'matched)
4633 ;; (message "Failed to match GetProperty in class %s" class))
4634 ;;(unless (get 'set-props 'matched)
4635 ;; (message "Failed to match SetProperty in class %s" class))
4643 ;; Create correctly structured list elements from ROUTINE or METHOD
4644 ;; XML list structures. Return a list of list elements, with more
4645 ;; than one sub-list possible if a routine can serve as both
4646 ;; procedure and function (e.g. call_method).
4653 syntax kwd klink pref-list kwds pelem ptype props result type)
4688 ;; Debug
4689 ;; (if (and (null (aref syntax-vec 0))
4690 ;; (null (aref syntax-vec 1))
4691 ;; (null (aref syntax-vec 2)))
4692 ;; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints")
4693 ;; (if class
4694 ;; (insert (format "Missing SYNTAX entry for %s::%s\n" class name))
4695 ;; (insert (message "Missing SYNTAX entry for %s\n" name)))))
4697 ;; Executive commands are treated specially
4709 result)))
4713 ;; Group keywords by link file, as a list with elements
4714 ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2))
4726 ;; Ensure the master link is there
4729 linkfiles
4734 ;; Clean up the syntax of routines which are actually aliases by
4735 ;; removing the "OR" from the statements
4744 ;; Duplicate and trim original routine aliases from rinfo list
4745 ;; This if for, e.g. OPENR/OPENW/OPENU
4755 ;; Add any missing aliases (separate by slashes)
4770 ;; Duplicate and trim original routine aliases from rinfo list
4771 ;; This if for, e.g. !X, !Y, !Z.
4784 ;; Create a sysvar list entry from the xml parsed list.
4792 pelem ptype props tags)
4803 tags))))
4817 ;; Automatically generated from source file:
4822 idlwave-xml-routine-info-file))
4840 "Convert XML supplied IDL routine info into internal form.
4841 Cache to disk for quick recovery."
4847 props rinfo msg-cnt elem type nelem class-result alias
4848 routines routine-aliases statement-aliases sysvar-aliases)
4858 ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff.
4868 idlwave-system-variables-alist nil
4869 idlwave-system-class-info nil
4870 idlwave-executive-commands-alist nil
4871 idlwave-help-special-topic-words nil)
4887 routine-aliases)
4892 ;; a cons cell is an executive commands
4904 idlwave-help-special-topic-words)
4905 ;; Save the links to those which are statement aliases (not routines)
4914 sysvar-aliases)
4916 idlwave-system-variables-alist)))
4927 ;; ("ROUTINE" type class
4928 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4929 ;; (buffer pro_file dir) | (compiled pro_file dir)
4930 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4931 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4941 ;;(load "idlw-rinfo" 'noerror 'nomessage)
4963 ;; Check for the old style catalog and warn
4966 idlwave-library-routines)
4971 idlwave-user-catalog-file))
4998 ;; restart the timer
5003 idlwave-init-rinfo-when-idle-after
5009 ;; Load and case-treat the system, user catalog, and library routine
5010 ;; info files.
5012 ;; System
5014 ;;(load "idlw-rinfo" 'noerror 'nomessage))
5026 ;; User catalog
5035 idlwave-library-routines)
5038 idlwave-user-catalog-file))
5047 ;; Library catalog
5058 ;; Scan all buffers, current buffer last
5063 ;; Don't scan any buffers
5066 ;; Just scan this buffer
5072 ;; Put the result into the correct variable
5077 "Put the different sources for routine information together."
5078 ;; The sequence here is important because earlier definitions shadow
5079 ;; later ones. We assume that if things in the buffers are newer
5080 ;; then in the shell of the system, they are meant to be different.
5082 idlwave-compiled-routines
5083 idlwave-library-catalog-routines
5084 idlwave-user-catalog-routines)))
5085 ;; Not actually used for anything?
5091 ;; Give a message with information about the number of routines we have.
5094 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
5104 "Return the class alist - make it if necessary."
5111 idlwave-class-alist)))
5113 ;; Three functions for the hooks
5122 "Update `idlwave-routines' for current buffer.
5123 Can run from `after-save-hook'."
5127 idlwave-scan-all-buffers-for-routine-info
5128 idlwave-routines)
5134 nil
5140 routines)
5144 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
5146 found)
5148 ;; The following test uses eq to make sure it works correctly
5149 ;; when two buffers visit the same file. Then the file names
5150 ;; will be equal, but not eq.
5156 ;; End of that section reached. Jump.
5162 ;;----- Scanning buffers -------------------
5165 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
5171 buffer-file-name)
5172 ;; yes, this buffer has the right mode.
5177 ;; Concatenate the individual lists and return the result
5181 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
5183 routine-list string entry)
5197 routine-list))
5202 "Parse a module definition."
5204 start name args type keywords class)
5205 ;; Remove comments
5208 ;; Remove the continuation line stuff
5213 ;; Match the name and type.
5221 ;; Match normal args and keyword args
5224 string start)
5229 ;; Normalize and sort.
5233 ;; Make and return the entry
5234 ;; We don't know which argument are optional, so this information
5235 ;; will not be contained in the calling sequence.
5238 class
5241 ; ((string= (downcase (file-name-base))
5242 ; (downcase name))
5243 ; (list 'lib))
5244 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
5250 "%s"
5258 nil))))
5261 ;;----- Scanning the user catalog -------------------
5264 "Return the syslib directory, or a dummy that never matches."
5268 idlwave-system-directory)
5274 "Scan all files on selected dirs of IDL search path for routine information.
5276 A widget checklist will allow you to choose the directories. Write
5277 the result as a file `idlwave-user-catalog-file'. When this file
5278 exists, it will be automatically loaded to give routine information
5279 about library routines. With ARG, just rescan the same directories
5280 as last time - so no widget will pop up."
5282 ;; Make sure the file is loaded if it exists.
5288 ;; Make sure the file name makes sense
5294 idlwave-user-catalog-file))))
5298 ;; Rescan the known directories
5303 ;; Expand the directories from library-path and run the widget
5307 ;; Propagate any flags on the existing path-alist
5310 idlwave-true-path-alist)))
5317 ;; Ask the shell for the path and then run the widget
5326 ;; Parse shell path information and select among it.
5328 ;; Command hook used by `idlwave-create-user-catalog-file'.
5330 ;; Scan immediately
5332 ;; Set the path and display the widget
5338 "This is the front-end to the creation of the IDLWAVE user catalog.
5339 Please select the directories on IDL's search path from which you
5340 would like to extract routine information, to be stored in the file:
5342 %s
5344 If this is not the correct file, first set variable
5345 `idlwave-user-catalog-file', and call this command again.
5347 N.B. Many libraries include pre-scanned catalog files
5349 not be scanned. You can scan your own libraries off-line using the
5350 perl script `idlwave_catalog'.
5352 After selecting the directories, choose [Scan & Save] to scan the library
5353 directories and save the routine info.
5359 "Create the widget to select IDL search path directories for scanning."
5371 idlwave-user-catalog-file))
5382 :notify
5392 :notify
5410 'checklist
5414 dirs-list))
5415 :greedy t
5437 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
5442 dir-entry)
5448 selected-dirs)
5455 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5459 dirs-alist dir files file)
5461 idlwave-path-alist path-alist ; for library-path instead
5462 idlwave-true-path-alist nil)
5483 idlwave-user-catalog-routines)))))))))
5491 ;; Define the routine info list
5498 idlwave-user-catalog-routines))
5505 idlwave-user-catalog-file)
5522 ;; Define the variable which knows the value of "!DIR"
5524 idlwave-system-directory))
5526 ;; Define the variable which contains a list of all scanned directories
5533 idlwave-path-alist))
5538 ;; Expand parts of path starting with '+' recursively into directory list.
5539 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5549 ;; Expand recursively
5551 ;; Keep unchanged
5557 ;; Return a list of all directories below DIR, including DIR itself
5566 path1))
5569 ;;----- Scanning the library catalogs ------------------
5575 "Scan for library catalog files (.idlwave_catalog) and ingest.
5577 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5578 instead, if present) are searched. Print MESSAGE-BASE along with the
5579 libraries being loaded, if passed, and skip loading/normalizing if
5580 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5581 be set to nil to disable library catalog scanning."
5588 dir-entry dir catalog all-routines)
5596 ;; Load the catalog file
5601 message-base
5603 old-libname)))
5605 idlwave-library-catalog-libname))
5612 all-routines))))
5614 ;; Add a 'lib flag if on path-alist
5621 ;;----- Communicating with the Shell -------------------
5623 ;; First, here is the idl program which can be used to query IDL for
5624 ;; defined routines.
5626 "
5627 ;; START OF IDLWAVE SUPPORT ROUTINES
5628 pro idlwave_print_safe,item,limit
5629 catch,err
5630 if err ne 0 then begin
5631 print,'Could not print item.'
5632 return
5633 endif
5634 if n_elements(item) gt limit then $
5635 print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $
5636 else print,item
5637 end
5639 pro idlwave_print_info_entry,name,func=func,separator=sep
5640 ;; See if it's an object method
5641 if name eq '' then return
5642 func = keyword_set(func)
5643 methsep = strpos(name,'::')
5644 meth = methsep ne -1
5646 ;; Get routine info
5647 pars = routine_info(name,/parameters,functions=func)
5648 source = routine_info(name,/source,functions=func)
5649 nargs = pars.num_args
5650 nkw = pars.num_kw_args
5651 if nargs gt 0 then args = pars.args
5652 if nkw gt 0 then kwargs = pars.kw_args
5654 ;; Trim the class, and make the name
5655 if meth then begin
5656 class = strmid(name,0,methsep)
5657 name = strmid(name,methsep+2,strlen(name)-1)
5658 if nargs gt 0 then begin
5659 ;; remove the self argument
5660 wh = where(args ne 'SELF',nargs)
5661 if nargs gt 0 then args = args[wh]
5662 endif
5663 endif else begin
5664 ;; No class, just a normal routine.
5666 endelse
5668 ;; Calling sequence
5670 if func then cs = 'Result = '
5671 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5672 cs = cs + '%s'
5673 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5674 if nargs gt 0 then begin
5675 for j=0,nargs-1 do begin
5676 cs = cs + args[j]
5677 if j lt nargs-1 then cs = cs + ', '
5678 endfor
5679 end
5680 if func then cs = cs + ')'
5681 ;; Keyword arguments
5682 kwstring = ''
5683 if nkw gt 0 then begin
5684 for j=0,nkw-1 do begin
5685 kwstring = kwstring + ' ' + kwargs[j]
5686 endfor
5687 endif
5689 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5691 print,ret + ': ' + name + sep + class + sep + source[0].path $
5692 + sep + cs + sep + kwstring
5693 end
5695 pro idlwave_routine_info,file
5696 on_error,1
5697 sep = '<@>'
5699 all = routine_info()
5700 fileQ=n_elements(file) ne 0
5701 if fileQ then file=strtrim(file,2)
5702 for i=0L,n_elements(all)-1L do begin
5703 if fileQ then begin
5704 if (routine_info(all[i],/SOURCE)).path eq file then $
5705 idlwave_print_info_entry,all[i],separator=sep
5706 endif else idlwave_print_info_entry,all[i],separator=sep
5707 endfor
5708 all = routine_info(/functions)
5709 for i=0L,n_elements(all)-1L do begin
5710 if fileQ then begin
5711 if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $
5712 idlwave_print_info_entry,all[i],separator=sep,/FUNC
5713 endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC
5714 endfor
5715 print,'>>>END OF IDLWAVE ROUTINE INFO'
5716 end
5718 pro idlwave_get_sysvars
5719 on_error,1
5720 catch,error_status
5721 if error_status ne 0 then begin
5722 print, 'Cannot get info about system variables'
5723 endif else begin
5724 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5725 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5726 v = strsplit(s,' +',/regex,/extract) ; get variables
5727 for i=0L,n_elements(v)-1 do begin
5728 t = [''] ; get tag list
5729 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5730 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5731 endfor
5732 endelse
5733 end
5735 pro idlwave_get_class_tags, class
5736 res = execute('tags=tag_names({'+class+'})')
5737 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5738 end
5739 ;; END OF IDLWAVE SUPPORT ROUTINES
5740 "
5761 (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5766 ;; Restore if necessary. Must use execute to hide lame routine_info
5767 ;; errors on undefined routine
5769 (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'"
5770 idlwave-shell-temp-rinfo-save-file
5771 idlwave-shell-temp-rinfo-save-file)
5776 "Query the shell for routine_info of compiled modules and update the lists."
5777 ;; Save and compile the procedure. The compiled procedure is then
5778 ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may
5779 ;; need to test for and possibly RESTORE the procedure each time we
5780 ;; use it, since the user may have killed or redefined it. In
5781 ;; particular, .RESET_SESSION will kill all user procedures. If
5782 ;; FILE is set, only update routine info for routines in that file.
5785 ; execute the routine_info procedure, and analyze the output
5793 ;; ---------------------------------------------------------------------------
5794 ;;
5795 ;; Completion and displaying routine calling sequences
5807 "Complete a function, procedure or keyword name at point.
5808 This function is smart and figures out what can be completed
5809 at this point.
5810 - At the beginning of a statement it completes procedure names.
5811 - In the middle of a statement it completes function names.
5812 - After a `(' or `,' in the argument list of a function or procedure,
5813 it completes a keyword of the relevant function or procedure.
5814 - In the first arg of `OBJ_NEW', it completes a class name.
5816 When several completions are possible, a list will be displayed in
5817 the *Completions* buffer. If this list is too long to fit into the
5818 window, scrolling can be achieved by repeatedly pressing
5821 The function also knows about object methods. When it needs a class
5822 name, the action depends upon `idlwave-query-class', which see. You
5823 can force IDLWAVE to ask you for a class name with a
5826 See also the variables `idlwave-keyword-completion-adds-equal' and
5827 `idlwave-function-completion-adds-paren'.
5829 The optional ARG can be used to specify the completion type in order
5830 to override IDLWAVE's idea of what should be completed at point.
5831 Possible values are:
5833 0 <=> query for the completion type
5834 1 <=> 'procedure
5835 2 <=> 'procedure-keyword
5836 3 <=> 'function
5837 4 <=> 'function-keyword
5838 5 <=> 'procedure-method
5839 6 <=> 'procedure-method-keyword
5840 7 <=> 'function-method
5841 8 <=> 'function-method-keyword
5842 9 <=> 'class
5844 As a special case, the universal argument C-u forces completion of
5845 function names in places where the default would be a keyword.
5847 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5848 completion.
5850 For Lisp programmers only:
5851 When we force a keyword, optional argument MODULE can contain the module name.
5852 When we force a method or a method keyword, CLASS can specify the class."
5879 ;; Complete a filename in quotes
5884 ;; Check for any special completion functions
5891 ;; Complete a class
5897 ;; Complete a procedure name
5910 isa
5916 isa
5920 ;; Complete a function name
5933 isa
5939 isa
5947 ;; Complete a procedure keyword
5964 super-classes system))
5976 isa
5980 ;; Complete a function keyword
5993 msg-name)
5998 super-classes system))
5999 ;; OBJ_NEW: Messages mention the proper Init method
6006 msg-name))
6015 isa
6021 "List of special completion functions.
6022 These functions are called for each completion. Each function must
6023 check if its own special completion context is present. If yes, it
6024 should use `idlwave-complete-in-buffer' to do some completion and
6025 return t. If such a function returns t, *no further* attempts to
6026 complete other contexts will be done. If the function returns nil,
6031 fun ret)
6036 nil)))
6039 ;; Return an artificial WHERE specification to force the completion
6040 ;; routine to complete a specific item independent of context.
6041 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
6042 ;; MODULE and CLASS can be used to specify the routine name and class.
6043 ;; The class name will also be found in MODULE if that is like "class::mod".
6061 what)
6134 ;; Completing read, case insensitive
6144 "Use the comint stuff to complete a file name."
6152 idlwave-shell-default-directory
6153 default-directory)))
6157 ;; Make a fully qualified module name including the class name
6161 "Like `idlwave-rinfo-assq', but sintern strings first."
6167 ;; Works like assq, but also checks type and class
6178 ;; Return the first matching method on the inheritance list
6180 class rtn)
6184 rtn))
6187 keep-system)
6188 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
6189 If WITH-FILE is passed, find the best rinfo entry with a file
6190 included. If KEEP-SYSTEM is set, don't prune system for compiled
6191 syslib files."
6194 list))
6195 syslibp)
6202 ;; Its a compiled syslib, so we need to remove the system entry
6208 twins)))))
6212 keep-system)
6213 "Like `idlwave-best-rinfo-assq', but sintern strings first."
6219 "Does the entry list ENTRIES contain a syslib entry?
6220 If yes, return the index (>=1)."
6229 nil)))
6232 "Return a list of all associations of Key in LIST."
6240 "Return all classes which have a method METHOD.
6241 TYPE is 'fun or 'pro.
6242 When TYPE is not specified, both procedures and functions will be considered."
6255 "Return all classes which have a method METHOD with keyword KEYWORD.
6256 TYPE is 'fun or 'pro.
6257 When TYPE is not specified, both procedures and functions will be considered."
6260 nil
6272 "Return list of all elements in LIST which are also in CLUB."
6281 "Return list of all elements in LIST which are not in CLUB."
6285 nil
6291 "Return whether or not the class is listed explicitly, ala a->b::c.
6292 INFO is as returned by `idlwave-what-function' or `-procedure'."
6299 "List of special functions for determining class.
6303 ;; Determine the class of a routine call.
6304 ;; INFO is the `cw-list' structure as returned by idlwave-where.
6305 ;; The second element in this structure is the class. When nil, we
6306 ;; return nil. When t, try to get the class from text properties at
6307 ;; the arrow. When the object is "self", we use the class of the
6308 ;; current routine. otherwise prompt the user for a class name.
6309 ;; Also stores the selected class as a text property at the arrow.
6310 ;; TYPE is 'fun or 'pro.
6316 idlwave-query-class))
6318 idlwave-query-class))
6330 store special-class class-alist)
6334 ;; There is an object which would like to know its class
6336 idlwave-store-inquired-class
6343 ;; Before prompting, try any special class determination routines
6345 idlwave-determine-class-special
6351 store idlwave-store-inquired-class)))
6353 ;; Prompt for a class, if we need to
6374 ;; Store it, if requested
6376 ;; We have a real class here
6382 rear-nonsticky t))
6385 ;; Return the class
6386 class)
6387 ;; Default as fallback
6397 ;; Record a file link, if any, for the tested names during selection.
6401 sel))
6405 "Find out where we are.
6406 The return value is a list with the following stuff:
6407 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
6409 PRO-LIST (PRO POINT CLASS ARROW)
6410 FUNC-LIST (FUNC POINT CLASS ARROW)
6411 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
6412 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
6413 be completed here.
6414 LAST-CHAR last relevant character before point (non-white non-comment,
6415 not part of current identifier or leading slash).
6417 In the lists, we have these meanings:
6418 PRO: Procedure name
6419 FUNC: Function name
6420 POINT: Where is this
6421 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
6422 ARROW: Location of the arrow"
6440 cw cw-mod cw-arrow cw-class cw-point)
6444 match-string)
6450 match-string))
6452 cw-arrow pro-arrow))
6454 match-string)
6455 nil)
6457 match-string)
6460 match-string)
6467 cw-class func-class cw-arrow func-arrow))
6470 cw-class pro-class cw-arrow pro-arrow))
6471 ; ((member last-char '(?\' ?\) ?\] ?!))
6472 ; ;; after these chars, a function makes no sense
6473 ; ;; FIXME: I am sure there can be more in this list
6474 ; ;; FIXME: Do we want to do this at all?
6475 ; nil)
6476 ;; Everywhere else we try a function.
6480 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t)
6484 t))))))
6487 cw
6489 last-char)))
6492 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6500 ;; Find out if point is within the argument list of a function.
6501 ;; The return value is ("function-name" class arrow-start (point) level).
6502 ;; Level is 1 on the top level parentheses, higher further down.
6504 ;; If the optional BOUND is an integer, bound backwards directed
6505 ;; searches to this point.
6509 func-point
6511 func arrow-start class)
6516 ;; move back out of the current parenthesis
6525 bound t))
6528 pos func-point)
6534 'exit
6538 arrow-start func-point cnt)))
6543 ;; Find out if point is within the argument list of a procedure.
6544 ;; The return value is ("procedure-name" class arrow-pos (point)).
6546 ;; If the optional BOUND is an integer, bound backwards directed
6547 ;; searches to this point.
6549 pro class arrow-start string)
6551 ;;(idlwave-beginning-of-statement)
6561 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6562 string))
6567 pos)
6572 arrow-start
6573 pro-point)))
6576 ;; If there is an object at point, move over it and return t.
6586 nil)
6604 nil)))
6607 "Return the last character before point which is not white or a comment
6608 and also not part of the current identifier. Since we do this in
6609 order to identify places where keywords are, we consider the initial
6610 `/' of a keyword as part of the identifier.
6611 This function is not general, can only be used for completion stuff."
6614 ;; skip the current identifier
6616 ;; also skip a leading slash which might be belong to the keyword
6619 ;; FIXME: does not check if this is a valid identifier
6627 ;; continuation line
6641 &optional prepare-display-function
6642 special-selector)
6643 "Perform TYPE completion of word before point against LIST.
6644 SELECTOR is the PREDICATE argument for the completion function. Show
6645 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6646 'procedure, 'class-tag, 'keyword, 'sysvar, etc. SPECIAL-SELECTOR is
6647 used only once, for `all-completions', and can be used to, e.g.,
6648 accumulate information on matching completions."
6651 dpart dcompletion)
6656 ;; What is already in the buffer?
6661 idlwave-complete-after-success-form
6664 idlwave-complete-after-success-form-force
6668 ;; Try a completion
6674 idlwave-completion-help-links nil)
6677 ;; nothing available.
6681 ;; We can add something
6685 idlwave-complete-empty-string-as-lower-case)
6687 dcompletion
6688 completion))
6690 ;; Now this is a unique match
6692 t)
6698 selector))))))
6700 ;; This is already complete
6703 nil)
6705 ;; We cannot add something - offer a list.
6713 idlwave-completion-help-links))))
6714 list))
6716 ;; "complete" means, this is already a valid completion
6719 ;; (completion-fixup-function ; Emacs
6720 ;; (lambda () (and (eq (preceding-char) ?>)
6721 ;; (re-search-backward " <" beg t)))))
6729 idlwave-complete-empty-string-as-lower-case)
6735 x)
6736 list)))
6738 t))))
6741 "Complete a class at point."
6743 ;; Call `idlwave-routines' to make sure the class list will be available
6745 ;; Check for the special case of completing empty string after pro/function
6754 ;; Yank the full class specification
6756 ;; Do the completion, using list gathered from `idlwave-routines'
6765 idlwave-completion-help-links))
6766 x))
6767 list)))))
6770 ;; Attach the proper class list to a LIST of completion items.
6771 ;; TYPE, when 'kwd, shows classes for method keywords, when
6772 ;; 'class-tag, for class tags, and otherwise for methods.
6773 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6779 ;; In these cases, we do not have to do anything
6780 list
6784 ;; (do-dots (featurep 'xemacs))
6790 classes nclasses class-info space)
6793 ;; get the classes
6795 ;; Just one class for tags
6799 ;; Multiple classes for method or method-keyword
6803 method-selector x type-selector)
6809 classes)))))
6811 ;; Make the separator between item and class-info
6816 ;; We do want info in the buffer
6819 space
6824 ;; We do want properties
6828 x))
6831 x))
6832 list))))
6835 ;; Call idlwave-attach-classes with method parameters
6838 ;; Call idlwave-attach-classes with keyword parameters
6841 ;; Call idlwave-attach-classes with class structure tags
6845 ;;----------------------------------------------------------------------
6846 ;;----------------------------------------------------------------------
6847 ;;----------------------------------------------------------------------
6848 ;;----------------------------------------------------------------------
6849 ;;----------------------------------------------------------------------
6856 "Select an item in LIST with a popup menu.
6857 TITLE is the title to put atop the popup. If SORT is non-nil,
6858 sort the list before displaying."
6860 rtn menu)
6870 x)))
6871 list)))
6884 rtn))
6887 "Split the MENU into submenus of maximum length N."
6889 ;; No splitting needed
6890 menu
6905 nextmenu))
6907 nextmenu nil
6912 "Split the MENU into submenus of maximum length N."
6914 ;; No splitting needed
6915 menu
6931 nextmenu))
6933 nextmenu nil
6937 menu)))
6942 "Scroll the completion window on this frame."
6960 "Display the completions in LIST in the completions buffer and echo MESSAGE."
6968 list)
6971 ;; Store a special value in `this-command'. When `idlwave-complete'
6972 ;; finds this in `last-command', it will scroll the *Completions* buffer.
6975 ;; Mark the completions buffer as created by cib
6978 ;; Fontify the classes
6983 ;; Run the hook
6986 ;; Display the message
6990 "Call FUNCTION as a completion chooser and pass ARGS to it."
6996 ;; For the shell, remove the fontification of the word before point
7011 "Restore the old (before completion) window configuration."
7013 idlwave-before-completion-wconf
7017 "Make the user select an element from the alist in the variable SYM.
7018 The keys of the alist are expected to be strings. The function returns the
7019 car of the selected association.
7020 To do this, PROMPT is displayed and the user must hit a letter key to
7021 select an entry. If the user does not reply within DELAY seconds, a help
7022 window with the options is displayed automatically.
7023 The key which is associated with each option is generated automatically.
7025 If these don't exist, a letter in the string is automatically selected."
7029 keys-alist char)
7030 ;; First check the cache
7033 ;; Need to make new list
7037 ;; Display prompt and wait for quick reply
7042 ;; No quick reply: Show help
7051 ;; Return the selected result
7054 ;; Used for, e.g., electric debug super-examine.
7056 "Make an alist for single key selection."
7064 ;; First check if the configuration predetermined a key
7071 ;; Then check for capital letters
7081 t t name))
7084 ;; Now check for lowercase letters
7094 t t name))
7097 ;; Bummer, nothing found! Use a stupid number
7104 "Set the buffer-local value of VAR in BUFFER to VALUE."
7109 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
7114 ;; In XEmacs, we can use :activate-callback directly to advice the
7115 ;; choose functions. We use the private keymap only for the online
7116 ;; help feature.
7125 cl-args))
7134 "Execute `default-choose-completion' and then restore the win-conf."
7138 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7141 (define-key new-map [button3] (lambda ()
7142 (interactive)
7143 (setq this-command last-command)))
7144 new-map))
7146 ;; In Emacs we also replace keybindings in the completion
7147 ;; map in order to install our wrappers.
7149 (defun idlwave-display-completion-list-emacs (list)
7150 "Display completion list and install the choose wrappers."
7151 (with-output-to-temp-buffer "*Completions*"
7152 (display-completion-list list))
7153 (with-current-buffer "*Completions*"
7154 (use-local-map
7155 (or idlwave-completion-map
7156 (setq idlwave-completion-map
7157 (idlwave-make-modified-completion-map-emacs
7158 (current-local-map)))))))
7160 (defun idlwave-make-modified-completion-map-emacs (old-map)
7161 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7162 (let ((new-map (copy-keymap old-map)))
7163 (substitute-key-definition
7164 'choose-completion 'idlwave-choose-completion new-map)
7165 (substitute-key-definition
7166 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
7167 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
7168 new-map))
7170 (defun idlwave-choose-completion (&rest args)
7171 "Choose the completion that point is in or next to."
7172 (interactive)
7173 (apply 'idlwave-choose 'choose-completion args))
7175 (defun idlwave-mouse-choose-completion (&rest args)
7176 "Click on an alternative in the `*Completions*' buffer to choose it."
7177 (interactive "e")
7178 (apply 'idlwave-choose 'mouse-choose-completion args))
7180 ;;----------------------------------------------------------------------
7181 ;;----------------------------------------------------------------------
7183 ;;; ------------------------------------------------------------------------
7184 ;;; Structure parsing code, and code to manage class info
7186 ;;
7187 ;; - Go again over the documentation how to write a completion
7188 ;; plugin. It is in self.el, but currently still very bad.
7189 ;; This could be in a separate file in the distribution, or
7190 ;; in an appendix for the manual.
7192 (defvar idlwave-struct-skip
7194 "Regexp for skipping continued blank or comment-only lines in structures.")
7196 (defvar idlwave-struct-tag-regexp
7197 (concat "[{,]" ;leading comma/brace
7198 idlwave-struct-skip ; 4 groups
7201 "Regexp for structure tags.")
7203 (defun idlwave-struct-tags ()
7204 "Return a list of all tags in the structure defined at point.
7205 Point is expected just before the opening `{' of the struct definition."
7206 (save-excursion
7207 (let* ((borders (idlwave-struct-borders))
7208 (beg (car borders))
7209 (end (cdr borders))
7210 tags)
7211 (goto-char beg)
7212 (save-restriction
7213 (narrow-to-region beg end)
7214 (while (re-search-forward idlwave-struct-tag-regexp end t)
7215 ;; Check if we are still on the top level of the structure.
7216 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7217 (= (point) beg))
7218 (push (match-string-no-properties 5) tags))
7219 (goto-char (match-end 0))))
7220 (nreverse tags))))
7222 (defun idlwave-find-struct-tag (tag)
7223 "Find a given TAG in the structure defined at point."
7224 (let* ((borders (idlwave-struct-borders))
7225 (end (cdr borders))
7226 (case-fold-search t))
7228 end t)))
7230 (defun idlwave-struct-inherits ()
7231 "Return a list of all `inherits' names in the struct at point.
7232 Point is expected just before the opening `{' of the struct definition."
7233 (save-excursion
7234 (let* ((borders (idlwave-struct-borders))
7235 (beg (car borders))
7236 (end (cdr borders))
7237 (case-fold-search t)
7238 names)
7239 (goto-char beg)
7240 (save-restriction
7241 (narrow-to-region beg end)
7242 (while (re-search-forward
7243 (concat "[{,]" ;leading comma/brace
7244 idlwave-struct-skip ; 4 groups
7245 "inherits" ; The INHERITS tag
7246 idlwave-struct-skip ; 4 more
7248 end t)
7249 ;; Check if we are still on the top level of the structure.
7250 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7251 (= (point) beg))
7252 (push (match-string-no-properties 9) names))
7253 (goto-char (match-end 0))))
7254 (nreverse names))))
7256 (defun idlwave-in-structure ()
7257 "Return t if point is inside an IDL structure definition."
7258 (let ((beg (point)))
7259 (save-excursion
7260 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
7261 (if (idlwave-find-structure-definition nil nil 'back)
7262 (let ((borders (idlwave-struct-borders)))
7263 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
7264 (and (> beg (car borders)) (< beg (cdr borders))))))))))
7266 (defun idlwave-struct-borders ()
7267 "Return the borders of the {...} after point as a cons cell."
7268 (let (beg)
7269 (save-excursion
7270 (skip-chars-forward "^{")
7271 (setq beg (point))
7272 (condition-case nil (forward-list 1)
7273 (error (goto-char beg)))
7274 (cons beg (point)))))
7276 (defun idlwave-find-structure-definition (&optional var name bound)
7277 "Search forward for a structure definition.
7278 If VAR is non-nil, search for a structure assigned to variable VAR.
7279 If NAME is non-nil, search for a named structure NAME, if a string,
7280 or a generic named structure otherwise. If BOUND is an integer, limit
7281 the search. If BOUND is the symbol `all', we search first back and
7282 then forward through the entire file. If BOUND is the symbol `back'
7283 we search only backward."
7285 (case-fold-search t)
7286 (lim (if (integerp bound) bound nil))
7287 (re (concat
7288 (if var
7292 (if name
7293 (if (stringp name)
7295 ;; Just a generic name
7297 ""))))
7298 (if (or (and (or (eq bound 'all) (eq bound 'back))
7299 (re-search-backward re nil t))
7300 (and (not (eq bound 'back)) (re-search-forward re lim t)))
7301 (progn
7302 (goto-char (match-beginning 3))
7303 (match-string-no-properties 5)))))
7305 (defvar idlwave-class-info nil)
7306 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
7308 (add-hook 'idlwave-update-rinfo-hook
7309 (lambda () (setq idlwave-class-reset t)))
7310 (add-hook 'idlwave-after-load-rinfo-hook
7311 (lambda () (setq idlwave-class-info nil)))
7313 (defun idlwave-class-info (class)
7314 (let (list entry)
7315 (if idlwave-class-info
7316 (if idlwave-class-reset
7317 (setq
7318 idlwave-class-reset nil
7319 idlwave-class-info ; Remove any visited in a buffer
7320 (delq nil (mapcar
7321 (lambda (x)
7322 (let ((filebuf
7323 (idlwave-class-file-or-buffer
7324 (or (cdr (assq 'found-in x)) (car x)))))
7325 (if (cdr filebuf)
7326 nil
7327 x)))
7328 idlwave-class-info))))
7329 ;; Info is nil, put in the system stuff to start.
7330 (setq idlwave-class-info idlwave-system-class-info)
7331 (setq list idlwave-class-info)
7332 (while (setq entry (pop list))
7333 (idlwave-sintern-class-info entry)))
7334 (setq class (idlwave-sintern-class class))
7335 (or (assq class idlwave-class-info)
7336 (progn (idlwave-scan-class-info class)
7337 (assq class idlwave-class-info)))))
7339 (defun idlwave-sintern-class-info (entry)
7340 "Sintern the class names in a class-info entry."
7341 (let ((inherits (assq 'inherits entry)))
7342 (setcar entry (idlwave-sintern-class (car entry) 'set))
7343 (if inherits
7344 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
7345 (cdr inherits))))))
7347 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
7348 "Find class structure definition(s).
7349 If ALL-HOOK is set, find all named structure definitions in a given
7350 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
7351 set, look for the name__define pro, and inside of it, for the ALT-CLASS
7352 class/struct definition."
7353 (let ((case-fold-search t) end-lim name)
7354 (when (re-search-forward
7356 (if all-hook
7357 (progn
7358 ;; For everything there
7359 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
7360 (while (setq name
7361 (idlwave-find-structure-definition nil t end-lim))
7362 (funcall all-hook name)))
7363 (idlwave-find-structure-definition nil (or alt-class class))))))
7366 (defun idlwave-class-file-or-buffer (class)
7367 "Find buffer visiting CLASS definition."
7368 (let* ((pro (concat (downcase class) "__define"))
7369 (file (idlwave-routine-source-file
7370 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
7371 (idlwave-routines))))))
7372 (cons file (if file (idlwave-get-buffer-visiting file)))))
7375 (defun idlwave-scan-class-info (class)
7376 "Scan all class and named structure info in the class__define pro."
7377 (let* ((idlwave-auto-routine-info-updates nil)
7378 (filebuf (idlwave-class-file-or-buffer class))
7379 (file (car filebuf))
7380 (buf (cdr filebuf))
7381 (class (idlwave-sintern-class class)))
7382 (if (or
7383 (not file)
7384 (and ;; neither a regular file nor a visited buffer
7385 (not buf)
7386 (not (file-regular-p file))))
7387 nil ; Cannot find the file/buffer to get any info
7388 (save-excursion
7389 (if buf (set-buffer buf)
7390 ;; Read the file in temporarily
7391 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
7392 (erase-buffer)
7393 (unless (derived-mode-p 'idlwave-mode)
7394 (idlwave-mode))
7395 (insert-file-contents file))
7396 (save-excursion
7397 (goto-char 1)
7398 (idlwave-find-class-definition class
7399 ;; Scan all of the structures found there
7400 (lambda (name)
7401 (let* ((this-class (idlwave-sintern-class name))
7402 (entry
7403 (list this-class
7404 (cons 'tags (idlwave-struct-tags))
7405 (cons 'inherits (idlwave-struct-inherits)))))
7406 (if (not (eq this-class class))
7407 (setq entry (nconc entry (list (cons 'found-in class)))))
7408 (idlwave-sintern-class-info entry)
7409 (push entry idlwave-class-info)))))))))
7411 (defun idlwave-class-found-in (class)
7412 "Return the FOUND-IN property of the CLASS."
7413 (cdr (assq 'found-in (idlwave-class-info class))))
7414 (defun idlwave-class-tags (class)
7415 "Return the native tags in CLASS."
7416 (cdr (assq 'tags (idlwave-class-info class))))
7417 (defun idlwave-class-inherits (class)
7418 "Return the direct superclasses of CLASS."
7419 (cdr (assq 'inherits (idlwave-class-info class))))
7422 (defun idlwave-all-class-tags (class)
7423 "Return a list of native and inherited tags in CLASS."
7424 (condition-case err
7425 (apply 'append (mapcar 'idlwave-class-tags
7426 (cons class (idlwave-all-class-inherits class))))
7427 (error
7428 (idlwave-class-tag-reset)
7429 (error "%s" (error-message-string err)))))
7432 (defun idlwave-all-class-inherits (class)
7433 "Return a list of all superclasses of CLASS (recursively expanded).
7434 The list is cached in `idlwave-class-info' for faster access."
7435 (cond
7436 ((not idlwave-support-inheritance) nil)
7437 ((eq class nil) nil)
7438 ((eq class t) nil)
7439 (t
7440 (let ((info (idlwave-class-info class))
7441 entry)
7442 (if (setq entry (assq 'all-inherits info))
7443 (cdr entry)
7444 ;; Save the depth of inheritance scan to check for circular references
7445 (let ((inherits (mapcar (lambda (x) (cons x 0))
7446 (idlwave-class-inherits class)))
7447 rtn all-inherits cl)
7448 (while inherits
7449 (setq cl (pop inherits)
7450 rtn (cons (car cl) rtn)
7451 inherits (append (mapcar (lambda (x)
7452 (cons x (1+ (cdr cl))))
7453 (idlwave-class-inherits (car cl)))
7454 inherits))
7455 (if (> (cdr cl) 999)
7456 (error
7457 "Class scan: inheritance depth exceeded. Circular inheritance?")
7458 ))
7459 (setq all-inherits (nreverse rtn))
7460 (nconc info (list (cons 'all-inherits all-inherits)))
7461 all-inherits))))))
7463 (defun idlwave-entry-keywords (entry &optional record-link)
7464 "Return the flat entry keywords alist from routine-info entry.
7465 If RECORD-LINK is non-nil, the keyword text is copied and a text
7466 property indicating the link is added."
7467 (let (kwds)
7468 (mapc
7469 (lambda (key-list)
7470 (let ((file (car key-list)))
7471 (mapcar (lambda (key-cons)
7472 (let ((key (car key-cons))
7473 (link (cdr key-cons)))
7474 (when (and record-link file)
7475 (setq key (copy-sequence key))
7476 (put-text-property
7477 0 (length key)
7478 'link
7479 (concat
7480 file
7481 (if link
7482 (concat idlwave-html-link-sep
7483 (number-to-string link))))
7484 key))
7485 (push (list key) kwds)))
7486 (cdr key-list))))
7487 (nthcdr 5 entry))
7488 (nreverse kwds)))
7490 (defun idlwave-entry-find-keyword (entry keyword)
7491 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set."
7492 (catch 'exit
7493 (mapc
7494 (lambda (key-list)
7495 (let ((file (car key-list))
7496 (kwd (assoc keyword (cdr key-list))))
7497 (when kwd
7498 (setq kwd (cons (car kwd)
7499 (if (and file (cdr kwd))
7500 (concat file
7501 idlwave-html-link-sep
7502 (number-to-string (cdr kwd)))
7503 (cdr kwd))))
7504 (throw 'exit kwd))))
7505 (nthcdr 5 entry))))
7507 ;;==========================================================================
7508 ;;
7509 ;; Completing class structure tags. This is a completion plugin.
7510 ;; The necessary taglist is constructed dynamically
7512 (defvar idlwave-current-tags-class nil)
7513 (defvar idlwave-current-class-tags nil)
7514 (defvar idlwave-current-native-class-tags nil)
7515 (defvar idlwave-sint-class-tags nil)
7516 (declare-function idlwave-sintern-class-tag "idlwave" t t)
7517 (idlwave-new-sintern-type 'class-tag)
7518 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7519 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7521 (defun idlwave-complete-class-structure-tag ()
7522 "Complete a structure tag on a `self' argument in an object method."
7523 (interactive)
7524 (let ((pos (point))
7525 (case-fold-search t))
7526 (if (save-excursion
7527 ;; Check if the context is right
7528 (skip-chars-backward "a-zA-Z0-9._$")
7529 (and (< (point) (- pos 4))
7531 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7532 (super-classes (idlwave-all-class-inherits class-selector)))
7533 ;; Check if we are in a class routine
7534 (unless class-selector
7535 (error "Not in a method procedure or function"))
7536 ;; Check if we need to update the "current" class
7537 (if (not (equal class-selector idlwave-current-tags-class))
7538 (idlwave-prepare-class-tag-completion class-selector))
7539 (setq idlwave-completion-help-info
7540 (list 'idlwave-complete-class-structure-tag-help
7541 (idlwave-sintern-routine
7542 (concat class-selector "__define"))
7543 nil))
7544 ;; FIXME: idlwave-cpl-bold doesn't seem used anywhere.
7545 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7546 (idlwave-complete-in-buffer
7547 'class-tag 'class-tag
7548 idlwave-current-class-tags nil
7549 (format "Select a tag of class %s" class-selector)
7550 "class tag"
7551 'idlwave-attach-class-tag-classes))
7552 t) ; return t to skip other completions
7553 nil)))
7555 (defun idlwave-class-tag-reset ()
7556 (setq idlwave-current-tags-class nil))
7558 (defun idlwave-prepare-class-tag-completion (class)
7559 "Find and parse the necessary class definitions for class structure tags."
7560 (setq idlwave-sint-class-tags nil)
7561 (setq idlwave-current-tags-class class)
7562 (setq idlwave-current-class-tags
7563 (mapcar (lambda (x)
7564 (list (idlwave-sintern-class-tag x 'set)))
7565 (idlwave-all-class-tags class)))
7566 (setq idlwave-current-native-class-tags
7567 (mapcar 'downcase (idlwave-class-tags class))))
7569 ;===========================================================================
7570 ;;
7571 ;; Completing system variables and their structure fields
7572 ;; This is also a plugin.
7574 (defvar idlwave-sint-sysvars nil)
7575 (defvar idlwave-sint-sysvartags nil)
7576 (declare-function idlwave-sintern-sysvar "idlwave" t t)
7577 (declare-function idlwave-sintern-sysvartag "idlwave" t t)
7578 (idlwave-new-sintern-type 'sysvar)
7579 (idlwave-new-sintern-type 'sysvartag)
7580 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7581 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7582 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7585 (defun idlwave-complete-sysvar-or-tag ()
7586 "Complete a system variable."
7587 (interactive)
7588 (let ((pos (point))
7589 (case-fold-search t))
7590 (cond ((save-excursion
7591 ;; Check if the context is right for system variable
7592 (skip-chars-backward "[a-zA-Z0-9_$]")
7593 (equal (char-before) ?!))
7594 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7595 (idlwave-complete-in-buffer 'sysvar 'sysvar
7596 idlwave-system-variables-alist nil
7597 "Select a system variable"
7598 "system variable")
7599 t) ; return t to skip other completions
7600 ((save-excursion
7601 ;; Check if the context is right for sysvar tag
7602 (skip-chars-backward "a-zA-Z0-9_$.")
7603 (and (equal (char-before) ?!)
7605 (<= (match-end 0) pos)))
7606 ;; Complete a system variable tag
7607 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7608 (entry (assq var idlwave-system-variables-alist))
7609 (tags (cdr (assq 'tags entry))))
7610 (or entry (error "!%s is not a known system variable" var))
7611 (or tags (error "System variable !%s is not a structure" var))
7612 (setq idlwave-completion-help-info
7613 (list 'idlwave-complete-sysvar-tag-help var))
7614 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7615 tags nil
7616 "Select a system variable tag"
7617 "system variable tag")
7618 t)) ; return t to skip other completions
7619 (t nil))))
7621 (defvar idlw-help-link) ;dynamic variables set by help callback
7622 (defun idlwave-complete-sysvar-help (mode word)
7623 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7624 (entry (assoc word idlwave-system-variables-alist)))
7625 (cond
7626 ((eq mode 'test)
7627 (and (stringp word) entry (nth 1 (assq 'link entry))))
7628 ((eq mode 'set)
7629 ;; Setting dynamic!!!
7630 (if entry (setq idlw-help-link (nth 1 (assq 'link entry)))))
7631 (t (error "This should not happen")))))
7633 (defun idlwave-complete-sysvar-tag-help (mode word)
7634 (let* ((var (nth 1 idlwave-completion-help-info))
7635 (entry (assoc var idlwave-system-variables-alist))
7636 (tags (cdr (assq 'tags entry)))
7637 (main (nth 1 (assq 'link entry)))
7638 target)
7639 (cond
7640 ((eq mode 'test) ; we can at least link the main
7641 (and (stringp word) entry main))
7642 ((eq mode 'set)
7643 (if entry
7644 (setq idlw-help-link
7645 (if (setq target (cdr (assoc-string word tags t)))
7646 (idlwave-substitute-link-target main target)
7647 main)))) ;; setting dynamic!!!
7648 (t (error "This should not happen")))))
7650 (defun idlwave-split-link-target (link)
7651 "Split a given LINK into link file and anchor."
7652 (if (string-match idlwave-html-link-sep link)
7653 (cons (substring link 0 (match-beginning 0))
7654 (string-to-number (substring link (match-end 0))))))
7656 (defun idlwave-substitute-link-target (link target)
7657 "Substitute the TARGET anchor for the given LINK."
7658 (let (main-base)
7659 (setq main-base (if (string-match "#" link)
7660 (substring link 0 (match-beginning 0))
7661 link))
7662 (if target
7663 (concat main-base idlwave-html-link-sep (number-to-string target))
7664 link)))
7666 ;; Fake help in the source buffer for class structure tags.
7667 ;; IDLW-HELP-LINK AND IDLW-HELP-NAME ARE GLOBAL-VARIABLES HERE.
7668 ;; (from idlwave-do-mouse-completion-help)
7669 (defvar idlw-help-name)
7670 (defvar idlw-help-link)
7671 (defvar idlwave-help-do-class-struct-tag nil)
7672 (defun idlwave-complete-class-structure-tag-help (mode word)
7673 (cond
7674 ((eq mode 'test) ; nothing gets fontified for class tags
7675 nil)
7676 ((eq mode 'set)
7677 (let (class-with found-in)
7678 (when (setq class-with
7679 (idlwave-class-or-superclass-with-tag
7680 idlwave-current-tags-class
7681 word))
7682 (if (assq (idlwave-sintern-class class-with)
7683 idlwave-system-class-info)
7684 (error "No help available for system class tags"))
7685 (if (setq found-in (idlwave-class-found-in class-with))
7686 (setq idlw-help-name (cons (concat found-in "__define") class-with))
7687 (setq idlw-help-name (concat class-with "__define")))))
7688 (setq idlw-help-link word
7689 idlwave-help-do-class-struct-tag t))
7690 (t (error "This should not happen"))))
7692 (defun idlwave-class-or-superclass-with-tag (class tag)
7693 "Find and return the CLASS or one of its superclass with the
7694 associated TAG, if any."
7695 (let ((sclasses (cons class (idlwave-all-class-inherits class)))
7696 cl)
7697 (catch 'exit
7698 (while sclasses
7699 (setq cl (pop sclasses))
7700 (let ((tags (idlwave-class-tags cl)))
7701 (while tags
7702 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7703 (throw 'exit cl))
7704 (setq tags (cdr tags))))))))
7707 (defun idlwave-sysvars-reset ()
7708 (if (and (fboundp 'idlwave-shell-is-running)
7709 (idlwave-shell-is-running)
7710 idlwave-idlwave_routine_info-compiled)
7711 (idlwave-shell-send-command "idlwave_get_sysvars"
7712 'idlwave-process-sysvars 'hide)))
7714 (defun idlwave-process-sysvars ()
7715 (idlwave-shell-filter-sysvars)
7716 (setq idlwave-sint-sysvars nil
7717 idlwave-sint-sysvartags nil)
7718 (idlwave-sintern-sysvar-alist))
7720 (defun idlwave-sintern-sysvar-alist ()
7721 (let ((list idlwave-system-variables-alist) entry tags)
7722 (while (setq entry (pop list))
7723 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7724 (setq tags (assq 'tags entry))
7725 (if tags
7726 (setcdr tags
7727 (mapcar (lambda (x)
7728 (cons (idlwave-sintern-sysvartag (car x) 'set)
7729 (cdr x)))
7730 (cdr tags)))))))
7732 (defvar idlwave-shell-command-output)
7733 (defun idlwave-shell-filter-sysvars ()
7734 "Get any new system variables and tags."
7735 (let ((text idlwave-shell-command-output)
7736 (start 0)
7737 (old idlwave-system-variables-alist)
7738 var tags type name class link old-entry)
7739 (setq idlwave-system-variables-alist nil)
7741 text start)
7742 (setq start (match-end 0)
7743 var (match-string 1 text)
7744 tags (if (match-end 3)
7745 (idlwave-split-string (match-string 3 text))))
7746 ;; Maintain old links, if present
7747 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7748 (setq link (assq 'link old-entry))
7749 (setq idlwave-system-variables-alist
7750 (cons (list var
7751 (cons
7752 'tags
7753 (mapcar (lambda (x)
7754 (cons x
7755 (cdr (assq
7756 (idlwave-sintern-sysvartag x)
7757 (cdr (assq 'tags old-entry))))))
7758 tags)) link)
7759 idlwave-system-variables-alist)))
7760 ;; Keep the old value if query was not successful
7761 (setq idlwave-system-variables-alist
7762 (or idlwave-system-variables-alist old))))
7764 (defun idlwave-completion-fontify-classes ()
7765 "Goto the *Completions* buffer and fontify the class info."
7766 (when (featurep 'font-lock)
7767 (with-current-buffer "*Completions*"
7768 (save-excursion
7769 (goto-char (point-min))
7770 (let ((buffer-read-only nil))
7772 (put-text-property (match-beginning 0) (match-end 0)
7773 'face 'font-lock-string-face)))))))
7775 (defun idlwave-uniquify (list)
7776 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7777 (delq nil
7778 (mapcar (lambda (x)
7779 (unless (gethash x ht)
7780 (puthash x t ht)
7781 x))
7782 list))))
7784 (defun idlwave-after-successful-completion (type slash &optional verify)
7785 "Add `=' or `(' after successful completion of keyword and function.
7786 Restore the pre-completion window configuration if possible."
7787 (cond
7788 ((eq type 'procedure)
7789 nil)
7790 ((eq type 'function)
7791 (cond
7792 ((equal idlwave-function-completion-adds-paren nil) nil)
7793 ((or (equal idlwave-function-completion-adds-paren t)
7794 (equal idlwave-function-completion-adds-paren 1))
7795 (insert "("))
7796 ((equal idlwave-function-completion-adds-paren 2)
7797 (insert "()")
7798 (backward-char 1))
7799 (t nil)))
7800 ((eq type 'keyword)
7801 (if (and idlwave-keyword-completion-adds-equal
7802 (not slash))
7803 (progn (insert "=") t)
7804 nil)))
7806 ;; Restore the pre-completion window configuration if this is safe.
7808 (if (or (eq verify 'force) ; force
7809 (and
7810 (get-buffer-window "*Completions*") ; visible
7811 (idlwave-local-value 'idlwave-completion-p
7812 "*Completions*") ; cib-buffer
7813 (eq (marker-buffer idlwave-completion-mark)
7814 (current-buffer)) ; buffer OK
7815 (equal (marker-position idlwave-completion-mark)
7816 verify))) ; pos OK
7817 (idlwave-restore-wconf-after-completion))
7818 (move-marker idlwave-completion-mark nil)
7819 (setq idlwave-before-completion-wconf nil))
7821 (defun idlwave-mouse-context-help (ev &optional arg)
7822 "Call `idlwave-context-help' on the clicked location."
7823 (interactive "eP")
7824 (mouse-set-point ev)
7825 (idlwave-context-help arg))
7827 (defvar idlwave-last-context-help-pos nil)
7828 (defun idlwave-context-help (&optional arg)
7829 "Display IDL Online Help on context.
7830 If point is on a keyword, help for that keyword will be shown. If
7831 point is on a routine name or in the argument list of a routine, help
7832 for that routine will be displayed. Works for system routines and
7833 keywords, it pulls up text help. For other routines and keywords,
7834 visits the source file, finding help in the header (if
7835 `idlwave-help-source-try-header' is non-nil) or the routine definition
7836 itself."
7837 (interactive "P")
7838 (idlwave-do-context-help arg))
7840 (defun idlwave-mouse-completion-help (ev)
7841 "Display online help about the completion at point."
7842 (interactive "eP")
7843 ;; Restore last-command for next command, to make
7844 ;; scrolling/canceling of completions work.
7845 (setq this-command last-command)
7846 (idlwave-do-mouse-completion-help ev))
7848 (defun idlwave-routine-info (&optional arg external)
7849 "Display a routines calling sequence and list of keywords.
7850 When point is on the name a function or procedure, or in the argument
7851 list of a function or procedure, this command displays a help buffer with
7852 the information. When called with prefix arg, enforce class query.
7854 When point is on an object operator `->', display the class stored in
7855 this arrow, if any (see `idlwave-store-inquired-class'). With a prefix
7856 arg, the class property is cleared out."
7858 (interactive "P")
7859 (idlwave-routines)
7860 (if (string-match "->" (buffer-substring
7861 (max (point-min) (1- (point)))
7862 (min (+ 2 (point)) (point-max))))
7863 ;; Cursor is on an arrow
7864 (if (get-text-property (point) 'idlwave-class)
7865 ;; arrow has class property
7866 (if arg
7867 ;; Remove property
7868 (save-excursion
7869 (backward-char 1)
7871 (remove-text-properties (match-beginning 1) (match-end 1)
7872 '(idlwave-class nil face nil))
7873 (message "Class property removed from arrow")))
7874 ;; Echo class property
7875 (message "Arrow has text property identifying object to be class %s"
7876 (get-text-property (point) 'idlwave-class)))
7877 ;; No property found
7878 (message "Arrow has no class text property"))
7880 ;; Not on an arrow...
7881 (let* ((idlwave-query-class nil)
7882 (idlwave-force-class-query (equal arg '(4)))
7883 (module (idlwave-what-module)))
7884 (if (car module)
7885 (apply 'idlwave-display-calling-sequence
7886 (idlwave-fix-module-if-obj_new module))
7887 (error "Don't know which calling sequence to show")))))
7889 (defun idlwave-resolve (&optional arg)
7890 "Call RESOLVE_ROUTINE on the module name at point.
7891 Like `idlwave-routine-info', this looks for a routine call at point.
7892 After confirmation in the minibuffer, it will use the shell to issue
7893 a RESOLVE call for this routine, to attempt to make it defined and its
7894 routine info available for IDLWAVE. If the routine is a method call,
7895 both `class__method' and `class__define' will be tried.
7896 With ARG, enforce query for the class of object methods."
7897 (interactive "P")
7898 (let* ((idlwave-query-class nil)
7899 (idlwave-force-class-query (equal arg '(4)))
7900 (module (idlwave-what-module))
7901 (name (idlwave-make-full-name (nth 2 module) (car module)))
7902 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7903 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7904 (kwd "")
7905 class)
7907 resolve)
7908 (setq type (match-string 1 resolve)
7909 class (if (match-beginning 2)
7910 (match-string 3 resolve)
7911 nil)
7912 name (match-string 4 resolve)))
7913 (if (string= (downcase type) "function")
7914 (setq kwd ",/is_function"))
7916 (cond
7917 ((null class)
7918 (idlwave-shell-send-command
7919 (format "resolve_routine,'%s'%s" (downcase name) kwd)
7920 'idlwave-update-routine-info
7921 nil t))
7922 (t
7923 (idlwave-shell-send-command
7924 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
7925 (list 'idlwave-shell-send-command
7926 (format "resolve_routine,'%s__%s'%s"
7927 (downcase class) (downcase name) kwd)
7928 '(idlwave-update-routine-info)
7929 nil t))))))
7931 (defun idlwave-find-module-this-file ()
7932 (interactive)
7933 (idlwave-find-module '(4)))
7935 (defun idlwave-find-module (&optional arg)
7936 "Find the source code of an IDL module.
7937 Works for modules for which IDLWAVE has routine info available.
7938 The function offers as default the module name `idlwave-routine-info'
7939 would use. With ARG limit to this buffer. With two prefix ARG's
7940 force class query for object methods."
7941 (interactive "P")
7942 (let* ((idlwave-query-class nil)
7943 (idlwave-force-class-query (equal arg '(16)))
7944 (this-buffer (equal arg '(4)))
7945 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
7946 (default (if module
7947 (concat (idlwave-make-full-name
7948 (nth 2 module) (car module))
7949 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
7950 "none"))
7951 (list
7952 (idlwave-uniquify
7953 (delq nil
7954 (mapcar (lambda (x)
7955 (if (eq 'system (car-safe (nth 3 x)))
7956 ;; Take out system routines with no source.
7957 nil
7958 (list
7959 (concat (idlwave-make-full-name
7960 (nth 2 x) (car x))
7961 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
7962 (if this-buffer
7963 (idlwave-save-buffer-update)
7964 (idlwave-routines))))))
7965 (name (idlwave-completing-read
7966 (if (or (not this-buffer)
7967 (assoc default list))
7968 (format "Module (Default %s): " default)
7969 (format "Module in this file: "))
7970 list))
7971 type class)
7973 ;; Nothing, use the default.
7974 (setq name default))
7975 (if (string-match "<[fp]>" name)
7976 (setq type (substring name -2 -1)
7977 name (substring name 0 -3)))
7979 (setq class (match-string 1 name)
7980 name (match-string 2 name)))
7981 (setq name (idlwave-sintern-routine-or-method name class)
7982 class (idlwave-sintern-class class)
7983 type (cond ((equal type "f") 'fun)
7984 ((equal type "p") 'pro)
7985 (t t)))
7986 (idlwave-do-find-module name type class nil this-buffer)))
7988 (defun idlwave-do-find-module (name type class
7989 &optional force-source this-buffer)
7990 (let ((name1 (idlwave-make-full-name class name))
7991 source buf1 entry
7992 (buf (current-buffer))
7993 (pos (point))
7994 file name2)
7995 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
7996 'WITH-FILE)
7997 source (or force-source (nth 3 entry))
7998 name2 (if (nth 2 entry)
7999 (idlwave-make-full-name (nth 2 entry) name)
8000 name1))
8001 (if source
8002 (setq file (idlwave-routine-source-file source)))
8003 (unless file ; Try to find it on the path.
8004 (setq file
8005 (idlwave-expand-lib-file-name
8006 (if class
8007 (format "%s__define.pro" (downcase class))
8008 (format "%s.pro" (downcase name))))))
8009 (cond
8010 ((or (null name) (equal name ""))
8011 (error "Abort"))
8012 ((eq (car source) 'system)
8013 (error "Source code for system routine %s is not available"
8014 name2))
8015 ((or (not file) (not (file-regular-p file)))
8016 (error "Source code for routine %s is not available"
8017 name2))
8018 (t
8019 (when (not this-buffer)
8020 (setq buf1
8021 (idlwave-find-file-noselect file 'find))
8022 (pop-to-buffer buf1 t))
8023 (goto-char (point-max))
8024 (let ((case-fold-search t))
8025 (if (re-search-backward
8027 (cond ((eq type 'fun) "function")
8028 ((eq type 'pro) "pro")
8031 (regexp-quote (downcase name2))
8032 "[^a-zA-Z0-9_$]")
8033 nil t)
8034 (goto-char (match-beginning 0))
8035 (pop-to-buffer buf)
8036 (goto-char pos)
8037 (error "Could not find routine %s" name2)))))))
8039 (defun idlwave-what-module ()
8040 "Return a default module for stuff near point.
8041 Used by `idlwave-routine-info' and `idlwave-find-module'."
8042 (idlwave-routines)
8043 (if (let ((case-fold-search t))
8044 (save-excursion
8045 (idlwave-beginning-of-statement)
8046 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
8047 ;; This is a function or procedure definition statement
8048 ;; We return the defined routine as module.
8049 (list
8050 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
8051 (match-string-no-properties 2))
8052 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
8053 (idlwave-sintern-class (match-string 3)))
8055 ;; Not a definition statement - analyze precise position.
8056 (let* ((where (idlwave-where))
8057 (cw (nth 2 where))
8058 (pro (car (nth 0 where)))
8059 (func (car (nth 1 where)))
8060 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
8061 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
8062 (following-char)))
8063 )
8064 (cond
8065 ((and (eq cw 'procedure)
8066 (not (equal this-word "")))
8067 (setq this-word (idlwave-sintern-routine-or-method
8068 this-word (nth 2 (nth 3 where))))
8069 (list this-word 'pro
8070 (idlwave-determine-class
8071 (cons this-word (cdr (nth 3 where)))
8072 'pro)))
8073 ((and (eq cw 'function)
8074 (not (equal this-word ""))
8075 (or (eq next-char ?\() ; exclude arrays, vars.
8077 (setq this-word (idlwave-sintern-routine-or-method
8078 this-word (nth 2 (nth 3 where))))
8079 (list this-word 'fun
8080 (idlwave-determine-class
8081 (cons this-word (cdr (nth 3 where)))
8082 'fun)))
8083 ((and (memq cw '(function-keyword procedure-keyword))
8084 (not (equal this-word ""))
8085 (eq next-char ?\()) ; A function!
8086 (setq this-word (idlwave-sintern-routine this-word))
8087 (list this-word 'fun nil))
8088 (func
8089 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
8090 (pro
8091 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
8092 (t nil)))))
8094 (defun idlwave-what-module-find-class ()
8095 "Call `idlwave-what-module' and find the inherited class if necessary."
8096 (let* ((module (idlwave-what-module))
8097 (class (nth 2 module)))
8098 (if (and (= (length module) 3)
8099 (stringp class))
8100 (list (car module)
8101 (nth 1 module)
8102 (apply 'idlwave-find-inherited-class module))
8103 module)))
8105 (defun idlwave-find-inherited-class (name type class)
8106 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
8107 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
8108 (if entry
8109 (nth 2 entry)
8110 class)))
8112 (defun idlwave-fix-module-if-obj_new (module)
8113 "Check if MODULE points to obj_new.
8114 If yes, and if the cursor is in the keyword region, change to the
8115 appropriate Init method."
8116 (let* ((name (car module))
8117 (pos (point))
8118 (case-fold-search t)
8119 string)
8120 (if (and (stringp name)
8121 (equal (downcase name) "obj_new")
8122 (save-excursion
8123 (idlwave-beginning-of-statement)
8124 (setq string (buffer-substring (point) pos))
8126 string)))
8127 (let ((name "Init")
8128 (class (match-string 1 string)))
8129 (setq module (list (idlwave-sintern-method "Init")
8130 'fun
8131 (idlwave-sintern-class class)))))
8132 module))
8134 (defun idlwave-fix-keywords (name type class keywords
8135 &optional super-classes system)
8136 "Update a list of keywords.
8137 Translate OBJ_NEW, adding all super-class keywords, or all keywords
8138 from all classes if CLASS equals t. If SYSTEM is non-nil, don't
8139 demand _EXTRA in the keyword list."
8140 (let ((case-fold-search t))
8142 ;; If this is the OBJ_NEW function, try to figure out the class and use
8143 ;; the keywords from the corresponding INIT method.
8144 (if (and (equal (upcase name) "OBJ_NEW")
8145 (derived-mode-p 'idlwave-mode 'idlwave-shell-mode))
8146 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
8147 (string (buffer-substring bos (point)))
8148 (case-fold-search t)
8149 class)
8151 string)
8152 (setq class (idlwave-sintern-class (match-string 1 string)))
8153 (setq idlwave-current-obj_new-class class)
8154 (setq keywords
8155 (append keywords
8156 (idlwave-entry-keywords
8157 (idlwave-rinfo-assq
8158 (idlwave-sintern-method "INIT")
8159 'fun
8160 class
8161 (idlwave-routines)) 'do-link))))))
8163 ;; If the class is `t', combine all keywords of all methods NAME
8164 (when (eq class t)
8165 (mapc (lambda (entry)
8166 (and
8167 (nth 2 entry) ; non-nil class
8168 (eq (nth 1 entry) type) ; correct type
8169 (setq keywords
8170 (append keywords
8171 (idlwave-entry-keywords entry 'do-link)))))
8172 (idlwave-all-assq name (idlwave-routines)))
8173 (setq keywords (idlwave-uniquify keywords)))
8175 ;; If we have inheritance, add all keywords from superclasses, if
8176 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
8177 (when (and
8178 super-classes
8179 idlwave-keyword-class-inheritance
8180 (stringp class)
8181 (or
8182 system
8183 (assq (idlwave-sintern-keyword "_extra") keywords)
8184 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
8185 ;; Check if one of the keyword-class regexps matches the name
8186 (let ((regexps idlwave-keyword-class-inheritance) re)
8187 (catch 'exit
8188 (while (setq re (pop regexps))
8189 (if (string-match re name) (throw 'exit t))))))
8191 (loop for entry in (idlwave-routines) do
8192 (and (nth 2 entry) ; non-nil class
8193 (memq (nth 2 entry) super-classes) ; an inherited class
8194 (eq (nth 1 entry) type) ; correct type
8195 (eq (car entry) name) ; correct name
8196 (mapc (lambda (k) (add-to-list 'keywords k))
8197 (idlwave-entry-keywords entry 'do-link))))
8198 (setq keywords (idlwave-uniquify keywords)))
8200 ;; Return the final list
8201 keywords))
8203 (defun idlwave-expand-keyword (keyword module)
8204 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
8205 KEYWORD may be an exact match or an abbreviation of a keyword.
8206 If the match is exact, KEYWORD itself is returned, even if there may be other
8207 keywords of which KEYWORD is an abbreviation. This is necessary because some
8208 system routines have keywords which are prefixes of other keywords.
8209 If KEYWORD is an abbreviation of several keywords, a list of all possible
8210 completions is returned.
8211 If the abbreviation was unique, the correct keyword is returned.
8212 If it cannot be a keyword, the function return nil.
8213 If we do not know about MODULE, just return KEYWORD literally."
8214 (let* ((name (car module))
8215 (type (nth 1 module))
8216 (class (nth 2 module))
8217 (kwd (idlwave-sintern-keyword keyword))
8218 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
8219 (kwd-alist (idlwave-entry-keywords entry))
8220 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
8221 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
8222 (completion-ignore-case t)
8223 candidates)
8224 (cond ((assq kwd kwd-alist)
8225 kwd)
8226 ((setq candidates (all-completions kwd kwd-alist))
8227 (if (= (length candidates) 1)
8228 (car candidates)
8229 candidates))
8230 ((and entry extra)
8231 ;; Inheritance may cause this keyword to be correct
8232 keyword)
8233 (entry
8234 ;; We do know the function, which does not have the keyword.
8235 nil)
8236 (t
8237 ;; We do not know the function, so this just might be a correct
8238 ;; keyword - return it as it is.
8239 keyword))))
8241 (defvar idlwave-rinfo-mouse-map
8242 (let ((map (make-sparse-keymap)))
8243 (define-key map
8244 (if (featurep 'xemacs) [button2] [mouse-2])
8245 'idlwave-mouse-active-rinfo)
8246 (define-key map
8247 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
8248 'idlwave-mouse-active-rinfo-shift)
8249 (define-key map
8250 (if (featurep 'xemacs) [button3] [mouse-3])
8251 'idlwave-mouse-active-rinfo-right)
8252 (define-key map " " 'idlwave-active-rinfo-space)
8253 (define-key map "q" 'idlwave-quit-help)
8254 map))
8256 (defvar idlwave-rinfo-map
8257 (let ((map (make-sparse-keymap)))
8258 (define-key map "q" 'idlwave-quit-help)
8259 map))
8261 (defvar idlwave-popup-source nil)
8262 (defvar idlwave-rinfo-marker (make-marker))
8264 (defun idlwave-quit-help ()
8265 (interactive)
8266 (let ((ri-window (get-buffer-window "*Help*"))
8267 (olh-window (get-buffer-window "*IDLWAVE Help*")))
8268 (when (and olh-window
8269 (fboundp 'idlwave-help-quit))
8270 (select-window olh-window)
8271 (idlwave-help-quit))
8272 (when (window-live-p ri-window)
8273 (delete-window ri-window))))
8275 (defun idlwave-display-calling-sequence (name type class
8276 &optional initial-class)
8277 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
8278 (let* ((initial-class (or initial-class class))
8279 (entry (or (idlwave-best-rinfo-assq name type class
8280 (idlwave-routines))
8281 (idlwave-rinfo-assq name type class
8282 idlwave-unresolved-routines)))
8283 (name (or (car entry) name))
8284 (class (or (nth 2 entry) class))
8285 (superclasses (idlwave-all-class-inherits initial-class))
8286 (twins (idlwave-routine-twins entry))
8287 (dtwins (idlwave-study-twins twins))
8288 (all dtwins)
8289 (system (eq (car (nth 3 entry)) 'system))
8290 (calling-seq (nth 4 entry))
8291 (keywords (idlwave-entry-keywords entry 'do-link))
8292 (html-file (car (nth 5 entry)))
8293 (help-echo-kwd
8294 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
8295 (help-echo-use
8296 "Button2/3: Online Help")
8297 (help-echo-src
8298 "Button2: Jump to source and back | Button3: Source in Help window.")
8299 (help-echo-class
8300 "Button2: Display info about same method in superclass")
8301 (col 0)
8302 (data (list name type class (current-buffer) nil initial-class))
8303 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8304 (face 'idlwave-help-link)
8305 beg props win cnt total)
8306 ;; Fix keywords, but don't add chained super-classes, since these
8307 ;; are shown separately for that super-class
8308 (setq keywords (idlwave-fix-keywords name type class keywords))
8309 (cond
8310 ((null entry)
8311 (error "No %s %s known %s" type name
8312 (if initial-class (concat "in class " initial-class) "")))
8313 ((or (null name) (equal name ""))
8314 (error "No function or procedure call at point"))
8315 ((null calling-seq)
8316 (error "Calling sequence of %s %s not available" type name))
8317 (t
8318 (move-marker idlwave-rinfo-marker (point))
8319 (with-current-buffer (get-buffer-create "*Help*")
8320 (use-local-map idlwave-rinfo-map)
8321 (setq buffer-read-only nil)
8322 (erase-buffer)
8323 (set (make-local-variable 'idlwave-popup-source) nil)
8324 (set (make-local-variable 'idlwave-current-obj_new-class)
8325 idlwave-current-obj_new-class)
8326 (when superclasses
8327 (setq props (list 'mouse-face 'highlight
8328 km-prop idlwave-rinfo-mouse-map
8329 'help-echo help-echo-class
8330 'data (cons 'class data)))
8331 (let ((classes (cons initial-class superclasses)) c)
8332 (insert "Classes: ")
8333 (while (setq c (pop classes))
8334 (insert " ")
8335 (setq beg (point))
8336 (insert c)
8337 (if (equal (downcase c) (downcase class))
8338 (add-text-properties beg (point) (list 'face 'bold))
8339 ;; If Method exists in a different class link it
8340 (if (idlwave-rinfo-assq name type c (idlwave-routines))
8341 (add-text-properties beg (point) props))))
8343 (setq props (list 'mouse-face 'highlight
8344 km-prop idlwave-rinfo-mouse-map
8345 'help-echo help-echo-use
8346 'data (cons 'usage data)))
8347 (if html-file (setq props (append (list 'face face 'link html-file)
8348 props)))
8349 (insert "Usage: ")
8350 (setq beg (point))
8351 (insert (if class
8352 (format calling-seq class name class name class name)
8353 (format calling-seq name name name name))
8355 (add-text-properties beg (point) props)
8357 (insert "Keywords:")
8358 (if (null keywords)
8359 (insert " No keywords accepted.")
8360 (setq col 9)
8361 (mapc
8362 (lambda (x)
8363 (if (>= (+ col 1 (length (car x)))
8364 (window-width))
8365 (progn
8367 (setq col 9)))
8368 (insert " ")
8369 (setq beg (point)
8370 ;; Relevant keywords already have link property attached
8371 props (list 'mouse-face 'highlight
8372 km-prop idlwave-rinfo-mouse-map
8373 'data (cons 'keyword data)
8374 'help-echo help-echo-kwd
8375 'keyword (car x)))
8376 (if system (setq props (append (list 'face face) props)))
8377 (insert (car x))
8378 (add-text-properties beg (point) props)
8379 (setq col (+ col 1 (length (car x)))))
8380 keywords))
8382 (setq cnt 1 total (length all))
8383 ;; Here entry is (key file (list of type-conses))
8384 (while (setq entry (pop all))
8385 (setq props (list 'mouse-face 'highlight
8386 km-prop idlwave-rinfo-mouse-map
8387 'help-echo help-echo-src
8388 'source (list (car (car (nth 2 entry))) ;type
8389 (nth 1 entry)
8390 nil
8391 (cdr (car (nth 2 entry))))
8392 'data (cons 'source data)))
8393 (idlwave-insert-source-location
8395 (if (equal cnt 1)
8396 (if (> total 1) "Sources:" "Source:")
8397 "")
8398 (if (> total 1) "- " ""))
8399 entry props)
8400 (incf cnt)
8401 (when (and all (> cnt idlwave-rinfo-max-source-lines))
8402 ;; No more source lines, please
8403 (insert (format
8405 idlwave-rinfo-max-source-lines))
8406 (setq all nil)))
8407 (goto-char (point-min))
8408 (setq buffer-read-only t))
8409 (display-buffer "*Help*")
8410 (if (and (setq win (get-buffer-window "*Help*"))
8411 idlwave-resize-routine-help-window)
8412 (progn
8413 (let ((ww (selected-window)))
8414 (unwind-protect
8415 (progn
8416 (select-window win)
8417 (enlarge-window (- (/ (frame-height) 2)
8418 (window-height)))
8419 (shrink-window-if-larger-than-buffer))
8420 (select-window ww)))))))))
8422 (defun idlwave-insert-source-location (prefix entry &optional file-props)
8423 "Insert a source location into the routine info buffer.
8424 Start line with PREFIX. If a file name is inserted, add FILE-PROPS
8425 to it."
8426 (let* ((key (car entry))
8427 (file (nth 1 entry))
8428 (types (nth 2 entry))
8429 (shell-flag (assq 'compiled types))
8430 (buffer-flag (assq 'buffer types))
8431 (user-flag (assq 'user types))
8432 (lib-flag (assq 'lib types))
8433 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
8434 (and user-flag (idlwave-count-memq 'user types))
8435 (and lib-flag (idlwave-count-memq 'lib types))
8436 1))
8437 (doflags t)
8438 beg special)
8440 (insert prefix)
8442 (cond
8443 ((eq key 'system)
8444 (setq doflags nil)
8445 (insert "System "))
8447 ((eq key 'builtin)
8448 (setq doflags nil)
8449 (insert "Builtin "))
8451 ((and (not file) shell-flag)
8452 (insert "Unresolved"))
8454 ((null file)
8455 (insert "ERROR"))
8457 ((idlwave-syslib-p file)
8458 (if (string-match "obsolete" (file-name-directory file))
8459 (insert "Obsolete ")
8460 (insert "SystemLib ")))
8462 ;; New special syntax: taken directly from routine-info for
8463 ;; library catalog routines
8464 ((setq special (or (cdr lib-flag) (cdr user-flag)))
8465 (insert (format "%-10s" special)))
8467 ;; Old special syntax: a matching regexp
8468 ((setq special (idlwave-special-lib-test file))
8469 (insert (format "%-10s" special)))
8471 ;; Catch-all with file
8472 ((idlwave-lib-p file) (insert "Library "))
8474 ;; Sanity catch all
8475 (t (insert "Other ")))
8477 (when doflags
8478 (insert (concat
8479 " ["
8480 (if lib-flag "L" "-")
8481 (if user-flag "C" "-")
8482 (if shell-flag "S" "-")
8483 (if buffer-flag "B" "-")
8484 "] ")))
8485 (when (> ndupl 1)
8486 (setq beg (point))
8487 (insert (format "(%dx) " ndupl))
8488 (add-text-properties beg (point) (list 'face 'bold)))
8489 (when (and file (not (equal file "")))
8490 (setq beg (point))
8491 (insert (apply 'abbreviate-file-name
8492 (if (featurep 'xemacs) (list file t) (list file))))
8493 (if file-props
8494 (add-text-properties beg (point) file-props)))))
8496 (defun idlwave-special-lib-test (file)
8497 "Check the path of FILE against the regexps which define special libs.
8498 Return the name of the special lib if there is a match."
8499 (let ((alist idlwave-special-lib-alist)
8500 entry rtn)
8501 (cond
8502 ((stringp file)
8503 (while (setq entry (pop alist))
8504 (if (string-match (car entry) file)
8505 (setq rtn (cdr entry)
8506 alist nil)))
8507 rtn)
8508 (t nil))))
8510 (defun idlwave-mouse-active-rinfo-right (ev)
8511 (interactive "e")
8512 (idlwave-mouse-active-rinfo ev 'right))
8514 (defun idlwave-mouse-active-rinfo-shift (ev)
8515 (interactive "e")
8516 (idlwave-mouse-active-rinfo ev nil 'shift))
8518 (defun idlwave-active-rinfo-space ()
8519 (interactive)
8520 (idlwave-mouse-active-rinfo nil 'right))
8522 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8523 "Do the mouse actions in the routine info buffer.
8524 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8525 was pressed."
8526 (interactive "e")
8527 (if ev (mouse-set-point ev))
8528 (let (data id name type class buf bufwin source link keyword
8529 word initial-class)
8530 (setq data (get-text-property (point) 'data)
8531 source (get-text-property (point) 'source)
8532 keyword (get-text-property (point) 'keyword)
8533 link (get-text-property (point) 'link)
8534 id (car data)
8535 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8536 buf (nth 4 data)
8537 initial-class (nth 6 data)
8538 word (idlwave-this-word)
8539 bufwin (get-buffer-window buf t))
8541 (cond ((eq id 'class) ; Switch class being displayed
8542 (if (window-live-p bufwin) (select-window bufwin))
8543 (idlwave-display-calling-sequence
8544 (idlwave-sintern-method name)
8545 type (idlwave-sintern-class word)
8546 initial-class))
8547 ((eq id 'usage) ; Online help on this routine
8548 (idlwave-online-help link name type class))
8549 ((eq id 'source) ; Source in help or buffer
8550 (if right ; In help
8551 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8552 (idlwave-help-source-try-header nil)
8553 ;; Fake idlwave-routines so help will find the right entry
8554 (idlwave-routines
8555 (list (list name type class source ""))))
8556 (idlwave-help-get-special-help name type class nil))
8557 ;; Otherwise just pop to the source
8558 (setq idlwave-popup-source (not idlwave-popup-source))
8559 (if idlwave-popup-source
8560 (condition-case err
8561 (idlwave-do-find-module name type class source)
8562 (error
8563 (setq idlwave-popup-source nil)
8564 (if (window-live-p bufwin) (select-window bufwin))
8565 (error (nth 1 err))))
8566 (if bufwin
8567 (select-window bufwin)
8568 (pop-to-buffer buf))
8569 (goto-char (marker-position idlwave-rinfo-marker)))))
8570 ((eq id 'keyword)
8571 (if right
8572 (idlwave-online-help link name type class keyword)
8573 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8575 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8576 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8577 (let ((bwin (get-buffer-window buffer)))
8578 (if idlwave-complete-empty-string-as-lower-case
8579 (setq keyword (downcase keyword)))
8580 (if bwin
8581 (select-window bwin)
8582 (pop-to-buffer buffer)
8583 (setq bwin (get-buffer-window buffer)))
8584 (if (eq (preceding-char) ?/)
8585 (insert keyword)
8586 (unless (save-excursion
8587 (re-search-backward
8589 (min (- (point) 100) (point-min)) t))
8590 (insert ", "))
8591 (if shift (insert "/"))
8592 (insert keyword)
8593 (if (and (not shift)
8594 idlwave-keyword-completion-adds-equal)
8595 (insert "=")))))
8597 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8598 "List the load path shadows of all routines defined in current buffer."
8599 (interactive "P")
8600 (idlwave-routines)
8601 (if (derived-mode-p 'idlwave-mode)
8602 (idlwave-list-load-path-shadows
8603 nil (idlwave-update-current-buffer-info 'save-buffer)
8604 "in current buffer")
8605 (error "Current buffer is not in idlwave-mode")))
8607 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8608 "List the load path shadows of all routines compiled under the shell.
8609 This is very useful for checking an IDL application. Just compile the
8610 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8611 routines and update IDLWAVE internal info. Then check for shadowing
8612 with this command."
8613 (interactive "P")
8614 (cond
8615 ((or (not (fboundp 'idlwave-shell-is-running))
8616 (not (idlwave-shell-is-running)))
8617 (error "Shell is not running"))
8618 ((null idlwave-compiled-routines)
8619 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8620 (t
8621 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8622 "in the shell"))))
8624 (defun idlwave-list-all-load-path-shadows (&optional arg)
8625 "List the load path shadows of all routines known to IDLWAVE."
8626 (interactive "P")
8627 (idlwave-list-load-path-shadows nil nil "globally"))
8629 (defvar idlwave-sort-prefer-buffer-info t
8630 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8632 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8633 "List the routines which are defined multiple times.
8634 Search the information IDLWAVE has about IDL routines for multiple
8635 definitions.
8636 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8638 When IDL hits a routine call which is not defined, it will search on
8639 the load path in order to find a definition. The output of this command
8640 can be used to detect possible name clashes during this process."
8641 (idlwave-routines) ; Make sure everything is loaded.
8642 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8643 (or (y-or-n-p
8644 "You don't have any user or library catalogs. Continue anyway? ")
8645 (error "Abort")))
8646 (let* ((routines (append idlwave-system-routines
8647 idlwave-compiled-routines
8648 idlwave-library-catalog-routines
8649 idlwave-user-catalog-routines
8650 idlwave-buffer-routines
8651 nil))
8652 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8653 (keymap (make-sparse-keymap))
8654 (props (list 'mouse-face 'highlight
8655 km-prop keymap
8656 'help-echo "Mouse2: Find source"))
8657 (nroutines (length (or special-routines routines)))
8658 (step (/ nroutines 100))
8659 (n 0)
8660 (cnt 0)
8661 (idlwave-sort-prefer-buffer-info nil)
8662 routine twins dtwins twin done props1 lroutines)
8664 (if special-routines
8665 ;; Just looking for shadows of a few special routines
8666 (setq lroutines routines
8667 routines special-routines))
8669 (message "Sorting routines...")
8670 (setq routines (sort routines
8671 (lambda (a b)
8672 (string< (downcase (idlwave-make-full-name
8673 (nth 2 a) (car a)))
8674 (downcase (idlwave-make-full-name
8675 (nth 2 b) (car b)))))))
8676 (message "Sorting routines...done")
8678 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8679 (lambda (ev)
8680 (interactive "e")
8681 (mouse-set-point ev)
8682 (apply 'idlwave-do-find-module
8683 (get-text-property (point) 'find-args))))
8684 (define-key keymap [(return)]
8685 (lambda ()
8686 (interactive)
8687 (apply 'idlwave-do-find-module
8688 (get-text-property (point) 'find-args))))
8689 (message "Compiling list...( 0%%)")
8690 (with-current-buffer (get-buffer-create "*Shadows*")
8691 (setq buffer-read-only nil)
8692 (erase-buffer)
8693 (while (setq routine (pop routines))
8694 (if (= (mod (setq n (1+ n)) step) 0)
8695 (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines)))
8697 ;; Get a list of all twins
8698 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8699 (if (memq routine done)
8700 (setq dtwins nil)
8701 (setq dtwins (idlwave-study-twins twins)))
8702 ;; Mark all twins as dealt with
8703 (setq done (append twins done))
8704 (when (or (> (length dtwins) 1)
8705 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8706 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8707 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8708 (incf cnt)
8710 (idlwave-make-full-name (nth 2 routine)
8711 (car routine))
8712 (if (eq (nth 1 routine) 'fun) "()" "")))
8713 (while (setq twin (pop dtwins))
8714 (setq props1 (append (list 'find-args
8715 (list (nth 0 routine)
8716 (nth 1 routine)
8717 (nth 2 routine)))
8718 props))
8720 (goto-char (point-min))
8721 (setq buffer-read-only t))
8722 (setq loc (or loc ""))
8723 (if (> cnt 0)
8724 (progn
8725 (display-buffer (get-buffer "*Shadows*"))
8726 (message "%d case%s of shadowing found %s"
8727 cnt (if (= cnt 1) "" "s") loc))
8728 (message "No shadowing conflicts found %s" loc))))
8730 (defun idlwave-print-source (routine)
8731 (let* ((source (nth 3 routine))
8732 (stype (car source))
8733 (sfile (idlwave-routine-source-file source)))
8734 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8735 (if (and (eq stype 'compiled)
8736 (or (not (stringp sfile))
8738 (setq stype 'unresolved))
8740 stype
8741 (if sfile sfile "No source code available")))))
8743 (defun idlwave-routine-twins (entry &optional list)
8744 "Return all twin entries of ENTRY in LIST.
8745 LIST defaults to `idlwave-routines'.
8746 Twin entries are those which have the same name, type, and class.
8747 ENTRY will also be returned, as the first item of this list."
8748 (let* ((name (car entry))
8749 (type (nth 1 entry))
8750 (class (nth 2 entry))
8751 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8752 twins candidate)
8753 (while (setq candidate (pop candidates))
8754 (if (and (not (eq candidate entry))
8755 (eq type (nth 1 candidate))
8756 (eq class (nth 2 candidate)))
8757 (push candidate twins)))
8758 (if (setq candidate (idlwave-rinfo-assq name type class
8759 idlwave-unresolved-routines))
8760 (push candidate twins))
8761 (cons entry (nreverse twins))))
8763 (defun idlwave-study-twins (entries)
8764 "Return dangerous twins of first entry in ENTRIES.
8765 Dangerous twins are routines with same name, but in different files on
8766 the load path. If a file is in the system library and has an entry in
8767 the `idlwave-system-routines' list, we omit the latter as
8768 non-dangerous because many IDL routines are implemented as library
8769 routines, and may have been scanned."
8770 (let* ((entry (car entries))
8771 (idlwave-twin-name (car entry)) ;
8772 (type (nth 1 entry)) ; Must be bound for
8773 (idlwave-twin-class (nth 2 entry)) ; idlwave-routine-twin-compare
8774 (cnt 0)
8775 source type type-cons file alist syslibp key)
8776 (while (setq entry (pop entries))
8777 (incf cnt)
8778 (setq source (nth 3 entry)
8779 type (car source)
8780 type-cons (cons type (nth 3 source))
8781 file (idlwave-routine-source-file source))
8783 ;; Make KEY to index entry properly
8784 (setq key (cond ((eq type 'system) type)
8785 (file (file-truename file))
8786 (t 'unresolved)))
8788 ;; Check for an entry in the system library
8789 (if (and file
8790 (not syslibp)
8791 (idlwave-syslib-p file))
8792 (setq syslibp t))
8794 ;; If there's more than one matching entry for the same file, just
8795 ;; append the type-cons to the type list.
8796 (if (setq entry (assoc key alist))
8797 (push type-cons (nth 2 entry))
8798 (push (list key file (list type-cons)) alist)))
8800 (setq alist (nreverse alist))
8802 (when syslibp
8803 ;; File is in system *library* - remove any 'system entry
8804 (setq alist (delq (assq 'system alist) alist)))
8806 ;; If 'system remains and we've scanned the syslib, it's a builtin
8807 ;; (rather than a !DIR/lib/.pro file bundled as source).
8808 (when (and (idlwave-syslib-scanned-p)
8809 (setq entry (assoc 'system alist)))
8810 (setcar entry 'builtin))
8811 (sort alist 'idlwave-routine-twin-compare)))
8813 ;; FIXME: Dynamically scoped vars need to use the `idlwave-' prefix.
8814 ;; (defvar type)
8815 (defmacro idlwave-xor (a b)
8816 `(and (or ,a ,b)
8817 (not (and ,a ,b))))
8819 (defun idlwave-routine-entry-compare (a b)
8820 "Compare two routine info entries for sorting.
8821 This is the general case. It first compares class, names, and type.
8822 If it turns out that A and B are twins (same name, class, and type),
8823 calls another routine which compares twins on the basis of their file
8824 names and path locations."
8825 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8826 (cond
8827 ((not (equal (idlwave-downcase-safe class)
8828 (idlwave-downcase-safe (nth 2 b))))
8829 ;; Class decides
8830 (cond ((null (nth 2 b)) nil)
8831 ((null class) t)
8832 (t (string< (downcase class) (downcase (nth 2 b))))))
8833 ((not (equal (downcase name) (downcase (car b))))
8834 ;; Name decides
8835 (string< (downcase name) (downcase (car b))))
8836 ((not (eq type (nth 1 b)))
8837 ;; Type decides
8838 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8839 (t
8840 ;; A and B are twins - so the decision is more complicated.
8841 ;; Call twin-compare with the proper arguments.
8842 (idlwave-routine-entry-compare-twins a b)))))
8844 (defun idlwave-routine-entry-compare-twins (a b)
8845 "Compare two routine entries, under the assumption that they are twins.
8846 This basically calls `idlwave-routine-twin-compare' with the correct args."
8847 (let* ((idlwave-twin-name (car a))
8848 (type (nth 1 a))
8849 (idlwave-twin-class (nth 2 a)) ; used in idlwave-routine-twin-compare
8850 (asrc (nth 3 a))
8851 (atype (car asrc))
8852 (bsrc (nth 3 b))
8853 (btype (car bsrc))
8854 (afile (idlwave-routine-source-file asrc))
8855 (bfile (idlwave-routine-source-file bsrc)))
8856 (idlwave-routine-twin-compare
8857 (if (stringp afile)
8858 (list (file-truename afile) afile (list atype))
8859 (list atype afile (list atype)))
8860 (if (stringp bfile)
8861 (list (file-truename bfile) bfile (list btype))
8862 (list btype bfile (list btype))))))
8864 ;; Bound in idlwave-study-twins,idlwave-routine-entry-compare-twins.
8865 (defvar idlwave-twin-class)
8866 (defvar idlwave-twin-name)
8868 (defun idlwave-routine-twin-compare (a b)
8869 "Compare two routine twin entries for sorting.
8870 In here, A and B are not normal routine info entries, but special
8871 lists (KEY FILENAME (TYPES...)).
8872 This expects NAME TYPE IDLWAVE-TWIN-CLASS to be bound to the right values."
8873 (let* (;; Dis-assemble entries
8874 (akey (car a)) (bkey (car b))
8875 (afile (nth 1 a)) (bfile (nth 1 b))
8876 (atypes (nth 2 a)) (btypes (nth 2 b))
8877 ;; System routines?
8878 (asysp (memq akey '(builtin system)))
8879 (bsysp (memq bkey '(builtin system)))
8880 ;; Compiled routines?
8881 (acompp (memq 'compiled atypes))
8882 (bcompp (memq 'compiled btypes))
8883 ;; Unresolved?
8884 (aunresp (or (eq akey 'unresolved)
8885 (and acompp (not afile))))
8886 (bunresp (or (eq bkey 'unresolved)
8887 (and bcompp (not bfile))))
8888 ;; Buffer info available?
8889 (abufp (memq 'buffer atypes))
8890 (bbufp (memq 'buffer btypes))
8891 ;; On search path?
8892 (tpath-alist (idlwave-true-path-alist))
8893 (apathp (and (stringp akey)
8894 (assoc (file-name-directory akey) tpath-alist)))
8895 (bpathp (and (stringp bkey)
8896 (assoc (file-name-directory bkey) tpath-alist)))
8897 ;; How early on search path? High number means early since we
8898 ;; measure the tail of the path list
8899 (anpath (length (memq apathp tpath-alist)))
8900 (bnpath (length (memq bpathp tpath-alist)))
8901 ;; Look at file names
8902 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8903 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8904 (fname-re (if idlwave-twin-class
8906 (regexp-quote (downcase idlwave-twin-class))
8907 (regexp-quote (downcase idlwave-twin-name)))
8909 ;; Is file name derived from the routine name?
8910 ;; Method file or class definition file?
8911 (anamep (string-match fname-re aname))
8912 (adefp (and idlwave-twin-class anamep
8913 (string= "define" (match-string 1 aname))))
8914 (bnamep (string-match fname-re bname))
8915 (bdefp (and idlwave-twin-class bnamep
8916 (string= "define" (match-string 1 bname)))))
8918 ;; Now: follow JD's ideas about sorting. Looks really simple now,
8919 ;; doesn't it? The difficult stuff is hidden above...
8920 (cond
8921 ((idlwave-xor asysp bsysp) asysp) ; System entries first
8922 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
8923 ((and idlwave-sort-prefer-buffer-info
8924 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
8925 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
8926 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
8927 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
8928 ((and idlwave-twin-class anamep bnamep ; both file names match ->
8929 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
8930 ((> anpath bnpath) t) ; Who is first on path?
8931 (t nil)))) ; Default
8933 (defun idlwave-routine-source-file (source)
8934 (if (nth 2 source)
8935 (expand-file-name (nth 1 source) (nth 2 source))
8936 (nth 1 source)))
8938 (defun idlwave-downcase-safe (string)
8939 "Downcase if string, else return unchanged."
8940 (if (stringp string)
8941 (downcase string)
8942 string))
8944 (defun idlwave-count-eq (elt list)
8945 "How often is ELT in LIST?"
8946 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
8948 (defun idlwave-count-memq (elt alist)
8949 "How often is ELT a key in ALIST?"
8950 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
8952 (defun idlwave-syslib-p (file)
8953 "Non-nil if FILE is in the system library."
8954 (let* ((true-syslib (file-name-as-directory
8955 (file-truename
8956 (expand-file-name "lib" (idlwave-sys-dir)))))
8957 (true-file (file-truename file)))
8958 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
8960 (defun idlwave-lib-p (file)
8961 "Non-nil if FILE is in the library."
8962 (let ((true-dir (file-name-directory (file-truename file))))
8963 (assoc true-dir (idlwave-true-path-alist))))
8965 (defun idlwave-path-alist-add-flag (list-entry flag)
8966 "Add a flag to the path list entry, if not set."
8967 (let ((flags (cdr list-entry)))
8968 (add-to-list 'flags flag)
8969 (setcdr list-entry flags)))
8971 (defun idlwave-path-alist-remove-flag (list-entry flag)
8972 "Remove a flag to the path list entry, if set."
8973 (let ((flags (delq flag (cdr list-entry))))
8974 (setcdr list-entry flags)))
8976 (defun idlwave-true-path-alist ()
8977 "Return `idlwave-path-alist' alist with true-names.
8978 Info is cached, but relies on the functions setting `idlwave-path-alist'
8979 to reset the variable `idlwave-true-path-alist' to nil."
8980 (or idlwave-true-path-alist
8981 (setq idlwave-true-path-alist
8982 (mapcar (lambda(x) (cons
8983 (file-name-as-directory
8984 (file-truename
8985 (directory-file-name
8986 (car x))))
8987 (cdr x)))
8988 idlwave-path-alist))))
8990 (defun idlwave-syslib-scanned-p ()
8991 "Non-nil if the system lib file !DIR/lib has been scanned."
8992 (let* ((true-syslib (file-name-as-directory
8993 (file-truename
8994 (expand-file-name "lib" (idlwave-sys-dir))))))
8995 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
8997 ;; ----------------------------------------------------------------------------
8998 ;;
8999 ;; Online Help display
9002 ;; ----------------------------------------------------------------------------
9003 ;;
9004 ;; Additions for use with imenu.el and func-menu.el
9005 ;; (pop-up a list of IDL units in the current file).
9006 ;;
9008 (defun idlwave-prev-index-position ()
9009 "Search for the previous procedure or function.
9010 Return nil if not found. For use with imenu.el."
9011 (save-match-data
9012 (cond
9014 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
9015 (t nil))))
9017 (defun idlwave-unit-name ()
9018 "Return the unit name.
9019 Assumes that point is at the beginning of the unit as found by
9020 `idlwave-prev-index-position'."
9021 (forward-sexp 2)
9022 (forward-sexp -1)
9023 (let ((begin (point)))
9024 (re-search-forward
9026 (if (fboundp 'buffer-substring-no-properties)
9027 (buffer-substring-no-properties begin (point))
9028 (buffer-substring begin (point)))))
9030 (defalias 'idlwave-function-menu
9031 (condition-case nil
9032 (progn
9033 (require 'func-menu)
9034 'function-menu)
9035 (error (condition-case nil
9036 (progn
9037 (require 'imenu)
9038 'imenu)
9039 (error nil)))))
9041 ;; Here we hack func-menu.el in order to support this new mode.
9042 ;; The latest versions of func-menu.el already have this stuff in, so
9043 ;; we hack only if it is not already there.
9044 (when (featurep 'xemacs)
9045 (eval-after-load "func-menu"
9046 '(progn
9047 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
9048 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
9049 (setq fume-function-name-regexp-alist
9050 (cons '(idlwave-mode . fume-function-name-regexp-idl)
9051 fume-function-name-regexp-alist)))
9052 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
9053 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
9054 (setq fume-find-function-name-method-alist
9055 (cons '(idlwave-mode . fume-find-next-idl-function-name)
9056 fume-find-function-name-method-alist))))))
9058 (defun idlwave-edit-in-idlde ()
9059 "Edit the current file in IDL Development environment."
9060 (interactive)
9061 (start-process "idldeclient" nil
9062 idlwave-shell-explicit-file-name "-c" "-e"
9063 (buffer-file-name)))
9065 (defvar idlwave-help-use-assistant)
9066 (defun idlwave-launch-idlhelp ()
9067 "Start the IDLhelp application."
9068 (interactive)
9069 (if idlwave-help-use-assistant
9070 (idlwave-help-assistant-raise)
9071 (start-process "idlhelp" nil idlwave-help-application)))
9073 ;; Menus - using easymenu.el
9074 (defvar idlwave-mode-menu-def
9075 `("IDLWAVE"
9076 ["PRO/FUNC menu" idlwave-function-menu t]
9077 ("Motion"
9078 ["Subprogram Start" idlwave-beginning-of-subprogram t]
9079 ["Subprogram End" idlwave-end-of-subprogram t]
9080 ["Block Start" idlwave-beginning-of-block t]
9081 ["Block End" idlwave-end-of-block t]
9082 ["Up Block" idlwave-backward-up-block t]
9083 ["Down Block" idlwave-down-block t]
9084 ["Skip Block Backward" idlwave-backward-block t]
9085 ["Skip Block Forward" idlwave-forward-block t])
9086 ("Mark"
9087 ["Subprogram" idlwave-mark-subprogram t]
9088 ["Block" idlwave-mark-block t]
9089 ["Header" idlwave-mark-doclib t])
9090 ("Format"
9091 ["Indent Entire Statement" idlwave-indent-statement
9093 ["Indent Subprogram" idlwave-indent-subprogram t]
9094 ["(Un)Comment Region" idlwave-toggle-comment-region t]
9095 ["Continue/Split line" idlwave-split-line t]
9096 "--"
9097 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
9098 :selected (symbol-value idlwave-fill-function)])
9099 ("Templates"
9100 ["Procedure" idlwave-procedure t]
9101 ["Function" idlwave-function t]
9102 ["Doc Header" idlwave-doc-header t]
9103 ["Log" idlwave-doc-modification t]
9104 "--"
9105 ["Case" idlwave-case t]
9106 ["For" idlwave-for t]
9107 ["Repeat" idlwave-repeat t]
9108 ["While" idlwave-while t]
9109 "--"
9110 ["Close Block" idlwave-close-block t])
9111 ("Completion"
9112 ["Complete" idlwave-complete t]
9113 ("Complete Specific"
9114 ["1 Procedure Name" (idlwave-complete 'procedure) t]
9115 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
9116 "--"
9117 ["3 Function Name" (idlwave-complete 'function) t]
9118 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
9119 "--"
9120 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
9121 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
9122 "--"
9123 ["7 Function Method Name" (idlwave-complete 'function-method) t]
9124 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
9125 "--"
9126 ["9 Class Name" idlwave-complete-class t]))
9127 ("Routine Info"
9128 ["Show Routine Info" idlwave-routine-info t]
9129 ["Online Context Help" idlwave-context-help t]
9130 "--"
9131 ["Find Routine Source" idlwave-find-module t]
9132 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
9133 "--"
9134 ["Update Routine Info" idlwave-update-routine-info t]
9135 ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t]
9136 "--"
9137 "IDL User Catalog"
9138 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
9139 ["Scan Directories" (idlwave-update-routine-info '(16))
9140 (and idlwave-path-alist (not idlwave-catalog-process))]
9141 ["Scan Directories &" (idlwave-update-routine-info '(64))
9142 (and idlwave-path-alist (not idlwave-catalog-process))]
9143 "--"
9144 "Routine Shadows"
9145 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
9146 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
9147 ["Check Everything" idlwave-list-all-load-path-shadows t])
9148 ("Misc"
9149 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
9150 "--"
9151 ["Insert TAB character" idlwave-hard-tab t])
9152 "--"
9153 ("External"
9154 ["Start IDL shell" idlwave-shell t]
9155 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
9156 ["Launch IDL Help" idlwave-launch-idlhelp t])
9157 "--"
9158 ("Customize"
9159 ["Browse IDLWAVE Group" idlwave-customize t]
9160 "--"
9161 ["Build Full Customize Menu" idlwave-create-customize-menu
9162 (fboundp 'customize-menu-create)])
9163 ("Documentation"
9164 ["Describe Mode" describe-mode t]
9165 ["Abbreviation List" idlwave-list-abbrevs t]
9166 "--"
9167 ["Commentary in idlwave.el" idlwave-show-commentary t]
9168 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
9169 "--"
9170 ["Info" idlwave-info t]
9171 "--"
9172 ["Help with Topic" idlwave-help-assistant-help-with-topic
9173 idlwave-help-use-assistant]
9174 ["Launch IDL Help" idlwave-launch-idlhelp t])))
9176 (defvar idlwave-mode-debug-menu-def
9177 '("Debug"
9178 ["Start IDL shell" idlwave-shell t]
9179 ["Save and .RUN buffer" idlwave-shell-save-and-run
9180 (and (boundp 'idlwave-shell-automatic-start)
9181 idlwave-shell-automatic-start)]))
9183 (if (or (featurep 'easymenu) (load "easymenu" t))
9184 (progn
9185 (easy-menu-define idlwave-mode-menu idlwave-mode-map
9186 "IDL and WAVE CL editing menu"
9187 idlwave-mode-menu-def)
9188 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
9189 "IDL and WAVE CL editing menu"
9190 idlwave-mode-debug-menu-def)))
9192 (defun idlwave-customize ()
9193 "Call the customize function with `idlwave' as argument."
9194 (interactive)
9195 ;; Try to load the code for the shell, so that we can customize it
9196 ;; as well.
9197 (or (featurep 'idlw-shell)
9198 (load "idlw-shell" t))
9199 (customize-browse 'idlwave))
9201 (defun idlwave-create-customize-menu ()
9202 "Create a full customization menu for IDLWAVE, insert it into the menu."
9203 (interactive)
9204 (if (fboundp 'customize-menu-create)
9205 (progn
9206 ;; Try to load the code for the shell, so that we can customize it
9207 ;; as well.
9208 (or (featurep 'idlw-shell)
9209 (load "idlw-shell" t))
9210 (easy-menu-change
9211 '("IDLWAVE") "Customize"
9212 `(["Browse IDLWAVE group" idlwave-customize t]
9213 "--"
9214 ,(customize-menu-create 'idlwave)
9215 ["Set" Custom-set t]
9216 ["Save" Custom-save t]
9217 ["Reset to Current" Custom-reset-current t]
9218 ["Reset to Saved" Custom-reset-saved t]
9219 ["Reset to Standard Settings" Custom-reset-standard t]))
9221 (error "Cannot expand menu (outdated version of cus-edit.el)")))
9223 (defun idlwave-show-commentary ()
9224 "Use the finder to view the file documentation from `idlwave.el'."
9225 (interactive)
9226 (finder-commentary "idlwave.el"))
9228 (defun idlwave-shell-show-commentary ()
9229 "Use the finder to view the file documentation from `idlw-shell.el'."
9230 (interactive)
9231 (finder-commentary "idlw-shell.el"))
9233 (defun idlwave-info ()
9234 "Read documentation for IDLWAVE in the info system."
9235 (interactive)
9236 (info "idlwave"))
9238 (defun idlwave-list-abbrevs (arg)
9239 "Show the code abbreviations define in IDLWAVE mode.
9240 This lists all abbrevs where the replacement text differs from the input text.
9241 These are the ones the users want to learn to speed up their writing.
9243 The function does *not* list abbrevs which replace a word with itself
9244 to call a hook. These hooks are used to change the case of words or
9245 to blink the matching `begin', and the user does not need to know them.
9247 With arg, list all abbrevs with the corresponding hook.
9249 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
9251 (interactive "P")
9252 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
9253 abbrevs
9254 str rpl func fmt (len-str 0) (len-rpl 0))
9255 (mapatoms
9256 (lambda (sym)
9257 (if (symbol-value sym)
9258 (progn
9259 (setq str (symbol-name sym)
9260 rpl (symbol-value sym)
9261 func (symbol-function sym))
9262 (if arg
9263 (setq func (prin1-to-string func))
9264 (if (and (listp func) (stringp (nth 2 func)))
9265 (setq rpl (concat "EVAL: " (nth 2 func))
9266 func "")
9267 (setq func "")))
9268 (if (or arg (not (string= rpl str)))
9269 (progn
9270 (setq len-str (max len-str (length str)))
9271 (setq len-rpl (max len-rpl (length rpl)))
9272 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
9273 table)
9274 ;; sort the list
9275 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
9276 ;; Make the format
9278 (with-output-to-temp-buffer "*Help*"
9279 (if arg
9280 (progn
9283 (princ (format fmt "KEY" "REPLACE" "HOOK"))
9284 (princ (format fmt "---" "-------" "----")))
9287 (princ (format fmt "KEY" "ACTION" ""))
9288 (princ (format fmt "---" "------" "")))
9289 (dolist (list abbrevs)
9290 (setq str (car list)
9291 rpl (nth 1 list)
9292 func (nth 2 list))
9293 (princ (format fmt str rpl func)))))
9294 ;; Make sure each abbreviation uses only one display line
9295 (with-current-buffer "*Help*"
9296 (setq truncate-lines t)))
9298 (declare-function speedbar-add-supported-extension "speedbar" (extension))
9300 ;; Add .pro files to speedbar for support, if it's loaded
9301 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
9303 ;; Set an idle timer to load the routine info.
9304 ;; Will only work on systems which support this.
9305 (or idlwave-routines (idlwave-start-load-rinfo-timer))
9307 ;; Run the hook
9308 (run-hooks 'idlwave-load-hook)
9310 (provide 'idlwave)
9312 ;;; idlwave.el ends here