| blob | 1233ee19ff65be5f087b3da5bb52676ea27e4204 |
1 ;; idlwave.el --- IDL editing mode for GNU Emacs
3 ;; Copyright (C) 1999-2011 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 .emacs 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."
463 "Alist of regular expressions matching special library directories.
464 When listing routine source locations, IDLWAVE gives a short hint where
465 the file defining the routine is located. By default it lists `SystemLib'
466 for routines in the system library `!DIR/lib' and `Library' for anything
467 else. This variable can define additional types. The car of each entry
468 is a regular expression matching the file name (they normally will match
469 on the path). The cdr is the string to be used as identifier. Max 10
470 chars are allowed."
476 "Write out path (!PATH) and system directory (!DIR) info automatically.
477 Path info is needed to locate library catalog files. If non-nil,
478 whenever the path-list changes as a result of shell-query, etc., it is
480 used to force a write."
485 "Completion options for IDLWAVE mode."
502 "Association list setting the case of completed words.
504 This variable determines the case (UPPER/lower/Capitalized...) of
505 words inserted into the buffer by completion. The preferred case can
506 be specified separately for routine names, keywords, classes and
507 methods.
508 This alist should therefore have entries for `routine' (normal
509 functions and procedures, i.e. non-methods), `keyword', `class', and
510 `method'. Plausible values are
512 upcase upcase whole word, like `BOX_CURSOR'
513 downcase downcase whole word, like `read_ppm'
514 capitalize capitalize each part, like `Widget_Control'
515 preserve preserve case as is, like `IDLgrView'
517 The value can also be any Emacs Lisp function which transforms the
518 case of characters in a string.
520 A value of `preserve' means that the case of the completed word is
521 identical to the way it was written in the definition statement of the
522 routine. This was implemented to allow for mixed-case completion, in
523 particular of object classes and methods.
524 If a completable word is defined in multiple locations, the meaning of
525 `preserve' is not unique since the different definitions might be
526 cased differently. Therefore IDLWAVE always takes the case of the
527 *first* definition it encounters during routine info collection and
528 uses the case derived from it consistently.
530 Note that a lowercase-only string in the buffer will always be completed in
531 lower case (but see the variable `idlwave-completion-force-default-case').
533 After changing this variable, you need to either restart Emacs or press
534 `C-u C-c C-i' to update the internal lists."
541 "*Non-nil means, completion will always honor `idlwave-completion-case'.
542 When nil, only the completion of a mixed case or upper case string
543 will honor the default settings in `idlwave-completion-case', while
544 the completion of lower case strings will be completed entirely in
545 lower case."
550 "*Non-nil means, the empty string is considered downcase for completion.
551 The case of what is already in the buffer determines the case of completions.
552 When this variable is non-nil, the empty string is considered to be downcase.
553 Completing on the empty string then offers downcase versions of the possible
554 completions."
559 "Obsolete variable. See `idlwave-complete-empty-string-as-lower-case' and
563 "*Non-nil means, the case of tokens in buffers dominates over system stuff.
564 To make this possible, we need to re-case everything each time we update
565 the routine info from the buffers. This is slow.
566 The default is to consider the case given in the system and library files
567 first which makes updating much faster."
572 "*Non-nil means, highlight completions for which system help is available.
573 Help can then be accessed with mouse-3.
574 This option is only effective when the online help system is installed."
579 "Non-nil means, treat inheritance with completion, online help etc.
580 When nil, IDLWAVE only knows about the native methods and tags of a class,
581 not about inherited ones."
586 "List of regular expressions for class-driven keyword inheritance.
588 up the class tree. While it cannot be assumed that the presence of an
589 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
590 certain methods this assumption is almost always true. The methods
591 for which to assume this can be set here."
597 "*Number of classes to show when completing object methods and keywords.
598 When completing methods or keywords for an object with unknown class,
599 the *Completions* buffer will show the valid classes for each completion
600 like this:
602 MyMethod <Class1,Class2,Class3>
604 The value of this variable may be nil to inhibit display, or an integer to
605 indicate the maximum number of classes to display.
607 On XEmacs, a full list of classes will also be placed into a `help-echo'
608 property on the completion items, so that the list of classes for the current
609 item is displayed in the echo area. If the value of this variable is a
610 negative integer, the `help-echo' property will be suppressed."
616 "*Non-nil means, fontify the classes in completions buffer.
617 This makes it easier to distinguish the completion items from the extra
618 class info listed. See `idlwave-completion-show-classes'."
624 "Association list governing specification of object classes for completion.
626 When IDLWAVE tries to complete object-oriented methods, it usually
627 cannot determine the class of a given object from context. In order
628 to provide the user with a correct list of methods or keywords, it
629 needs to determine the appropriate class. IDLWAVE has two ways of
630 doing this (well, three ways if you count the shell... see
631 `idlwave-shell-query-for-class'):
633 1. Combine the items of all available classes which contain this
634 method for the purpose of completion. So when completing a method,
635 all methods of all known classes are available, and when completing
636 a keyword, all keywords allowed for this method in any class are
637 shown. This behavior is very much like normal completion and is
638 therefore the default. It works much better than one might think -
639 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
640 become uncomfortably long. See also
641 `idlwave-completion-show-classes'.
643 2. The second possibility is to ask the user on each occasion. To
644 make this less interruptive, IDLWAVE can store the class as a text
645 property on the object operator `->'. For a given object in the
646 source code, class selection will then be needed only once
647 - for example to complete the method. Keywords to the method can
648 then be completed directly, because the class is already known.
649 You will have to turn on the storage of the selected class
650 explicitly with the variable `idlwave-store-inquired-class'.
652 This variable allows you to configure IDLWAVE's method and
653 method-keyword completion behavior. Its value is an alist, which
654 should contain at least two elements: (method-default . VALUE) and
655 \(keyword-default . VALUE), where VALUE is either t or nil. These
656 specify if the class should be found during method and keyword
657 completion, respectively.
659 The alist may have additional entries specifying exceptions from the
660 keyword completion rule for specific methods, like INIT or
661 GETPROPERTY. In order to turn on class specification for the INIT
671 :inline t
676 "*Non-nil means, store class of a method call as text property on `->'.
677 IDLWAVE sometimes has to ask the user for the class associated with a
678 particular object method call. This happens during the commands
679 `idlwave-routine-info' and `idlwave-complete', depending upon the
680 value of the variable `idlwave-query-class'.
682 When you specify a class, this information can be stored as a text
683 property on the `->' arrow in the source code, so that during the same
684 editing session, IDLWAVE will not have to ask again. When this
685 variable is non-nil, IDLWAVE will store and reuse the class information.
687 on the arrow.
689 The default of this variable is nil, since the result of commands then
690 is more predictable. However, if you know what you are doing, it can
691 be nice to turn this on.
693 An arrow which knows the class will be highlighted with
695 displays (with prefix arg: deletes) the class stored on the arrow
696 at point."
701 "*Face to highlight object operator arrows `->' which carry a class property.
702 When IDLWAVE stores a class name as text property on an object arrow
703 \(see variable `idlwave-store-inquired-class', it highlights the arrow
704 with this font in order to remind the user that this arrow is special."
709 "*Non-nil means, resize the Routine-info *Help* window to fit the content."
714 "*Non-nil means, completion automatically adds `=' after completed keywords."
719 "*Non-nil means, completion automatically adds `(' after completed function.
720 nil means, don't add anything.
721 A value of `2' means, also add the closing parenthesis and position cursor
722 between the two."
729 "*Non-nil means, try to restore the window configuration after completion.
730 When completion is not unique, Emacs displays a list of completions.
731 This messes up your window configuration. With this variable set, IDLWAVE
732 restores the old configuration after successful completion."
736 ;;; Variables for abbrev and action behavior -----------------------------
739 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
740 The variables in this group govern this."
744 "*Non-nil means performs actions when indenting.
745 The actions that can be performed are listed in `idlwave-indent-action-table'."
750 "*A single character string used to start abbreviations in abbrev mode.
751 Possible characters to chose from: ~`\%
752 or even '?'. '.' is not a good choice because it can make structure
753 field names act like abbrevs in certain circumstances.
755 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
756 must set it directly using `setq' in the .emacs file before idlwave.el
757 is loaded."
762 "*Non-nil means, enable `idlwave-surround'.
763 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
764 `idlwave-surround'.
765 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
767 Also see the default key bindings for keys using `idlwave-surround'.
768 Keys are bound and made into actions calling `idlwave-surround' with
769 `idlwave-action-and-binding'.
770 See help for `idlwave-action-and-binding' for examples.
772 Also see help for `idlwave-surround'."
777 "*Non-nil means pad '=' in keywords (routine calls or defs) like assignment.
778 Whenever `idlwave-surround' is non-nil then this affects how '=' is
779 padded for keywords and for variables. If t, pad the same as for
780 assignments. If nil then spaces are removed. With any other value,
781 spaces are left unchanged."
789 "*Non-nil means point blinks to block beginning for `idlwave-show-begin'."
794 "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
799 "*Non-nil means re-indent line after END was typed."
804 "*Non-nil means the abbrev hook can move point.
805 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
806 definitions, use the command `list-abbrevs', for abbrevs that move
807 point. Moving point is useful, for example, to place point between
808 parentheses of expanded functions.
810 See `idlwave-check-abbrev'."
815 "*Non-nil means all abbrevs will be forced to either upper or lower case.
816 If the value t, all expanded abbrevs will be upper case.
817 If the value is 'down then abbrevs will be forced to lower case.
818 If nil, the case will not change.
819 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
820 upper case, regardless of this variable."
825 "*Non-nil means, reserved words will be made upper case via abbrev expansion.
826 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
827 Has effect only if in abbrev-mode."
831 ;;; Action/Expand Tables.
832 ;;
833 ;; The average user may have difficulty modifying this directly. It
834 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
835 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
836 ;; examples of how to add an action.
837 ;;
838 ;; The action table is used by `idlwave-indent-line' whereas both the
839 ;; action and expand tables are used by `idlwave-indent-and-action'. In
840 ;; general, the expand table is only used when a line is explicitly
841 ;; indented. Whereas, in addition to being used when the expand table
842 ;; is used, the action table is used when a line is indirectly
843 ;; indented via line splitting, auto-filling or a new line creation.
844 ;;
845 ;; Example actions:
846 ;;
847 ;; Capitalize system vars
848 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
849 ;;
850 ;; Capitalize procedure name
851 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
852 ;; '(capitalize-word 1) t)
853 ;;
854 ;; Capitalize common block name
855 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
856 ;; '(capitalize-word 1) t)
857 ;; Capitalize label
858 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
859 ;; '(capitalize-word -1) t)
862 "*Associated array containing action lists of search string (car),
863 and function as a cdr. This table is used by `idlwave-indent-line'.
864 See documentation for `idlwave-do-action' for a complete description of
865 the action lists.
867 Additions to the table are made with `idlwave-action-and-binding' when a
868 binding is not requested.
872 "*Associated array containing action lists of search string (car),
873 and function as a cdr. The table is used by the
874 `idlwave-indent-and-action' function. See documentation for
875 `idlwave-do-action' for a complete description of the action lists.
877 Additions to the table are made with `idlwave-action-and-binding' when a
878 binding is requested.
881 ;;; Documentation header and history keyword ---------------------------------
884 "Options for documenting IDLWAVE files."
887 ;; FIXME: make defcustom?
890 ";+
891 ; NAME:
892 ;
893 ;
894 ;
895 ; PURPOSE:
896 ;
897 ;
898 ;
899 ; CATEGORY:
900 ;
901 ;
902 ;
903 ; CALLING SEQUENCE:
904 ;
905 ;
906 ;
907 ; INPUTS:
908 ;
909 ;
910 ;
911 ; OPTIONAL INPUTS:
912 ;
913 ;
914 ;
915 ; KEYWORD PARAMETERS:
916 ;
917 ;
918 ;
919 ; OUTPUTS:
920 ;
921 ;
922 ;
923 ; OPTIONAL OUTPUTS:
924 ;
925 ;
926 ;
927 ; COMMON BLOCKS:
928 ;
929 ;
930 ;
931 ; SIDE EFFECTS:
932 ;
933 ;
934 ;
935 ; RESTRICTIONS:
936 ;
937 ;
938 ;
939 ; PROCEDURE:
940 ;
941 ;
942 ;
943 ; EXAMPLE:
944 ;
945 ;
946 ;
947 ; MODIFICATION HISTORY:
948 ;
949 ;-
951 "*A list (PATHNAME STRING) specifying the doc-header template to use for
952 summarizing a file. If PATHNAME is non-nil then this file will be included.
953 Otherwise STRING is used. If nil, the file summary will be omitted.
954 For example you might set PATHNAME to the path for the
958 "*Non-nil means, the documentation header will always be at start of file.
959 When nil, the header is positioned between the PRO/FUNCTION line of
960 the current routine and the code, allowing several routine headers in
961 a file."
966 "*The hook function used to update the timestamp of a function."
971 "*The modifications keyword to use with the log documentation commands.
972 A ':' is added to the keyword end.
973 Inserted by doc-header and used to position logs by doc-modification.
974 If nil it will not be inserted."
979 "*Regexp matching the start of a document library header."
984 "*Regexp matching the end of a document library header."
988 ;;; External Programs -------------------------------------------------------
991 "Path locations of external commands used by IDLWAVE."
995 "*If non-nil, this is the command to run IDL.
996 Should be an absolute file path or path relative to the current environment
997 execution search path. If you want to specify command line switches
998 for the IDL program, use `idlwave-shell-command-line-options'.
1000 I know the name of this variable is badly chosen, but I cannot change
1001 it without compromising backwards-compatibility."
1006 "*A list of command line options for calling the IDL program.
1007 Since IDL is executed directly without going through a shell like /bin/sh,
1009 string for each argument. But you may also give a single string which
1010 contains the options whitespace-separated. Emacs will be kind enough to
1011 split it for you."
1013 string
1018 "*The external application providing reference help for programming.
1019 Obsolete, if the IDL Assistant is being used for help."
1023 ;;; Some Shell variables which must be defined here.-----------------------
1026 "List of modifiers to be used for the debugging commands.
1027 Will be used to bind debugging commands in the shell buffer and in all
1028 source buffers. These are additional convenience bindings, the debugging
1029 commands are always available with the `C-c C-d' prefix.
1030 If you set this to '(control shift), this means setting a breakpoint will
1031 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1032 are `control', `meta', `super', `hyper', `alt', and `shift'."
1043 "*If non-nil attempt invoke `idlwave-shell' if not already running.
1044 This is checked when an attempt to send a command to an
1045 IDL process is made."
1049 ;;; Miscellaneous variables -------------------------------------------------
1052 "Miscellaneous options for IDLWAVE mode."
1057 "*Non-nil displays a startup message when `idlwave-mode' is first called."
1063 common-blocks class-arrows)
1064 "Items which should be fontified on the default fontification level 2.
1065 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1066 is everything and level 2 is specified by this list.
1067 This variable must be set before IDLWAVE gets loaded.
1068 It is a list of symbols; the following symbols are allowed:
1070 pros-and-functions Procedure and Function definitions
1071 batch-files Batch Files
1072 idlwave-idl-keywords IDL Keywords
1073 label Statement Labels
1074 goto Goto Statements
1075 common-blocks Common Blocks
1076 keyword-parameters Keyword Parameters in routine definitions and calls
1077 system-variables System Variables
1078 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1079 class-arrows Object Arrows with class property"
1097 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1102 "Normal hook. Executed when idlwave.el is loaded."
1107 "Non-nil means turn on a few experimental features.
1108 This variable is only for the maintainer, to test difficult stuff,
1109 while still distributing stable releases.
1112 ;;;
1113 ;;; End customization variables section
1114 ;;;
1116 ;;; Non customization variables
1118 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1119 ;;; Simon Marshall <simon_at_gnu.ai.mit.edu>
1120 ;;; and Carsten Dominik...
1122 ;; The following are the reserved words in IDL. Maybe we should
1123 ;; highlight some more stuff as well?
1124 ;; Procedure declarations. Fontify keyword plus procedure name.
1126 ;; To update this regexp, update the list of keywords and
1127 ;; evaluate the form.
1128 ;; (insert
1129 ;; (prin1-to-string
1130 ;; (concat
1131 ;; "\\<\\("
1132 ;; (regexp-opt
1133 ;; '("||" "&&" "and" "or" "xor" "not"
1134 ;; "eq" "ge" "gt" "le" "lt" "ne"
1135 ;; "for" "do" "endfor"
1136 ;; "if" "then" "endif" "else" "endelse"
1137 ;; "case" "of" "endcase"
1138 ;; "switch" "break" "continue" "endswitch"
1139 ;; "begin" "end"
1140 ;; "repeat" "until" "endrep"
1141 ;; "while" "endwhile"
1142 ;; "goto" "return"
1143 ;; "inherits" "mod"
1144 ;; "compile_opt" "forward_function"
1145 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1146 ;; "\\)\\>")))
1147 "\\<\\(&&\\|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\\|||\\)\\>")
1151 ;; Function declarations. Fontify keyword plus function name.
1157 ;; Common blocks
1163 ;; Start with point after block name and comma
1165 nil
1167 )))
1169 ;; Batch files
1173 ;; FIXME warning.
1177 ;; Labels
1181 ;; The goto statement and its label
1187 ;; Tags in structure definitions. Note that this definition
1188 ;; actually collides with labels, so we have to use the same
1189 ;; face. It also matches named subscript ranges,
1190 ;; e.g. vec{bottom:top]. No good way around this.
1194 ;; Structure names
1199 ;; Keyword parameters, like /xlog or ,xrange=[]
1200 ;; This is anchored to the comma preceding the keyword.
1201 ;; Treats continuation lines, works only during whole buffer
1202 ;; fontification. Slow, use it only in fancy fontification.
1204 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\([ \t]*\\(;.*\\)?\n\\)*[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1207 ;; System variables start with a bang.
1212 ;; Special and unusual operators (not used because too noisy)
1213 ;; (special-operators
1214 ;; '("[<>#]" (0 font-lock-keyword-face)))
1216 ;; All operators (not used because too noisy)
1217 ;; (all-operators
1218 ;; '("[-*^#+<>/]" (0 font-lock-keyword-face)))
1220 ;; Arrows with text property `idlwave-class'
1234 batch-files
1235 idlwave-idl-keywords
1236 label goto
1237 structtag
1238 structname
1239 common-blocks
1240 keyword-parameters
1241 system-variables
1242 class-arrows)
1246 ;; Match an object arrow with class property
1256 idlwave-font-lock-keywords-1
1257 idlwave-font-lock-keywords-2
1258 idlwave-font-lock-keywords-3)
1259 nil t
1261 beginning-of-line))
1267 "Regexp to match the start of a full-line comment.
1268 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1273 "Regular expression to find the beginning of a block.
1277 "Regular expression to find the beginning of a unit.
1281 "Regular expression to find the line that indicates the end of unit.
1282 This line is the end of buffer or the start of another unit.
1290 "Regular expression to find the end of a block.
1303 "Matches between statements and the corresponding END variant.
1304 The cars are the reserved words starting a block. If the block really
1305 begins with BEGIN, the cars are the reserved words before the begin
1306 which can be used to identify the block type.
1307 This is used to check for the correct END type, to close blocks and
1312 "Regular expression matching reserved words which can stand before
1313 blocks starting with a BEGIN statement. The matches must have associations
1330 ))
1334 ;; "endif else" is the only possible "end" that can be
1335 ;; followed by a statement on the same line.
1337 ;; all other "end"s can not be followed by a statement.
1350 idlwave-identifier
1354 idlwave-identifier
1359 "Associated list of statement matching regular expressions.
1360 Each regular expression matches the start of an IDL statement.
1361 The first element of each association is a symbol giving the statement
1362 type. The associated value is a list. The first element of this list
1363 is a regular expression matching the start of an IDL statement for
1364 identifying the statement type. The second element of this list is a
1365 regular expression for finding a substatement for the type. The
1366 substatement starts after the end of the found match modulo
1367 whitespace. If it is nil then the statement has no substatement. The
1368 list order matters since matching an assignment statement exactly is
1369 not possible without parsing. Thus assignment statement become just
1372 ;; FIXME: This var seems to only ever be set, but never actually used!
1379 ;; Note that this is documented in the v18 manuals as being a string
1380 ;; of length one rather than a single character.
1381 ;; The code in this file accepts either format for compatibility.
1383 "Character to be inserted for IDL comment indentation.
1387 "Character which is inserted as a last character on previous line by
1393 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1397 ;; If I take the time I can replace idlwave-keyword-abbrev with
1398 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1399 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1400 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1401 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1404 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1405 Specifically, if the abbrev is in a comment or string it is unexpanded.
1406 Otherwise ARGS forms a list that is evaluated."
1407 ;; FIXME: it would probably be better to rely on the new :enable-function
1408 ;; to enforce the "don't expand in comments or strings".
1433 ;;(define-key map "\C-c\C- " 'idlwave-hard-tab)
1452 ;; (define-key map "\r" 'idlwave-newline)
1453 ;; (define-key map "\t" 'idlwave-indent-line)
1464 ;; Bind the debug commands also with the special modifiers.
1481 ;; (define-key map "\C-c\C-f" 'idlwave-function)
1482 ;; (define-key map "\C-c\C-p" 'idlwave-procedure)
1495 ;; Pickup both forms of Esc/Meta binding
1504 map)
1530 st)
1539 st)
1543 "Execute BODY with a different syntax table."
1551 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1552 ; "Execute BODY with a different syntax table."
1553 ; `(let ((saved-syntax (syntax-table)))
1554 ; (unwind-protect
1555 ; (progn
1556 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1557 ; ,@body)
1558 ; (set-syntax-table saved-syntax))))
1561 "KEY and CMD are made into a key binding and an indent action.
1562 KEY is a string - same as for the `define-key' function. CMD is a
1563 function of no arguments or a list to be evaluated. CMD is bound to
1564 KEY in `idlwave-mode-map' by defining an anonymous function calling
1565 `self-insert-command' followed by CMD. If KEY contains more than one
1566 character a binding will only be set if SELECT is 'both.
1568 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1569 replacing any previous value for KEY. If a binding is not set then it
1570 will instead be placed in `idlwave-indent-action-table'.
1572 If the optional argument SELECT is nil then an action and binding are
1573 created. If SELECT is 'noaction, then a binding is always set and no
1574 action is created. If SELECT is 'both then an action and binding
1575 will both be created even if KEY contains more than one character.
1576 Otherwise, if SELECT is non-nil then only an action is created.
1578 Some examples:
1579 No spaces before and 1 after a comma
1581 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1583 Capitalize system variables - action only
1584 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1586 ;; Add action
1592 ;; Replace action command
1594 ;; New action
1596 ;; Make key binding for action
1606 ;; Set action and key bindings.
1607 ;; See description of the function `idlwave-action-and-binding'.
1608 ;; Automatically add spaces for the following characters
1610 ;; Actions for & are complicated by &&
1613 ;; Automatically add spaces to equal sign if not keyword. This needs
1614 ;; to go ahead of > and <, so >= and <= will be treated correctly
1617 ;; Actions for > and < are complicated by >=, <=, and ->...
1624 ;;;
1625 ;;; Abbrev Section
1626 ;;;
1627 ;;; When expanding abbrevs and the abbrev hook moves backward, an extra
1628 ;;; space is inserted (this is the space typed by the user to expanded
1629 ;;; the abbrev).
1630 ;;;
1636 "Define-abbrev with backward compatibility.
1638 If NOPREFIX is non-nil, don't prepend prefix character. Installs into
1639 `idlwave-mode-abbrev-table' unless TABLE is non-nil."
1643 expansion
1644 hook)))
1654 ;;
1655 ;; Templates
1656 ;;
1666 ;;
1667 ;; Keywords, system functions, conversion routines
1668 ;;
1726 ;; This section is reserved words only. (From IDL user manual)
1727 ;;
1773 ;; defined later - so just make the compiler hush
1777 ;;;###autoload
1779 "Major mode for editing IDL source files (version 6.1_em22).
1781 The main features of this mode are
1783 1. Indentation and Formatting
1784 --------------------------
1785 Like other Emacs programming modes, C-j inserts a newline and indents.
1786 TAB is used for explicit indentation of the current line.
1789 function can also be used in the middle of a line to split the line
1790 at that point. When used inside a long constant string, the string
1791 is split at that point with the `+' concatenation operator.
1793 Comments are indented as follows:
1795 `;;;' Indentation remains unchanged.
1796 `;;' Indent like the surrounding code
1797 `;' Indent to a minimum column.
1799 The indentation of comments starting in column 0 is never changed.
1802 comment. The indentation of the second line of the paragraph
1803 relative to the first will be retained. Use
1805 comments. When the variable `idlwave-fill-comment-line-only' is
1806 nil, code can also be auto-filled and auto-indented.
1808 To convert pre-existing IDL code to your formatting style, mark the
1813 2. Routine Info
1814 ------------
1815 IDLWAVE displays information about the calling sequence and the
1816 accepted keyword parameters of a procedure or function with
1818 source file of a module. These commands know about system
1819 routines, all routines in idlwave-mode buffers and (when the
1820 idlwave-shell is active) about all modules currently compiled under
1821 this shell. It also makes use of pre-compiled or custom-scanned
1822 user and library catalogs many popular libraries ship with by
1824 information, which is also used for completion (see item 4).
1826 3. Online IDL Help
1827 ---------------
1830 for the system variable, keyword, or routines at point. A single
1831 key stroke gets you directly to the right place in the docs. See
1832 the manual to configure where and how the HTML help is displayed.
1834 4. Completion
1835 ----------
1837 class names, keyword parameters, system variables and tags, class
1838 tags, structure tags, filenames and much more. It is context
1839 sensitive and figures out what is expected at point. Lower case
1840 strings are completed in lower case, other strings in mixed or
1841 upper case.
1843 5. Code Templates and Abbreviations
1844 --------------------------------
1845 Many Abbreviations are predefined to expand to code fragments and templates.
1860 have direct keybindings - see the list of keybindings below.
1863 beginning of the current program unit (pro, function or main).
1864 Change log entries can be added to the current program unit with
1867 6. Automatic Case Conversion
1868 -------------------------
1869 The case of reserved words and some abbrevs is controlled by
1870 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1872 7. Automatic END completion
1873 ------------------------
1874 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1875 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1877 8. Hooks
1878 -----
1879 Loading idlwave.el runs `idlwave-load-hook'.
1880 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1882 9. Documentation and Customization
1883 -------------------------------
1884 Info documentation for this package is available. Use
1886 not work). For Postscript, PDF, and HTML versions of the
1887 documentation, check IDLWAVE's homepage at URL `http://idlwave.org'.
1888 IDLWAVE has customize support - see the group `idlwave'.
1890 10.Keybindings
1891 -----------
1892 Here is a list of all keybindings of this mode.
1894 followed by the key sequence to see what the key sequence does.
1897 :abbrev-table idlwave-mode-abbrev-table
1929 ;; ChangeLog
1933 ;; Set tag table list to use IDLTAGS as file name.
1937 ;; Font-lock additions
1938 ;; Following line is for Emacs - XEmacs uses the corresponding property
1939 ;; on the `idlwave-mode' symbol.
1946 ;; Imenu setup
1954 ;; HideShow setup
1957 idlwave-begin-block-reg
1958 idlwave-end-block-reg
1959 ";"
1962 ;; Make a local post-command-hook and add our hook to it
1963 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1964 ;; (make-local-hook 'post-command-hook)
1967 ;; Make local hooks for buffer updates
1968 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1969 ;; (make-local-hook 'kill-buffer-hook)
1971 ;; (make-local-hook 'after-save-hook)
1975 ;; Setup directories and file, if necessary
1978 ;; Update the routine info with info about current buffer?
1981 ;; Check help location
1991 idlwave-user-catalog-file
1992 idlwave-config-directory)
1993 idlwave-xml-system-rinfo-converted-file
1995 idlwave-xml-system-rinfo-converted-file
1996 idlwave-config-directory)
1998 idlwave-path-file
1999 idlwave-config-directory))
2004 "Fontify continuation lines correctly."
2015 ;;
2016 ;; Code Formatting ----------------------------------------------------
2017 ;;
2020 "Insert TAB in buffer in current position."
2024 ;;; This stuff is experimental
2027 "If non-nil, a list that can be evaluated using `eval'.
2028 It is evaluated in the lisp function `idlwave-command-hook' which is
2032 "Command run after every command.
2033 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
2034 sets the variable to zero afterwards."
2042 ;;; End experiment
2044 ;; It would be better to use expand.el for better abbrev handling and
2045 ;; versatility.
2048 "Reverse abbrev expansion if in comment or string.
2049 Argument ARG is the number of characters to move point
2050 backward if `idlwave-abbrev-move' is non-nil.
2051 If optional argument RESERVED is non-nil then the expansion
2052 consists of reserved words, which will be capitalized if
2053 `idlwave-reserved-word-upcase' is non-nil.
2054 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2055 is non-nil, unless its value is \`down in which case the abbrev will be
2056 made into all lowercase.
2057 Returns non-nil if abbrev is left expanded."
2060 nil)
2072 t))
2075 "Return t if point is inside a comment, nil otherwise."
2081 "Move to start of comment delimiter on current line.
2082 Moves to end of line if there is no comment delimiter.
2083 Ignores comment delimiters in strings.
2084 Returns point if comment found and nil otherwise."
2087 found)
2088 ;; Look for first comment delimiter not in a string
2100 "Should we operate on an active region?"
2106 "Insert quote and show matching quote if this is end of a string."
2117 ;; Not the end of a string
2121 "Ensure that the previous word was a token before `idlwave-show-begin'.
2122 An END token must be preceded by whitespace."
2132 "Find the start of current block and blinks to it for a second.
2133 Also checks if the correct END statement has been used."
2134 ;; All end statements are reserved words
2135 ;; Re-indent end line
2136 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2137 ;;(backward-char 1)
2141 begin-pos end-pos end end1 )
2145 idlwave-show-block)
2147 ;; Move inside current block
2160 end-pos))
2168 ;; A generic end
2179 end1 end)
2181 ;;(delete-char 1))
2195 ;; seems to be a case thing
2199 idlwave-block-matches))
2201 ;; Just a normal block
2206 "Terminate the current block with the correct END statement."
2208 ;; Start new line if we are not in a new line
2219 "Surround &, leaving room for && (which surround as well)."
2229 "Surround > and < by blanks, leaving room for >= and <=, and considering ->."
2235 ;; Key binding: pad only on left, to save for possible >=/<=
2239 "Surround the LENGTH characters before point with blanks.
2240 LENGTH defaults to 1.
2241 Optional arguments BEFORE and AFTER affect the behavior before and
2242 after the characters (see also description of `idlwave-make-space'):
2244 nil do nothing
2245 0 force no spaces
2246 integer > 0 force exactly n spaces
2247 integer < 0 at least |n| spaces
2249 The function does nothing if any of the following conditions is true:
2250 - `idlwave-surround-by-blank' is nil
2251 - the character before point is inside a string or comment"
2259 ;; avoid clobbering indent
2269 ;; Check to see if the line should auto wrap
2275 "Make space at point.
2276 The space affected is all the spaces and tabs around point.
2277 If n is non-nil then point is left abs(n) spaces from the beginning of
2278 the contiguous space.
2279 The amount of space at point is determined by N.
2280 If the value of N is:
2281 nil - do nothing.
2282 > 0 - exactly N spaces.
2283 < 0 - a minimum of -N spaces, i.e., do not change if there are
2284 already -N spaces.
2285 0 - no spaces (i.e. remove any existing space)."
2299 ;; n = 0, done
2300 ))))
2303 "Insert a newline and indent the current and previous line."
2305 ;;
2306 ;; Handle unterminated single and double quotes
2307 ;; If not in a comment and in a string then insertion of a newline
2308 ;; will mean unbalanced quotes.
2309 ;;
2314 ;;
2315 ;; The current line is being split, the cursor should be at the
2316 ;; beginning of the new line skipping the leading indentation.
2317 ;;
2318 ;; The reason we insert the new line before indenting is that the
2319 ;; indenting could be confused by keywords (e.g. END) on the line
2320 ;; after the split point. This prevents us from just using
2321 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2322 ;;
2328 ;;
2329 ;; Use global variable 'comment-column' to set parallel comment
2330 ;;
2331 ;; Modeled on lisp.el
2332 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2334 "Compute indent for the beginning of the IDL comment delimiter."
2340 ;; On line by itself, indent as code
2343 ;; after code - do not change
2347 comment-column))))
2350 "Continue line by breaking line at point and indent the lines.
2351 For a code line insert continuation marker. If the line is a line comment
2352 then the new line will contain a comment with the same indentation.
2353 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2354 non-nil."
2356 ;; Expand abbreviation, just like normal RET would.
2360 ;; For code line add continuation.
2361 ;; Check if splitting a string.
2365 ;; Split the string.
2367 idlwave-continuation-char beg)
2371 ;; Do not split the string.
2375 ;; Not splitting a string.
2381 ;; Indent previous line
2386 ;; Reindent new line
2390 "Move point to the beginning of the current program unit.
2391 If NOMARK is non-nil, do not push mark."
2396 "Move point to the start of the next program unit.
2397 If NOMARK is non-nil, do not push mark."
2403 "Mark current IDL statement."
2411 "Mark containing block."
2423 "Put mark at beginning of program, point at end.
2424 The marks are pushed."
2434 "Move to beginning of enclosing block if prefix ARG >= 0.
2435 If prefix ARG < 0 then move forward to enclosing block end."
2440 "Go to the beginning of the current block."
2446 "Go to the beginning of the current block."
2452 "Move across next nested block."
2459 "Move backward across previous nested block."
2465 "Go down a block.
2466 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2467 Returns non-nil if successfull."
2471 ;; Backward
2479 ;; Forward
2487 status))
2490 "Put point at beginning of doc library header, mark at end.
2491 The marks are pushed."
2512 "Return (NAME TYPE CLASS) of current routine."
2516 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2525 "Move to beginning of the current statement.
2526 Skips back past statement continuations.
2527 Point is placed at the beginning of the line whether or not this is an
2528 actual statement."
2540 "Move point to beginning of the previous statement.
2541 Returns t if the current line before moving is the beginning of
2542 the first non-comment statement in the file, and nil otherwise."
2546 ;; first line in file
2547 t
2548 ;; skip blank lines, label lines, include lines and line comments
2550 ;; The current statement is the first statement until we
2551 ;; reach another statement.
2559 ;; skip continuation lines
2565 first-statement)))
2568 "Move point to the end of the current IDL statement.
2569 If not in a statement just moves to end of line. Returns position."
2579 "Move point to the end of the current IDL statement.
2580 If not in a statement just moves to end of line. Returns position."
2588 "Move point to beginning of the next IDL statement.
2589 Returns t if that statement is the last non-comment IDL statement
2590 in the file, and nil otherwise."
2594 ;; skip blank lines, label lines, include lines and line comments
2596 ;; The current statement is the last statement until
2597 ;; we reach a new statement.
2604 last-statement))
2607 "Skip past multiple commands on a line (with `&')."
2617 "Skip label or case statement element.
2618 Returns position after label.
2619 If there is no label point is not moved and nil is returned."
2620 ;; Case expressions and labels are terminated by a colon.
2621 ;; So we find the first colon in the line and make sure
2622 ;; - no `?' is before it (might be a ? b : c)
2623 ;; - it is not in a comment
2624 ;; - not in a string constant
2625 ;; - not in parenthesis (like a[0:3])
2626 ;; - not followed by another ":" in explicit class, ala a->b::c
2627 ;; As many in this mode, this function is heuristic and not an exact
2628 ;; parser.
2640 nil)))
2643 "Move to start of next IDL substatement after point.
2644 Uses the type of the current IDL statement to determine if the next
2645 statement is on a new line or is a subpart of the current statement.
2646 Returns point at start of substatement modulo whitespace.
2647 If optional argument is non-nil move to beginning of current
2648 substatement."
2652 st nst last)
2658 ;; Continue looking for substatements until we are past orig
2672 ;; If a continuation line starts here, move to next line
2678 "Return the type of the current IDL statement.
2679 Uses `idlwave-statement-match' to return a cons of (type . point) with
2680 point the ending position where the type was determined. Type is the
2681 association from `idlwave-statement-match', i.e. the cons cell from the
2682 list not just the type symbol. Returns nil if not an identifiable
2683 statement."
2685 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2686 ;; and possibly comments
2698 "Pad '=' with spaces.
2699 Two cases: Assignment statement, and keyword assignment.
2700 Which case is determined using `idlwave-start-of-substatement' and
2701 `idlwave-statement-type'. The equal sign will be surrounded by BEFORE
2702 and AFTER blanks. If `idlwave-pad-keyword' is t then keyword assignment
2703 is treated just like assignment statements. When nil, spaces are
2704 removed for keyword assignment. Any other value keeps the current space
2705 around the `='. Limits in for loops are treated as keyword assignment.
2707 Starting with IDL 6.0, a number of op= assignments are available.
2708 Since ambiguities of the form:
2710 r and= b
2711 rand= b
2713 can occur, alphanumeric operator assignment will never be pre-padded,
2714 only post-padded. You must use a space before these to disambiguate
2715 \(not just for padding, but for proper parsing by IDL too!). Other
2716 operators, such as ##=, ^=, etc., will be pre-padded.
2718 IS-ACTION is ignored.
2720 See `idlwave-surround'."
2733 ;; Why doesn't ##? work for both?
2737 ;(setq begin nil) ; won't modify begin
2741 ;; Everything gets padded equally
2743 ;; Treating keywords/for variables specially...
2761 "Call `idlwave-indent-line' and do expand actions.
2762 With prefix ARG non-nil, indent the entire sub-statement."
2770 ;;Expand the END abbreviation, just as RET or Space would have.
2781 "Indent current IDL line as code or as a comment.
2782 The actions in `idlwave-indent-action-table' are performed.
2783 If the optional argument EXPAND is non-nil then the actions in
2784 `idlwave-indent-expand-table' are performed."
2786 ;; Move point out of left margin.
2795 ;; Indentation for a line comment
2799 ;;
2800 ;; Code Line
2801 ;;
2802 ;; Before indenting, run action routines.
2803 ;;
2806 ;;
2809 ;;
2810 ;; No longer expand abbrevs on the line. The user can do this
2811 ;; manually using expand-region-abbrevs.
2812 ;;
2813 ;; Indent for code line
2814 ;;
2817 ;; a label line
2819 ;; a batch command
2821 ;; leave flush left
2822 nil
2823 ;; indent the line
2825 ;; Adjust parallel comment
2828 ;; Emacs 21 is too smart with fill-column on comment indent
2831 fill-column)))
2834 ;; Get rid of marker
2838 "Perform an action repeatedly on a line.
2839 ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is
2840 either a function name to be called with `funcall' or a list to be
2841 evaluated with `eval'. The action performed by FUNC should leave
2842 point after the match for REG - otherwise an infinite loop may be
2843 entered. FUNC is always passed a final argument of 'is-action, so it
2844 can discriminate between being run as an action, or a key binding."
2854 "Indent from point with spaces until column COL.
2855 Inserts space before markers at point."
2861 "Indent the current line to column COL.
2862 Indents such that first non-whitespace character is at column COL
2863 Inserts spaces before markers at point."
2870 "Indent program unit which contains point."
2882 "Indent current statement, including all continuation lines."
2891 "Return appropriate indentation for current line as IDL code."
2895 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2896 ;; function
2899 ;; Check for continuation line
2904 ;; calculate indent based on previous and current statements
2907 ;; calculate indent based on previous statement
2910 ;; Beginning of file
2915 ;; Main block
2918 idlwave-main-block-indent))
2919 ;; Begin block
2922 idlwave-block-indent))
2923 ;; End Block
2926 ;; Match to the *beginning* of the block opener
2930 ;; idlwave-end-offset
2931 ;; idlwave-block-indent))
2933 ;; Default to current indent
2935 ;; adjust the indentation based on the current statement
2937 ;; End block
2942 ;;
2943 ;; Parentheses indent
2944 ;;
2947 "Calculate the continuation indent inside a paren group.
2948 Returns a cons-cell with (open . indent), where open is the
2949 location of the open paren."
2951 ;; Found an innermost open paren.
2954 ;; Line up with next word unless this is a closing paren.
2957 ;; Plain Kernighan-style nested indent
2961 ;; This is a closed paren - line up under open paren.
2965 ;; Empty (or just comment) follows -- revert to basic indent
2967 ;; Skip paren
2970 nil)
2972 ;; Line up with first word after any blank space
2978 "Calculates the IDL continuation indent column from the previous statement.
2979 Note that here previous statement usually means the beginning of the
2980 current statement if this statement is a continuation of the previous
2981 line. Various special types of continuations, including assignments,
2982 routine definitions, and parenthetical groupings, are treated separately."
2993 idlwave-continuation-indent))
2994 fancy-nonparen-indent fancy-paren-indent)
2996 ;; Align then with its matching if, etc.
3003 match cont-re)
3018 ;; Indent in from the previous line for continuing statements
3023 match)
3035 ;; Parenthetical indent, either traditional or Kernighan style
3042 indent-cons)
3045 beg-reg end-reg close-exp))
3046 ;; First permitted containing paren
3048 idlwave-indent-to-open-paren
3049 idlwave-indent-parens-nested
3052 idlwave-max-extra-continuation-indent))
3055 fancy-paren-indent)
3057 ;; A continued assignment, or procedure call/definition
3065 ;; A continued Procedure call or definition
3068 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3070 ;; Comment only, or blank line with "$"? Basic indent.
3072 nil
3075 ;; Continued assignment (with =):
3089 idlwave-max-extra-continuation-indent))
3092 fancy-nonparen-indent))
3094 ;; Basic indent, by default
3100 "Move to next match of the regular expression KEY-RE.
3101 Matches inside comments or string constants will be ignored.
3102 If DIR is negative, the search will be backwards.
3103 At a successful match, the mark is pushed unless NOMARK is non-nil.
3104 Searches are limited to LIMIT.
3105 Searches are case-insensitive and use a special syntax table which
3106 treats `$' and `_' as word characters.
3107 Return value is the beginning of the match or (in case of failure) nil."
3111 found)
3125 found)
3126 nil)))
3129 "When optional argument DIR is non-negative, move forward to end of
3130 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3131 regular expressions. When DIR is negative, move backwards to block beginning.
3132 Recursively calls itself to skip over nested blocks. DIR defaults to
3133 forward. Calls `push-mark' unless the optional argument NOMARK is
3134 non-nil. Movement is limited by the start of program units because of
3135 possibility of unbalanced blocks."
3142 idlwave-begin-block-reg
3143 idlwave-end-block-reg))
3144 found
3146 idlwave-end-block-reg))
3150 idlwave-begin-unit-reg dir t limit)
3153 idlwave-end-unit-reg dir t limit)))
3154 limit)))
3166 "The minimum indent in the current statement."
3177 min
3181 "Return indentation of the current statement.
3182 If in a statement, moves to beginning of statement before finding indent."
3189 "Return the column of the indentation of the current line.
3190 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3194 ;; if we are at the end of blank line return 0
3199 "Test if current line is continuation line.
3200 Blank or comment-only lines following regular continuation lines (with
3201 `$') count as continuations too."
3212 "Test if the current line is a comment line."
3218 "Test if the current line is a comment line."
3224 "Search current line from current point for REGEXP.
3225 If optional argument CONT is non-nil, searches to the end of
3226 the current statement.
3227 If optional arg BEG is non-nil, search starts from the beginning of the
3228 current statement.
3229 Ignores matches that end in a comment or inside a string expression.
3230 Returns point if successful, nil otherwise.
3231 This function produces unexpected results if REGEXP contains quotes or
3232 a comment delimiter. The search is case insensitive.
3233 If successful leaves point after the match, otherwise, does not move point."
3239 found)
3245 found))
3248 "Fill paragraphs in comments.
3249 A paragraph is made up of all contiguous lines having the same comment
3250 leader (the leading whitespace before the comment delimiter and the
3251 comment delimiter). In addition, paragraphs are separated by blank
3252 line comments. The indentation is given by the hanging indent of the
3253 first line, otherwise by the minimum indentation of the lines after
3254 the first line. The indentation of the first line does not change.
3255 Does not effect code lines. Does not fill comments on the same line
3256 with code. The hanging indent is given by the end of the first match
3257 matching `idlwave-hang-indent-regexp' on the paragraph's first line.
3258 If the optional argument NOHANG is non-nil then the hanging indent is
3259 ignored."
3261 ;; check if this is a line comment
3268 pre here diff fill-prefix-reg bcl first-indent
3269 hang start end)
3270 ;; Change tabs to spaces in the surrounding paragraph.
3271 ;; The surrounding paragraph will be the largest containing block of
3272 ;; contiguous line comments. Thus, we may be changing tabs in
3273 ;; a much larger area than is needed, but this is the easiest
3274 ;; brute force way to do it.
3275 ;;
3276 ;; This has the undesirable side effect of replacing the tabs
3277 ;; permanently without the user's request or knowledge.
3285 ;;
3291 ;; Get the comment leader on the line and its length
3293 ;; the comment leader is the indentation plus exactly the
3294 ;; number of consecutive ";".
3301 ;; Mark the beginning and end of the paragraph
3307 ;; Move to first line of paragraph
3321 ;; if at end of buffer add a newline (need this because
3322 ;; fill-region needs END to be at the beginning of line after
3323 ;; the paragraph or it will add a line).
3326 ;; Set END to the beginning of line after the paragraph
3327 ;; END is calculated as distance from end of buffer
3329 ;;
3330 ;; Calculate the indentation for the paragraph.
3331 ;;
3332 ;; In the following while statements, after one iteration
3333 ;; point will be at the beginning of a line in which case
3334 ;; the while will not be executed for the
3335 ;; the first paragraph line and thus will not affect the
3336 ;; indentation.
3337 ;;
3338 ;; First check to see if indentation is based on hanging indent.
3344 ;; Adjust lines of paragraph by inserting spaces so that
3345 ;; each line's indent is at least as great as the hanging
3346 ;; indent. This is needed for fill-paragraph to work with
3347 ;; a fill-prefix.
3356 ;; adjust the original location for the
3357 ;; inserted text.
3361 )
3363 ;; No hang. Instead find minimum indentation of paragraph
3364 ;; after first line.
3365 ;; For the following while statement, since START is at the
3366 ;; beginning of line and END is at the end of line
3367 ;; point is greater than START at least once (which would
3368 ;; be the case for a single line paragraph).
3379 ?\ )))
3380 ;; first-line indent
3386 indent))
3388 ;; try to keep point at its original place
3391 ;; In place of the more modern fill-region-as-paragraph, a hack
3392 ;; to keep whitespace untouched on the first line within the
3393 ;; indent length and to preserve any indent on the first line
3394 ;; (first indent).
3400 start
3403 nil)
3407 ;; When we want the point at the beginning of the comment
3408 ;; body fill-region will put it at the beginning of the line.
3413 "Calculate the position of the hanging indent for the comment paragraph.
3414 The hanging indent position is given by the first match with the
3415 `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3416 non-nil then use last occurrence matching `idlwave-hang-indent-regexp'
3417 on the line.
3418 If not found returns nil."
3430 "Called to break lines in auto fill mode.
3431 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3432 non-nil. Places a continuation character at the end of the line if
3433 not in a comment. Splits strings with IDL concatenation operator `+'
3434 if `idlwave-auto-fill-split-string' is non-nil."
3436 nil ; do not to fill
3439 ;; Check for comment line
3444 ;; Prevent actions do-auto-fill which calls indent-line-function.
3449 idlwave-auto-fill-split-string)
3452 ))))
3456 ;; Indent the split line
3461 ;; A continued line comment
3462 ;; We treat continued line comments as part of a comment
3463 ;; paragraph. So we check for a hanging indent.
3471 ;; Remove whitespace between comment delimiter and
3472 ;; text, insert spaces for appropriate indentation.
3478 ;; Split code or comment?
3482 ;; Splitting a non-full-line comment.
3483 ;; Insert the comment delimiter from split line
3488 ;; Insert blank to keep off beginning of line
3497 ;; Split code line - add continuation character
3500 ;; Check to see if we split a string
3502 idlwave-auto-fill-split-string)
3503 ;; Split the string and concatenate.
3504 ;; The first extra space is for the space
3505 ;; the line was split. That space was removed.
3510 ;; Make the second part of continued string
3515 ;; Warning
3518 ;; Although do-auto-fill (via indent-new-comment-line) calls
3519 ;; idlwave-indent-line for the new line, re-indent again
3520 ;; because of the addition of the continuation character.
3522 )))))
3525 "Toggle auto-fill mode for IDL mode.
3526 With arg, turn auto-fill mode on if arg is positive.
3527 In auto-fill mode, inserting a space at a column beyond `fill-column'
3528 automatically breaks the line at a previous space."
3534 'idlwave-auto-fill
3535 nil))
3536 ;; update mode-line
3539 ;(defun idlwave-fill-routine-call ()
3540 ; "Fill a routine definition or statement, indenting appropriately."
3541 ; (let ((where (idlwave-where)))))
3545 "Insert a documentation header at the beginning of the unit.
3546 Inserts the value of the variable `idlwave-file-header'. Sets mark
3547 before moving to do insertion unless the optional prefix argument
3548 NOMARK is non-nil."
3551 ;; make sure we catch the current line if it begins the unit
3557 ;; skip function or procedure line
3571 "Default timestamp insertion function."
3577 ;; Remove extra spaces from line
3579 ;; Insert a blank line comment to separate from the date entry -
3580 ;; will keep the entry from flowing onto date line if re-filled.
3584 "Insert a brief modification log at the beginning of the current program.
3585 Looks for an occurrence of the value of user variable
3586 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user
3587 name and places the point for the user to add a log. Before moving, saves
3588 location on mark ring so that the user can return to previous point."
3603 end t)
3614 ;; CJC 3/16/93
3615 ;; Interface to expand-region-abbrevs which did not work when the
3616 ;; abbrev hook associated with an abbrev moves point backwards
3617 ;; after abbrev expansion, e.g., as with the abbrev '.n'.
3618 ;; The original would enter an infinite loop in attempting to expand
3619 ;; .n (it would continually expand and unexpand the abbrev without expanding
3620 ;; because the point would keep going back to the beginning of the
3621 ;; abbrev instead of to the end of the abbrev). We now keep the
3622 ;; abbrev hook from moving backwards.
3623 ;;;
3625 "Expand each abbrev occurrence in the region.
3626 Calling from a program, arguments are START END."
3635 "Return t if point is in a comment or quoted string.
3636 Returns nil otherwise."
3640 "Return location of the opening quote
3641 if point is in a IDL string constant, nil otherwise.
3642 Ignores comment delimiters on the current line.
3643 Properly handles nested quotation marks and octal
3644 constants - a double quote followed by an octal digit."
3645 ;; Treat an octal inside an apostrophe to be a normal string. Treat a
3646 ;; double quote followed by an octal digit to be an octal constant
3647 ;; rather than a string. Therefore, there is no terminating double
3648 ;; quote.
3650 ;; Because single and double quotes can quote each other we must
3651 ;; search for the string start from the beginning of line.
3657 delim
3658 found)
3660 ;; Find string start
3661 ;; Don't find an octal constant beginning with a double quote
3663 ;; Find the string end.
3664 ;; In IDL, two consecutive delimiters after the start of a
3665 ;; string act as an
3666 ;; escape for the delimiter in the string.
3667 ;; Two consecutive delimiters alone (i.e., not after the
3668 ;; start of a string) is the null string.
3670 ;; Move to position after quote
3673 ;; Get the string delimiter
3675 ;; Check for null string
3678 ;; Look for next unpaired delimiter
3684 ))
3687 ;; return string beginning position or nil
3691 "Determine if the character after point is a pointer dereference *."
3701 ;; Statement templates
3703 ;; Replace these with a general template function, something like
3704 ;; expand.el (I think there was also something with a name similar to
3705 ;; dmacro.el)
3708 "Build a template with optional prompt expression.
3710 Opens a line if point is not followed by a newline modulo intervening
3711 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3712 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3713 adjusted according to `idlwave-abbrev-change-case'. If optional
3714 argument PROMPT is a string then it is displayed as a message in the
3715 minibuffer. The PROMPT serves as a reminder to the user of an
3716 expression to enter.
3718 The lines containing S1 and S2 are reindented using `indent-region'
3719 unless the optional second argument NOINDENT is non-nil."
3721 ;; This is a gross hack to avoit template abbrev expansion
3722 ;; in the shell. FIXME: This is a dirty hack.
3732 end)
3745 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3748 string))
3751 "Build skeleton IDL if-else block."
3759 "Build skeleton IDL case statement."
3767 "Build skeleton IDL switch statement."
3775 "Build skeleton IDL loop statement."
3783 "Build skeleton IDL if statement."
3819 "Return a list of substrings of STRING which are separated by PATTERN.
3833 end)
3841 ;; Return the buffer currently visiting FILE
3851 "List of buffers pulled up by IDLWAVE for special reasons.
3855 ;; Return a buffer visiting file.
3859 buf)))
3862 "Kill buffers created automatically by IDLWAVE.
3863 Function prompts for a letter to identify the buffers to kill.
3864 Possible letters are:
3867 clicks in the routine info window.
3868 s Buffers created by the IDLWAVE Shell to display where execution
3869 stopped or an error was found.
3870 a Both of the above.
3872 Buffers containing unsaved changes require confirmation before they are killed."
3876 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3890 "How many outlawed buffers have tag TAG?"
3894 idlwave-outlawed-buffers))))
3897 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3900 entry)
3914 "Remove BUFFER from the buffers which may be killed.
3915 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3916 Intended for `after-save-hook'."
3919 ;; Revoke license
3923 ;; Remove this function from the hook.
3928 ;; Find FILE on the scanned lib path and return a buffer visiting it
3930 dir efile)
3938 ;; Find FILE on the scanned lib path and return a buffer visiting it
3939 ;; This is for, e.g., finding source with no user catalog
3946 "Create the IDL tags file IDLTAGS in the current directory from
3947 the list of directories specified in the minibuffer. Directories may be
3948 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
3949 specified top directories are searched if the directory name is prefixed
3950 by @. Specify @ directories with care, it may take a long, long time if
3951 you specify /."
3954 buffer save_buffer files numfiles item errbuf)
3956 ;;
3957 ;; Read list of directories
3960 ;;
3961 ;; Set etags command, vars
3967 ;;
3968 ;; For each directory
3972 ;;
3973 ;; Find the subdirectories
3995 ;;
3996 ;; For each subdirectory
4000 ;;
4001 ;; Call etags
4010 0
4012 ;;
4013 ;; Append additional tags
4020 )))
4032 ))
4035 "Comment the lines in the region if the first non-blank line is
4036 commented, and conversely, uncomment region. If optional prefix arg
4037 N is non-nil, then for N positive, add N comment delimiters or for N
4038 negative, remove N comment delimiters.
4039 Uses `comment-region' which does not place comment delimiters on
4040 blank lines."
4047 ;; skip blank lines
4059 ;; ----------------------------------------------------------------------------
4060 ;; ----------------------------------------------------------------------------
4061 ;; ----------------------------------------------------------------------------
4062 ;; ----------------------------------------------------------------------------
4063 ;;
4064 ;; Completion and Routine Info
4065 ;;
4067 ;; String "intern" functions
4069 ;; For the completion and routine info function, we want to normalize
4070 ;; the case of procedure names etc. We do this by "interning" these
4071 ;; string is a hand-crafted way. Hashes are used to map the downcase
4072 ;; version of the strings to the cased versions. Most *-sint-*
4073 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4074 ;; system hash. The former is re-scanned, and the latter takes case
4075 ;; precedence.
4076 ;;
4077 ;; Since these cased versions are really lisp objects, we can use `eq'
4078 ;; to search, which is a large performance boost. All new strings
4079 ;; need to be "sinterned". We do this as early as possible after
4080 ;; getting these strings from completion or buffer substrings. So
4081 ;; most of the code can simply assume to deal with "sinterned"
4082 ;; strings. The only exception is that the functions which scan whole
4083 ;; buffers for routine information do not intern the grabbed strings.
4084 ;; This is only done afterwards. Therefore in these functions it is
4085 ;; *not* safe to assume the strings can be compared with `eq' and be
4086 ;; fed into the routine assq functions.
4088 ;; Here we define the hashing functions.
4090 ;; The variables which hold the hashes.
4099 "Reset all sintern hashes."
4100 ;; Make sure the hash functions are accessible.
4111 ;; Make sure these are lists
4116 ;; Reset the system & library hash
4124 idlwave-sint-libnames nil))
4126 ;; Reset the buffer & shell hash
4142 ;;(defmacro idlwave-sintern (type var)
4143 ;; `(cond ((not (stringp name)) name)
4144 ;; ((gethash (downcase name) (cdr ,var)))
4145 ;; ((gethash (downcase name) (car ,var)))
4146 ;; (set (idlwave-sintern-set name ,type ,var set))
4147 ;; (name)))
4187 iname))
4190 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4194 kwd-list)
4197 "Sintern all strings in the rinfo LIST.
4198 With optional parameter SET: also set new patterns. Probably this
4199 will always have to be t. If DEFAULT-DIR is passed, it is used as
4200 the base of the directory."
4212 ;; The class and name
4220 ;; The source
4233 ;; The keywords
4236 kwds))
4238 ;; Build a canonicalized list
4243 ;; Creating new sintern tables
4246 "Define a variable and a function to sintern the new type TAG.
4247 This defines the function `idlwave-sintern-TAG' and the variable
4248 `idlwave-sint-TAGs'."
4260 name)
4264 "Reset the sintern variable associated with TAG."
4267 ;;---------------------------------------------------------------------------
4270 ;; The variables which hold the information
4286 "Alist with !PATH directories and zero or more flags if the dir has
4287 been scanned in a user catalog ('user) or discovered in a library
4303 ;;
4304 ;; The code to get routine info from different sources.
4311 "Provide a list of IDL routines.
4312 This routine loads the builtin routines on the first call.
4313 Later it only returns the value of the variable."
4323 ;; Keep it running...
4324 )
4326 ;; Something is wrong, get rid of the process
4335 ;; return the current value
4336 idlwave-routines)))
4339 "List of functions which should run after a global rinfo update.
4343 "Rescan the previously selected directories. For batch processing."
4347 "Dispatch another Emacs instance to update the idlwave catalog.
4348 After the process finishes normally, the first access to routine info
4349 will re-read the catalog."
4373 nil emacs args)))
4376 process
4380 idlwave-system-routines nil
4381 idlwave-catalog-process nil)
4387 ;; Format for all routine info user catalog, library catalogs, etc.:
4388 ;;
4389 ;; ("ROUTINE" type class
4390 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4391 ;; (buffer pro_file dir) | (compiled pro_file dir)
4392 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4393 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4394 ;;
4395 ;; DIR will be supplied dynamically while loading library catalogs,
4396 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4397 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4398 ;; be nil, as can LINK1, etc., if no HTML help is available.
4405 "Update the internal routine-info lists.
4408 about individual routines.
4410 The information can come from 4 sources:
4411 1. IDL programs in the current editing session
4412 2. Compiled modules in an IDL shell running as Emacs subprocess
4413 3. A list which covers the IDL system routines.
4414 4. A list which covers the prescanned library files.
4416 Scans all IDLWAVE-mode buffers of the current editing session (see
4417 `idlwave-scan-all-buffers-for-routine-info').
4418 When an IDL shell is running, this command also queries the IDL program
4419 for currently compiled routines.
4421 With prefix ARG, also reload the system and library lists.
4422 With two prefix ARG's, also rescans the chosen user catalog tree.
4423 With three prefix args, dispatch asynchronous process to do the update.
4425 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4426 lists, but instead wait for the shell query to complete and
4427 asynchronously finish updating routine info. This is set
4428 automatically when called interactively. When you need routine
4429 information updated immediately, leave NO-CONCATENATE nil."
4431 ;; Stop any idle processing
4439 ;; Start a background process which updates the catalog.
4442 ;; Update the user catalog now, and wait for them.
4446 idlwave-buffer-case-takes-precedence
4448 ;; The override-idle means, even if the idle timer has done some
4449 ;; preparing work, load and renormalize everything anyway.
4453 idlwave-compiled-routines nil
4454 idlwave-unresolved-routines nil)
4455 ;; Reset the appropriate hashes
4457 ;; reset was already done in idle time, so skip this step now once
4464 ;; We can safely scan the buffer stuff first
4468 ;; We first do the system info, and then the buffers
4472 ;; Let's see if there is a shell
4476 idlwave-query-shell-for-routine-info)))
4478 ;; Load the library catalogs again, first re-scanning the path
4490 ;; 1. If we are not going to ask the shell, we need to do the
4491 ;; concatenation now.
4492 ;; 2. When this function is called non-interactively, it
4493 ;; means that someone needs routine info *now*. The
4494 ;; shell update causes the concatenation to be
4495 ;; *delayed*, so not in time for the current command.
4496 ;; Therefore, we do a concatenation now, even though
4497 ;; the shell might do it again.
4501 ;; Ask the shell about the routines it knows of.
4524 idlwave-init-rinfo-when-idle-after
4530 ;;------ XML Help routine info system
4532 ;; Load the system routine info from the cached routine info file,
4533 ;; which, if necessary, will be re-created from the XML file on
4534 ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo
4535 ;; file distributed with older IDLWAVE versions (<6.0)
4539 ;; See if we can create it from XML source
4559 idlwave-xml-system-rinfo-converted-file
4560 catalog-file)))
4564 "Alist of system variables and the associated structure tags.
4572 ;; From a list of syntax statements, shorten with %s and group with "or"
4581 x)
4586 ;; Create a class list entry from the xml parsed list., returning a
4587 ;; cons of form (class-entry method-entries).
4593 class-entry
4594 method methods-entry extra-kwds
4595 props get-props set-props init-props inherits
4596 pelem ptype)
4626 init-props)
4629 get-props)
4632 set-props)
4636 methods-entry)))
4639 ;;(unless (get 'init-props 'matched)
4640 ;; (message "Failed to match Init in class %s" class))
4641 ;;(unless (get 'get-props 'matched)
4642 ;; (message "Failed to match GetProperty in class %s" class))
4643 ;;(unless (get 'set-props 'matched)
4644 ;; (message "Failed to match SetProperty in class %s" class))
4652 ;; Create correctly structured list elements from ROUTINE or METHOD
4653 ;; XML list structures. Return a list of list elements, with more
4654 ;; than one sub-list possible if a routine can serve as both
4655 ;; procedure and function (e.g. call_method).
4662 syntax kwd klink pref-list kwds pelem ptype props result type)
4697 ;; Debug
4698 ;; (if (and (null (aref syntax-vec 0))
4699 ;; (null (aref syntax-vec 1))
4700 ;; (null (aref syntax-vec 2)))
4701 ;; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints")
4702 ;; (if class
4703 ;; (insert (format "Missing SYNTAX entry for %s::%s\n" class name))
4704 ;; (insert (message "Missing SYNTAX entry for %s\n" name)))))
4706 ;; Executive commands are treated specially
4718 result)))
4722 ;; Group keywords by link file, as a list with elements
4723 ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2))
4735 ;; Ensure the master link is there
4738 linkfiles
4743 ;; Clean up the syntax of routines which are actually aliases by
4744 ;; removing the "OR" from the statements
4753 ;; Duplicate and trim original routine aliases from rinfo list
4754 ;; This if for, e.g. OPENR/OPENW/OPENU
4764 ;; Add any missing aliases (separate by slashes)
4779 ;; Duplicate and trim original routine aliases from rinfo list
4780 ;; This if for, e.g. !X, !Y, !Z.
4793 ;; Create a sysvar list entry from the xml parsed list.
4801 pelem ptype props tags)
4812 tags))))
4826 ;; Automatically generated from source file:
4831 idlwave-xml-routine-info-file))
4849 "Convert XML supplied IDL routine info into internal form.
4850 Cache to disk for quick recovery."
4856 props rinfo msg-cnt elem type nelem class-result alias
4857 routines routine-aliases statement-aliases sysvar-aliases)
4867 ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff.
4877 idlwave-system-variables-alist nil
4878 idlwave-system-class-info nil
4879 idlwave-executive-commands-alist nil
4880 idlwave-help-special-topic-words nil)
4896 routine-aliases)
4901 ;; a cons cell is an executive commands
4913 idlwave-help-special-topic-words)
4914 ;; Save the links to those which are statement aliases (not routines)
4923 sysvar-aliases)
4925 idlwave-system-variables-alist)))
4936 ;; ("ROUTINE" type class
4937 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4938 ;; (buffer pro_file dir) | (compiled pro_file dir)
4939 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4940 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4950 ;;(load "idlw-rinfo" 'noerror 'nomessage)
4972 ;; Check for the old style catalog and warn
4975 idlwave-library-routines)
4980 idlwave-user-catalog-file))
5007 ;; restart the timer
5012 idlwave-init-rinfo-when-idle-after
5018 ;; Load and case-treat the system, user catalog, and library routine
5019 ;; info files.
5021 ;; System
5023 ;;(load "idlw-rinfo" 'noerror 'nomessage))
5035 ;; User catalog
5044 idlwave-library-routines)
5047 idlwave-user-catalog-file))
5056 ;; Library catalog
5067 ;; Scan all buffers, current buffer last
5072 ;; Don't scan any buffers
5075 ;; Just scan this buffer
5081 ;; Put the result into the correct variable
5086 "Put the different sources for routine information together."
5087 ;; The sequence here is important because earlier definitions shadow
5088 ;; later ones. We assume that if things in the buffers are newer
5089 ;; then in the shell of the system, they are meant to be different.
5092 idlwave-compiled-routines
5093 idlwave-library-catalog-routines
5094 idlwave-user-catalog-routines))
5097 ;; Give a message with information about the number of routines we have.
5100 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
5110 "Return the class alist - make it if necessary."
5117 idlwave-class-alist)))
5119 ;; Three functions for the hooks
5128 "Update `idlwave-routines' for current buffer.
5129 Can run from `after-save-hook'."
5133 idlwave-scan-all-buffers-for-routine-info
5134 idlwave-routines)
5140 nil
5146 routines)
5150 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
5152 found)
5154 ;; The following test uses eq to make sure it works correctly
5155 ;; when two buffers visit the same file. Then the file names
5156 ;; will be equal, but not eq.
5162 ;; End of that section reached. Jump.
5168 ;;----- Scanning buffers -------------------
5171 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
5177 buffer-file-name)
5178 ;; yes, this buffer has the right mode.
5183 ;; Concatenate the individual lists and return the result
5187 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
5189 routine-list string entry)
5203 routine-list))
5208 "Parse a module definition."
5210 start name args type keywords class)
5211 ;; Remove comments
5214 ;; Remove the continuation line stuff
5219 ;; Match the name and type.
5227 ;; Match normal args and keyword args
5230 string start)
5235 ;; Normalize and sort.
5239 ;; Make and return the entry
5240 ;; We don't know which argument are optional, so this information
5241 ;; will not be contained in the calling sequence.
5244 class
5247 ; ((string= (downcase
5248 ; (file-name-sans-extension
5249 ; (file-name-nondirectory (buffer-file-name))))
5250 ; (downcase name))
5251 ; (list 'lib))
5252 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
5258 "%s"
5266 nil))))
5269 ;;----- Scanning the user catalog -------------------
5272 "Return the syslib directory, or a dummy that never matches."
5276 idlwave-system-directory)
5282 "Scan all files on selected dirs of IDL search path for routine information.
5284 A widget checklist will allow you to choose the directories. Write
5285 the result as a file `idlwave-user-catalog-file'. When this file
5286 exists, it will be automatically loaded to give routine information
5287 about library routines. With ARG, just rescan the same directories
5288 as last time - so no widget will pop up."
5290 ;; Make sure the file is loaded if it exists.
5296 ;; Make sure the file name makes sense
5302 idlwave-user-catalog-file))))
5306 ;; Rescan the known directories
5311 ;; Expand the directories from library-path and run the widget
5315 ;; Propagate any flags on the existing path-alist
5318 idlwave-true-path-alist)))
5325 ;; Ask the shell for the path and then run the widget
5334 ;; Parse shell path information and select among it.
5336 ;; Command hook used by `idlwave-create-user-catalog-file'.
5338 ;; Scan immediately
5340 ;; Set the path and display the widget
5346 "This is the front-end to the creation of the IDLWAVE user catalog.
5347 Please select the directories on IDL's search path from which you
5348 would like to extract routine information, to be stored in the file:
5350 %s
5352 If this is not the correct file, first set variable
5353 `idlwave-user-catalog-file', and call this command again.
5355 N.B. Many libraries include pre-scanned catalog files
5357 not be scanned. You can scan your own libraries off-line using the
5358 perl script `idlwave_catalog'.
5360 After selecting the directories, choose [Scan & Save] to scan the library
5361 directories and save the routine info.
5367 "Create the widget to select IDL search path directories for scanning."
5379 idlwave-user-catalog-file))
5390 :notify
5400 :notify
5418 'checklist
5422 dirs-list))
5423 :greedy t
5445 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
5450 dir-entry)
5456 selected-dirs)
5463 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5467 dirs-alist dir files file)
5469 idlwave-path-alist path-alist ; for library-path instead
5470 idlwave-true-path-alist nil)
5491 idlwave-user-catalog-routines)))))))))
5499 font-lock-mode)
5505 ;; Define the routine info list
5512 idlwave-user-catalog-routines))
5516 ;; Save the buffer
5522 idlwave-user-catalog-file)
5540 font-lock-mode)
5545 ;; Define the variable which knows the value of "!DIR"
5547 idlwave-system-directory))
5549 ;; Define the variable which contains a list of all scanned directories
5556 idlwave-path-alist))
5563 ;; Expand parts of path starting with '+' recursively into directory list.
5564 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5574 ;; Expand recursively
5576 ;; Keep unchanged
5582 ;; Return a list of all directories below DIR, including DIR itself
5591 path1))
5594 ;;----- Scanning the library catalogs ------------------
5600 "Scan for library catalog files (.idlwave_catalog) and ingest.
5602 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5603 instead, if present) are searched. Print MESSAGE-BASE along with the
5604 libraries being loaded, if passed, and skip loading/normalizing if
5605 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5606 be set to nil to disable library catalog scanning."
5613 dir-entry dir catalog all-routines)
5621 ;; Load the catalog file
5626 message-base
5628 old-libname)))
5630 idlwave-library-catalog-libname))
5637 all-routines))))
5639 ;; Add a 'lib flag if on path-alist
5646 ;;----- Communicating with the Shell -------------------
5648 ;; First, here is the idl program which can be used to query IDL for
5649 ;; defined routines.
5651 "
5652 ;; START OF IDLWAVE SUPPORT ROUTINES
5653 pro idlwave_print_safe,item,limit
5654 catch,err
5655 if err ne 0 then begin
5656 print,'Could not print item.'
5657 return
5658 endif
5659 if n_elements(item) gt limit then $
5660 print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $
5661 else print,item
5662 end
5664 pro idlwave_print_info_entry,name,func=func,separator=sep
5665 ;; See if it's an object method
5666 if name eq '' then return
5667 func = keyword_set(func)
5668 methsep = strpos(name,'::')
5669 meth = methsep ne -1
5671 ;; Get routine info
5672 pars = routine_info(name,/parameters,functions=func)
5673 source = routine_info(name,/source,functions=func)
5674 nargs = pars.num_args
5675 nkw = pars.num_kw_args
5676 if nargs gt 0 then args = pars.args
5677 if nkw gt 0 then kwargs = pars.kw_args
5679 ;; Trim the class, and make the name
5680 if meth then begin
5681 class = strmid(name,0,methsep)
5682 name = strmid(name,methsep+2,strlen(name)-1)
5683 if nargs gt 0 then begin
5684 ;; remove the self argument
5685 wh = where(args ne 'SELF',nargs)
5686 if nargs gt 0 then args = args[wh]
5687 endif
5688 endif else begin
5689 ;; No class, just a normal routine.
5691 endelse
5693 ;; Calling sequence
5695 if func then cs = 'Result = '
5696 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5697 cs = cs + '%s'
5698 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5699 if nargs gt 0 then begin
5700 for j=0,nargs-1 do begin
5701 cs = cs + args[j]
5702 if j lt nargs-1 then cs = cs + ', '
5703 endfor
5704 end
5705 if func then cs = cs + ')'
5706 ;; Keyword arguments
5707 kwstring = ''
5708 if nkw gt 0 then begin
5709 for j=0,nkw-1 do begin
5710 kwstring = kwstring + ' ' + kwargs[j]
5711 endfor
5712 endif
5714 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5716 print,ret + ': ' + name + sep + class + sep + source[0].path $
5717 + sep + cs + sep + kwstring
5718 end
5720 pro idlwave_routine_info,file
5721 on_error,1
5722 sep = '<@>'
5724 all = routine_info()
5725 fileQ=n_elements(file) ne 0
5726 if fileQ then file=strtrim(file,2)
5727 for i=0L,n_elements(all)-1L do begin
5728 if fileQ then begin
5729 if (routine_info(all[i],/SOURCE)).path eq file then $
5730 idlwave_print_info_entry,all[i],separator=sep
5731 endif else idlwave_print_info_entry,all[i],separator=sep
5732 endfor
5733 all = routine_info(/functions)
5734 for i=0L,n_elements(all)-1L do begin
5735 if fileQ then begin
5736 if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $
5737 idlwave_print_info_entry,all[i],separator=sep,/FUNC
5738 endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC
5739 endfor
5740 print,'>>>END OF IDLWAVE ROUTINE INFO'
5741 end
5743 pro idlwave_get_sysvars
5744 on_error,1
5745 catch,error_status
5746 if error_status ne 0 then begin
5747 print, 'Cannot get info about system variables'
5748 endif else begin
5749 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5750 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5751 v = strsplit(s,' +',/regex,/extract) ; get variables
5752 for i=0L,n_elements(v)-1 do begin
5753 t = [''] ; get tag list
5754 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5755 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5756 endfor
5757 endelse
5758 end
5760 pro idlwave_get_class_tags, class
5761 res = execute('tags=tag_names({'+class+'})')
5762 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5763 end
5764 ;; END OF IDLWAVE SUPPORT ROUTINES
5765 "
5786 (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5791 ;; Restore if necessary. Must use execute to hide lame routine_info
5792 ;; errors on undefinded routine
5794 (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'"
5795 idlwave-shell-temp-rinfo-save-file
5796 idlwave-shell-temp-rinfo-save-file)
5801 "Query the shell for routine_info of compiled modules and update the lists."
5802 ;; Save and compile the procedure. The compiled procedure is then
5803 ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may
5804 ;; need to test for and possibly RESTORE the procedure each time we
5805 ;; use it, since the user may have killed or redefined it. In
5806 ;; particular, .RESET_SESSION will kill all user procedures. If
5807 ;; FILE is set, only update routine info for routines in that file.
5810 ; execute the routine_info procedure, and analyze the output
5818 ;; ---------------------------------------------------------------------------
5819 ;;
5820 ;; Completion and displaying routine calling sequences
5832 "Complete a function, procedure or keyword name at point.
5833 This function is smart and figures out what can be completed
5834 at this point.
5835 - At the beginning of a statement it completes procedure names.
5836 - In the middle of a statement it completes function names.
5837 - After a `(' or `,' in the argument list of a function or procedure,
5838 it completes a keyword of the relevant function or procedure.
5839 - In the first arg of `OBJ_NEW', it completes a class name.
5841 When several completions are possible, a list will be displayed in
5842 the *Completions* buffer. If this list is too long to fit into the
5843 window, scrolling can be achieved by repeatedly pressing
5846 The function also knows about object methods. When it needs a class
5847 name, the action depends upon `idlwave-query-class', which see. You
5848 can force IDLWAVE to ask you for a class name with a
5851 See also the variables `idlwave-keyword-completion-adds-equal' and
5852 `idlwave-function-completion-adds-paren'.
5854 The optional ARG can be used to specify the completion type in order
5855 to override IDLWAVE's idea of what should be completed at point.
5856 Possible values are:
5858 0 <=> query for the completion type
5859 1 <=> 'procedure
5860 2 <=> 'procedure-keyword
5861 3 <=> 'function
5862 4 <=> 'function-keyword
5863 5 <=> 'procedure-method
5864 6 <=> 'procedure-method-keyword
5865 7 <=> 'function-method
5866 8 <=> 'function-method-keyword
5867 9 <=> 'class
5869 As a special case, the universal argument C-u forces completion of
5870 function names in places where the default would be a keyword.
5872 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5873 completion.
5875 For Lisp programmers only:
5876 When we force a keyword, optional argument MODULE can contain the module name.
5877 When we force a method or a method keyword, CLASS can specify the class."
5904 ;; Complete a filename in quotes
5909 ;; Check for any special completion functions
5916 ;; Complete a class
5922 ;; Complete a procedure name
5935 isa
5941 isa
5945 ;; Complete a function name
5958 isa
5964 isa
5972 ;; Complete a procedure keyword
5989 super-classes system))
6001 isa
6005 ;; Complete a function keyword
6018 msg-name)
6023 super-classes system))
6024 ;; OBJ_NEW: Messages mention the proper Init method
6031 msg-name))
6040 isa
6046 "List of special completion functions.
6047 These functions are called for each completion. Each function must
6048 check if its own special completion context is present. If yes, it
6049 should use `idlwave-complete-in-buffer' to do some completion and
6050 return t. If such a function returns t, *no further* attempts to
6051 complete other contexts will be done. If the function returns nil,
6056 fun ret)
6061 nil)))
6064 ;; Return an artificial WHERE specification to force the completion
6065 ;; routine to complete a specific item independent of context.
6066 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
6067 ;; MODULE and CLASS can be used to specify the routine name and class.
6068 ;; The class name will also be found in MODULE if that is like "class::mod".
6086 what)
6159 ;; Completing read, case insensitive
6169 "Use the comint stuff to complete a file name."
6177 idlwave-shell-default-directory
6178 default-directory)))
6182 ;; Make a fully qualified module name including the class name
6186 "Like `idlwave-rinfo-assq', but sintern strings first."
6192 ;; Works like assq, but also checks type and class
6203 ;; Return the first matching method on the inheritance list
6205 class rtn)
6209 rtn))
6212 keep-system)
6213 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
6214 If WITH-FILE is passed, find the best rinfo entry with a file
6215 included. If KEEP-SYSTEM is set, don't prune system for compiled
6216 syslib files."
6219 list))
6220 syslibp)
6227 ;; Its a compiled syslib, so we need to remove the system entry
6233 twins)))))
6237 keep-system)
6238 "Like `idlwave-best-rinfo-assq', but sintern strings first."
6244 "Does the entry list ENTRIES contain a syslib entry?
6245 If yes, return the index (>=1)."
6254 nil)))
6257 "Return a list of all associations of Key in LIST."
6265 "Return all classes which have a method METHOD.
6266 TYPE is 'fun or 'pro.
6267 When TYPE is not specified, both procedures and functions will be considered."
6280 "Return all classes which have a method METHOD with keyword KEYWORD.
6281 TYPE is 'fun or 'pro.
6282 When TYPE is not specified, both procedures and functions will be considered."
6285 nil
6297 "Return list of all elements in LIST which are also in CLUB."
6306 "Return list of all elements in LIST which are not in CLUB."
6310 nil
6316 "Return whether or not the class is listed explicitly, ala a->b::c.
6317 INFO is as returned by `idlwave-what-function' or `-procedure'."
6324 "List of special functions for determining class.
6328 ;; Determine the class of a routine call.
6329 ;; INFO is the `cw-list' structure as returned by idlwave-where.
6330 ;; The second element in this structure is the class. When nil, we
6331 ;; return nil. When t, try to get the class from text properties at
6332 ;; the arrow. When the object is "self", we use the class of the
6333 ;; current routine. otherwise prompt the user for a class name.
6334 ;; Also stores the selected class as a text property at the arrow.
6335 ;; TYPE is 'fun or 'pro.
6341 idlwave-query-class))
6343 idlwave-query-class))
6355 store special-class class-alist)
6359 ;; There is an object which would like to know its class
6361 idlwave-store-inquired-class
6368 ;; Before prompting, try any special class determination routines
6370 idlwave-determine-class-special
6376 store idlwave-store-inquired-class)))
6378 ;; Prompt for a class, if we need to
6399 ;; Store it, if requested
6401 ;; We have a real class here
6407 rear-nonsticky t))
6410 ;; Return the class
6411 class)
6412 ;; Default as fallback
6422 ;; Record a file link, if any, for the tested names during selection.
6426 sel))
6430 "Find out where we are.
6431 The return value is a list with the following stuff:
6432 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
6434 PRO-LIST (PRO POINT CLASS ARROW)
6435 FUNC-LIST (FUNC POINT CLASS ARROW)
6436 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
6437 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
6438 be completed here.
6439 LAST-CHAR last relevant character before point (non-white non-comment,
6440 not part of current identifier or leading slash).
6442 In the lists, we have these meanings:
6443 PRO: Procedure name
6444 FUNC: Function name
6445 POINT: Where is this
6446 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
6447 ARROW: Location of the arrow"
6465 cw cw-mod cw-arrow cw-class cw-point)
6469 match-string)
6475 match-string))
6477 cw-arrow pro-arrow))
6479 match-string)
6480 nil)
6482 match-string)
6485 match-string)
6492 cw-class func-class cw-arrow func-arrow))
6495 cw-class pro-class cw-arrow pro-arrow))
6496 ; ((member last-char '(?\' ?\) ?\] ?!))
6497 ; ;; after these chars, a function makes no sense
6498 ; ;; FIXME: I am sure there can be more in this list
6499 ; ;; FIXME: Do we want to do this at all?
6500 ; nil)
6501 ;; Everywhere else we try a function.
6505 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t)
6509 t))))))
6512 cw
6514 last-char)))
6517 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6525 ;; Find out if point is within the argument list of a function.
6526 ;; The return value is ("function-name" class arrow-start (point) level).
6527 ;; Level is 1 on the top level parentheses, higher further down.
6529 ;; If the optional BOUND is an integer, bound backwards directed
6530 ;; searches to this point.
6534 func-point
6536 func arrow-start class)
6541 ;; move back out of the current parenthesis
6550 bound t))
6553 pos func-point)
6559 'exit
6563 arrow-start func-point cnt)))
6568 ;; Find out if point is within the argument list of a procedure.
6569 ;; The return value is ("procedure-name" class arrow-pos (point)).
6571 ;; If the optional BOUND is an integer, bound backwards directed
6572 ;; searches to this point.
6574 pro class arrow-start string)
6576 ;;(idlwave-beginning-of-statement)
6586 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6587 string))
6592 pos)
6597 arrow-start
6598 pro-point)))
6601 ;; If there is an object at point, move over it and return t.
6611 nil)
6629 nil)))
6632 "Return the last character before point which is not white or a comment
6633 and also not part of the current identifier. Since we do this in
6634 order to identify places where keywords are, we consider the initial
6635 `/' of a keyword as part of the identifier.
6636 This function is not general, can only be used for completion stuff."
6639 ;; skip the current identifier
6641 ;; also skip a leading slash which might be belong to the keyword
6644 ;; FIXME: does not check if this is a valid identifier
6652 ;; continuation line
6666 &optional prepare-display-function
6667 special-selector)
6668 "Perform TYPE completion of word before point against LIST.
6669 SELECTOR is the PREDICATE argument for the completion function. Show
6670 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6671 'procedure, 'class-tag, 'keyword, 'sysvar, etc. SPECIAL-SELECTOR is
6672 used only once, for `all-completions', and can be used to, e.g.,
6673 accumulate information on matching completions."
6676 dpart dcompletion)
6681 ;; What is already in the buffer?
6686 idlwave-complete-after-success-form
6689 idlwave-complete-after-success-form-force
6693 ;; Try a completion
6699 idlwave-completion-help-links nil)
6702 ;; nothing available.
6706 ;; We can add something
6710 idlwave-complete-empty-string-as-lower-case)
6712 dcompletion
6713 completion))
6715 ;; Now this is a unique match
6717 t)
6723 selector))))))
6725 ;; This is already complete
6728 nil)
6730 ;; We cannot add something - offer a list.
6738 idlwave-completion-help-links))))
6739 list))
6741 ;; "complete" means, this is already a valid completion
6744 ;; (completion-fixup-function ; Emacs
6745 ;; (lambda () (and (eq (preceding-char) ?>)
6746 ;; (re-search-backward " <" beg t)))))
6754 idlwave-complete-empty-string-as-lower-case)
6760 x)
6761 list)))
6763 t))))
6766 "Complete a class at point."
6768 ;; Call `idlwave-routines' to make sure the class list will be available
6770 ;; Check for the special case of completing empty string after pro/function
6779 ;; Yank the full class specification
6781 ;; Do the completion, using list gathered from `idlwave-routines'
6790 idlwave-completion-help-links))
6791 x))
6792 list)))))
6795 ;; Attach the proper class list to a LIST of completion items.
6796 ;; TYPE, when 'kwd, shows classes for method keywords, when
6797 ;; 'class-tag, for class tags, and otherwise for methods.
6798 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6804 ;; In these cases, we do not have to do anything
6805 list
6809 ;; (do-dots (featurep 'xemacs))
6815 classes nclasses class-info space)
6818 ;; get the classes
6820 ;; Just one class for tags
6824 ;; Multiple classes for method or method-keyword
6828 method-selector x type-selector)
6834 classes)))))
6836 ;; Make the separator between item and class-info
6841 ;; We do want info in the buffer
6844 space
6849 ;; We do want properties
6853 x))
6856 x))
6857 list))))
6860 ;; Call idlwave-attach-classes with method parameters
6863 ;; Call idlwave-attach-classes with keyword parameters
6866 ;; Call idlwave-attach-classes with class structure tags
6870 ;;----------------------------------------------------------------------
6871 ;;----------------------------------------------------------------------
6872 ;;----------------------------------------------------------------------
6873 ;;----------------------------------------------------------------------
6874 ;;----------------------------------------------------------------------
6881 "Select an item in LIST with a popup menu.
6882 TITLE is the title to put atop the popup. If SORT is non-nil,
6883 sort the list before displaying."
6885 rtn menu)
6895 x)))
6896 list)))
6909 rtn))
6912 "Split the MENU into submenus of maximum length N."
6914 ;; No splitting needed
6915 menu
6930 nextmenu))
6932 nextmenu nil
6937 "Split the MENU into submenus of maximum length N."
6939 ;; No splitting needed
6940 menu
6956 nextmenu))
6958 nextmenu nil
6962 menu)))
6967 "Scroll the completion window on this frame."
6985 "Display the completions in LIST in the completions buffer and echo MESSAGE."
6993 list)
6996 ;; Store a special value in `this-command'. When `idlwave-complete'
6997 ;; finds this in `last-command', it will scroll the *Completions* buffer.
7000 ;; Mark the completions buffer as created by cib
7003 ;; Fontify the classes
7008 ;; Run the hook
7011 ;; Display the message
7015 "Call FUNCTION as a completion chooser and pass ARGS to it."
7021 ;; For the shell, remove the fontification of the word before point
7036 "Restore the old (before completion) window configuration."
7038 idlwave-before-completion-wconf
7042 "Make the user select an element from the alist in the variable SYM.
7043 The keys of the alist are expected to be strings. The function returns the
7044 car of the selected association.
7045 To do this, PROMPT is displayed and the user must hit a letter key to
7046 select an entry. If the user does not reply within DELAY seconds, a help
7047 window with the options is displayed automatically.
7048 The key which is associated with each option is generated automatically.
7050 If these don't exist, a letter in the string is automatically selected."
7054 keys-alist char)
7055 ;; First check the cache
7058 ;; Need to make new list
7062 ;; Display prompt and wait for quick reply
7067 ;; No quick reply: Show help
7076 ;; Return the selected result
7079 ;; Used for, e.g., electric debug super-examine.
7081 "Make an alist for single key selection."
7089 ;; First check if the configuration predetermined a key
7096 ;; Then check for capital letters
7106 t t name))
7109 ;; Now check for lowercase letters
7119 t t name))
7122 ;; Bummer, nothing found! Use a stupid number
7129 "Set the buffer-local value of VAR in BUFFER to VALUE."
7134 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
7139 ;; In XEmacs, we can use :activate-callback directly to advice the
7140 ;; choose functions. We use the private keymap only for the online
7141 ;; help feature.
7150 cl-args))
7159 "Execute `default-choose-completion' and then restore the win-conf."
7163 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7166 (define-key new-map [button3] (lambda ()
7167 (interactive)
7168 (setq this-command last-command)))
7169 new-map))
7171 ;; In Emacs we also replace keybindings in the completion
7172 ;; map in order to install our wrappers.
7174 (defun idlwave-display-completion-list-emacs (list)
7175 "Display completion list and install the choose wrappers."
7176 (with-output-to-temp-buffer "*Completions*"
7177 (display-completion-list list))
7178 (with-current-buffer "*Completions*"
7179 (use-local-map
7180 (or idlwave-completion-map
7181 (setq idlwave-completion-map
7182 (idlwave-make-modified-completion-map-emacs
7183 (current-local-map)))))))
7185 (defun idlwave-make-modified-completion-map-emacs (old-map)
7186 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7187 (let ((new-map (copy-keymap old-map)))
7188 (substitute-key-definition
7189 'choose-completion 'idlwave-choose-completion new-map)
7190 (substitute-key-definition
7191 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
7192 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
7193 new-map))
7195 (defun idlwave-choose-completion (&rest args)
7196 "Choose the completion that point is in or next to."
7197 (interactive)
7198 (apply 'idlwave-choose 'choose-completion args))
7200 (defun idlwave-mouse-choose-completion (&rest args)
7201 "Click on an alternative in the `*Completions*' buffer to choose it."
7202 (interactive "e")
7203 (apply 'idlwave-choose 'mouse-choose-completion args))
7205 ;;----------------------------------------------------------------------
7206 ;;----------------------------------------------------------------------
7208 ;;; ------------------------------------------------------------------------
7209 ;;; Structure parsing code, and code to manage class info
7211 ;;
7212 ;; - Go again over the documentation how to write a completion
7213 ;; plugin. It is in self.el, but currently still very bad.
7214 ;; This could be in a separate file in the distribution, or
7215 ;; in an appendix for the manual.
7217 (defvar idlwave-struct-skip
7219 "Regexp for skipping continued blank or comment-only lines in structures.")
7221 (defvar idlwave-struct-tag-regexp
7222 (concat "[{,]" ;leading comma/brace
7223 idlwave-struct-skip ; 4 groups
7226 "Regexp for structure tags.")
7228 (defun idlwave-struct-tags ()
7229 "Return a list of all tags in the structure defined at point.
7230 Point is expected just before the opening `{' of the struct definition."
7231 (save-excursion
7232 (let* ((borders (idlwave-struct-borders))
7233 (beg (car borders))
7234 (end (cdr borders))
7235 tags)
7236 (goto-char beg)
7237 (save-restriction
7238 (narrow-to-region beg end)
7239 (while (re-search-forward idlwave-struct-tag-regexp end t)
7240 ;; Check if we are still on the top level of the structure.
7241 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7242 (= (point) beg))
7243 (push (match-string-no-properties 5) tags))
7244 (goto-char (match-end 0))))
7245 (nreverse tags))))
7247 (defun idlwave-find-struct-tag (tag)
7248 "Find a given TAG in the structure defined at point."
7249 (let* ((borders (idlwave-struct-borders))
7250 (end (cdr borders))
7251 (case-fold-search t))
7253 end t)))
7255 (defun idlwave-struct-inherits ()
7256 "Return a list of all `inherits' names in the struct at point.
7257 Point is expected just before the opening `{' of the struct definition."
7258 (save-excursion
7259 (let* ((borders (idlwave-struct-borders))
7260 (beg (car borders))
7261 (end (cdr borders))
7262 (case-fold-search t)
7263 names)
7264 (goto-char beg)
7265 (save-restriction
7266 (narrow-to-region beg end)
7267 (while (re-search-forward
7268 (concat "[{,]" ;leading comma/brace
7269 idlwave-struct-skip ; 4 groups
7270 "inherits" ; The INHERITS tag
7271 idlwave-struct-skip ; 4 more
7273 end t)
7274 ;; Check if we are still on the top level of the structure.
7275 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7276 (= (point) beg))
7277 (push (match-string-no-properties 9) names))
7278 (goto-char (match-end 0))))
7279 (nreverse names))))
7281 (defun idlwave-in-structure ()
7282 "Return t if point is inside an IDL structure definition."
7283 (let ((beg (point)))
7284 (save-excursion
7285 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
7286 (if (idlwave-find-structure-definition nil nil 'back)
7287 (let ((borders (idlwave-struct-borders)))
7288 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
7289 (and (> beg (car borders)) (< beg (cdr borders))))))))))
7291 (defun idlwave-struct-borders ()
7292 "Return the borders of the {...} after point as a cons cell."
7293 (let (beg)
7294 (save-excursion
7295 (skip-chars-forward "^{")
7296 (setq beg (point))
7297 (condition-case nil (forward-list 1)
7298 (error (goto-char beg)))
7299 (cons beg (point)))))
7301 (defun idlwave-find-structure-definition (&optional var name bound)
7302 "Search forward for a structure definition.
7303 If VAR is non-nil, search for a structure assigned to variable VAR.
7304 If NAME is non-nil, search for a named structure NAME, if a string,
7305 or a generic named structure otherwise. If BOUND is an integer, limit
7306 the search. If BOUND is the symbol `all', we search first back and
7307 then forward through the entire file. If BOUND is the symbol `back'
7308 we search only backward."
7310 (case-fold-search t)
7311 (lim (if (integerp bound) bound nil))
7312 (re (concat
7313 (if var
7317 (if name
7318 (if (stringp name)
7320 ;; Just a generic name
7322 ""))))
7323 (if (or (and (or (eq bound 'all) (eq bound 'back))
7324 (re-search-backward re nil t))
7325 (and (not (eq bound 'back)) (re-search-forward re lim t)))
7326 (progn
7327 (goto-char (match-beginning 3))
7328 (match-string-no-properties 5)))))
7330 (defvar idlwave-class-info nil)
7331 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
7333 (add-hook 'idlwave-update-rinfo-hook
7334 (lambda () (setq idlwave-class-reset t)))
7335 (add-hook 'idlwave-after-load-rinfo-hook
7336 (lambda () (setq idlwave-class-info nil)))
7338 (defun idlwave-class-info (class)
7339 (let (list entry)
7340 (if idlwave-class-info
7341 (if idlwave-class-reset
7342 (setq
7343 idlwave-class-reset nil
7344 idlwave-class-info ; Remove any visited in a buffer
7345 (delq nil (mapcar
7346 (lambda (x)
7347 (let ((filebuf
7348 (idlwave-class-file-or-buffer
7349 (or (cdr (assq 'found-in x)) (car x)))))
7350 (if (cdr filebuf)
7351 nil
7352 x)))
7353 idlwave-class-info))))
7354 ;; Info is nil, put in the system stuff to start.
7355 (setq idlwave-class-info idlwave-system-class-info)
7356 (setq list idlwave-class-info)
7357 (while (setq entry (pop list))
7358 (idlwave-sintern-class-info entry)))
7359 (setq class (idlwave-sintern-class class))
7360 (or (assq class idlwave-class-info)
7361 (progn (idlwave-scan-class-info class)
7362 (assq class idlwave-class-info)))))
7364 (defun idlwave-sintern-class-info (entry)
7365 "Sintern the class names in a class-info entry."
7366 (let ((inherits (assq 'inherits entry)))
7367 (setcar entry (idlwave-sintern-class (car entry) 'set))
7368 (if inherits
7369 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
7370 (cdr inherits))))))
7372 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
7373 "Find class structure definition(s).
7374 If ALL-HOOK is set, find all named structure definitions in a given
7375 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
7376 set, look for the name__define pro, and inside of it, for the ALT-CLASS
7377 class/struct definition."
7378 (let ((case-fold-search t) end-lim name)
7379 (when (re-search-forward
7381 (if all-hook
7382 (progn
7383 ;; For everything there
7384 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
7385 (while (setq name
7386 (idlwave-find-structure-definition nil t end-lim))
7387 (funcall all-hook name)))
7388 (idlwave-find-structure-definition nil (or alt-class class))))))
7391 (defun idlwave-class-file-or-buffer (class)
7392 "Find buffer visiting CLASS definition."
7393 (let* ((pro (concat (downcase class) "__define"))
7394 (file (idlwave-routine-source-file
7395 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
7396 (idlwave-routines))))))
7397 (cons file (if file (idlwave-get-buffer-visiting file)))))
7400 (defun idlwave-scan-class-info (class)
7401 "Scan all class and named structure info in the class__define pro."
7402 (let* ((idlwave-auto-routine-info-updates nil)
7403 (filebuf (idlwave-class-file-or-buffer class))
7404 (file (car filebuf))
7405 (buf (cdr filebuf))
7406 (class (idlwave-sintern-class class)))
7407 (if (or
7408 (not file)
7409 (and ;; neither a regular file nor a visited buffer
7410 (not buf)
7411 (not (file-regular-p file))))
7412 nil ; Cannot find the file/buffer to get any info
7413 (save-excursion
7414 (if buf (set-buffer buf)
7415 ;; Read the file in temporarily
7416 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
7417 (erase-buffer)
7418 (unless (derived-mode-p 'idlwave-mode)
7419 (idlwave-mode))
7420 (insert-file-contents file))
7421 (save-excursion
7422 (goto-char 1)
7423 (idlwave-find-class-definition class
7424 ;; Scan all of the structures found there
7425 (lambda (name)
7426 (let* ((this-class (idlwave-sintern-class name))
7427 (entry
7428 (list this-class
7429 (cons 'tags (idlwave-struct-tags))
7430 (cons 'inherits (idlwave-struct-inherits)))))
7431 (if (not (eq this-class class))
7432 (setq entry (nconc entry (list (cons 'found-in class)))))
7433 (idlwave-sintern-class-info entry)
7434 (push entry idlwave-class-info)))))))))
7436 (defun idlwave-class-found-in (class)
7437 "Return the FOUND-IN property of the CLASS."
7438 (cdr (assq 'found-in (idlwave-class-info class))))
7439 (defun idlwave-class-tags (class)
7440 "Return the native tags in CLASS."
7441 (cdr (assq 'tags (idlwave-class-info class))))
7442 (defun idlwave-class-inherits (class)
7443 "Return the direct superclasses of CLASS."
7444 (cdr (assq 'inherits (idlwave-class-info class))))
7447 (defun idlwave-all-class-tags (class)
7448 "Return a list of native and inherited tags in CLASS."
7449 (condition-case err
7450 (apply 'append (mapcar 'idlwave-class-tags
7451 (cons class (idlwave-all-class-inherits class))))
7452 (error
7453 (idlwave-class-tag-reset)
7454 (error "%s" (error-message-string err)))))
7457 (defun idlwave-all-class-inherits (class)
7458 "Return a list of all superclasses of CLASS (recursively expanded).
7459 The list is cached in `idlwave-class-info' for faster access."
7460 (cond
7461 ((not idlwave-support-inheritance) nil)
7462 ((eq class nil) nil)
7463 ((eq class t) nil)
7464 (t
7465 (let ((info (idlwave-class-info class))
7466 entry)
7467 (if (setq entry (assq 'all-inherits info))
7468 (cdr entry)
7469 ;; Save the depth of inheritance scan to check for circular references
7470 (let ((inherits (mapcar (lambda (x) (cons x 0))
7471 (idlwave-class-inherits class)))
7472 rtn all-inherits cl)
7473 (while inherits
7474 (setq cl (pop inherits)
7475 rtn (cons (car cl) rtn)
7476 inherits (append (mapcar (lambda (x)
7477 (cons x (1+ (cdr cl))))
7478 (idlwave-class-inherits (car cl)))
7479 inherits))
7480 (if (> (cdr cl) 999)
7481 (error
7482 "Class scan: inheritance depth exceeded. Circular inheritance?")
7483 ))
7484 (setq all-inherits (nreverse rtn))
7485 (nconc info (list (cons 'all-inherits all-inherits)))
7486 all-inherits))))))
7488 (defun idlwave-entry-keywords (entry &optional record-link)
7489 "Return the flat entry keywords alist from routine-info entry.
7490 If RECORD-LINK is non-nil, the keyword text is copied and a text
7491 property indicating the link is added."
7492 (let (kwds)
7493 (mapc
7494 (lambda (key-list)
7495 (let ((file (car key-list)))
7496 (mapcar (lambda (key-cons)
7497 (let ((key (car key-cons))
7498 (link (cdr key-cons)))
7499 (when (and record-link file)
7500 (setq key (copy-sequence key))
7501 (put-text-property
7502 0 (length key)
7503 'link
7504 (concat
7505 file
7506 (if link
7507 (concat idlwave-html-link-sep
7508 (number-to-string link))))
7509 key))
7510 (push (list key) kwds)))
7511 (cdr key-list))))
7512 (nthcdr 5 entry))
7513 (nreverse kwds)))
7515 (defun idlwave-entry-find-keyword (entry keyword)
7516 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set."
7517 (catch 'exit
7518 (mapc
7519 (lambda (key-list)
7520 (let ((file (car key-list))
7521 (kwd (assoc keyword (cdr key-list))))
7522 (when kwd
7523 (setq kwd (cons (car kwd)
7524 (if (and file (cdr kwd))
7525 (concat file
7526 idlwave-html-link-sep
7527 (number-to-string (cdr kwd)))
7528 (cdr kwd))))
7529 (throw 'exit kwd))))
7530 (nthcdr 5 entry))))
7532 ;;==========================================================================
7533 ;;
7534 ;; Completing class structure tags. This is a completion plugin.
7535 ;; The necessary taglist is constructed dynamically
7537 (defvar idlwave-current-tags-class nil)
7538 (defvar idlwave-current-class-tags nil)
7539 (defvar idlwave-current-native-class-tags nil)
7540 (defvar idlwave-sint-class-tags nil)
7541 (declare-function idlwave-sintern-class-tag "idlwave" t t)
7542 (idlwave-new-sintern-type 'class-tag)
7543 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7544 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7546 (defun idlwave-complete-class-structure-tag ()
7547 "Complete a structure tag on a `self' argument in an object method."
7548 (interactive)
7549 (let ((pos (point))
7550 (case-fold-search t))
7551 (if (save-excursion
7552 ;; Check if the context is right
7553 (skip-chars-backward "a-zA-Z0-9._$")
7554 (and (< (point) (- pos 4))
7556 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7557 (super-classes (idlwave-all-class-inherits class-selector)))
7558 ;; Check if we are in a class routine
7559 (unless class-selector
7560 (error "Not in a method procedure or function"))
7561 ;; Check if we need to update the "current" class
7562 (if (not (equal class-selector idlwave-current-tags-class))
7563 (idlwave-prepare-class-tag-completion class-selector))
7564 (setq idlwave-completion-help-info
7565 (list 'idlwave-complete-class-structure-tag-help
7566 (idlwave-sintern-routine
7567 (concat class-selector "__define"))
7568 nil))
7569 ;; FIXME: idlwave-cpl-bold doesn't seem used anywhere.
7570 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7571 (idlwave-complete-in-buffer
7572 'class-tag 'class-tag
7573 idlwave-current-class-tags nil
7574 (format "Select a tag of class %s" class-selector)
7575 "class tag"
7576 'idlwave-attach-class-tag-classes))
7577 t) ; return t to skip other completions
7578 nil)))
7580 (defun idlwave-class-tag-reset ()
7581 (setq idlwave-current-tags-class nil))
7583 (defun idlwave-prepare-class-tag-completion (class)
7584 "Find and parse the necessary class definitions for class structure tags."
7585 (setq idlwave-sint-class-tags nil)
7586 (setq idlwave-current-tags-class class)
7587 (setq idlwave-current-class-tags
7588 (mapcar (lambda (x)
7589 (list (idlwave-sintern-class-tag x 'set)))
7590 (idlwave-all-class-tags class)))
7591 (setq idlwave-current-native-class-tags
7592 (mapcar 'downcase (idlwave-class-tags class))))
7594 ;===========================================================================
7595 ;;
7596 ;; Completing system variables and their structure fields
7597 ;; This is also a plugin.
7599 (defvar idlwave-sint-sysvars nil)
7600 (defvar idlwave-sint-sysvartags nil)
7601 (declare-function idlwave-sintern-sysvar "idlwave" t t)
7602 (declare-function idlwave-sintern-sysvartag "idlwave" t t)
7603 (idlwave-new-sintern-type 'sysvar)
7604 (idlwave-new-sintern-type 'sysvartag)
7605 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7606 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7607 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7610 (defun idlwave-complete-sysvar-or-tag ()
7611 "Complete a system variable."
7612 (interactive)
7613 (let ((pos (point))
7614 (case-fold-search t))
7615 (cond ((save-excursion
7616 ;; Check if the context is right for system variable
7617 (skip-chars-backward "[a-zA-Z0-9_$]")
7618 (equal (char-before) ?!))
7619 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7620 (idlwave-complete-in-buffer 'sysvar 'sysvar
7621 idlwave-system-variables-alist nil
7622 "Select a system variable"
7623 "system variable")
7624 t) ; return t to skip other completions
7625 ((save-excursion
7626 ;; Check if the context is right for sysvar tag
7627 (skip-chars-backward "a-zA-Z0-9_$.")
7628 (and (equal (char-before) ?!)
7630 (<= (match-end 0) pos)))
7631 ;; Complete a system variable tag
7632 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7633 (entry (assq var idlwave-system-variables-alist))
7634 (tags (cdr (assq 'tags entry))))
7635 (or entry (error "!%s is not a known system variable" var))
7636 (or tags (error "System variable !%s is not a structure" var))
7637 (setq idlwave-completion-help-info
7638 (list 'idlwave-complete-sysvar-tag-help var))
7639 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7640 tags nil
7641 "Select a system variable tag"
7642 "system variable tag")
7643 t)) ; return t to skip other completions
7644 (t nil))))
7646 (defvar idlw-help-link) ;dynamic variables set by help callback
7647 (defun idlwave-complete-sysvar-help (mode word)
7648 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7649 (entry (assoc word idlwave-system-variables-alist)))
7650 (cond
7651 ((eq mode 'test)
7652 (and (stringp word) entry (nth 1 (assq 'link entry))))
7653 ((eq mode 'set)
7654 ;; Setting dynamic!!!
7655 (if entry (setq idlw-help-link (nth 1 (assq 'link entry)))))
7656 (t (error "This should not happen")))))
7658 (defun idlwave-complete-sysvar-tag-help (mode word)
7659 (let* ((var (nth 1 idlwave-completion-help-info))
7660 (entry (assoc var idlwave-system-variables-alist))
7661 (tags (cdr (assq 'tags entry)))
7662 (main (nth 1 (assq 'link entry)))
7663 target)
7664 (cond
7665 ((eq mode 'test) ; we can at least link the main
7666 (and (stringp word) entry main))
7667 ((eq mode 'set)
7668 (if entry
7669 (setq idlw-help-link
7670 (if (setq target (cdr (assoc-string word tags t)))
7671 (idlwave-substitute-link-target main target)
7672 main)))) ;; setting dynamic!!!
7673 (t (error "This should not happen")))))
7675 (defun idlwave-split-link-target (link)
7676 "Split a given LINK into link file and anchor."
7677 (if (string-match idlwave-html-link-sep link)
7678 (cons (substring link 0 (match-beginning 0))
7679 (string-to-number (substring link (match-end 0))))))
7681 (defun idlwave-substitute-link-target (link target)
7682 "Substitute the TARGET anchor for the given LINK."
7683 (let (main-base)
7684 (setq main-base (if (string-match "#" link)
7685 (substring link 0 (match-beginning 0))
7686 link))
7687 (if target
7688 (concat main-base idlwave-html-link-sep (number-to-string target))
7689 link)))
7691 ;; Fake help in the source buffer for class structure tags.
7692 ;; IDLW-HELP-LINK AND IDLW-HELP-NAME ARE GLOBAL-VARIABLES HERE.
7693 ;; (from idlwave-do-mouse-completion-help)
7694 (defvar idlw-help-name)
7695 (defvar idlw-help-link)
7696 (defvar idlwave-help-do-class-struct-tag nil)
7697 (defun idlwave-complete-class-structure-tag-help (mode word)
7698 (cond
7699 ((eq mode 'test) ; nothing gets fontified for class tags
7700 nil)
7701 ((eq mode 'set)
7702 (let (class-with found-in)
7703 (when (setq class-with
7704 (idlwave-class-or-superclass-with-tag
7705 idlwave-current-tags-class
7706 word))
7707 (if (assq (idlwave-sintern-class class-with)
7708 idlwave-system-class-info)
7709 (error "No help available for system class tags"))
7710 (if (setq found-in (idlwave-class-found-in class-with))
7711 (setq idlw-help-name (cons (concat found-in "__define") class-with))
7712 (setq idlw-help-name (concat class-with "__define")))))
7713 (setq idlw-help-link word
7714 idlwave-help-do-class-struct-tag t))
7715 (t (error "This should not happen"))))
7717 (defun idlwave-class-or-superclass-with-tag (class tag)
7718 "Find and return the CLASS or one of its superclass with the
7719 associated TAG, if any."
7720 (let ((sclasses (cons class (idlwave-all-class-inherits class)))
7721 cl)
7722 (catch 'exit
7723 (while sclasses
7724 (setq cl (pop sclasses))
7725 (let ((tags (idlwave-class-tags cl)))
7726 (while tags
7727 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7728 (throw 'exit cl))
7729 (setq tags (cdr tags))))))))
7732 (defun idlwave-sysvars-reset ()
7733 (if (and (fboundp 'idlwave-shell-is-running)
7734 (idlwave-shell-is-running)
7735 idlwave-idlwave_routine_info-compiled)
7736 (idlwave-shell-send-command "idlwave_get_sysvars"
7737 'idlwave-process-sysvars 'hide)))
7739 (defun idlwave-process-sysvars ()
7740 (idlwave-shell-filter-sysvars)
7741 (setq idlwave-sint-sysvars nil
7742 idlwave-sint-sysvartags nil)
7743 (idlwave-sintern-sysvar-alist))
7745 (defun idlwave-sintern-sysvar-alist ()
7746 (let ((list idlwave-system-variables-alist) entry tags)
7747 (while (setq entry (pop list))
7748 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7749 (setq tags (assq 'tags entry))
7750 (if tags
7751 (setcdr tags
7752 (mapcar (lambda (x)
7753 (cons (idlwave-sintern-sysvartag (car x) 'set)
7754 (cdr x)))
7755 (cdr tags)))))))
7757 (defvar idlwave-shell-command-output)
7758 (defun idlwave-shell-filter-sysvars ()
7759 "Get any new system variables and tags."
7760 (let ((text idlwave-shell-command-output)
7761 (start 0)
7762 (old idlwave-system-variables-alist)
7763 var tags type name class link old-entry)
7764 (setq idlwave-system-variables-alist nil)
7766 text start)
7767 (setq start (match-end 0)
7768 var (match-string 1 text)
7769 tags (if (match-end 3)
7770 (idlwave-split-string (match-string 3 text))))
7771 ;; Maintain old links, if present
7772 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7773 (setq link (assq 'link old-entry))
7774 (setq idlwave-system-variables-alist
7775 (cons (list var
7776 (cons
7777 'tags
7778 (mapcar (lambda (x)
7779 (cons x
7780 (cdr (assq
7781 (idlwave-sintern-sysvartag x)
7782 (cdr (assq 'tags old-entry))))))
7783 tags)) link)
7784 idlwave-system-variables-alist)))
7785 ;; Keep the old value if query was not successful
7786 (setq idlwave-system-variables-alist
7787 (or idlwave-system-variables-alist old))))
7789 (defun idlwave-completion-fontify-classes ()
7790 "Goto the *Completions* buffer and fontify the class info."
7791 (when (featurep 'font-lock)
7792 (with-current-buffer "*Completions*"
7793 (save-excursion
7794 (goto-char (point-min))
7795 (let ((buffer-read-only nil))
7797 (put-text-property (match-beginning 0) (match-end 0)
7798 'face 'font-lock-string-face)))))))
7800 (defun idlwave-uniquify (list)
7801 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7802 (delq nil
7803 (mapcar (lambda (x)
7804 (unless (gethash x ht)
7805 (puthash x t ht)
7806 x))
7807 list))))
7809 (defun idlwave-after-successful-completion (type slash &optional verify)
7810 "Add `=' or `(' after successful completion of keyword and function.
7811 Restore the pre-completion window configuration if possible."
7812 (cond
7813 ((eq type 'procedure)
7814 nil)
7815 ((eq type 'function)
7816 (cond
7817 ((equal idlwave-function-completion-adds-paren nil) nil)
7818 ((or (equal idlwave-function-completion-adds-paren t)
7819 (equal idlwave-function-completion-adds-paren 1))
7820 (insert "("))
7821 ((equal idlwave-function-completion-adds-paren 2)
7822 (insert "()")
7823 (backward-char 1))
7824 (t nil)))
7825 ((eq type 'keyword)
7826 (if (and idlwave-keyword-completion-adds-equal
7827 (not slash))
7828 (progn (insert "=") t)
7829 nil)))
7831 ;; Restore the pre-completion window configuration if this is safe.
7833 (if (or (eq verify 'force) ; force
7834 (and
7835 (get-buffer-window "*Completions*") ; visible
7836 (idlwave-local-value 'idlwave-completion-p
7837 "*Completions*") ; cib-buffer
7838 (eq (marker-buffer idlwave-completion-mark)
7839 (current-buffer)) ; buffer OK
7840 (equal (marker-position idlwave-completion-mark)
7841 verify))) ; pos OK
7842 (idlwave-restore-wconf-after-completion))
7843 (move-marker idlwave-completion-mark nil)
7844 (setq idlwave-before-completion-wconf nil))
7846 (defun idlwave-mouse-context-help (ev &optional arg)
7847 "Call `idlwave-context-help' on the clicked location."
7848 (interactive "eP")
7849 (mouse-set-point ev)
7850 (idlwave-context-help arg))
7852 (defvar idlwave-last-context-help-pos nil)
7853 (defun idlwave-context-help (&optional arg)
7854 "Display IDL Online Help on context.
7855 If point is on a keyword, help for that keyword will be shown. If
7856 point is on a routine name or in the argument list of a routine, help
7857 for that routine will be displayed. Works for system routines and
7858 keywords, it pulls up text help. For other routies and keywords,
7859 visits the source file, finding help in the header (if
7860 `idlwave-help-source-try-header' is non-nil) or the routine definition
7861 itself."
7862 (interactive "P")
7863 (idlwave-do-context-help arg))
7865 (defun idlwave-mouse-completion-help (ev)
7866 "Display online help about the completion at point."
7867 (interactive "eP")
7868 ;; Restore last-command for next command, to make
7869 ;; scrolling/cancelling of completions work.
7870 (setq this-command last-command)
7871 (idlwave-do-mouse-completion-help ev))
7873 (defun idlwave-routine-info (&optional arg external)
7874 "Display a routines calling sequence and list of keywords.
7875 When point is on the name a function or procedure, or in the argument
7876 list of a function or procedure, this command displays a help buffer with
7877 the information. When called with prefix arg, enforce class query.
7879 When point is on an object operator `->', display the class stored in
7880 this arrow, if any (see `idlwave-store-inquired-class'). With a prefix
7881 arg, the class property is cleared out."
7883 (interactive "P")
7884 (idlwave-routines)
7885 (if (string-match "->" (buffer-substring
7886 (max (point-min) (1- (point)))
7887 (min (+ 2 (point)) (point-max))))
7888 ;; Cursor is on an arrow
7889 (if (get-text-property (point) 'idlwave-class)
7890 ;; arrow has class property
7891 (if arg
7892 ;; Remove property
7893 (save-excursion
7894 (backward-char 1)
7896 (remove-text-properties (match-beginning 1) (match-end 1)
7897 '(idlwave-class nil face nil))
7898 (message "Class property removed from arrow")))
7899 ;; Echo class property
7900 (message "Arrow has text property identifying object to be class %s"
7901 (get-text-property (point) 'idlwave-class)))
7902 ;; No property found
7903 (message "Arrow has no class text property"))
7905 ;; Not on an arrow...
7906 (let* ((idlwave-query-class nil)
7907 (idlwave-force-class-query (equal arg '(4)))
7908 (module (idlwave-what-module)))
7909 (if (car module)
7910 (apply 'idlwave-display-calling-sequence
7911 (idlwave-fix-module-if-obj_new module))
7912 (error "Don't know which calling sequence to show")))))
7914 (defun idlwave-resolve (&optional arg)
7915 "Call RESOLVE_ROUTINE on the module name at point.
7916 Like `idlwave-routine-info', this looks for a routine call at point.
7917 After confirmation in the minibuffer, it will use the shell to issue
7918 a RESOLVE call for this routine, to attempt to make it defined and its
7919 routine info available for IDLWAVE. If the routine is a method call,
7920 both `class__method' and `class__define' will be tried.
7921 With ARG, enforce query for the class of object methods."
7922 (interactive "P")
7923 (let* ((idlwave-query-class nil)
7924 (idlwave-force-class-query (equal arg '(4)))
7925 (module (idlwave-what-module))
7926 (name (idlwave-make-full-name (nth 2 module) (car module)))
7927 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7928 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7929 (kwd "")
7930 class)
7932 resolve)
7933 (setq type (match-string 1 resolve)
7934 class (if (match-beginning 2)
7935 (match-string 3 resolve)
7936 nil)
7937 name (match-string 4 resolve)))
7938 (if (string= (downcase type) "function")
7939 (setq kwd ",/is_function"))
7941 (cond
7942 ((null class)
7943 (idlwave-shell-send-command
7944 (format "resolve_routine,'%s'%s" (downcase name) kwd)
7945 'idlwave-update-routine-info
7946 nil t))
7947 (t
7948 (idlwave-shell-send-command
7949 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
7950 (list 'idlwave-shell-send-command
7951 (format "resolve_routine,'%s__%s'%s"
7952 (downcase class) (downcase name) kwd)
7953 '(idlwave-update-routine-info)
7954 nil t))))))
7956 (defun idlwave-find-module-this-file ()
7957 (interactive)
7958 (idlwave-find-module '(4)))
7960 (defun idlwave-find-module (&optional arg)
7961 "Find the source code of an IDL module.
7962 Works for modules for which IDLWAVE has routine info available.
7963 The function offers as default the module name `idlwave-routine-info'
7964 would use. With ARG limit to this buffer. With two prefix ARG's
7965 force class query for object methods."
7966 (interactive "P")
7967 (let* ((idlwave-query-class nil)
7968 (idlwave-force-class-query (equal arg '(16)))
7969 (this-buffer (equal arg '(4)))
7970 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
7971 (default (if module
7972 (concat (idlwave-make-full-name
7973 (nth 2 module) (car module))
7974 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
7975 "none"))
7976 (list
7977 (idlwave-uniquify
7978 (delq nil
7979 (mapcar (lambda (x)
7980 (if (eq 'system (car-safe (nth 3 x)))
7981 ;; Take out system routines with no source.
7982 nil
7983 (list
7984 (concat (idlwave-make-full-name
7985 (nth 2 x) (car x))
7986 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
7987 (if this-buffer
7988 (idlwave-save-buffer-update)
7989 (idlwave-routines))))))
7990 (name (idlwave-completing-read
7991 (if (or (not this-buffer)
7992 (assoc default list))
7993 (format "Module (Default %s): " default)
7994 (format "Module in this file: "))
7995 list))
7996 type class)
7998 ;; Nothing, use the default.
7999 (setq name default))
8000 (if (string-match "<[fp]>" name)
8001 (setq type (substring name -2 -1)
8002 name (substring name 0 -3)))
8004 (setq class (match-string 1 name)
8005 name (match-string 2 name)))
8006 (setq name (idlwave-sintern-routine-or-method name class)
8007 class (idlwave-sintern-class class)
8008 type (cond ((equal type "f") 'fun)
8009 ((equal type "p") 'pro)
8010 (t t)))
8011 (idlwave-do-find-module name type class nil this-buffer)))
8013 (defun idlwave-do-find-module (name type class
8014 &optional force-source this-buffer)
8015 (let ((name1 (idlwave-make-full-name class name))
8016 source buf1 entry
8017 (buf (current-buffer))
8018 (pos (point))
8019 file name2)
8020 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
8021 'WITH-FILE)
8022 source (or force-source (nth 3 entry))
8023 name2 (if (nth 2 entry)
8024 (idlwave-make-full-name (nth 2 entry) name)
8025 name1))
8026 (if source
8027 (setq file (idlwave-routine-source-file source)))
8028 (unless file ; Try to find it on the path.
8029 (setq file
8030 (idlwave-expand-lib-file-name
8031 (if class
8032 (format "%s__define.pro" (downcase class))
8033 (format "%s.pro" (downcase name))))))
8034 (cond
8035 ((or (null name) (equal name ""))
8036 (error "Abort"))
8037 ((eq (car source) 'system)
8038 (error "Source code for system routine %s is not available"
8039 name2))
8040 ((or (not file) (not (file-regular-p file)))
8041 (error "Source code for routine %s is not available"
8042 name2))
8043 (t
8044 (when (not this-buffer)
8045 (setq buf1
8046 (idlwave-find-file-noselect file 'find))
8047 (pop-to-buffer buf1 t))
8048 (goto-char (point-max))
8049 (let ((case-fold-search t))
8050 (if (re-search-backward
8052 (cond ((eq type 'fun) "function")
8053 ((eq type 'pro) "pro")
8056 (regexp-quote (downcase name2))
8057 "[^a-zA-Z0-9_$]")
8058 nil t)
8059 (goto-char (match-beginning 0))
8060 (pop-to-buffer buf)
8061 (goto-char pos)
8062 (error "Could not find routine %s" name2)))))))
8064 (defun idlwave-what-module ()
8065 "Return a default module for stuff near point.
8066 Used by `idlwave-routine-info' and `idlwave-find-module'."
8067 (idlwave-routines)
8068 (if (let ((case-fold-search t))
8069 (save-excursion
8070 (idlwave-beginning-of-statement)
8071 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
8072 ;; This is a function or procedure definition statement
8073 ;; We return the defined routine as module.
8074 (list
8075 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
8076 (match-string-no-properties 2))
8077 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
8078 (idlwave-sintern-class (match-string 3)))
8080 ;; Not a definition statement - analyze precise position.
8081 (let* ((where (idlwave-where))
8082 (cw (nth 2 where))
8083 (pro (car (nth 0 where)))
8084 (func (car (nth 1 where)))
8085 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
8086 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
8087 (following-char)))
8088 )
8089 (cond
8090 ((and (eq cw 'procedure)
8091 (not (equal this-word "")))
8092 (setq this-word (idlwave-sintern-routine-or-method
8093 this-word (nth 2 (nth 3 where))))
8094 (list this-word 'pro
8095 (idlwave-determine-class
8096 (cons this-word (cdr (nth 3 where)))
8097 'pro)))
8098 ((and (eq cw 'function)
8099 (not (equal this-word ""))
8100 (or (eq next-char ?\() ; exclude arrays, vars.
8102 (setq this-word (idlwave-sintern-routine-or-method
8103 this-word (nth 2 (nth 3 where))))
8104 (list this-word 'fun
8105 (idlwave-determine-class
8106 (cons this-word (cdr (nth 3 where)))
8107 'fun)))
8108 ((and (memq cw '(function-keyword procedure-keyword))
8109 (not (equal this-word ""))
8110 (eq next-char ?\()) ; A function!
8111 (setq this-word (idlwave-sintern-routine this-word))
8112 (list this-word 'fun nil))
8113 (func
8114 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
8115 (pro
8116 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
8117 (t nil)))))
8119 (defun idlwave-what-module-find-class ()
8120 "Call `idlwave-what-module' and find the inherited class if necessary."
8121 (let* ((module (idlwave-what-module))
8122 (class (nth 2 module)))
8123 (if (and (= (length module) 3)
8124 (stringp class))
8125 (list (car module)
8126 (nth 1 module)
8127 (apply 'idlwave-find-inherited-class module))
8128 module)))
8130 (defun idlwave-find-inherited-class (name type class)
8131 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
8132 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
8133 (if entry
8134 (nth 2 entry)
8135 class)))
8137 (defun idlwave-fix-module-if-obj_new (module)
8138 "Check if MODULE points to obj_new.
8139 If yes, and if the cursor is in the keyword region, change to the
8140 appropriate Init method."
8141 (let* ((name (car module))
8142 (pos (point))
8143 (case-fold-search t)
8144 string)
8145 (if (and (stringp name)
8146 (equal (downcase name) "obj_new")
8147 (save-excursion
8148 (idlwave-beginning-of-statement)
8149 (setq string (buffer-substring (point) pos))
8151 string)))
8152 (let ((name "Init")
8153 (class (match-string 1 string)))
8154 (setq module (list (idlwave-sintern-method "Init")
8155 'fun
8156 (idlwave-sintern-class class)))))
8157 module))
8159 (defun idlwave-fix-keywords (name type class keywords
8160 &optional super-classes system)
8161 "Update a list of keywords.
8162 Translate OBJ_NEW, adding all super-class keywords, or all keywords
8163 from all classes if CLASS equals t. If SYSTEM is non-nil, don't
8164 demand _EXTRA in the keyword list."
8165 (let ((case-fold-search t))
8167 ;; If this is the OBJ_NEW function, try to figure out the class and use
8168 ;; the keywords from the corresponding INIT method.
8169 (if (and (equal (upcase name) "OBJ_NEW")
8170 (derived-mode-p 'idlwave-mode 'idlwave-shell-mode))
8171 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
8172 (string (buffer-substring bos (point)))
8173 (case-fold-search t)
8174 class)
8176 string)
8177 (setq class (idlwave-sintern-class (match-string 1 string)))
8178 (setq idlwave-current-obj_new-class class)
8179 (setq keywords
8180 (append keywords
8181 (idlwave-entry-keywords
8182 (idlwave-rinfo-assq
8183 (idlwave-sintern-method "INIT")
8184 'fun
8185 class
8186 (idlwave-routines)) 'do-link))))))
8188 ;; If the class is `t', combine all keywords of all methods NAME
8189 (when (eq class t)
8190 (mapc (lambda (entry)
8191 (and
8192 (nth 2 entry) ; non-nil class
8193 (eq (nth 1 entry) type) ; correct type
8194 (setq keywords
8195 (append keywords
8196 (idlwave-entry-keywords entry 'do-link)))))
8197 (idlwave-all-assq name (idlwave-routines)))
8198 (setq keywords (idlwave-uniquify keywords)))
8200 ;; If we have inheritance, add all keywords from superclasses, if
8201 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
8202 (when (and
8203 super-classes
8204 idlwave-keyword-class-inheritance
8205 (stringp class)
8206 (or
8207 system
8208 (assq (idlwave-sintern-keyword "_extra") keywords)
8209 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
8210 ;; Check if one of the keyword-class regexps matches the name
8211 (let ((regexps idlwave-keyword-class-inheritance) re)
8212 (catch 'exit
8213 (while (setq re (pop regexps))
8214 (if (string-match re name) (throw 'exit t))))))
8216 (loop for entry in (idlwave-routines) do
8217 (and (nth 2 entry) ; non-nil class
8218 (memq (nth 2 entry) super-classes) ; an inherited class
8219 (eq (nth 1 entry) type) ; correct type
8220 (eq (car entry) name) ; correct name
8221 (mapc (lambda (k) (add-to-list 'keywords k))
8222 (idlwave-entry-keywords entry 'do-link))))
8223 (setq keywords (idlwave-uniquify keywords)))
8225 ;; Return the final list
8226 keywords))
8228 (defun idlwave-expand-keyword (keyword module)
8229 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
8230 KEYWORD may be an exact match or an abbreviation of a keyword.
8231 If the match is exact, KEYWORD itself is returned, even if there may be other
8232 keywords of which KEYWORD is an abbreviation. This is necessary because some
8233 system routines have keywords which are prefixes of other keywords.
8234 If KEYWORD is an abbreviation of several keywords, a list of all possible
8235 completions is returned.
8236 If the abbreviation was unique, the correct keyword is returned.
8237 If it cannot be a keyword, the function return nil.
8238 If we do not know about MODULE, just return KEYWORD literally."
8239 (let* ((name (car module))
8240 (type (nth 1 module))
8241 (class (nth 2 module))
8242 (kwd (idlwave-sintern-keyword keyword))
8243 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
8244 (kwd-alist (idlwave-entry-keywords entry))
8245 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
8246 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
8247 (completion-ignore-case t)
8248 candidates)
8249 (cond ((assq kwd kwd-alist)
8250 kwd)
8251 ((setq candidates (all-completions kwd kwd-alist))
8252 (if (= (length candidates) 1)
8253 (car candidates)
8254 candidates))
8255 ((and entry extra)
8256 ;; Inheritance may cause this keyword to be correct
8257 keyword)
8258 (entry
8259 ;; We do know the function, which does not have the keyword.
8260 nil)
8261 (t
8262 ;; We do not know the function, so this just might be a correct
8263 ;; keyword - return it as it is.
8264 keyword))))
8266 (defvar idlwave-rinfo-mouse-map
8267 (let ((map (make-sparse-keymap)))
8268 (define-key map
8269 (if (featurep 'xemacs) [button2] [mouse-2])
8270 'idlwave-mouse-active-rinfo)
8271 (define-key map
8272 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
8273 'idlwave-mouse-active-rinfo-shift)
8274 (define-key map
8275 (if (featurep 'xemacs) [button3] [mouse-3])
8276 'idlwave-mouse-active-rinfo-right)
8277 (define-key map " " 'idlwave-active-rinfo-space)
8278 (define-key map "q" 'idlwave-quit-help)
8279 map))
8281 (defvar idlwave-rinfo-map
8282 (let ((map (make-sparse-keymap)))
8283 (define-key map "q" 'idlwave-quit-help)
8284 map))
8286 (defvar idlwave-popup-source nil)
8287 (defvar idlwave-rinfo-marker (make-marker))
8289 (defun idlwave-quit-help ()
8290 (interactive)
8291 (let ((ri-window (get-buffer-window "*Help*"))
8292 (olh-window (get-buffer-window "*IDLWAVE Help*")))
8293 (when (and olh-window
8294 (fboundp 'idlwave-help-quit))
8295 (select-window olh-window)
8296 (idlwave-help-quit))
8297 (when (window-live-p ri-window)
8298 (delete-window ri-window))))
8300 (defun idlwave-display-calling-sequence (name type class
8301 &optional initial-class)
8302 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
8303 (let* ((initial-class (or initial-class class))
8304 (entry (or (idlwave-best-rinfo-assq name type class
8305 (idlwave-routines))
8306 (idlwave-rinfo-assq name type class
8307 idlwave-unresolved-routines)))
8308 (name (or (car entry) name))
8309 (class (or (nth 2 entry) class))
8310 (superclasses (idlwave-all-class-inherits initial-class))
8311 (twins (idlwave-routine-twins entry))
8312 (dtwins (idlwave-study-twins twins))
8313 (all dtwins)
8314 (system (eq (car (nth 3 entry)) 'system))
8315 (calling-seq (nth 4 entry))
8316 (keywords (idlwave-entry-keywords entry 'do-link))
8317 (html-file (car (nth 5 entry)))
8318 (help-echo-kwd
8319 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
8320 (help-echo-use
8321 "Button2/3: Online Help")
8322 (help-echo-src
8323 "Button2: Jump to source and back | Button3: Source in Help window.")
8324 (help-echo-class
8325 "Button2: Display info about same method in superclass")
8326 (col 0)
8327 (data (list name type class (current-buffer) nil initial-class))
8328 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8329 (face 'idlwave-help-link)
8330 beg props win cnt total)
8331 ;; Fix keywords, but don't add chained super-classes, since these
8332 ;; are shown separately for that super-class
8333 (setq keywords (idlwave-fix-keywords name type class keywords))
8334 (cond
8335 ((null entry)
8336 (error "No %s %s known %s" type name
8337 (if initial-class (concat "in class " initial-class) "")))
8338 ((or (null name) (equal name ""))
8339 (error "No function or procedure call at point"))
8340 ((null calling-seq)
8341 (error "Calling sequence of %s %s not available" type name))
8342 (t
8343 (move-marker idlwave-rinfo-marker (point))
8344 (with-current-buffer (get-buffer-create "*Help*")
8345 (use-local-map idlwave-rinfo-map)
8346 (setq buffer-read-only nil)
8347 (erase-buffer)
8348 (set (make-local-variable 'idlwave-popup-source) nil)
8349 (set (make-local-variable 'idlwave-current-obj_new-class)
8350 idlwave-current-obj_new-class)
8351 (when superclasses
8352 (setq props (list 'mouse-face 'highlight
8353 km-prop idlwave-rinfo-mouse-map
8354 'help-echo help-echo-class
8355 'data (cons 'class data)))
8356 (let ((classes (cons initial-class superclasses)) c)
8357 (insert "Classes: ")
8358 (while (setq c (pop classes))
8359 (insert " ")
8360 (setq beg (point))
8361 (insert c)
8362 (if (equal (downcase c) (downcase class))
8363 (add-text-properties beg (point) (list 'face 'bold))
8364 ;; If Method exists in a different class link it
8365 (if (idlwave-rinfo-assq name type c (idlwave-routines))
8366 (add-text-properties beg (point) props))))
8368 (setq props (list 'mouse-face 'highlight
8369 km-prop idlwave-rinfo-mouse-map
8370 'help-echo help-echo-use
8371 'data (cons 'usage data)))
8372 (if html-file (setq props (append (list 'face face 'link html-file)
8373 props)))
8374 (insert "Usage: ")
8375 (setq beg (point))
8376 (insert (if class
8377 (format calling-seq class name class name class name)
8378 (format calling-seq name name name name))
8380 (add-text-properties beg (point) props)
8382 (insert "Keywords:")
8383 (if (null keywords)
8384 (insert " No keywords accepted.")
8385 (setq col 9)
8386 (mapc
8387 (lambda (x)
8388 (if (>= (+ col 1 (length (car x)))
8389 (window-width))
8390 (progn
8392 (setq col 9)))
8393 (insert " ")
8394 (setq beg (point)
8395 ;; Relevant keywords already have link property attached
8396 props (list 'mouse-face 'highlight
8397 km-prop idlwave-rinfo-mouse-map
8398 'data (cons 'keyword data)
8399 'help-echo help-echo-kwd
8400 'keyword (car x)))
8401 (if system (setq props (append (list 'face face) props)))
8402 (insert (car x))
8403 (add-text-properties beg (point) props)
8404 (setq col (+ col 1 (length (car x)))))
8405 keywords))
8407 (setq cnt 1 total (length all))
8408 ;; Here entry is (key file (list of type-conses))
8409 (while (setq entry (pop all))
8410 (setq props (list 'mouse-face 'highlight
8411 km-prop idlwave-rinfo-mouse-map
8412 'help-echo help-echo-src
8413 'source (list (car (car (nth 2 entry))) ;type
8414 (nth 1 entry)
8415 nil
8416 (cdr (car (nth 2 entry))))
8417 'data (cons 'source data)))
8418 (idlwave-insert-source-location
8420 (if (equal cnt 1)
8421 (if (> total 1) "Sources:" "Source:")
8422 "")
8423 (if (> total 1) "- " ""))
8424 entry props)
8425 (incf cnt)
8426 (when (and all (> cnt idlwave-rinfo-max-source-lines))
8427 ;; No more source lines, please
8428 (insert (format
8430 idlwave-rinfo-max-source-lines))
8431 (setq all nil)))
8432 (goto-char (point-min))
8433 (setq buffer-read-only t))
8434 (display-buffer "*Help*")
8435 (if (and (setq win (get-buffer-window "*Help*"))
8436 idlwave-resize-routine-help-window)
8437 (progn
8438 (let ((ww (selected-window)))
8439 (unwind-protect
8440 (progn
8441 (select-window win)
8442 (enlarge-window (- (/ (frame-height) 2)
8443 (window-height)))
8444 (shrink-window-if-larger-than-buffer))
8445 (select-window ww)))))))))
8447 (defun idlwave-insert-source-location (prefix entry &optional file-props)
8448 "Insert a source location into the routine info buffer.
8449 Start line with PREFIX. If a file name is inserted, add FILE-PROPS
8450 to it."
8451 (let* ((key (car entry))
8452 (file (nth 1 entry))
8453 (types (nth 2 entry))
8454 (shell-flag (assq 'compiled types))
8455 (buffer-flag (assq 'buffer types))
8456 (user-flag (assq 'user types))
8457 (lib-flag (assq 'lib types))
8458 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
8459 (and user-flag (idlwave-count-memq 'user types))
8460 (and lib-flag (idlwave-count-memq 'lib types))
8461 1))
8462 (doflags t)
8463 beg special)
8465 (insert prefix)
8467 (cond
8468 ((eq key 'system)
8469 (setq doflags nil)
8470 (insert "System "))
8472 ((eq key 'builtin)
8473 (setq doflags nil)
8474 (insert "Builtin "))
8476 ((and (not file) shell-flag)
8477 (insert "Unresolved"))
8479 ((null file)
8480 (insert "ERROR"))
8482 ((idlwave-syslib-p file)
8483 (if (string-match "obsolete" (file-name-directory file))
8484 (insert "Obsolete ")
8485 (insert "SystemLib ")))
8487 ;; New special syntax: taken directly from routine-info for
8488 ;; library catalog routines
8489 ((setq special (or (cdr lib-flag) (cdr user-flag)))
8490 (insert (format "%-10s" special)))
8492 ;; Old special syntax: a matching regexp
8493 ((setq special (idlwave-special-lib-test file))
8494 (insert (format "%-10s" special)))
8496 ;; Catch-all with file
8497 ((idlwave-lib-p file) (insert "Library "))
8499 ;; Sanity catch all
8500 (t (insert "Other ")))
8502 (when doflags
8503 (insert (concat
8504 " ["
8505 (if lib-flag "L" "-")
8506 (if user-flag "C" "-")
8507 (if shell-flag "S" "-")
8508 (if buffer-flag "B" "-")
8509 "] ")))
8510 (when (> ndupl 1)
8511 (setq beg (point))
8512 (insert (format "(%dx) " ndupl))
8513 (add-text-properties beg (point) (list 'face 'bold)))
8514 (when (and file (not (equal file "")))
8515 (setq beg (point))
8516 (insert (apply 'abbreviate-file-name
8517 (if (featurep 'xemacs) (list file t) (list file))))
8518 (if file-props
8519 (add-text-properties beg (point) file-props)))))
8521 (defun idlwave-special-lib-test (file)
8522 "Check the path of FILE against the regexps which define special libs.
8523 Return the name of the special lib if there is a match."
8524 (let ((alist idlwave-special-lib-alist)
8525 entry rtn)
8526 (cond
8527 ((stringp file)
8528 (while (setq entry (pop alist))
8529 (if (string-match (car entry) file)
8530 (setq rtn (cdr entry)
8531 alist nil)))
8532 rtn)
8533 (t nil))))
8535 (defun idlwave-mouse-active-rinfo-right (ev)
8536 (interactive "e")
8537 (idlwave-mouse-active-rinfo ev 'right))
8539 (defun idlwave-mouse-active-rinfo-shift (ev)
8540 (interactive "e")
8541 (idlwave-mouse-active-rinfo ev nil 'shift))
8543 (defun idlwave-active-rinfo-space ()
8544 (interactive)
8545 (idlwave-mouse-active-rinfo nil 'right))
8547 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8548 "Do the mouse actions in the routine info buffer.
8549 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8550 was pressed."
8551 (interactive "e")
8552 (if ev (mouse-set-point ev))
8553 (let (data id name type class buf bufwin source link keyword
8554 word initial-class)
8555 (setq data (get-text-property (point) 'data)
8556 source (get-text-property (point) 'source)
8557 keyword (get-text-property (point) 'keyword)
8558 link (get-text-property (point) 'link)
8559 id (car data)
8560 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8561 buf (nth 4 data)
8562 initial-class (nth 6 data)
8563 word (idlwave-this-word)
8564 bufwin (get-buffer-window buf t))
8566 (cond ((eq id 'class) ; Switch class being displayed
8567 (if (window-live-p bufwin) (select-window bufwin))
8568 (idlwave-display-calling-sequence
8569 (idlwave-sintern-method name)
8570 type (idlwave-sintern-class word)
8571 initial-class))
8572 ((eq id 'usage) ; Online help on this routine
8573 (idlwave-online-help link name type class))
8574 ((eq id 'source) ; Source in help or buffer
8575 (if right ; In help
8576 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8577 (idlwave-help-source-try-header nil)
8578 ;; Fake idlwave-routines so help will find the right entry
8579 (idlwave-routines
8580 (list (list name type class source ""))))
8581 (idlwave-help-get-special-help name type class nil))
8582 ;; Otherwise just pop to the source
8583 (setq idlwave-popup-source (not idlwave-popup-source))
8584 (if idlwave-popup-source
8585 (condition-case err
8586 (idlwave-do-find-module name type class source)
8587 (error
8588 (setq idlwave-popup-source nil)
8589 (if (window-live-p bufwin) (select-window bufwin))
8590 (error (nth 1 err))))
8591 (if bufwin
8592 (select-window bufwin)
8593 (pop-to-buffer buf))
8594 (goto-char (marker-position idlwave-rinfo-marker)))))
8595 ((eq id 'keyword)
8596 (if right
8597 (idlwave-online-help link name type class keyword)
8598 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8600 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8601 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8602 (let ((bwin (get-buffer-window buffer)))
8603 (if idlwave-complete-empty-string-as-lower-case
8604 (setq keyword (downcase keyword)))
8605 (if bwin
8606 (select-window bwin)
8607 (pop-to-buffer buffer)
8608 (setq bwin (get-buffer-window buffer)))
8609 (if (eq (preceding-char) ?/)
8610 (insert keyword)
8611 (unless (save-excursion
8612 (re-search-backward
8614 (min (- (point) 100) (point-min)) t))
8615 (insert ", "))
8616 (if shift (insert "/"))
8617 (insert keyword)
8618 (if (and (not shift)
8619 idlwave-keyword-completion-adds-equal)
8620 (insert "=")))))
8622 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8623 "List the load path shadows of all routines defined in current buffer."
8624 (interactive "P")
8625 (idlwave-routines)
8626 (if (derived-mode-p 'idlwave-mode)
8627 (idlwave-list-load-path-shadows
8628 nil (idlwave-update-current-buffer-info 'save-buffer)
8629 "in current buffer")
8630 (error "Current buffer is not in idlwave-mode")))
8632 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8633 "List the load path shadows of all routines compiled under the shell.
8634 This is very useful for checking an IDL application. Just compile the
8635 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8636 routines and update IDLWAVE internal info. Then check for shadowing
8637 with this command."
8638 (interactive "P")
8639 (cond
8640 ((or (not (fboundp 'idlwave-shell-is-running))
8641 (not (idlwave-shell-is-running)))
8642 (error "Shell is not running"))
8643 ((null idlwave-compiled-routines)
8644 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8645 (t
8646 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8647 "in the shell"))))
8649 (defun idlwave-list-all-load-path-shadows (&optional arg)
8650 "List the load path shadows of all routines known to IDLWAVE."
8651 (interactive "P")
8652 (idlwave-list-load-path-shadows nil nil "globally"))
8654 (defvar idlwave-sort-prefer-buffer-info t
8655 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8657 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8658 "List the routines which are defined multiple times.
8659 Search the information IDLWAVE has about IDL routines for multiple
8660 definitions.
8661 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8663 When IDL hits a routine call which is not defined, it will search on
8664 the load path in order to find a definition. The output of this command
8665 can be used to detect possible name clashes during this process."
8666 (idlwave-routines) ; Make sure everything is loaded.
8667 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8668 (or (y-or-n-p
8669 "You don't have any user or library catalogs. Continue anyway? ")
8670 (error "Abort")))
8671 (let* ((routines (append idlwave-system-routines
8672 idlwave-compiled-routines
8673 idlwave-library-catalog-routines
8674 idlwave-user-catalog-routines
8675 idlwave-buffer-routines
8676 nil))
8677 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8678 (keymap (make-sparse-keymap))
8679 (props (list 'mouse-face 'highlight
8680 km-prop keymap
8681 'help-echo "Mouse2: Find source"))
8682 (nroutines (length (or special-routines routines)))
8683 (step (/ nroutines 100))
8684 (n 0)
8685 (cnt 0)
8686 (idlwave-sort-prefer-buffer-info nil)
8687 routine twins dtwins twin done props1 lroutines)
8689 (if special-routines
8690 ;; Just looking for shadows of a few special routines
8691 (setq lroutines routines
8692 routines special-routines))
8694 (message "Sorting routines...")
8695 (setq routines (sort routines
8696 (lambda (a b)
8697 (string< (downcase (idlwave-make-full-name
8698 (nth 2 a) (car a)))
8699 (downcase (idlwave-make-full-name
8700 (nth 2 b) (car b)))))))
8701 (message "Sorting routines...done")
8703 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8704 (lambda (ev)
8705 (interactive "e")
8706 (mouse-set-point ev)
8707 (apply 'idlwave-do-find-module
8708 (get-text-property (point) 'find-args))))
8709 (define-key keymap [(return)]
8710 (lambda ()
8711 (interactive)
8712 (apply 'idlwave-do-find-module
8713 (get-text-property (point) 'find-args))))
8714 (message "Compiling list...( 0%%)")
8715 (with-current-buffer (get-buffer-create "*Shadows*")
8716 (setq buffer-read-only nil)
8717 (erase-buffer)
8718 (while (setq routine (pop routines))
8719 (if (= (mod (setq n (1+ n)) step) 0)
8720 (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines)))
8722 ;; Get a list of all twins
8723 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8724 (if (memq routine done)
8725 (setq dtwins nil)
8726 (setq dtwins (idlwave-study-twins twins)))
8727 ;; Mark all twins as dealt with
8728 (setq done (append twins done))
8729 (when (or (> (length dtwins) 1)
8730 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8731 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8732 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8733 (incf cnt)
8735 (idlwave-make-full-name (nth 2 routine)
8736 (car routine))
8737 (if (eq (nth 1 routine) 'fun) "()" "")))
8738 (while (setq twin (pop dtwins))
8739 (setq props1 (append (list 'find-args
8740 (list (nth 0 routine)
8741 (nth 1 routine)
8742 (nth 2 routine)))
8743 props))
8745 (goto-char (point-min))
8746 (setq buffer-read-only t))
8747 (setq loc (or loc ""))
8748 (if (> cnt 0)
8749 (progn
8750 (display-buffer (get-buffer "*Shadows*"))
8751 (message "%d case%s of shadowing found %s"
8752 cnt (if (= cnt 1) "" "s") loc))
8753 (message "No shadowing conflicts found %s" loc))))
8755 (defun idlwave-print-source (routine)
8756 (let* ((source (nth 3 routine))
8757 (stype (car source))
8758 (sfile (idlwave-routine-source-file source)))
8759 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8760 (if (and (eq stype 'compiled)
8761 (or (not (stringp sfile))
8763 (setq stype 'unresolved))
8765 stype
8766 (if sfile sfile "No source code available")))))
8768 (defun idlwave-routine-twins (entry &optional list)
8769 "Return all twin entries of ENTRY in LIST.
8770 LIST defaults to `idlwave-routines'.
8771 Twin entries are those which have the same name, type, and class.
8772 ENTRY will also be returned, as the first item of this list."
8773 (let* ((name (car entry))
8774 (type (nth 1 entry))
8775 (class (nth 2 entry))
8776 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8777 twins candidate)
8778 (while (setq candidate (pop candidates))
8779 (if (and (not (eq candidate entry))
8780 (eq type (nth 1 candidate))
8781 (eq class (nth 2 candidate)))
8782 (push candidate twins)))
8783 (if (setq candidate (idlwave-rinfo-assq name type class
8784 idlwave-unresolved-routines))
8785 (push candidate twins))
8786 (cons entry (nreverse twins))))
8788 (defun idlwave-study-twins (entries)
8789 "Return dangerous twins of first entry in ENTRIES.
8790 Dangerous twins are routines with same name, but in different files on
8791 the load path. If a file is in the system library and has an entry in
8792 the `idlwave-system-routines' list, we omit the latter as
8793 non-dangerous because many IDL routines are implemented as library
8794 routines, and may have been scanned."
8795 (let* ((entry (car entries))
8796 (idlwave-twin-name (car entry)) ;
8797 (type (nth 1 entry)) ; Must be bound for
8798 (idlwave-twin-class (nth 2 entry)) ; idlwave-routine-twin-compare
8799 (cnt 0)
8800 source type type-cons file alist syslibp key)
8801 (while (setq entry (pop entries))
8802 (incf cnt)
8803 (setq source (nth 3 entry)
8804 type (car source)
8805 type-cons (cons type (nth 3 source))
8806 file (idlwave-routine-source-file source))
8808 ;; Make KEY to index entry properly
8809 (setq key (cond ((eq type 'system) type)
8810 (file (file-truename file))
8811 (t 'unresolved)))
8813 ;; Check for an entry in the system library
8814 (if (and file
8815 (not syslibp)
8816 (idlwave-syslib-p file))
8817 (setq syslibp t))
8819 ;; If there's more than one matching entry for the same file, just
8820 ;; append the type-cons to the type list.
8821 (if (setq entry (assoc key alist))
8822 (push type-cons (nth 2 entry))
8823 (push (list key file (list type-cons)) alist)))
8825 (setq alist (nreverse alist))
8827 (when syslibp
8828 ;; File is in system *library* - remove any 'system entry
8829 (setq alist (delq (assq 'system alist) alist)))
8831 ;; If 'system remains and we've scanned the syslib, it's a builtin
8832 ;; (rather than a !DIR/lib/.pro file bundled as source).
8833 (when (and (idlwave-syslib-scanned-p)
8834 (setq entry (assoc 'system alist)))
8835 (setcar entry 'builtin))
8836 (sort alist 'idlwave-routine-twin-compare)))
8838 ;; FIXME: Dynamically scoped vars need to use the `idlwave-' prefix.
8839 ;; (defvar type)
8840 (defmacro idlwave-xor (a b)
8841 `(and (or ,a ,b)
8842 (not (and ,a ,b))))
8844 (defun idlwave-routine-entry-compare (a b)
8845 "Compare two routine info entries for sorting.
8846 This is the general case. It first compares class, names, and type.
8847 If it turns out that A and B are twins (same name, class, and type),
8848 calls another routine which compares twins on the basis of their file
8849 names and path locations."
8850 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8851 (cond
8852 ((not (equal (idlwave-downcase-safe class)
8853 (idlwave-downcase-safe (nth 2 b))))
8854 ;; Class decides
8855 (cond ((null (nth 2 b)) nil)
8856 ((null class) t)
8857 (t (string< (downcase class) (downcase (nth 2 b))))))
8858 ((not (equal (downcase name) (downcase (car b))))
8859 ;; Name decides
8860 (string< (downcase name) (downcase (car b))))
8861 ((not (eq type (nth 1 b)))
8862 ;; Type decides
8863 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8864 (t
8865 ;; A and B are twins - so the decision is more complicated.
8866 ;; Call twin-compare with the proper arguments.
8867 (idlwave-routine-entry-compare-twins a b)))))
8869 (defun idlwave-routine-entry-compare-twins (a b)
8870 "Compare two routine entries, under the assumption that they are twins.
8871 This basically calls `idlwave-routine-twin-compare' with the correct args."
8872 (let* ((idlwave-twin-name (car a))
8873 (type (nth 1 a))
8874 (idlwave-twin-class (nth 2 a)) ; used in idlwave-routine-twin-compare
8875 (asrc (nth 3 a))
8876 (atype (car asrc))
8877 (bsrc (nth 3 b))
8878 (btype (car bsrc))
8879 (afile (idlwave-routine-source-file asrc))
8880 (bfile (idlwave-routine-source-file bsrc)))
8881 (idlwave-routine-twin-compare
8882 (if (stringp afile)
8883 (list (file-truename afile) afile (list atype))
8884 (list atype afile (list atype)))
8885 (if (stringp bfile)
8886 (list (file-truename bfile) bfile (list btype))
8887 (list btype bfile (list btype))))))
8889 ;; Bound in idlwave-study-twins,idlwave-routine-entry-compare-twins.
8890 (defvar idlwave-twin-class)
8891 (defvar idlwave-twin-name)
8893 (defun idlwave-routine-twin-compare (a b)
8894 "Compare two routine twin entries for sorting.
8895 In here, A and B are not normal routine info entries, but special
8896 lists (KEY FILENAME (TYPES...)).
8897 This expects NAME TYPE IDLWAVE-TWIN-CLASS to be bound to the right values."
8898 (let* (;; Dis-assemble entries
8899 (akey (car a)) (bkey (car b))
8900 (afile (nth 1 a)) (bfile (nth 1 b))
8901 (atypes (nth 2 a)) (btypes (nth 2 b))
8902 ;; System routines?
8903 (asysp (memq akey '(builtin system)))
8904 (bsysp (memq bkey '(builtin system)))
8905 ;; Compiled routines?
8906 (acompp (memq 'compiled atypes))
8907 (bcompp (memq 'compiled btypes))
8908 ;; Unresolved?
8909 (aunresp (or (eq akey 'unresolved)
8910 (and acompp (not afile))))
8911 (bunresp (or (eq bkey 'unresolved)
8912 (and bcompp (not bfile))))
8913 ;; Buffer info available?
8914 (abufp (memq 'buffer atypes))
8915 (bbufp (memq 'buffer btypes))
8916 ;; On search path?
8917 (tpath-alist (idlwave-true-path-alist))
8918 (apathp (and (stringp akey)
8919 (assoc (file-name-directory akey) tpath-alist)))
8920 (bpathp (and (stringp bkey)
8921 (assoc (file-name-directory bkey) tpath-alist)))
8922 ;; How early on search path? High number means early since we
8923 ;; measure the tail of the path list
8924 (anpath (length (memq apathp tpath-alist)))
8925 (bnpath (length (memq bpathp tpath-alist)))
8926 ;; Look at file names
8927 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8928 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8929 (fname-re (if idlwave-twin-class
8931 (regexp-quote (downcase idlwave-twin-class))
8932 (regexp-quote (downcase idlwave-twin-name)))
8934 ;; Is file name derived from the routine name?
8935 ;; Method file or class definition file?
8936 (anamep (string-match fname-re aname))
8937 (adefp (and idlwave-twin-class anamep
8938 (string= "define" (match-string 1 aname))))
8939 (bnamep (string-match fname-re bname))
8940 (bdefp (and idlwave-twin-class bnamep
8941 (string= "define" (match-string 1 bname)))))
8943 ;; Now: follow JD's ideas about sorting. Looks really simple now,
8944 ;; doesn't it? The difficult stuff is hidden above...
8945 (cond
8946 ((idlwave-xor asysp bsysp) asysp) ; System entries first
8947 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
8948 ((and idlwave-sort-prefer-buffer-info
8949 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
8950 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
8951 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
8952 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
8953 ((and idlwave-twin-class anamep bnamep ; both file names match ->
8954 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
8955 ((> anpath bnpath) t) ; Who is first on path?
8956 (t nil)))) ; Default
8958 (defun idlwave-routine-source-file (source)
8959 (if (nth 2 source)
8960 (expand-file-name (nth 1 source) (nth 2 source))
8961 (nth 1 source)))
8963 (defun idlwave-downcase-safe (string)
8964 "Downcase if string, else return unchanged."
8965 (if (stringp string)
8966 (downcase string)
8967 string))
8969 (defun idlwave-count-eq (elt list)
8970 "How often is ELT in LIST?"
8971 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
8973 (defun idlwave-count-memq (elt alist)
8974 "How often is ELT a key in ALIST?"
8975 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
8977 (defun idlwave-syslib-p (file)
8978 "Non-nil if FILE is in the system library."
8979 (let* ((true-syslib (file-name-as-directory
8980 (file-truename
8981 (expand-file-name "lib" (idlwave-sys-dir)))))
8982 (true-file (file-truename file)))
8983 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
8985 (defun idlwave-lib-p (file)
8986 "Non-nil if FILE is in the library."
8987 (let ((true-dir (file-name-directory (file-truename file))))
8988 (assoc true-dir (idlwave-true-path-alist))))
8990 (defun idlwave-path-alist-add-flag (list-entry flag)
8991 "Add a flag to the path list entry, if not set."
8992 (let ((flags (cdr list-entry)))
8993 (add-to-list 'flags flag)
8994 (setcdr list-entry flags)))
8996 (defun idlwave-path-alist-remove-flag (list-entry flag)
8997 "Remove a flag to the path list entry, if set."
8998 (let ((flags (delq flag (cdr list-entry))))
8999 (setcdr list-entry flags)))
9001 (defun idlwave-true-path-alist ()
9002 "Return `idlwave-path-alist' alist with true-names.
9003 Info is cached, but relies on the functions setting `idlwave-path-alist'
9004 to reset the variable `idlwave-true-path-alist' to nil."
9005 (or idlwave-true-path-alist
9006 (setq idlwave-true-path-alist
9007 (mapcar (lambda(x) (cons
9008 (file-name-as-directory
9009 (file-truename
9010 (directory-file-name
9011 (car x))))
9012 (cdr x)))
9013 idlwave-path-alist))))
9015 (defun idlwave-syslib-scanned-p ()
9016 "Non-nil if the system lib file !DIR/lib has been scanned."
9017 (let* ((true-syslib (file-name-as-directory
9018 (file-truename
9019 (expand-file-name "lib" (idlwave-sys-dir))))))
9020 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
9022 ;; ----------------------------------------------------------------------------
9023 ;;
9024 ;; Online Help display
9027 ;; ----------------------------------------------------------------------------
9028 ;;
9029 ;; Additions for use with imenu.el and func-menu.el
9030 ;; (pop-up a list of IDL units in the current file).
9031 ;;
9033 (defun idlwave-prev-index-position ()
9034 "Search for the previous procedure or function.
9035 Return nil if not found. For use with imenu.el."
9036 (save-match-data
9037 (cond
9039 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
9040 (t nil))))
9042 (defun idlwave-unit-name ()
9043 "Return the unit name.
9044 Assumes that point is at the beginning of the unit as found by
9045 `idlwave-prev-index-position'."
9046 (forward-sexp 2)
9047 (forward-sexp -1)
9048 (let ((begin (point)))
9049 (re-search-forward
9051 (if (fboundp 'buffer-substring-no-properties)
9052 (buffer-substring-no-properties begin (point))
9053 (buffer-substring begin (point)))))
9055 (defalias 'idlwave-function-menu
9056 (condition-case nil
9057 (progn
9058 (require 'func-menu)
9059 'function-menu)
9060 (error (condition-case nil
9061 (progn
9062 (require 'imenu)
9063 'imenu)
9064 (error nil)))))
9066 ;; Here we hack func-menu.el in order to support this new mode.
9067 ;; The latest versions of func-menu.el already have this stuff in, so
9068 ;; we hack only if it is not already there.
9069 (when (fboundp 'eval-after-load)
9070 (eval-after-load "func-menu"
9071 '(progn
9072 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
9073 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
9074 (setq fume-function-name-regexp-alist
9075 (cons '(idlwave-mode . fume-function-name-regexp-idl)
9076 fume-function-name-regexp-alist)))
9077 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
9078 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
9079 (setq fume-find-function-name-method-alist
9080 (cons '(idlwave-mode . fume-find-next-idl-function-name)
9081 fume-find-function-name-method-alist))))))
9083 (defun idlwave-edit-in-idlde ()
9084 "Edit the current file in IDL Development environment."
9085 (interactive)
9086 (start-process "idldeclient" nil
9087 idlwave-shell-explicit-file-name "-c" "-e"
9088 (buffer-file-name)))
9090 (defvar idlwave-help-use-assistant)
9091 (defun idlwave-launch-idlhelp ()
9092 "Start the IDLhelp application."
9093 (interactive)
9094 (if idlwave-help-use-assistant
9095 (idlwave-help-assistant-raise)
9096 (start-process "idlhelp" nil idlwave-help-application)))
9098 ;; Menus - using easymenu.el
9099 (defvar idlwave-mode-menu-def
9100 `("IDLWAVE"
9101 ["PRO/FUNC menu" idlwave-function-menu t]
9102 ("Motion"
9103 ["Subprogram Start" idlwave-beginning-of-subprogram t]
9104 ["Subprogram End" idlwave-end-of-subprogram t]
9105 ["Block Start" idlwave-beginning-of-block t]
9106 ["Block End" idlwave-end-of-block t]
9107 ["Up Block" idlwave-backward-up-block t]
9108 ["Down Block" idlwave-down-block t]
9109 ["Skip Block Backward" idlwave-backward-block t]
9110 ["Skip Block Forward" idlwave-forward-block t])
9111 ("Mark"
9112 ["Subprogram" idlwave-mark-subprogram t]
9113 ["Block" idlwave-mark-block t]
9114 ["Header" idlwave-mark-doclib t])
9115 ("Format"
9116 ["Indent Entire Statement" idlwave-indent-statement
9118 ["Indent Subprogram" idlwave-indent-subprogram t]
9119 ["(Un)Comment Region" idlwave-toggle-comment-region t]
9120 ["Continue/Split line" idlwave-split-line t]
9121 "--"
9122 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
9123 :selected (symbol-value idlwave-fill-function)])
9124 ("Templates"
9125 ["Procedure" idlwave-procedure t]
9126 ["Function" idlwave-function t]
9127 ["Doc Header" idlwave-doc-header t]
9128 ["Log" idlwave-doc-modification t]
9129 "--"
9130 ["Case" idlwave-case t]
9131 ["For" idlwave-for t]
9132 ["Repeat" idlwave-repeat t]
9133 ["While" idlwave-while t]
9134 "--"
9135 ["Close Block" idlwave-close-block t])
9136 ("Completion"
9137 ["Complete" idlwave-complete t]
9138 ("Complete Specific"
9139 ["1 Procedure Name" (idlwave-complete 'procedure) t]
9140 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
9141 "--"
9142 ["3 Function Name" (idlwave-complete 'function) t]
9143 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
9144 "--"
9145 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
9146 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
9147 "--"
9148 ["7 Function Method Name" (idlwave-complete 'function-method) t]
9149 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
9150 "--"
9151 ["9 Class Name" idlwave-complete-class t]))
9152 ("Routine Info"
9153 ["Show Routine Info" idlwave-routine-info t]
9154 ["Online Context Help" idlwave-context-help t]
9155 "--"
9156 ["Find Routine Source" idlwave-find-module t]
9157 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
9158 "--"
9159 ["Update Routine Info" idlwave-update-routine-info t]
9160 ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t]
9161 "--"
9162 "IDL User Catalog"
9163 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
9164 ["Scan Directories" (idlwave-update-routine-info '(16))
9165 (and idlwave-path-alist (not idlwave-catalog-process))]
9166 ["Scan Directories &" (idlwave-update-routine-info '(64))
9167 (and idlwave-path-alist (not idlwave-catalog-process))]
9168 "--"
9169 "Routine Shadows"
9170 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
9171 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
9172 ["Check Everything" idlwave-list-all-load-path-shadows t])
9173 ("Misc"
9174 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
9175 "--"
9176 ["Insert TAB character" idlwave-hard-tab t])
9177 "--"
9178 ("External"
9179 ["Start IDL shell" idlwave-shell t]
9180 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
9181 ["Launch IDL Help" idlwave-launch-idlhelp t])
9182 "--"
9183 ("Customize"
9184 ["Browse IDLWAVE Group" idlwave-customize t]
9185 "--"
9186 ["Build Full Customize Menu" idlwave-create-customize-menu
9187 (fboundp 'customize-menu-create)])
9188 ("Documentation"
9189 ["Describe Mode" describe-mode t]
9190 ["Abbreviation List" idlwave-list-abbrevs t]
9191 "--"
9192 ["Commentary in idlwave.el" idlwave-show-commentary t]
9193 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
9194 "--"
9195 ["Info" idlwave-info t]
9196 "--"
9197 ["Help with Topic" idlwave-help-assistant-help-with-topic
9198 idlwave-help-use-assistant]
9199 ["Launch IDL Help" idlwave-launch-idlhelp t])))
9201 (defvar idlwave-mode-debug-menu-def
9202 '("Debug"
9203 ["Start IDL shell" idlwave-shell t]
9204 ["Save and .RUN buffer" idlwave-shell-save-and-run
9205 (and (boundp 'idlwave-shell-automatic-start)
9206 idlwave-shell-automatic-start)]))
9208 (if (or (featurep 'easymenu) (load "easymenu" t))
9209 (progn
9210 (easy-menu-define idlwave-mode-menu idlwave-mode-map
9211 "IDL and WAVE CL editing menu"
9212 idlwave-mode-menu-def)
9213 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
9214 "IDL and WAVE CL editing menu"
9215 idlwave-mode-debug-menu-def)))
9217 (defun idlwave-customize ()
9218 "Call the customize function with `idlwave' as argument."
9219 (interactive)
9220 ;; Try to load the code for the shell, so that we can customize it
9221 ;; as well.
9222 (or (featurep 'idlw-shell)
9223 (load "idlw-shell" t))
9224 (customize-browse 'idlwave))
9226 (defun idlwave-create-customize-menu ()
9227 "Create a full customization menu for IDLWAVE, insert it into the menu."
9228 (interactive)
9229 (if (fboundp 'customize-menu-create)
9230 (progn
9231 ;; Try to load the code for the shell, so that we can customize it
9232 ;; as well.
9233 (or (featurep 'idlw-shell)
9234 (load "idlw-shell" t))
9235 (easy-menu-change
9236 '("IDLWAVE") "Customize"
9237 `(["Browse IDLWAVE group" idlwave-customize t]
9238 "--"
9239 ,(customize-menu-create 'idlwave)
9240 ["Set" Custom-set t]
9241 ["Save" Custom-save t]
9242 ["Reset to Current" Custom-reset-current t]
9243 ["Reset to Saved" Custom-reset-saved t]
9244 ["Reset to Standard Settings" Custom-reset-standard t]))
9246 (error "Cannot expand menu (outdated version of cus-edit.el)")))
9248 (defun idlwave-show-commentary ()
9249 "Use the finder to view the file documentation from `idlwave.el'."
9250 (interactive)
9251 (finder-commentary "idlwave.el"))
9253 (defun idlwave-shell-show-commentary ()
9254 "Use the finder to view the file documentation from `idlw-shell.el'."
9255 (interactive)
9256 (finder-commentary "idlw-shell.el"))
9258 (defun idlwave-info ()
9259 "Read documentation for IDLWAVE in the info system."
9260 (interactive)
9261 (info "idlwave"))
9263 (defun idlwave-list-abbrevs (arg)
9264 "Show the code abbreviations define in IDLWAVE mode.
9265 This lists all abbrevs where the replacement text differs from the input text.
9266 These are the ones the users want to learn to speed up their writing.
9268 The function does *not* list abbrevs which replace a word with itself
9269 to call a hook. These hooks are used to change the case of words or
9270 to blink the matching `begin', and the user does not need to know them.
9272 With arg, list all abbrevs with the corresponding hook.
9274 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
9276 (interactive "P")
9277 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
9278 abbrevs
9279 str rpl func fmt (len-str 0) (len-rpl 0))
9280 (mapatoms
9281 (lambda (sym)
9282 (if (symbol-value sym)
9283 (progn
9284 (setq str (symbol-name sym)
9285 rpl (symbol-value sym)
9286 func (symbol-function sym))
9287 (if arg
9288 (setq func (prin1-to-string func))
9289 (if (and (listp func) (stringp (nth 2 func)))
9290 (setq rpl (concat "EVAL: " (nth 2 func))
9291 func "")
9292 (setq func "")))
9293 (if (or arg (not (string= rpl str)))
9294 (progn
9295 (setq len-str (max len-str (length str)))
9296 (setq len-rpl (max len-rpl (length rpl)))
9297 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
9298 table)
9299 ;; sort the list
9300 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
9301 ;; Make the format
9303 (with-output-to-temp-buffer "*Help*"
9304 (if arg
9305 (progn
9308 (princ (format fmt "KEY" "REPLACE" "HOOK"))
9309 (princ (format fmt "---" "-------" "----")))
9312 (princ (format fmt "KEY" "ACTION" ""))
9313 (princ (format fmt "---" "------" "")))
9314 (dolist (list abbrevs)
9315 (setq str (car list)
9316 rpl (nth 1 list)
9317 func (nth 2 list))
9318 (princ (format fmt str rpl func)))))
9319 ;; Make sure each abbreviation uses only one display line
9320 (with-current-buffer "*Help*"
9321 (setq truncate-lines t)))
9323 ;; Add .pro files to speedbar for support, if it's loaded
9324 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
9326 ;; Set an idle timer to load the routine info.
9327 ;; Will only work on systems which support this.
9328 (or idlwave-routines (idlwave-start-load-rinfo-timer))
9330 ;; Run the hook
9331 (run-hooks 'idlwave-load-hook)
9333 (provide 'idlwave)
9335 ;;; idlwave.el ends here