| blob | 3d8a5175d270b714bf0583fdfa7515631a4319a1 |
1 ;; idlwave.el --- IDL editing mode for GNU Emacs
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008
4 ;; Free Software Foundation, Inc.
6 ;; Authors: J.D. Smith <jdsmith@as.arizona.edu>
7 ;; Carsten Dominik <dominik@science.uva.nl>
8 ;; Chris Chase <chase@att.com>
9 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
10 ;; Version: 6.1_em22
11 ;; Keywords: languages
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 3, or (at your option)
18 ;; any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING. If not, write to the
27 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
28 ;; Boston, MA 02110-1301, USA.
30 ;;; Commentary:
32 ;; IDLWAVE enables feature-rich development and interaction with IDL,
33 ;; the Interactive Data Language. It provides a compelling,
34 ;; full-featured alternative to the IDLDE development environment
35 ;; bundled with IDL.
37 ;; In the remotely distant past, based on pascal.el, though bears
38 ;; little resemblance to it now.
39 ;;
40 ;; Incorporates many ideas, such as abbrevs, action routines, and
41 ;; continuation line indenting, from wave.el.
42 ;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder.
43 ;;
44 ;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode")
45 ;; for features, key bindings, and info.
46 ;; Also, Info format documentation is available with `M-x idlwave-info'
47 ;;
48 ;; New versions of IDLWAVE, documentation, and more information
49 ;; available from:
50 ;; http://idlwave.org
51 ;;
52 ;; INSTALLATION
53 ;; ============
54 ;;
55 ;; Follow the instructions in the INSTALL file of the distribution.
56 ;; In short, put this file on your load path and add the following
57 ;; lines to your .emacs file:
58 ;;
59 ;; (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
60 ;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
61 ;; (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
62 ;;
63 ;;
64 ;; SOURCE
65 ;; ======
66 ;;
67 ;; The newest version of this file is available from the maintainer's
68 ;; Webpage:
69 ;;
70 ;; http://idlwave.org
71 ;;
72 ;; DOCUMENTATION
73 ;; =============
74 ;;
75 ;; IDLWAVE is documented online in info format. A printable version
76 ;; of the documentation is available from the maintainers webpage (see
77 ;; SOURCE).
78 ;;
79 ;;
80 ;; ACKNOWLEDGMENTS
81 ;; ===============
82 ;;
83 ;; Thanks to the following people for their contributions and comments:
84 ;;
85 ;; Ulrik Dickow <dickow_at_nbi.dk>
86 ;; Eric E. Dors <edors_at_lanl.gov>
87 ;; Stein Vidar H. Haugan <s.v.h.haugan_at_astro.uio.no>
88 ;; David Huenemoerder <dph_at_space.mit.edu>
89 ;; Kevin Ivory <Kevin.Ivory_at_linmpi.mpg.de>
90 ;; Dick Jackson <dick_at_d-jackson.com>
91 ;; Xuyong Liu <liu_at_stsci.edu>
92 ;; Simon Marshall <Simon.Marshall_at_esrin.esa.it>
93 ;; Laurent Mugnier <mugnier_at_onera.fr>
94 ;; Lubos Pochman <lubos_at_rsinc.com>
95 ;; Bob Portmann <portmann_at_al.noaa.gov>
96 ;; Patrick M. Ryan <pat_at_jaameri.gsfc.nasa.gov>
97 ;; Marty Ryba <ryba_at_ll.mit.edu>
98 ;; Paul Sorenson <aardvark62_at_msn.com>
99 ;; Phil Sterne <sterne_at_dublin.llnl.gov>
100 ;; Phil Williams <williams_at_irc.chmcc.org>
101 ;;
102 ;; CUSTOMIZATION:
103 ;; =============
104 ;;
105 ;; IDLWAVE has extensive customize support; to learn about the
106 ;; variables which control the mode's behavior, use `M-x
107 ;; idlwave-customize'.
108 ;;
109 ;; You can set your own preferred values with Customize, or with Lisp
110 ;; code in .emacs. For an example of what to put into .emacs, check
111 ;; the TexInfo documentation or see a complete .emacs available at the
112 ;; website.
113 ;;
114 ;; KNOWN PROBLEMS:
115 ;; ==============
116 ;;
117 ;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual
118 ;; Numerics, Inc. is growing less and less complete as the two
119 ;; languages grow increasingly apart. The mode probably shouldn't
120 ;; even have "WAVE" in its title, but it's catchy, and was required
121 ;; to avoid conflict with the CORBA idl.el mode. Caveat WAVEor.
122 ;;
123 ;; Moving the point backwards in conjunction with abbrev expansion
124 ;; does not work as I would like it, but this is a problem with
125 ;; emacs abbrev expansion done by the self-insert-command. It ends
126 ;; up inserting the character that expanded the abbrev after moving
127 ;; point backward, e.g., "\cl" expanded with a space becomes
128 ;; "LONG( )" with point before the close paren. This is solved by
129 ;; using a temporary function in `post-command-hook' - not pretty,
130 ;; but it works.
131 ;;
132 ;; Tabs and spaces are treated equally as whitespace when filling a
133 ;; comment paragraph. To accomplish this, tabs are permanently
134 ;; replaced by spaces in the text surrounding the paragraph, which
135 ;; may be an undesirable side-effect. Replacing tabs with spaces is
136 ;; limited to comments only and occurs only when a comment
137 ;; paragraph is filled via `idlwave-fill-paragraph'.
138 ;;
139 ;; Muti-statement lines (using "&") on block begin and end lines can
140 ;; ruin the formatting. For example, multiple end statements on a
141 ;; line: endif & endif. Using "&" outside of block begin/end lines
142 ;; should be okay.
143 ;;
144 ;; Determining the expression at point for printing and other
145 ;; examination commands is somewhat rough: currently only fairly
146 ;; simple entities are found. You can always drag-select or examine
147 ;; a pre-selected region.
148 ;;
149 ;; When forcing completion of method keywords, the initial
150 ;; query for a method has multiple entries for some methods. Would
151 ;; be too difficult to fix this hardly used case.
152 ;;
153 \f
154 ;;; Code:
160 ;; For XEmacs
182 "Major mode for editing IDL .pro files."
194 ;;; Variables for indentation behavior ---------------------------------------
197 "Indentation and formatting options for IDLWAVE mode."
201 "*Extra indentation for the main block of code.
202 That is the block between the FUNCTION/PRO statement and the END
203 statement for that program unit."
208 "*Extra indentation applied to block lines.
209 If you change this, you probably also want to change `idlwave-end-offset'."
214 "*Extra indentation applied to block END lines.
215 A value equal to negative `idlwave-block-indent' will make END lines
216 line up with the block BEGIN lines."
221 "*Extra indentation applied to continuation lines.
222 This extra offset applies to the first of a set of continuation lines.
223 The following lines receive the same indentation as the first."
228 "*Maximum additional indentation for special continuation indent.
229 Several special indentations are tried to help line up continuation
230 lines in routine calls or definitions, other statements with
231 parentheses, or assignment statements. This variable specifies a
232 maximum amount by which this special indentation can exceed the
233 standard continuation indentation, otherwise defaulting to a fixed
234 offset. Set to 0 to effectively disable all special continuation
235 indentation, or to a large number (like 100) to enable it in all
236 cases. See also `idlwave-indent-to-open-paren', which can override
237 this variable."
242 "*Non-nil means, indent continuation lines to innermost open
243 parenthesis. This indentation occurs even if otherwise disallowed by
244 `idlwave-max-extra-continuation-indent'. Matching parens and the
245 interleaving args are lined up. Example:
247 x = function_a(function_b(function_c( a, b, [1,2,3, $
248 4,5,6 $
249 ], $
250 c, d $
251 )))
253 When this variable is nil, paren alignment may still occur, based on
254 the value of `max-extra-continuation-indent', which, if zero, would
255 yield:
257 x = function_a(function_b(function_c( a, b, [1,2,3, $
258 4,5,6 $
259 ], $
260 c, d $
261 )))"
266 "*Non-nil means, indent continuation lines with parens by nesting
267 lines at consecutively deeper levels."
273 "*If set non-nil then comment paragraphs are indented under the
274 hanging indent given by `idlwave-hang-indent-regexp' match in the first line
275 of the paragraph."
280 "*Regular expression matching the position of the hanging indent
281 in the first line of a comment paragraph. The size of the indent
282 extends to the end of the match for the regular expression."
287 "*If non-nil then use last match on line for `idlwave-indent-regexp'."
292 "*If non-nil then auto fill will only operate on comment lines."
297 "*If non-nil then auto fill will split strings with the IDL `+' operator.
298 When the line end falls within a string, string concatenation with the
299 '+' operator will be used to distribute a long string over lines.
300 If nil and a string is split then a terminal beep and warning are issued.
302 This variable is ignored when `idlwave-fill-comment-line-only' is
303 non-nil, since in this case code is not auto-filled."
308 "*If non-nil then `idlwave-split-line' will split strings with `+'.
309 When the splitting point of a line falls inside a string, split the string
310 using the `+' string concatenation operator. If nil and a string is
311 split then a terminal beep and warning are issued."
316 "*The indentation of a comment that starts with this regular
317 expression will not be changed. Note that the indentation of a comment
318 at the beginning of a line is never changed."
323 "*A comment anchored at the beginning of line.
324 A comment matching this regular expression will not have its
333 "*A comment that starts with this regular expression on a line by
334 itself is indented as if it is a part of IDL code. As a result if
335 the comment is not preceded by whitespace it is unchanged."
339 ;; Comments not matching any of the above will be indented as a
340 ;; right-margin comment, i.e., to a minimum of `comment-column'.
342 ;;; Routine Info and Completion ---------------------------------------
345 "Routine Info options for IDLWAVE mode."
349 "*Non-nil means search the IDL path for library catalog files.
351 These files, named .idlwave_catalog, document routine information for
352 individual directories and libraries of IDL .pro files. Many popular
353 libraries come with catalog files by default, so leaving this on is a
354 usually a good idea.."
359 "*Seconds of idle time before routine info is automatically
360 initialized. Initializing the routine info can take a long time, in
361 particular if a large number of library catalogs are involved. When
362 Emacs is idle for more than the number of seconds specified by this
363 variable, it starts the initialization. The process is split into
364 five steps, in order to keep work interruption as short as possible.
365 If one of the steps finishes, and no user input has arrived in the
366 mean time, initialization proceeds immediately to the next step. A
367 good value for this variable is about 1/3 of the time initialization
368 take in your setup. So if you have a fast machine and no problems
369 with a slow network connection, don't hesitate to set this to 2
370 seconds. A Value of 0 means, don't initialize automatically, but
371 instead wait until routine information is needed, and initialize
372 then."
377 "*Non-nil means, scan buffers for IDL programs when updating info.
378 The scanning is done by the command `idlwave-update-routine-info'.
379 The following values are allowed:
381 nil Don't scan any buffers.
382 t Scan all idlwave-mode buffers in the current editing session.
383 current Scan only the current buffer, but no other buffers."
391 "*Non-nil means query the shell for info about compiled routines.
392 Querying the shell is useful to get information about compiled modules,
393 and it is turned on by default. However, when you have a complete library
394 scan, this is not necessary."
400 "*Controls under what circumstances routine info is updated automatically.
401 Possible values:
402 nil Never
403 t All available
404 \(...) A list of circumstances. Allowed members are:
405 find-file Add info for new IDLWAVE buffers.
406 save-buffer Update buffer info when buffer is saved
407 kill-buffer Remove buffer info when buffer gets killed
408 compile-buffer Update shell info after `idlwave-shell-save-and...'"
420 "*Maximum number of source files displayed in the Routine Info window.
421 When an integer, it is the maximum number of source files displayed.
422 t means to show all source files."
427 "Library path for Windows and MacOS (OS9). Not needed under UNIX.
428 When selecting the directories to scan for IDL user catalog routine
429 info, IDLWAVE can, under UNIX, query the shell for the exact search
430 path \(the value of !PATH). However, under Windows and MacOS
431 \(pre-OSX), the IDLWAVE shell does not work. In this case, this
432 variable can be set to specify the paths where IDLWAVE can find PRO
433 files. The shell will only be asked for a list of paths when this
434 variable is nil. The value is a list of directories. A directory
435 preceeded by a `+' will be searched recursively. If you set this
436 variable on a UNIX system, the shell will not be queried. See also
437 `idlwave-system-directory'."
442 "The IDL system directory for Windows and MacOS. Not needed under
443 UNIX. Set this to the value of the `!DIR' system variable in IDL.
444 IDLWAVE uses this to find out which of the library routines belong to
445 the official system library. All files inside the `lib' subdirectory
446 are considered system library files - so don't install private stuff
447 in this directory. On UNIX systems, IDLWAVE queries the shell for the
448 value of `!DIR'. See also `idlwave-library-path'."
452 ;; Configuration files
455 "*Directory for configuration files and user-library catalog."
467 "Alist of regular expressions matching special library directories.
468 When listing routine source locations, IDLWAVE gives a short hint where
469 the file defining the routine is located. By default it lists `SystemLib'
470 for routines in the system library `!DIR/lib' and `Library' for anything
471 else. This variable can define additional types. The car of each entry
472 is a regular expression matching the file name (they normally will match
473 on the path). The cdr is the string to be used as identifier. Max 10
474 chars are allowed."
480 "Write out path (!PATH) and system directory (!DIR) info automatically.
481 Path info is needed to locate library catalog files. If non-nil,
482 whenever the path-list changes as a result of shell-query, etc., it is
484 used to force a write."
489 "Completion options for IDLWAVE mode."
506 "Association list setting the case of completed words.
508 This variable determines the case (UPPER/lower/Capitalized...) of
509 words inserted into the buffer by completion. The preferred case can
510 be specified separately for routine names, keywords, classes and
511 methods.
512 This alist should therefore have entries for `routine' (normal
513 functions and procedures, i.e. non-methods), `keyword', `class', and
514 `method'. Plausible values are
516 upcase upcase whole word, like `BOX_CURSOR'
517 downcase downcase whole word, like `read_ppm'
518 capitalize capitalize each part, like `Widget_Control'
519 preserve preserve case as is, like `IDLgrView'
521 The value can also be any Emacs Lisp function which transforms the
522 case of characters in a string.
524 A value of `preserve' means that the case of the completed word is
525 identical to the way it was written in the definition statement of the
526 routine. This was implemented to allow for mixed-case completion, in
527 particular of object classes and methods.
528 If a completable word is defined in multiple locations, the meaning of
529 `preserve' is not unique since the different definitions might be
530 cased differently. Therefore IDLWAVE always takes the case of the
531 *first* definition it encounters during routine info collection and
532 uses the case derived from it consistently.
534 Note that a lowercase-only string in the buffer will always be completed in
535 lower case (but see the variable `idlwave-completion-force-default-case').
537 After changing this variable, you need to either restart Emacs or press
538 `C-u C-c C-i' to update the internal lists."
545 "*Non-nil means, completion will always honor `idlwave-completion-case'.
546 When nil, only the completion of a mixed case or upper case string
547 will honor the default settings in `idlwave-completion-case', while
548 the completion of lower case strings will be completed entirely in
549 lower case."
554 "*Non-nil means, the empty string is considered downcase for completion.
555 The case of what is already in the buffer determines the case of completions.
556 When this variable is non-nil, the empty string is considered to be downcase.
557 Completing on the empty string then offers downcase versions of the possible
558 completions."
563 "Obsolete variable. See `idlwave-complete-empty-string-as-lower-case' and
567 "*Non-nil means, the case of tokens in buffers dominates over system stuff.
568 To make this possible, we need to re-case everything each time we update
569 the routine info from the buffers. This is slow.
570 The default is to consider the case given in the system and library files
571 first which makes updating much faster."
576 "*Non-nil means, highlight completions for which system help is available.
577 Help can then be accessed with mouse-3.
578 This option is only effective when the online help system is installed."
583 "Non-nil means, treat inheritance with completion, online help etc.
584 When nil, IDLWAVE only knows about the native methods and tags of a class,
585 not about inherited ones."
590 "List of regular expressions for class-driven keyword inheritance.
592 up the class tree. While it cannot be assumed that the presence of an
593 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
594 certain methods this assumption is almost always true. The methods
595 for which to assume this can be set here."
601 "*Number of classes to show when completing object methods and keywords.
602 When completing methods or keywords for an object with unknown class,
603 the *Completions* buffer will show the valid classes for each completion
604 like this:
606 MyMethod <Class1,Class2,Class3>
608 The value of this variable may be nil to inhibit display, or an integer to
609 indicate the maximum number of classes to display.
611 On XEmacs, a full list of classes will also be placed into a `help-echo'
612 property on the competion items, so that the list of classes for the current
613 item is displayed in the echo area. If the value of this variable is a
614 negative integer, the `help-echo' property will be suppressed."
620 "*Non-nil means, fontify the classes in completions buffer.
621 This makes it easier to distinguish the completion items from the extra
622 class info listed. See `idlwave-completion-show-classes'."
628 "Association list governing specification of object classes for completion.
630 When IDLWAVE tries to complete object-oriented methods, it usually
631 cannot determine the class of a given object from context. In order
632 to provide the user with a correct list of methods or keywords, it
633 needs to determine the appropriate class. IDLWAVE has two ways of
634 doing this (well, three ways if you count the shell... see
635 `idlwave-shell-query-for-class'):
637 1. Combine the items of all available classes which contain this
638 method for the purpose of completion. So when completing a method,
639 all methods of all known classes are available, and when completing
640 a keyword, all keywords allowed for this method in any class are
641 shown. This behavior is very much like normal completion and is
642 therefore the default. It works much better than one might think -
643 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
644 become uncomfortably long. See also
645 `idlwave-completion-show-classes'.
647 2. The second possibility is to ask the user on each occasion. To
648 make this less interruptive, IDLWAVE can store the class as a text
649 property on the object operator `->'. For a given object in the
650 source code, class selection will then be needed only once
651 - for example to complete the method. Keywords to the method can
652 then be completed directly, because the class is already known.
653 You will have to turn on the storage of the selected class
654 explicitly with the variable `idlwave-store-inquired-class'.
656 This variable allows you to configure IDLWAVE's method and
657 method-keyword completion behavior. Its value is an alist, which
658 should contain at least two elements: (method-default . VALUE) and
659 \(keyword-default . VALUE), where VALUE is either t or nil. These
660 specify if the class should be found during method and keyword
661 completion, respectively.
663 The alist may have additional entries specifying exceptions from the
664 keyword completion rule for specific methods, like INIT or
665 GETPROPERTY. In order to turn on class specification for the INIT
675 :inline t
680 "*Non-nil means, store class of a method call as text property on `->'.
681 IDLWAVE sometimes has to ask the user for the class associated with a
682 particular object method call. This happens during the commands
683 `idlwave-routine-info' and `idlwave-complete', depending upon the
684 value of the variable `idlwave-query-class'.
686 When you specify a class, this information can be stored as a text
687 property on the `->' arrow in the source code, so that during the same
688 editing session, IDLWAVE will not have to ask again. When this
689 variable is non-nil, IDLWAVE will store and reuse the class information.
691 on the arrow.
693 The default of this variable is nil, since the result of commands then
694 is more predictable. However, if you know what you are doing, it can
695 be nice to turn this on.
697 An arrow which knows the class will be highlighted with
699 displays (with prefix arg: deletes) the class stored on the arrow
700 at point."
705 "*Face to highlight object operator arrows `->' which carry a class property.
706 When IDLWAVE stores a class name as text property on an object arrow
707 \(see variable `idlwave-store-inquired-class', it highlights the arrow
708 with this font in order to remind the user that this arrow is special."
713 "*Non-nil means, resize the Routine-info *Help* window to fit the content."
718 "*Non-nil means, completion automatically adds `=' after completed keywords."
723 "*Non-nil means, completion automatically adds `(' after completed function.
724 nil means, don't add anything.
725 A value of `2' means, also add the closing parenthesis and position cursor
726 between the two."
733 "*Non-nil means, try to restore the window configuration after completion.
734 When completion is not unique, Emacs displays a list of completions.
735 This messes up your window configuration. With this variable set, IDLWAVE
736 restores the old configuration after successful completion."
740 ;;; Variables for abbrev and action behavior -----------------------------
743 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
744 The variables in this group govern this."
748 "*Non-nil means performs actions when indenting.
749 The actions that can be performed are listed in `idlwave-indent-action-table'."
754 "*A single character string used to start abbreviations in abbrev mode.
755 Possible characters to chose from: ~`\%
756 or even '?'. '.' is not a good choice because it can make structure
757 field names act like abbrevs in certain circumstances.
759 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
760 must set it directly using `setq' in the .emacs file before idlwave.el
761 is loaded."
766 "*Non-nil means, enable `idlwave-surround'.
767 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
768 `idlwave-surround'.
769 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
771 Also see the default key bindings for keys using `idlwave-surround'.
772 Keys are bound and made into actions calling `idlwave-surround' with
773 `idlwave-action-and-binding'.
774 See help for `idlwave-action-and-binding' for examples.
776 Also see help for `idlwave-surround'."
781 "*Non-nil means pad '=' in keywords (routine calls or defs) like assignment.
782 Whenever `idlwave-surround' is non-nil then this affects how '=' is
783 padded for keywords and for variables. If t, pad the same as for
784 assignments. If nil then spaces are removed. With any other value,
785 spaces are left unchanged."
793 "*Non-nil means point blinks to block beginning for `idlwave-show-begin'."
798 "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
803 "*Non-nil means re-indent line after END was typed."
808 "*Non-nil means the abbrev hook can move point.
809 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
810 definitions, use the command `list-abbrevs', for abbrevs that move
811 point. Moving point is useful, for example, to place point between
812 parentheses of expanded functions.
814 See `idlwave-check-abbrev'."
819 "*Non-nil means all abbrevs will be forced to either upper or lower case.
820 If the value t, all expanded abbrevs will be upper case.
821 If the value is 'down then abbrevs will be forced to lower case.
822 If nil, the case will not change.
823 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
824 upper case, regardless of this variable."
829 "*Non-nil means, reserved words will be made upper case via abbrev expansion.
830 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
831 Has effect only if in abbrev-mode."
835 ;;; Action/Expand Tables.
836 ;;
837 ;; The average user may have difficulty modifying this directly. It
838 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
839 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
840 ;; examples of how to add an action.
841 ;;
842 ;; The action table is used by `idlwave-indent-line' whereas both the
843 ;; action and expand tables are used by `idlwave-indent-and-action'. In
844 ;; general, the expand table is only used when a line is explicitly
845 ;; indented. Whereas, in addition to being used when the expand table
846 ;; is used, the action table is used when a line is indirectly
847 ;; indented via line splitting, auto-filling or a new line creation.
848 ;;
849 ;; Example actions:
850 ;;
851 ;; Capitalize system vars
852 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
853 ;;
854 ;; Capitalize procedure name
855 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
856 ;; '(capitalize-word 1) t)
857 ;;
858 ;; Capitalize common block name
859 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
860 ;; '(capitalize-word 1) t)
861 ;; Capitalize label
862 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
863 ;; '(capitalize-word -1) t)
866 "*Associated array containing action lists of search string (car),
867 and function as a cdr. This table is used by `idlwave-indent-line'.
868 See documentation for `idlwave-do-action' for a complete description of
869 the action lists.
871 Additions to the table are made with `idlwave-action-and-binding' when a
872 binding is not requested.
876 "*Associated array containing action lists of search string (car),
877 and function as a cdr. The table is used by the
878 `idlwave-indent-and-action' function. See documentation for
879 `idlwave-do-action' for a complete description of the action lists.
881 Additions to the table are made with `idlwave-action-and-binding' when a
882 binding is requested.
885 ;;; Documentation header and history keyword ---------------------------------
888 "Options for documenting IDLWAVE files."
891 ;; FIXME: make defcustom?
894 ";+
895 ; NAME:
896 ;
897 ;
898 ;
899 ; PURPOSE:
900 ;
901 ;
902 ;
903 ; CATEGORY:
904 ;
905 ;
906 ;
907 ; CALLING SEQUENCE:
908 ;
909 ;
910 ;
911 ; INPUTS:
912 ;
913 ;
914 ;
915 ; OPTIONAL INPUTS:
916 ;
917 ;
918 ;
919 ; KEYWORD PARAMETERS:
920 ;
921 ;
922 ;
923 ; OUTPUTS:
924 ;
925 ;
926 ;
927 ; OPTIONAL OUTPUTS:
928 ;
929 ;
930 ;
931 ; COMMON BLOCKS:
932 ;
933 ;
934 ;
935 ; SIDE EFFECTS:
936 ;
937 ;
938 ;
939 ; RESTRICTIONS:
940 ;
941 ;
942 ;
943 ; PROCEDURE:
944 ;
945 ;
946 ;
947 ; EXAMPLE:
948 ;
949 ;
950 ;
951 ; MODIFICATION HISTORY:
952 ;
953 ;-
955 "*A list (PATHNAME STRING) specifying the doc-header template to use for
956 summarizing a file. If PATHNAME is non-nil then this file will be included.
957 Otherwise STRING is used. If nil, the file summary will be omitted.
958 For example you might set PATHNAME to the path for the
962 "*Non-nil means, the documentation header will always be at start of file.
963 When nil, the header is positioned between the PRO/FUNCTION line of
964 the current routine and the code, allowing several routine headers in
965 a file."
970 "*The hook function used to update the timestamp of a function."
975 "*The modifications keyword to use with the log documentation commands.
976 A ':' is added to the keyword end.
977 Inserted by doc-header and used to position logs by doc-modification.
978 If nil it will not be inserted."
983 "*Regexp matching the start of a document library header."
988 "*Regexp matching the end of a document library header."
992 ;;; External Programs -------------------------------------------------------
995 "Path locations of external commands used by IDLWAVE."
999 "*If non-nil, this is the command to run IDL.
1000 Should be an absolute file path or path relative to the current environment
1001 execution search path. If you want to specify command line switches
1002 for the idl program, use `idlwave-shell-command-line-options'.
1004 I know the name of this variable is badly chosen, but I cannot change
1005 it without compromizing backwards-compatibility."
1010 "*A list of command line options for calling the IDL program.
1011 Since IDL is executed directly without going through a shell like /bin/sh,
1013 string for each argument. But you may also give a single string which
1014 contains the options whitespace-separated. Emacs will be kind enough to
1015 split it for you."
1017 string
1022 "*The external application providing reference help for programming.
1023 Obsolete, if the IDL Assistant is being used for help."
1027 ;;; Some Shell variables which must be defined here.-----------------------
1030 "List of modifiers to be used for the debugging commands.
1031 Will be used to bind debugging commands in the shell buffer and in all
1032 source buffers. These are additional convenience bindings, the debugging
1033 commands are always available with the `C-c C-d' prefix.
1034 If you set this to '(control shift), this means setting a breakpoint will
1035 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1036 are `control', `meta', `super', `hyper', `alt', and `shift'."
1047 "*If non-nil attempt invoke idlwave-shell if not already running.
1048 This is checked when an attempt to send a command to an
1049 IDL process is made."
1053 ;;; Miscellaneous variables -------------------------------------------------
1056 "Miscellaneous options for IDLWAVE mode."
1061 "*Non-nil displays a startup message when `idlwave-mode' is first called."
1067 common-blocks class-arrows)
1068 "Items which should be fontified on the default fontification level 2.
1069 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1070 is everything and level 2 is specified by this list.
1071 This variable must be set before IDLWAVE gets loaded. It is
1072 a list of symbols, the following symbols are allowed.
1074 pros-and-functions Procedure and Function definitions
1075 batch-files Batch Files
1076 idlwave-idl-keywords IDL Keywords
1077 label Statement Labels
1078 goto Goto Statements
1079 common-blocks Common Blocks
1080 keyword-parameters Keyword Parameters in routine definitions and calls
1081 system-variables System Variables
1082 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1083 class-arrows Object Arrows with class property"
1101 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1106 "Normal hook. Executed when idlwave.el is loaded."
1111 "Non-nil means turn on a few experimental features.
1112 This variable is only for the maintainer, to test difficult stuff,
1113 while still distributing stable releases.
1116 ;;;
1117 ;;; End customization variables section
1118 ;;;
1120 ;;; Non customization variables
1122 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1123 ;;; Simon Marshall <simon_at_gnu.ai.mit.edu>
1124 ;;; and Carsten Dominik...
1126 ;; The following are the reserved words in IDL. Maybe we should
1127 ;; highlight some more stuff as well?
1128 ;; Procedure declarations. Fontify keyword plus procedure name.
1130 ;; To update this regexp, update the list of keywords and
1131 ;; evaluate the form.
1132 ;; (insert
1133 ;; (prin1-to-string
1134 ;; (concat
1135 ;; "\\<\\("
1136 ;; (regexp-opt
1137 ;; '("||" "&&" "and" "or" "xor" "not"
1138 ;; "eq" "ge" "gt" "le" "lt" "ne"
1139 ;; "for" "do" "endfor"
1140 ;; "if" "then" "endif" "else" "endelse"
1141 ;; "case" "of" "endcase"
1142 ;; "switch" "break" "continue" "endswitch"
1143 ;; "begin" "end"
1144 ;; "repeat" "until" "endrep"
1145 ;; "while" "endwhile"
1146 ;; "goto" "return"
1147 ;; "inherits" "mod"
1148 ;; "compile_opt" "forward_function"
1149 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1150 ;; "\\)\\>")))
1151 "\\<\\(&&\\|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\\|||\\)\\>")
1155 ;; Function declarations. Fontify keyword plus function name.
1161 ;; Common blocks
1167 ;; Start with point after block name and comma
1169 nil
1171 )))
1173 ;; Batch files
1177 ;; FIXME warning.
1181 ;; Labels
1185 ;; The goto statement and its label
1191 ;; Tags in structure definitions. Note that this definition
1192 ;; actually collides with labels, so we have to use the same
1193 ;; face. It also matches named subscript ranges,
1194 ;; e.g. vec{bottom:top]. No good way around this.
1198 ;; Structure names
1203 ;; Keyword parameters, like /xlog or ,xrange=[]
1204 ;; This is anchored to the comma preceeding the keyword.
1205 ;; Treats continuation lines, works only during whole buffer
1206 ;; fontification. Slow, use it only in fancy fontification.
1208 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\([ \t]*\\(;.*\\)?\n\\)*[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1211 ;; System variables start with a bang.
1216 ;; Special and unusual operators (not used because too noisy)
1220 ;; All operators (not used because too noisy)
1224 ;; Arrows with text property `idlwave-class'
1238 batch-files
1239 idlwave-idl-keywords
1240 label goto
1241 structtag
1242 structname
1243 common-blocks
1244 keyword-parameters
1245 system-variables
1246 class-arrows)
1250 ;; Match an object arrow with class property
1260 idlwave-font-lock-keywords-1
1261 idlwave-font-lock-keywords-2
1262 idlwave-font-lock-keywords-3)
1263 nil t
1265 beginning-of-line))
1271 "Regexp to match the start of a full-line comment.
1272 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1277 "Regular expression to find the beginning of a block. The case does
1281 "Regular expression to find the beginning of a unit. The case does
1285 "Regular expression to find the line that indicates the end of unit.
1286 This line is the end of buffer or the start of another unit. The case does
1294 "Regular expression to find the end of a block. The case does
1307 "Matches between statements and the corresponding END variant.
1308 The cars are the reserved words starting a block. If the block really
1309 begins with BEGIN, the cars are the reserved words before the begin
1310 which can be used to identify the block type.
1311 This is used to check for the correct END type, to close blocks and
1316 "Regular expression matching reserved words which can stand before
1317 blocks starting with a BEGIN statement. The matches must have associations
1334 ))
1338 ;; "endif else" is the only possible "end" that can be
1339 ;; followed by a statement on the same line.
1341 ;; all other "end"s can not be followed by a statement.
1354 idlwave-identifier
1358 idlwave-identifier
1363 "Associated list of statement matching regular expressions.
1364 Each regular expression matches the start of an IDL statement. The
1365 first element of each association is a symbol giving the statement
1366 type. The associated value is a list. The first element of this list
1367 is a regular expression matching the start of an IDL statement for
1368 identifying the statement type. The second element of this list is a
1369 regular expression for finding a substatement for the type. The
1370 substatement starts after the end of the found match modulo
1371 whitespace. If it is nil then the statement has no substatement. The
1372 list order matters since matching an assignment statement exactly is
1373 not possible without parsing. Thus assignment statement become just
1382 ;; Note that this is documented in the v18 manuals as being a string
1383 ;; of length one rather than a single character.
1384 ;; The code in this file accepts either format for compatibility.
1386 "Character to be inserted for IDL comment indentation.
1390 "Character which is inserted as a last character on previous line by
1396 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1400 ;; If I take the time I can replace idlwave-keyword-abbrev with
1401 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1402 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1403 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1404 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1407 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1408 Specifically, if the abbrev is in a comment or string it is unexpanded.
1409 Otherwise ARGS forms a list that is evaluated."
1454 "Execute BODY with a different syntax table."
1462 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1463 ; "Execute BODY with a different syntax table."
1464 ; `(let ((saved-syntax (syntax-table)))
1465 ; (unwind-protect
1466 ; (progn
1467 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1468 ; ,@body)
1469 ; (set-syntax-table saved-syntax))))
1472 "KEY and CMD are made into a key binding and an indent action.
1473 KEY is a string - same as for the `define-key' function. CMD is a
1474 function of no arguments or a list to be evaluated. CMD is bound to
1475 KEY in `idlwave-mode-map' by defining an anonymous function calling
1476 `self-insert-command' followed by CMD. If KEY contains more than one
1477 character a binding will only be set if SELECT is 'both.
1479 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1480 replacing any previous value for KEY. If a binding is not set then it
1481 will instead be placed in `idlwave-indent-action-table'.
1483 If the optional argument SELECT is nil then an action and binding are
1484 created. If SELECT is 'noaction, then a binding is always set and no
1485 action is created. If SELECT is 'both then an action and binding
1486 will both be created even if KEY contains more than one character.
1487 Otherwise, if SELECT is non-nil then only an action is created.
1489 Some examples:
1490 No spaces before and 1 after a comma
1492 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1494 Capitalize system variables - action only
1495 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1497 ;; Add action
1503 ;; Replace action command
1505 ;; New action
1507 ;; Make key binding for action
1516 cmd
1523 ;(define-key idlwave-mode-map "\C-c\C- " 'idlwave-hard-tab)
1542 ;; (define-key idlwave-mode-map "\r" 'idlwave-newline)
1543 ;; (define-key idlwave-mode-map "\t" 'idlwave-indent-line)
1555 ;; Bind the debug commands also with the special modifiers.
1572 ;; (define-key idlwave-mode-map "\C-c\C-f" 'idlwave-function)
1573 ;; (define-key idlwave-mode-map "\C-c\C-p" 'idlwave-procedure)
1597 ;; Pickup both forms of Esc/Meta binding
1607 ;; Set action and key bindings.
1608 ;; See description of the function `idlwave-action-and-binding'.
1609 ;; Automatically add spaces for the following characters
1611 ;; Actions for & are complicated by &&
1614 ;; Automatically add spaces to equal sign if not keyword. This needs
1615 ;; to go ahead of > and <, so >= and <= will be treated correctly
1618 ;; Actions for > and < are complicated by >=, <=, and ->...
1625 ;;;
1626 ;;; Abbrev Section
1627 ;;;
1628 ;;; When expanding abbrevs and the abbrev hook moves backward, an extra
1629 ;;; space is inserted (this is the space typed by the user to expanded
1630 ;;; the abbrev).
1631 ;;;
1637 "Define-abbrev with backward compatibility.
1639 If NOPREFIX is non-nil, don't prepend prefix character. Installs into
1640 idlwave-mode-abbrev-table unless TABLE is non-nil."
1644 expansion
1645 hook)))
1655 ;;
1656 ;; Templates
1657 ;;
1667 ;;
1668 ;; Keywords, system functions, conversion routines
1669 ;;
1727 ;; This section is reserved words only. (From IDL user manual)
1728 ;;
1774 ;; defined later - so just make the compiler hush
1778 ;;;###autoload
1780 "Major mode for editing IDL source files (version 6.1_em22).
1782 The main features of this mode are
1784 1. Indentation and Formatting
1785 --------------------------
1786 Like other Emacs programming modes, C-j inserts a newline and indents.
1787 TAB is used for explicit indentation of the current line.
1790 function can also be used in the middle of a line to split the line
1791 at that point. When used inside a long constant string, the string
1792 is split at that point with the `+' concatenation operator.
1794 Comments are indented as follows:
1796 `;;;' Indentation remains unchanged.
1797 `;;' Indent like the surrounding code
1798 `;' Indent to a minimum column.
1800 The indentation of comments starting in column 0 is never changed.
1803 comment. The indentation of the second line of the paragraph
1804 relative to the first will be retained. Use
1806 comments. When the variable `idlwave-fill-comment-line-only' is
1807 nil, code can also be auto-filled and auto-indented.
1809 To convert pre-existing IDL code to your formatting style, mark the
1814 2. Routine Info
1815 ------------
1816 IDLWAVE displays information about the calling sequence and the
1817 accepted keyword parameters of a procedure or function with
1819 source file of a module. These commands know about system
1820 routines, all routines in idlwave-mode buffers and (when the
1821 idlwave-shell is active) about all modules currently compiled under
1822 this shell. It also makes use of pre-compiled or custom-scanned
1823 user and library catalogs many popular libraries ship with by
1825 information, which is also used for completion (see item 4).
1827 3. Online IDL Help
1828 ---------------
1831 for the system variable, keyword, or routines at point. A single
1832 key stroke gets you directly to the right place in the docs. See
1833 the manual to configure where and how the HTML help is displayed.
1835 4. Completion
1836 ----------
1838 class names, keyword parameters, system variables and tags, class
1839 tags, structure tags, filenames and much more. It is context
1840 sensitive and figures out what is expected at point. Lower case
1841 strings are completed in lower case, other strings in mixed or
1842 upper case.
1844 5. Code Templates and Abbreviations
1845 --------------------------------
1846 Many Abbreviations are predefined to expand to code fragments and templates.
1861 have direct keybindings - see the list of keybindings below.
1864 beginning of the current program unit (pro, function or main).
1865 Change log entries can be added to the current program unit with
1868 6. Automatic Case Conversion
1869 -------------------------
1870 The case of reserved words and some abbrevs is controlled by
1871 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1873 7. Automatic END completion
1874 ------------------------
1875 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1876 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1878 8. Hooks
1879 -----
1880 Loading idlwave.el runs `idlwave-load-hook'.
1881 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1883 9. Documentation and Customization
1884 -------------------------------
1885 Info documentation for this package is available. Use
1887 not work). For Postscript, PDF, and HTML versions of the
1888 documentation, check IDLWAVE's homepage at `http://idlwave.org'.
1889 IDLWAVE has customize support - see the group `idlwave'.
1891 10.Keybindings
1892 -----------
1893 Here is a list of all keybindings of this mode.
1895 followed by the key sequence to see what the key sequence does.
1941 ;; ChangeLog
1945 ;; Set tag table list to use IDLTAGS as file name.
1949 ;; Font-lock additions
1950 ;; Following line is for Emacs - XEmacs uses the corresponding property
1951 ;; on the `idlwave-mode' symbol.
1958 ;; Imenu setup
1966 ;; HideShow setup
1969 idlwave-begin-block-reg
1970 idlwave-end-block-reg
1971 ";"
1974 ;; Make a local post-command-hook and add our hook to it
1975 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1976 ;; (make-local-hook 'post-command-hook)
1979 ;; Make local hooks for buffer updates
1980 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1981 ;; (make-local-hook 'kill-buffer-hook)
1983 ;; (make-local-hook 'after-save-hook)
1987 ;; Setup directories and file, if necessary
1990 ;; Update the routine info with info about current buffer?
1993 ;; Check help location
1996 ;; Run the mode hook
2006 idlwave-user-catalog-file
2007 idlwave-config-directory)
2008 idlwave-xml-system-rinfo-converted-file
2010 idlwave-xml-system-rinfo-converted-file
2011 idlwave-config-directory)
2013 idlwave-path-file
2014 idlwave-config-directory))
2019 "Fontify continuation lines correctly."
2030 ;;
2031 ;; Code Formatting ----------------------------------------------------
2032 ;;
2035 "Inserts TAB in buffer in current position."
2039 ;;; This stuff is experimental
2042 "If non-nil, a list that can be evaluated using `eval'.
2043 It is evaluated in the lisp function `idlwave-command-hook' which is
2047 "Command run after every command.
2048 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
2049 sets the variable to zero afterwards."
2057 ;;; End experiment
2059 ;; It would be better to use expand.el for better abbrev handling and
2060 ;; versatility.
2063 "Reverses abbrev expansion if in comment or string.
2064 Argument ARG is the number of characters to move point
2065 backward if `idlwave-abbrev-move' is non-nil.
2066 If optional argument RESERVED is non-nil then the expansion
2067 consists of reserved words, which will be capitalized if
2068 `idlwave-reserved-word-upcase' is non-nil.
2069 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2070 is non-nil, unless its value is \`down in which case the abbrev will be
2071 made into all lowercase.
2072 Returns non-nil if abbrev is left expanded."
2075 nil)
2087 t))
2090 "Returns t if point is inside a comment, nil otherwise."
2096 "Move to start of comment delimiter on current line.
2097 Moves to end of line if there is no comment delimiter.
2098 Ignores comment delimiters in strings.
2099 Returns point if comment found and nil otherwise."
2102 found)
2103 ;; Look for first comment delimiter not in a string
2115 "Should we operate on an active region?"
2121 "Insert quote and show matching quote if this is end of a string."
2132 ;; Not the end of a string
2136 "Ensure that the previous word was a token before `idlwave-show-begin'.
2137 An END token must be preceded by whitespace."
2147 "Finds the start of current block and blinks to it for a second.
2148 Also checks if the correct end statement has been used."
2149 ;; All end statements are reserved words
2150 ;; Re-indent end line
2151 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2152 ;;(backward-char 1)
2156 begin-pos end-pos end end1 )
2160 idlwave-show-block)
2162 ;; Move inside current block
2175 end-pos))
2183 ;; A generic end
2194 end1 end)
2196 ;;(delete-char 1))
2210 ;; seems to be a case thing
2214 idlwave-block-matches))
2216 ;; Just a normal block
2221 "Terminate the current block with the correct END statement."
2223 ;; Start new line if we are not in a new line
2234 "Surround &, leaving room for && (which surrround as well)."
2244 "Surround > and < by blanks, leaving room for >= and <=, and considering ->."
2250 ;; Key binding: pad only on left, to save for possible >=/<=
2254 "Surround the LENGTH characters before point with blanks.
2255 LENGTH defaults to 1.
2256 Optional arguments BEFORE and AFTER affect the behavior before and
2257 after the characters (see also description of `idlwave-make-space'):
2259 nil do nothing
2260 0 force no spaces
2261 integer > 0 force exactly n spaces
2262 integer < 0 at least |n| spaces
2264 The function does nothing if any of the following conditions is true:
2265 - `idlwave-surround-by-blank' is nil
2266 - the character before point is inside a string or comment"
2274 ;; avoid clobbering indent
2284 ;; Check to see if the line should auto wrap
2290 "Make space at point.
2291 The space affected is all the spaces and tabs around point.
2292 If n is non-nil then point is left abs(n) spaces from the beginning of
2293 the contiguous space.
2294 The amount of space at point is determined by N.
2295 If the value of N is:
2296 nil - do nothing.
2297 > 0 - exactly N spaces.
2298 < 0 - a minimum of -N spaces, i.e., do not change if there are
2299 already -N spaces.
2300 0 - no spaces (i.e. remove any existing space)."
2314 ;; n = 0, done
2315 ))))
2318 "Inserts a newline and indents the current and previous line."
2320 ;;
2321 ;; Handle unterminated single and double quotes
2322 ;; If not in a comment and in a string then insertion of a newline
2323 ;; will mean unbalanced quotes.
2324 ;;
2329 ;;
2330 ;; The current line is being split, the cursor should be at the
2331 ;; beginning of the new line skipping the leading indentation.
2332 ;;
2333 ;; The reason we insert the new line before indenting is that the
2334 ;; indenting could be confused by keywords (e.g. END) on the line
2335 ;; after the split point. This prevents us from just using
2336 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2337 ;;
2343 ;;
2344 ;; Use global variable 'comment-column' to set parallel comment
2345 ;;
2346 ;; Modeled on lisp.el
2347 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2349 "Compute indent for the beginning of the IDL comment delimiter."
2357 ;; On line by itself, indent as code
2360 ;; after code - do not change
2364 comment-column))))
2367 "Continue line by breaking line at point and indent the lines.
2368 For a code line insert continuation marker. If the line is a line comment
2369 then the new line will contain a comment with the same indentation.
2370 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2371 non-nil."
2373 ;; Expand abbreviation, just like normal RET would.
2377 ;; For code line add continuation.
2378 ;; Check if splitting a string.
2382 ;; Split the string.
2384 idlwave-continuation-char beg)
2388 ;; Do not split the string.
2392 ;; Not splitting a string.
2398 ;; Indent previous line
2403 ;; Reindent new line
2407 "Moves point to the beginning of the current program unit.
2408 If NOMARK is non-nil, do not push mark."
2413 "Moves point to the start of the next program unit.
2414 If NOMARK is non-nil, do not push mark."
2420 "Mark current IDL statement."
2428 "Mark containing block."
2440 "Put mark at beginning of program, point at end.
2441 The marks are pushed."
2451 "Move to beginning of enclosing block if prefix ARG >= 0.
2452 If prefix ARG < 0 then move forward to enclosing block end."
2457 "Go to the beginning of the current block."
2463 "Go to the beginning of the current block."
2469 "Move across next nested block."
2476 "Move backward across previous nested block."
2482 "Go down a block.
2483 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2484 Returns non-nil if successfull."
2488 ;; Backward
2496 ;; Forward
2504 status))
2507 "Put point at beginning of doc library header, mark at end.
2508 The marks are pushed."
2529 "Return (NAME TYPE CLASS) of current routine."
2533 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2542 "Move to beginning of the current statement.
2543 Skips back past statement continuations.
2544 Point is placed at the beginning of the line whether or not this is an
2545 actual statement."
2557 "Moves point to beginning of the previous statement.
2558 Returns t if the current line before moving is the beginning of
2559 the first non-comment statement in the file, and nil otherwise."
2563 ;; first line in file
2564 t
2565 ;; skip blank lines, label lines, include lines and line comments
2567 ;; The current statement is the first statement until we
2568 ;; reach another statement.
2576 ;; skip continuation lines
2582 first-statement)))
2585 "Moves point to the end of the current IDL statement.
2586 If not in a statement just moves to end of line. Returns position."
2596 "Moves point to the end of the current IDL statement.
2597 If not in a statement just moves to end of line. Returns position."
2605 "Moves point to beginning of the next IDL statement.
2606 Returns t if that statement is the last
2607 non-comment IDL statement in the file, and nil otherwise."
2611 ;; skip blank lines, label lines, include lines and line comments
2613 ;; The current statement is the last statement until
2614 ;; we reach a new statement.
2621 last-statement))
2624 "Skip past multiple commands on a line (with `&')."
2634 "Skip label or case statement element.
2635 Returns position after label.
2636 If there is no label point is not moved and nil is returned."
2637 ;; Case expressions and labels are terminated by a colon.
2638 ;; So we find the first colon in the line and make sure
2639 ;; - no `?' is before it (might be a ? b : c)
2640 ;; - it is not in a comment
2641 ;; - not in a string constant
2642 ;; - not in parenthesis (like a[0:3])
2643 ;; - not followed by another ":" in explicit class, ala a->b::c
2644 ;; As many in this mode, this function is heuristic and not an exact
2645 ;; parser.
2657 nil)))
2660 "Move to start of next IDL substatement after point.
2661 Uses the type of the current IDL statement to determine if the next
2662 statement is on a new line or is a subpart of the current statement.
2663 Returns point at start of substatement modulo whitespace.
2664 If optional argument is non-nil move to beginning of current
2665 substatement."
2669 st nst last)
2675 ;; Continue looking for substatements until we are past orig
2689 ;; If a continuation line starts here, move to next line
2695 "Return the type of the current IDL statement.
2696 Uses `idlwave-statement-match' to return a cons of (type . point) with
2697 point the ending position where the type was determined. Type is the
2698 association from `idlwave-statement-match', i.e. the cons cell from the
2699 list not just the type symbol. Returns nil if not an identifiable
2700 statement."
2702 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2703 ;; and possibly comments
2715 "Pad '=' with spaces. Two cases: Assignment statement, and keyword
2716 assignment. Which case is determined using
2717 `idlwave-start-of-substatement' and `idlwave-statement-type'. The
2718 equal sign will be surrounded by BEFORE and AFTER blanks. If
2719 `idlwave-pad-keyword' is t then keyword assignment is treated just
2720 like assignment statements. When nil, spaces are removed for keyword
2721 assignment. Any other value keeps the current space around the `='.
2722 Limits in for loops are treated as keyword assignment.
2724 Starting with IDL 6.0, a number of op= assignments are available.
2725 Since ambiguities of the form:
2727 r and= b
2728 rand= b
2730 can occur, alphanumeric operator assignment will never be pre-padded,
2731 only post-padded. You must use a space before these to disambiguate
2732 \(not just for padding, but for proper parsing by IDL too!). Other
2733 operators, such as ##=, ^=, etc., will be pre-padded.
2735 IS-ACTION is ignored.
2737 See `idlwave-surround'."
2750 ;; Why doesn't ##? work for both?
2754 ;(setq begin nil) ; won't modify begin
2758 ;; Everything gets padded equally
2760 ;; Treating keywords/for variables specially...
2778 "Call `idlwave-indent-line' and do expand actions.
2779 With prefix ARG non-nil, indent the entire sub-statement."
2787 ;;Expand the END abbreviation, just as RET or Space would have.
2798 "Indents current IDL line as code or as a comment.
2799 The actions in `idlwave-indent-action-table' are performed.
2800 If the optional argument EXPAND is non-nil then the actions in
2801 `idlwave-indent-expand-table' are performed."
2803 ;; Move point out of left margin.
2812 ;; Indentation for a line comment
2816 ;;
2817 ;; Code Line
2818 ;;
2819 ;; Before indenting, run action routines.
2820 ;;
2823 ;;
2826 ;;
2827 ;; No longer expand abbrevs on the line. The user can do this
2828 ;; manually using expand-region-abbrevs.
2829 ;;
2830 ;; Indent for code line
2831 ;;
2834 ;; a label line
2836 ;; a batch command
2838 ;; leave flush left
2839 nil
2840 ;; indent the line
2842 ;; Adjust parallel comment
2845 ;; Emacs 21 is too smart with fill-column on comment indent
2848 fill-column)))
2851 ;; Get rid of marker
2855 "Perform an action repeatedly on a line. ACTION is a list (REG
2856 . FUNC). REG is a regular expression. FUNC is either a function name
2857 to be called with `funcall' or a list to be evaluated with `eval'.
2858 The action performed by FUNC should leave point after the match for
2859 REG - otherwise an infinite loop may be entered. FUNC is always
2860 passed a final argument of 'is-action, so it can discriminate between
2861 being run as an action, or a key binding"
2871 "Indent from point with spaces until column COL.
2872 Inserts space before markers at point."
2878 "Indent the current line to column COL.
2879 Indents such that first non-whitespace character is at column COL
2880 Inserts spaces before markers at point."
2887 "Indents program unit which contains point."
2899 "Indent current statement, including all continuation lines."
2908 "Return appropriate indentation for current line as IDL code."
2912 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2913 ;; function
2916 ;; Check for continuation line
2921 ;; calculate indent based on previous and current statements
2924 ;; calculate indent based on previous statement
2927 ;; Beginning of file
2932 ;; Main block
2935 idlwave-main-block-indent))
2936 ;; Begin block
2939 idlwave-block-indent))
2940 ;; End Block
2943 ;; Match to the *beginning* of the block opener
2947 ;; idlwave-end-offset
2948 ;; idlwave-block-indent))
2950 ;; Default to current indent
2952 ;; adjust the indentation based on the current statement
2954 ;; End block
2959 ;;
2960 ;; Parentheses indent
2961 ;;
2964 "Calculate the continuation indent inside a paren group.
2965 Returns a cons-cell with (open . indent), where open is the
2966 location of the open paren"
2968 ;; Found an innermost open paren.
2971 ;; Line up with next word unless this is a closing paren.
2974 ;; Plain Kernighan-style nested indent
2978 ;; This is a closed paren - line up under open paren.
2982 ;; Empty (or just comment) follows -- revert to basic indent
2984 ;; Skip paren
2987 nil)
2989 ;; Line up with first word after any blank space
2995 "Calculates the IDL continuation indent column from the previous
2996 statement. Note that here previous statement usually means the
2997 beginning of the current statement if this statement is a continuation
2998 of the previous line. Various special types of continuations,
2999 including assignments, routine definitions, and parenthetical
3000 groupings, are treated separately."
3011 idlwave-continuation-indent))
3012 fancy-nonparen-indent fancy-paren-indent)
3014 ;; Align then with its matching if, etc.
3021 match cont-re)
3036 ;; Indent in from the previous line for continuing statements
3041 match)
3053 ;; Parenthetical indent, either traditional or Kernighan style
3060 indent-cons)
3063 beg-reg end-reg close-exp))
3064 ;; First permitted containing paren
3066 idlwave-indent-to-open-paren
3067 idlwave-indent-parens-nested
3070 idlwave-max-extra-continuation-indent))
3073 fancy-paren-indent)
3075 ;; A continued assignment, or procedure call/definition
3083 ;; A continued Procedure call or definition
3086 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3088 ;; Comment only, or blank line with "$"? Basic indent.
3090 nil
3093 ;; Continued assignment (with =):
3107 idlwave-max-extra-continuation-indent))
3110 fancy-nonparen-indent))
3112 ;; Basic indent, by default
3118 "Move to next match of the regular expression KEY-RE.
3119 Matches inside comments or string constants will be ignored.
3120 If DIR is negative, the search will be backwards.
3121 At a successful match, the mark is pushed unless NOMARK is non-nil.
3122 Searches are limited to LIMIT.
3123 Searches are case-insensitive and use a special syntax table which
3124 treats `$' and `_' as word characters.
3125 Return value is the beginning of the match or (in case of failure) nil."
3129 found)
3143 found)
3144 nil)))
3147 "When optional argument DIR is non-negative, move forward to end of
3148 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3149 regular expressions. When DIR is negative, move backwards to block beginning.
3150 Recursively calls itself to skip over nested blocks. DIR defaults to
3151 forward. Calls `push-mark' unless the optional argument NOMARK is
3152 non-nil. Movement is limited by the start of program units because of
3153 possibility of unbalanced blocks."
3160 idlwave-begin-block-reg
3161 idlwave-end-block-reg))
3162 found
3164 idlwave-end-block-reg))
3168 idlwave-begin-unit-reg dir t limit)
3171 idlwave-end-unit-reg dir t limit)))
3172 limit)))
3184 "The minimum indent in the current statement."
3195 min
3199 "Return indentation of the current statement.
3200 If in a statement, moves to beginning of statement before finding indent."
3207 "Return the column of the indentation of the current line.
3208 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3212 ;; if we are at the end of blank line return 0
3217 "Tests if current line is continuation line.
3218 Blank or comment-only lines following regular continuation lines (with
3219 `$') count as continuations too."
3230 "Tests if the current line is a comment line."
3236 "Tests if the current line is a comment line."
3242 "Searches current line from current point for REGEXP.
3243 If optional argument CONT is non-nil, searches to the end of
3244 the current statement.
3245 If optional arg BEG is non-nil, search starts from the beginning of the
3246 current statement.
3247 Ignores matches that end in a comment or inside a string expression.
3248 Returns point if successful, nil otherwise.
3249 This function produces unexpected results if REGEXP contains quotes or
3250 a comment delimiter. The search is case insensitive.
3251 If successful leaves point after the match, otherwise, does not move point."
3257 found)
3263 found))
3266 "Fills paragraphs in comments.
3267 A paragraph is made up of all contiguous lines having the same comment
3268 leader (the leading whitespace before the comment delimiter and the
3269 comment delimiter). In addition, paragraphs are separated by blank
3270 line comments. The indentation is given by the hanging indent of the
3271 first line, otherwise by the minimum indentation of the lines after
3272 the first line. The indentation of the first line does not change.
3273 Does not effect code lines. Does not fill comments on the same line
3274 with code. The hanging indent is given by the end of the first match
3275 matching `idlwave-hang-indent-regexp' on the paragraph's first line . If the
3276 optional argument NOHANG is non-nil then the hanging indent is
3277 ignored."
3279 ;; check if this is a line comment
3286 pre here diff fill-prefix-reg bcl first-indent
3287 hang start end)
3288 ;; Change tabs to spaces in the surrounding paragraph.
3289 ;; The surrounding paragraph will be the largest containing block of
3290 ;; contiguous line comments. Thus, we may be changing tabs in
3291 ;; a much larger area than is needed, but this is the easiest
3292 ;; brute force way to do it.
3293 ;;
3294 ;; This has the undesirable side effect of replacing the tabs
3295 ;; permanently without the user's request or knowledge.
3303 ;;
3310 t)
3311 ;; Get the comment leader on the line and its length
3313 ;; the comment leader is the indentation plus exactly the
3314 ;; number of consecutive ";".
3324 ;; Mark the beginning and end of the paragraph
3330 ;; Move to first line of paragraph
3344 ;; if at end of buffer add a newline (need this because
3345 ;; fill-region needs END to be at the beginning of line after
3346 ;; the paragraph or it will add a line).
3349 ;; Set END to the beginning of line after the paragraph
3350 ;; END is calculated as distance from end of buffer
3352 ;;
3353 ;; Calculate the indentation for the paragraph.
3354 ;;
3355 ;; In the following while statements, after one iteration
3356 ;; point will be at the beginning of a line in which case
3357 ;; the while will not be executed for the
3358 ;; the first paragraph line and thus will not affect the
3359 ;; indentation.
3360 ;;
3361 ;; First check to see if indentation is based on hanging indent.
3367 ;; Adjust lines of paragraph by inserting spaces so that
3368 ;; each line's indent is at least as great as the hanging
3369 ;; indent. This is needed for fill-paragraph to work with
3370 ;; a fill-prefix.
3377 t)
3381 ;; adjust the original location for the
3382 ;; inserted text.
3386 )
3388 ;; No hang. Instead find minimum indentation of paragraph
3389 ;; after first line.
3390 ;; For the following while statement, since START is at the
3391 ;; beginning of line and END is at the end of line
3392 ;; point is greater than START at least once (which would
3393 ;; be the case for a single line paragraph).
3400 comment-start-skip
3402 t)
3405 )
3408 ?\ )))
3409 ;; first-line indent
3414 comment-start-skip
3416 t)
3418 indent))
3420 ;; try to keep point at its original place
3423 ;; In place of the more modern fill-region-as-paragraph, a hack
3424 ;; to keep whitespace untouched on the first line within the
3425 ;; indent length and to preserve any indent on the first line
3426 ;; (first indent).
3432 start
3435 nil)
3439 ;; When we want the point at the beginning of the comment
3440 ;; body fill-region will put it at the beginning of the line.
3445 "Calculate the position of the hanging indent for the comment
3446 paragraph. The hanging indent position is given by the first match
3447 with the `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3448 non-nil then use last occurrence matching `idlwave-hang-indent-regexp' on
3449 the line.
3450 If not found returns nil."
3455 idlwave-hang-indent-regexp
3457 t)
3462 idlwave-hang-indent-regexp
3464 t)
3468 "Called to break lines in auto fill mode.
3469 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3470 non-nil. Places a continuation character at the end of the line if
3471 not in a comment. Splits strings with IDL concatenation operator `+'
3472 if `idlwave-auto-fill-split-string' is non-nil."
3474 nil ; do not to fill
3477 ;; Check for comment line
3482 ;; Prevent actions do-auto-fill which calls indent-line-function.
3487 idlwave-auto-fill-split-string)
3490 ))))
3494 ;; Indent the split line
3499 ;; A continued line comment
3500 ;; We treat continued line comments as part of a comment
3501 ;; paragraph. So we check for a hanging indent.
3510 ;; Remove whitespace between comment delimiter and
3511 ;; text, insert spaces for appropriate indentation.
3514 comment-start-skip
3519 )))
3520 ;; Split code or comment?
3524 ;; Splitting a non-full-line comment.
3525 ;; Insert the comment delimiter from split line
3530 ;; Insert blank to keep off beginning of line
3539 ;; Split code line - add continuation character
3542 ;; Check to see if we split a string
3544 idlwave-auto-fill-split-string)
3545 ;; Split the string and concatenate.
3546 ;; The first extra space is for the space
3547 ;; the line was split. That space was removed.
3552 ;; Make the second part of continued string
3557 ;; Warning
3560 ;; Although do-auto-fill (via indent-new-comment-line) calls
3561 ;; idlwave-indent-line for the new line, re-indent again
3562 ;; because of the addition of the continuation character.
3564 )))))
3567 "Toggle auto-fill mode for IDL mode.
3568 With arg, turn auto-fill mode on if arg is positive.
3569 In auto-fill mode, inserting a space at a column beyond `fill-column'
3570 automatically breaks the line at a previous space."
3576 'idlwave-auto-fill
3577 nil))
3578 ;; update mode-line
3581 ;(defun idlwave-fill-routine-call ()
3582 ; "Fill a routine definition or statement, indenting appropriately."
3583 ; (let ((where (idlwave-where)))))
3587 "Insert a documentation header at the beginning of the unit.
3588 Inserts the value of the variable idlwave-file-header. Sets mark before
3589 moving to do insertion unless the optional prefix argument NOMARK
3590 is non-nil."
3593 ;; make sure we catch the current line if it begins the unit
3599 ;; skip function or procedure line
3613 "Default timestamp insertion function"
3619 ;; Remove extra spaces from line
3621 ;; Insert a blank line comment to separate from the date entry -
3622 ;; will keep the entry from flowing onto date line if re-filled.
3626 "Insert a brief modification log at the beginning of the current program.
3627 Looks for an occurrence of the value of user variable
3628 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user name
3629 and places the point for the user to add a log. Before moving, saves
3630 location on mark ring so that the user can return to previous point."
3645 end t)
3656 ;;; CJC 3/16/93
3657 ;;; Interface to expand-region-abbrevs which did not work when the
3658 ;;; abbrev hook associated with an abbrev moves point backwards
3659 ;;; after abbrev expansion, e.g., as with the abbrev '.n'.
3660 ;;; The original would enter an infinite loop in attempting to expand
3661 ;;; .n (it would continually expand and unexpand the abbrev without expanding
3662 ;;; because the point would keep going back to the beginning of the
3663 ;;; abbrev instead of to the end of the abbrev). We now keep the
3664 ;;; abbrev hook from moving backwards.
3665 ;;;
3667 "Expand each abbrev occurrence in the region.
3668 Calling from a program, arguments are START END."
3677 "Returns t if point is in a comment or quoted string.
3678 nil otherwise."
3682 "Returns location of the opening quote
3683 if point is in a IDL string constant, nil otherwise.
3684 Ignores comment delimiters on the current line.
3685 Properly handles nested quotation marks and octal
3686 constants - a double quote followed by an octal digit."
3687 ;;; Treat an octal inside an apostrophe to be a normal string. Treat a
3688 ;;; double quote followed by an octal digit to be an octal constant
3689 ;;; rather than a string. Therefore, there is no terminating double
3690 ;;; quote.
3692 ;; Because single and double quotes can quote each other we must
3693 ;; search for the string start from the beginning of line.
3699 delim
3700 found)
3702 ;; Find string start
3703 ;; Don't find an octal constant beginning with a double quote
3705 ;; Find the string end.
3706 ;; In IDL, two consecutive delimiters after the start of a
3707 ;; string act as an
3708 ;; escape for the delimiter in the string.
3709 ;; Two consecutive delimiters alone (i.e., not after the
3710 ;; start of a string) is the null string.
3712 ;; Move to position after quote
3715 ;; Get the string delimiter
3717 ;; Check for null string
3720 ;; Look for next unpaired delimiter
3728 ))
3731 ;; return string beginning position or nil
3735 "Determines if the character after point is a pointer dereference *."
3746 ;; Statement templates
3748 ;; Replace these with a general template function, something like
3749 ;; expand.el (I think there was also something with a name similar to
3750 ;; dmacro.el)
3753 "Build a template with optional prompt expression.
3755 Opens a line if point is not followed by a newline modulo intervening
3756 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3757 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3758 adjusted according to `idlwave-abbrev-change-case'. If optional argument
3759 PROMPT is a string then it is displayed as a message in the
3760 minibuffer. The PROMPT serves as a reminder to the user of an
3761 expression to enter.
3763 The lines containing S1 and S2 are reindented using `indent-region'
3764 unless the optional second argument NOINDENT is non-nil."
3766 ;; This is a gross hack to avoit template abbrev expansion
3767 ;; in the shell. FIXME: This is a dirty hack.
3777 end)
3790 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3793 string))
3796 "Build skeleton IDL if-else block."
3804 "Build skeleton IDL case statement."
3812 "Build skeleton IDL switch statement."
3820 "Build skeleton for loop statment."
3828 "Build skeleton for loop statment."
3864 "Return a list of substrings of STRING which are separated by PATTERN.
3878 end)
3886 ;; Return the buffer currently visiting FILE
3896 "List of buffer pulled up by idlwave for special reasons.
3900 ;; Return a buffer visiting file.
3904 buf)))
3907 "Kill buffers created automatically by IDLWAVE.
3908 Function prompts for a letter to identify the buffers to kill.
3909 Possible letters are:
3912 clicks in the routine info window.
3913 s Buffers created by the IDLWAVE Shell to display where execution
3914 stopped or an error was found.
3915 a Both of the above.
3917 Buffer containing unsaved changes require confirmation before they are killed."
3921 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3935 "How many outlawed buffers have tag TAG?"
3939 idlwave-outlawed-buffers))))
3942 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3945 entry)
3959 "Remove BUFFER from the buffers which may be killed.
3960 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3961 Intended for `after-save-hook'."
3964 ;; Revoke license
3968 ;; Remove this function from the hook.
3973 ;; Find FILE on the scanned lib path and return a buffer visiting it
3975 dir efile)
3983 ;; Find FILE on the scanned lib path and return a buffer visiting it
3984 ;; This is for, e.g., finding source with no user catalog
3991 "Creates the IDL tags file IDLTAGS in the current directory from
3992 the list of directories specified in the minibuffer. Directories may be
3993 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
3994 specified top directories are searched if the directory name is prefixed
3995 by @. Specify @ directories with care, it may take a long, long time if
3996 you specify /."
3999 buffer save_buffer files numfiles item errbuf)
4001 ;;
4002 ;; Read list of directories
4005 ;;
4006 ;; Set etags command, vars
4012 ;;
4013 ;; For each directory
4017 ;;
4018 ;; Find the subdirectories
4040 ;;
4041 ;; For each subdirectory
4045 ;;
4046 ;; Call etags
4055 0
4057 ;;
4058 ;; Append additional tags
4065 )))
4077 ))
4080 "Comment the lines in the region if the first non-blank line is
4081 commented, and conversely, uncomment region. If optional prefix arg
4082 N is non-nil, then for N positive, add N comment delimiters or for N
4083 negative, remove N comment delimiters.
4084 Uses `comment-region' which does not place comment delimiters on
4085 blank lines."
4092 ;; skip blank lines
4104 ;; ----------------------------------------------------------------------------
4105 ;; ----------------------------------------------------------------------------
4106 ;; ----------------------------------------------------------------------------
4107 ;; ----------------------------------------------------------------------------
4108 ;;
4109 ;; Completion and Routine Info
4110 ;;
4112 ;; String "intern" functions
4114 ;; For the completion and routine info function, we want to normalize
4115 ;; the case of procedure names etc. We do this by "interning" these
4116 ;; string is a hand-crafted way. Hashes are used to map the downcase
4117 ;; version of the strings to the cased versions. Most *-sint-*
4118 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4119 ;; system hash. The former is re-scanned, and the latter takes case
4120 ;; precedence.
4121 ;;
4122 ;; Since these cased versions are really lisp objects, we can use `eq'
4123 ;; to search, which is a large performance boost. All new strings
4124 ;; need to be "sinterned". We do this as early as possible after
4125 ;; getting these strings from completion or buffer substrings. So
4126 ;; most of the code can simply assume to deal with "sinterned"
4127 ;; strings. The only exception is that the functions which scan whole
4128 ;; buffers for routine information do not intern the grabbed strings.
4129 ;; This is only done afterwards. Therefore in these functions it is
4130 ;; *not* safe to assume the strings can be compared with `eq' and be
4131 ;; fed into the routine assq functions.
4133 ;; Here we define the hashing functions.
4135 ;; The variables which hold the hashes.
4144 "Reset all sintern hashes."
4145 ;; Make sure the hash functions are accessible.
4157 ;; Make sure these are lists
4162 ;; Reset the system & library hash
4170 idlwave-sint-libnames nil))
4172 ;; Reset the buffer & shell hash
4188 ;;(defmacro idlwave-sintern (type var)
4189 ;; `(cond ((not (stringp name)) name)
4190 ;; ((gethash (downcase name) (cdr ,var)))
4191 ;; ((gethash (downcase name) (car ,var)))
4192 ;; (set (idlwave-sintern-set name ,type ,var set))
4193 ;; (name)))
4233 iname))
4236 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4240 kwd-list)
4243 "Sintern all strings in the rinfo LIST. With optional parameter
4244 SET: also set new patterns. Probably this will always have to be t.
4245 If DEFAULT-DIR is passed, it is used as the base of the directory"
4257 ;; The class and name
4265 ;; The source
4278 ;; The keywords
4281 kwds))
4283 ;; Build a canonicalized list
4288 ;; Creating new sintern tables
4291 "Define a variable and a function to sintern the new type TAG.
4292 This defines the function `idlwave-sintern-TAG' and the variable
4293 `idlwave-sint-TAGs'."
4305 name)
4309 "Reset the sintern variable associated with TAG."
4312 ;;---------------------------------------------------------------------------
4315 ;; The variables which hold the information
4331 "Alist with !PATH directories and zero or more flags if the dir has
4332 been scanned in a user catalog ('user) or discovered in a library
4348 ;;
4349 ;; The code to get routine info from different sources.
4356 "Provide a list of IDL routines.
4357 This routine loads the builtin routines on the first call. Later it
4358 only returns the value of the variable."
4368 ;; Keep it running...
4369 )
4371 ;; Something is wrong, get rid of the process
4380 ;; return the current value
4381 idlwave-routines)))
4384 "List of functions which should run after a global rinfo update.
4388 "Rescan the previously selected directories. For batch processing."
4392 "Dispatch another Emacs instance to update the idlwave catalog.
4393 After the process finishes normally, the first access to routine info
4394 will re-read the catalog."
4418 nil emacs args)))
4421 process
4425 idlwave-system-routines nil
4426 idlwave-catalog-process nil)
4432 ;; Format for all routine info user catalog, library catalogs, etc.:
4433 ;;
4434 ;; ("ROUTINE" type class
4435 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4436 ;; (buffer pro_file dir) | (compiled pro_file dir)
4437 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4438 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4439 ;;
4440 ;; DIR will be supplied dynamically while loading library catalogs,
4441 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4442 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4443 ;; be nil, as can LINK1, etc., if no HTML help is available.
4450 "Update the internal routine-info lists.
4453 about individual routines.
4455 The information can come from 4 sources:
4456 1. IDL programs in the current editing session
4457 2. Compiled modules in an IDL shell running as Emacs subprocess
4458 3. A list which covers the IDL system routines.
4459 4. A list which covers the prescanned library files.
4461 Scans all IDLWAVE-mode buffers of the current editing session (see
4462 `idlwave-scan-all-buffers-for-routine-info').
4463 When an IDL shell is running, this command also queries the IDL program
4464 for currently compiled routines.
4466 With prefix ARG, also reload the system and library lists.
4467 With two prefix ARG's, also rescans the chosen user catalog tree.
4468 With three prefix args, dispatch asynchronous process to do the update.
4470 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4471 lists, but instead wait for the shell query to complete and
4472 asynchronously finish updating routine info. This is set
4473 automatically when called interactively. When you need routine
4474 information updated immediately, leave NO-CONCATENATE nil."
4476 ;; Stop any idle processing
4484 ;; Start a background process which updates the catalog.
4487 ;; Update the user catalog now, and wait for them.
4491 idlwave-buffer-case-takes-precedence
4493 ;; The override-idle means, even if the idle timer has done some
4494 ;; preparing work, load and renormalize everything anyway.
4498 idlwave-compiled-routines nil
4499 idlwave-unresolved-routines nil)
4500 ;; Reset the appropriate hashes
4502 ;; reset was already done in idle time, so skip this step now once
4509 ;; We can safely scan the buffer stuff first
4513 ;; We first do the system info, and then the buffers
4517 ;; Let's see if there is a shell
4521 idlwave-query-shell-for-routine-info)))
4523 ;; Load the library catalogs again, first re-scanning the path
4535 ;; 1. If we are not going to ask the shell, we need to do the
4536 ;; concatenation now.
4537 ;; 2. When this function is called non-interactively, it
4538 ;; means that someone needs routine info *now*. The
4539 ;; shell update causes the concatenation to be
4540 ;; *delayed*, so not in time for the current command.
4541 ;; Therefore, we do a concatenation now, even though
4542 ;; the shell might do it again.
4546 ;; Ask the shell about the routines it knows of.
4569 idlwave-init-rinfo-when-idle-after
4575 ;;------ XML Help routine info system
4577 ;; Load the system routine info from the cached routine info file,
4578 ;; which, if necessary, will be re-created from the XML file on
4579 ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo
4580 ;; file distributed with older IDLWAVE versions (<6.0)
4584 ;; See if we can create it from XML source
4604 idlwave-xml-system-rinfo-converted-file
4605 catalog-file)))
4609 "Alist of system variables and the associated structure tags.
4617 ;; From a list of syntax statments, shorten with %s and group with "or"
4626 x)
4631 ;; Create a class list entry from the xml parsed list., returning a
4632 ;; cons of form (class-entry method-entries).
4638 class-entry
4639 method methods-entry extra-kwds
4640 props get-props set-props init-props inherits
4641 pelem ptype)
4671 init-props)
4674 get-props)
4677 set-props)
4681 methods-entry)))
4684 ;(unless (get 'init-props 'matched)
4685 ; (message "Failed to match Init in class %s" class))
4686 ;(unless (get 'get-props 'matched)
4687 ; (message "Failed to match GetProperty in class %s" class))
4688 ;(unless (get 'set-props 'matched)
4689 ; (message "Failed to match SetProperty in class %s" class))
4697 ;; Create correctly structured list elements from ROUTINE or METHOD
4698 ;; XML list structures. Return a list of list elements, with more
4699 ;; than one sub-list possible if a routine can serve as both
4700 ;; procedure and function (e.g. call_method).
4707 syntax kwd klink pref-list kwds pelem ptype entry props result type)
4742 ;; Debug
4743 ; (if (and (null (aref syntax-vec 0))
4744 ; (null (aref syntax-vec 1))
4745 ; (null (aref syntax-vec 2)))
4746 ; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints")
4747 ; (if class
4748 ; (insert (format "Missing SYNTAX entry for %s::%s\n" class name))
4749 ; (insert (message "Missing SYNTAX entry for %s\n" name)))))
4751 ;; Executive commands are treated specially
4763 result)))
4767 ;; Group keywords by link file, as a list with elements
4768 ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2))
4780 ;; Ensure the master link is there
4783 linkfiles
4788 ;; Clean up the syntax of routines which are actually aliases by
4789 ;; removing the "OR" from the statements
4798 ;; Duplicate and trim original routine aliases from rinfo list
4799 ;; This if for, e.g. OPENR/OPENW/OPENU
4809 ;; Add any missing aliases (separate by slashes)
4824 ;; Duplicate and trim original routine aliases from rinfo list
4825 ;; This if for, e.g. !X, !Y, !Z.
4838 ;; Create a sysvar list entry from the xml parsed list.
4846 pelem ptype props fields tags)
4857 tags))))
4871 ;; Automatically generated from source file:
4876 idlwave-xml-routine-info-file))
4894 "Convert XML supplied IDL routine info into internal form.
4895 Cache to disk for quick recovery."
4901 props rinfo msg-cnt elem type nelem class-result alias
4902 routines routine-aliases statement-aliases sysvar-aliases
4903 version-string)
4913 ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff.
4924 idlwave-system-variables-alist nil
4925 idlwave-system-class-info nil
4926 idlwave-executive-commands-alist nil
4927 idlwave-help-special-topic-words nil)
4943 routine-aliases)
4948 ;; a cons cell is an executive commands
4960 idlwave-help-special-topic-words)
4961 ;; Save the links to those which are statement aliases (not routines)
4970 sysvar-aliases)
4972 idlwave-system-variables-alist)))
4983 ;; ("ROUTINE" type class
4984 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4985 ;; (buffer pro_file dir) | (compiled pro_file dir)
4986 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4987 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4997 ;;(load "idlw-rinfo" 'noerror 'nomessage)
5019 ;; Check for the old style catalog and warn
5022 idlwave-library-routines)
5027 idlwave-user-catalog-file))
5054 ;; restart the timer
5059 idlwave-init-rinfo-when-idle-after
5063 ;; Load and case-treat the system, user catalog, and library routine
5064 ;; info files.
5066 ;; System
5068 ;;(load "idlw-rinfo" 'noerror 'nomessage))
5080 ;; User catalog
5089 idlwave-library-routines)
5092 idlwave-user-catalog-file))
5101 ;; Library catalog
5112 ;; Scan all buffers, current buffer last
5117 ;; Don't scan any buffers
5120 ;; Just scan this buffer
5126 ;; Put the result into the correct variable
5131 "Put the different sources for routine information together."
5132 ;; The sequence here is important because earlier definitions shadow
5133 ;; later ones. We assume that if things in the buffers are newer
5134 ;; then in the shell of the system, they are meant to be different.
5137 idlwave-compiled-routines
5138 idlwave-library-catalog-routines
5139 idlwave-user-catalog-routines))
5142 ;; Give a message with information about the number of routines we have.
5145 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
5155 "Return the class alist - make it if necessary."
5162 idlwave-class-alist)))
5164 ;; Three functions for the hooks
5173 "Update idlwave-routines for current buffer. Can run from after-save-hook."
5177 idlwave-scan-all-buffers-for-routine-info
5178 idlwave-routines)
5184 nil
5190 routines)
5194 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
5196 found)
5198 ;; The following test uses eq to make sure it works correctly
5199 ;; when two buffers visit the same file. Then the file names
5200 ;; will be equal, but not eq.
5206 ;; End of that section reached. Jump.
5212 ;;----- Scanning buffers -------------------
5215 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
5221 buffer-file-name)
5222 ;; yes, this buffer has the right mode.
5227 ;; Concatenate the individual lists and return the result
5231 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
5233 routine-list string entry)
5247 routine-list))
5251 "Parse a module definition."
5253 start name args type keywords class)
5254 ;; Remove comments
5257 ;; Remove the continuation line stuff
5262 ;; Match the name and type.
5270 ;; Match normal args and keyword args
5273 string start)
5278 ;; Normalize and sort.
5282 ;; Make and return the entry
5283 ;; We don't know which argument are optional, so this information
5284 ;; will not be contained in the calling sequence.
5287 class
5290 ; ((string= (downcase
5291 ; (file-name-sans-extension
5292 ; (file-name-nondirectory (buffer-file-name))))
5293 ; (downcase name))
5294 ; (list 'lib))
5295 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
5301 "%s"
5309 nil))))
5312 ;;----- Scanning the user catalog -------------------
5315 "Return the syslib directory, or a dummy that never matches."
5319 idlwave-system-directory)
5325 "Scan all files on selected dirs of IDL search path for routine information.
5327 A widget checklist will allow you to choose the directories. Write
5328 the result as a file `idlwave-user-catalog-file'. When this file
5329 exists, will be automatically loaded to give routine information about
5330 library routines. With ARG, just rescan the same directories as last
5331 time - so no widget will pop up."
5333 ;; Make sure the file is loaded if it exists.
5339 ;; Make sure the file name makes sense
5345 idlwave-user-catalog-file))))
5349 ;; Rescan the known directories
5354 ;; Expand the directories from library-path and run the widget
5358 ;; Propagate any flags on the existing path-alist
5361 idlwave-true-path-alist)))
5368 ;; Ask the shell for the path and then run the widget
5377 ;; Parse shell path information and select among it.
5379 ;; Command hook used by `idlwave-create-user-catalog-file'.
5381 ;; Scan immediately
5383 ;; Set the path and display the widget
5389 "This is the front-end to the creation of the IDLWAVE user catalog.
5390 Please select the directories on IDL's search path from which you
5391 would like to extract routine information, to be stored in the file:
5393 %s
5395 If this is not the correct file, first set variable
5396 `idlwave-user-catalog-file', and call this command again.
5398 N.B. Many libraries include pre-scanned catalog files
5400 not be scanned. You can scan your own libraries off-line using the
5401 perl script `idlwave_catalog'.
5403 After selecting the directories, choose [Scan & Save] to scan the library
5404 directories and save the routine info.
5410 "Create the widget to select IDL search path directories for scanning."
5422 idlwave-user-catalog-file))
5433 :notify
5439 path-list)
5444 :notify
5449 path-list)
5463 'checklist
5467 dirs-list))
5468 :greedy t
5490 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
5495 dir-entry)
5501 selected-dirs)
5508 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5512 dirs-alist dir files file)
5514 idlwave-path-alist path-alist ; for library-path instead
5515 idlwave-true-path-alist nil)
5537 idlwave-user-catalog-routines)))))))))
5545 font-lock-mode)
5551 ;; Define the routine info list
5558 idlwave-user-catalog-routines))
5562 ;; Save the buffer
5568 idlwave-user-catalog-file)
5586 font-lock-mode)
5591 ;; Define the variable which knows the value of "!DIR"
5593 idlwave-system-directory))
5595 ;; Define the variable which contains a list of all scanned directories
5602 idlwave-path-alist))
5609 ;; Expand parts of path starting with '+' recursively into directory list.
5610 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5620 ;; Expand recursively
5622 ;; Keep unchanged
5628 ;; Return a list of all directories below DIR, including DIR itself
5637 path1))
5640 ;;----- Scanning the library catalogs ------------------
5646 "Scan for library catalog files (.idlwave_catalog) and ingest.
5648 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5649 instead, if present) are searched. Print MESSAGE-BASE along with the
5650 libraries being loaded, if passed, and skip loading/normalizing if
5651 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5652 be set to nil to disable library catalog scanning."
5659 dir-entry dir flags catalog all-routines)
5667 ;; Load the catalog file
5672 message-base
5674 old-libname)))
5676 idlwave-library-catalog-libname))
5683 all-routines))))
5685 ;; Add a 'lib flag if on path-alist
5692 ;;----- Communicating with the Shell -------------------
5694 ;; First, here is the idl program which can be used to query IDL for
5695 ;; defined routines.
5697 "
5698 ;; START OF IDLWAVE SUPPORT ROUTINES
5699 pro idlwave_print_safe,item,limit
5700 catch,err
5701 if err ne 0 then begin
5702 print,'Could not print item.'
5703 return
5704 endif
5705 if n_elements(item) gt limit then $
5706 print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $
5707 else print,item
5708 end
5710 pro idlwave_print_info_entry,name,func=func,separator=sep
5711 ;; See if it's an object method
5712 if name eq '' then return
5713 func = keyword_set(func)
5714 methsep = strpos(name,'::')
5715 meth = methsep ne -1
5717 ;; Get routine info
5718 pars = routine_info(name,/parameters,functions=func)
5719 source = routine_info(name,/source,functions=func)
5720 nargs = pars.num_args
5721 nkw = pars.num_kw_args
5722 if nargs gt 0 then args = pars.args
5723 if nkw gt 0 then kwargs = pars.kw_args
5725 ;; Trim the class, and make the name
5726 if meth then begin
5727 class = strmid(name,0,methsep)
5728 name = strmid(name,methsep+2,strlen(name)-1)
5729 if nargs gt 0 then begin
5730 ;; remove the self argument
5731 wh = where(args ne 'SELF',nargs)
5732 if nargs gt 0 then args = args[wh]
5733 endif
5734 endif else begin
5735 ;; No class, just a normal routine.
5737 endelse
5739 ;; Calling sequence
5741 if func then cs = 'Result = '
5742 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5743 cs = cs + '%s'
5744 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5745 if nargs gt 0 then begin
5746 for j=0,nargs-1 do begin
5747 cs = cs + args[j]
5748 if j lt nargs-1 then cs = cs + ', '
5749 endfor
5750 end
5751 if func then cs = cs + ')'
5752 ;; Keyword arguments
5753 kwstring = ''
5754 if nkw gt 0 then begin
5755 for j=0,nkw-1 do begin
5756 kwstring = kwstring + ' ' + kwargs[j]
5757 endfor
5758 endif
5760 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5762 print,ret + ': ' + name + sep + class + sep + source[0].path $
5763 + sep + cs + sep + kwstring
5764 end
5766 pro idlwave_routine_info,file
5767 on_error,1
5768 sep = '<@>'
5770 all = routine_info()
5771 fileQ=n_elements(file) ne 0
5772 if fileQ then file=strtrim(file,2)
5773 for i=0L,n_elements(all)-1L do begin
5774 if fileQ then begin
5775 if (routine_info(all[i],/SOURCE)).path eq file then $
5776 idlwave_print_info_entry,all[i],separator=sep
5777 endif else idlwave_print_info_entry,all[i],separator=sep
5778 endfor
5779 all = routine_info(/functions)
5780 for i=0L,n_elements(all)-1L do begin
5781 if fileQ then begin
5782 if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $
5783 idlwave_print_info_entry,all[i],separator=sep,/FUNC
5784 endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC
5785 endfor
5786 print,'>>>END OF IDLWAVE ROUTINE INFO'
5787 end
5789 pro idlwave_get_sysvars
5790 on_error,1
5791 catch,error_status
5792 if error_status ne 0 then begin
5793 print, 'Cannot get info about system variables'
5794 endif else begin
5795 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5796 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5797 v = strsplit(s,' +',/regex,/extract) ; get variables
5798 for i=0L,n_elements(v)-1 do begin
5799 t = [''] ; get tag list
5800 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5801 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5802 endfor
5803 endelse
5804 end
5806 pro idlwave_get_class_tags, class
5807 res = execute('tags=tag_names({'+class+'})')
5808 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5809 end
5810 ;; END OF IDLWAVE SUPPORT ROUTINES
5811 "
5833 (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5838 ;; Restore if necessary. Must use execute to hide lame routine_info
5839 ;; errors on undefinded routine
5841 (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'"
5842 idlwave-shell-temp-rinfo-save-file
5843 idlwave-shell-temp-rinfo-save-file)
5848 "Query the shell for routine_info of compiled modules and update the lists."
5849 ;; Save and compile the procedure. The compiled procedure is then
5850 ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may
5851 ;; need to test for and possibly RESTORE the procedure each time we
5852 ;; use it, since the user may have killed or redefined it. In
5853 ;; particular, .RESET_SESSION will kill all user procedures. If
5854 ;; FILE is set, only update routine info for routines in that file.
5857 ; execute the routine_info procedure, and analyze the output
5865 ;; ---------------------------------------------------------------------------
5866 ;;
5867 ;; Completion and displaying routine calling sequences
5875 "Complete a function, procedure or keyword name at point.
5876 This function is smart and figures out what can be completed
5877 at this point.
5878 - At the beginning of a statement it completes procedure names.
5879 - In the middle of a statement it completes function names.
5880 - after a `(' or `,' in the argument list of a function or procedure,
5881 it completes a keyword of the relevant function or procedure.
5882 - In the first arg of `OBJ_NEW', it completes a class name.
5884 When several completions are possible, a list will be displayed in the
5885 *Completions* buffer. If this list is too long to fit into the
5886 window, scrolling can be achieved by repeatedly pressing
5889 The function also knows about object methods. When it needs a class
5890 name, the action depends upon `idlwave-query-class', which see. You
5891 can force IDLWAVE to ask you for a class name with a
5894 See also the variables `idlwave-keyword-completion-adds-equal' and
5895 `idlwave-function-completion-adds-paren'.
5897 The optional ARG can be used to specify the completion type in order
5898 to override IDLWAVE's idea of what should be completed at point.
5899 Possible values are:
5901 0 <=> query for the completion type
5902 1 <=> 'procedure
5903 2 <=> 'procedure-keyword
5904 3 <=> 'function
5905 4 <=> 'function-keyword
5906 5 <=> 'procedure-method
5907 6 <=> 'procedure-method-keyword
5908 7 <=> 'function-method
5909 8 <=> 'function-method-keyword
5910 9 <=> 'class
5912 As a special case, the universal argument C-u forces completion of
5913 function names in places where the default would be a keyword.
5915 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5916 completion.
5918 For Lisp programmers only:
5919 When we force a keyword, optional argument MODULE can contain the module name.
5920 When we force a method or a method keyword, CLASS can specify the class."
5947 ;; Complete a filename in quotes
5952 ;; Check for any special completion functions
5959 ;; Complete a class
5965 ;; Complete a procedure name
5978 isa
5984 isa
5988 ;; Complete a function name
6001 isa
6007 isa
6015 ;; Complete a procedure keyword
6032 super-classes system))
6044 isa
6048 ;; Complete a function keyword
6061 msg-name)
6066 super-classes system))
6067 ;; OBJ_NEW: Messages mention the proper Init method
6074 msg-name))
6083 isa
6089 "List of special completion functions.
6090 These functions are called for each completion. Each function must
6091 check if its own special completion context is present. If yes, it
6092 should use `idlwave-complete-in-buffer' to do some completion and
6093 return t. If such a function returns t, *no further* attempts to
6094 complete other contexts will be done. If the function returns nil,
6099 fun ret)
6104 nil)))
6107 ;; Return an artificial WHERE specification to force the completion
6108 ;; routine to complete a specific item independent of context.
6109 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
6110 ;; MODULE and CLASS can be used to specify the routine name and class.
6111 ;; The class name will also be found in MODULE if that is like "class::mod".
6129 what)
6202 ;; Completing read, case insensitive
6212 "Use the comint stuff to complete a file name."
6220 idlwave-shell-default-directory
6221 default-directory)))
6225 ;; Make a fully qualified module name including the class name
6229 "Like `idlwave-rinfo-assq', but sintern strings first."
6235 ;; Works like assq, but also checks type and class
6246 ;; Return the first matching method on the inheritance list
6248 class rtn)
6252 rtn))
6255 keep-system)
6256 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
6257 If WITH-FILE is passed, find the best rinfo entry with a file
6258 included. If KEEP-SYSTEM is set, don't prune system for compiled
6259 syslib files."
6262 list))
6263 syslibp)
6270 ;; Its a compiled syslib, so we need to remove the system entry
6276 twins)))))
6280 keep-system)
6281 "Like `idlwave-best-rinfo-assq', but sintern strings first."
6287 "Does the entry list ENTRIES contain a syslib entry?
6288 If yes, return the index (>=1)."
6297 nil)))
6300 "Return a list of all associations of Key in LIST."
6308 "Return all classes which have a method METHOD. TYPE is 'fun or 'pro.
6309 When TYPE is not specified, both procedures and functions will be considered."
6322 "Return all classes which have a method METHOD with keyword KEYWORD.
6323 TYPE is 'fun or 'pro.
6324 When TYPE is not specified, both procedures and functions will be considered."
6327 nil
6339 "Return list of all elements in LIST which are also in CLUB."
6348 "Return list of all elements in LIST which are not in CLUB."
6352 nil
6358 "Return whether or not the class is listed explicitly, ala a->b::c.
6359 INFO is as returned by idlwave-what-function or -procedure."
6366 "List of special functions for determining class.
6370 ;; Determine the class of a routine call.
6371 ;; INFO is the `cw-list' structure as returned by idlwave-where.
6372 ;; The second element in this structure is the class. When nil, we
6373 ;; return nil. When t, try to get the class from text properties at
6374 ;; the arrow. When the object is "self", we use the class of the
6375 ;; current routine. otherwise prompt the user for a class name.
6376 ;; Also stores the selected class as a text property at the arrow.
6377 ;; TYPE is 'fun or 'pro.
6383 idlwave-query-class))
6385 idlwave-query-class))
6397 store special-class class-alist)
6401 ;; There is an object which would like to know its class
6403 idlwave-store-inquired-class
6410 ;; Before prompting, try any special class determination routines
6412 idlwave-determine-class-special
6418 store idlwave-store-inquired-class)))
6420 ;; Prompt for a class, if we need to
6441 ;; Store it, if requested
6443 ;; We have a real class here
6449 rear-nonsticky t))
6452 ;; Return the class
6453 class)
6454 ;; Default as fallback
6468 ;; Record a file link, if any, for the tested names during selection.
6472 sel))
6476 "Find out where we are.
6477 The return value is a list with the following stuff:
6478 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
6480 PRO-LIST (PRO POINT CLASS ARROW)
6481 FUNC-LIST (FUNC POINT CLASS ARROW)
6482 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
6483 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
6484 be completed here.
6485 LAST-CHAR last relevant character before point (non-white non-comment,
6486 not part of current identifier or leading slash).
6488 In the lists, we have these meanings:
6489 PRO: Procedure name
6490 FUNC: Function name
6491 POINT: Where is this
6492 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
6493 ARROW: Location of the arrow"
6511 cw cw-mod cw-arrow cw-class cw-point)
6515 match-string)
6521 match-string))
6523 cw-arrow pro-arrow))
6525 match-string)
6526 nil)
6528 match-string)
6531 match-string)
6538 cw-class func-class cw-arrow func-arrow))
6541 cw-class pro-class cw-arrow pro-arrow))
6542 ; ((member last-char '(?\' ?\) ?\] ?!))
6543 ; ;; after these chars, a function makes no sense
6544 ; ;; FIXME: I am sure there can be more in this list
6545 ; ;; FIXME: Do we want to do this at all?
6546 ; nil)
6547 ;; Everywhere else we try a function.
6551 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t)
6555 t))))))
6558 cw
6560 last-char)))
6563 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6571 ;; Find out if point is within the argument list of a function.
6572 ;; The return value is ("function-name" class arrow-start (point) level).
6573 ;; Level is 1 on the top level parentheses, higher further down.
6575 ;; If the optional BOUND is an integer, bound backwards directed
6576 ;; searches to this point.
6580 func-point
6582 func arrow-start class)
6587 ;; move back out of the current parenthesis
6596 bound t))
6599 pos func-point)
6605 'exit
6609 arrow-start func-point cnt)))
6614 ;; Find out if point is within the argument list of a procedure.
6615 ;; The return value is ("procedure-name" class arrow-pos (point)).
6617 ;; If the optional BOUND is an integer, bound backwards directed
6618 ;; searches to this point.
6620 pro class arrow-start string)
6622 ;;(idlwave-beginning-of-statement)
6632 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6633 string))
6638 pos)
6643 arrow-start
6644 pro-point)))
6647 ;; If there is an object at point, move over it and return t.
6657 nil)
6675 nil)))
6678 "Return the last character before point which is not white or a comment
6679 and also not part of the current identifier. Since we do this in
6680 order to identify places where keywords are, we consider the initial
6681 `/' of a keyword as part of the identifier.
6682 This function is not general, can only be used for completion stuff."
6685 ;; skip the current identifier
6687 ;; also skip a leading slash which might be belong to the keyword
6690 ;; FIXME: does not check if this is a valid identifier
6698 ;; continuation line
6711 &optional prepare-display-function
6712 special-selector)
6713 "Perform TYPE completion of word before point against LIST.
6714 SELECTOR is the PREDICATE argument for the completion function. Show
6715 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6716 'procedure, 'class-tag, 'keyword, 'sysvar, etc.. SPECIAL-SELECTOR is
6717 used only once, for `all-completions', and can be used to, e.g.,
6718 accumulate information on matching completions."
6721 dpart dcompletion)
6726 ;; What is already in the buffer?
6731 idlwave-complete-after-success-form
6734 idlwave-complete-after-success-form-force
6738 ;; Try a completion
6744 idlwave-completion-help-links nil)
6747 ;; nothing available.
6751 ;; We can add something
6755 idlwave-complete-empty-string-as-lower-case)
6760 ;; Now this is a unique match
6762 t)
6768 selector))))))
6770 ;; This is already complete
6773 nil)
6775 ;; We cannot add something - offer a list.
6783 idlwave-completion-help-links))))
6784 list))
6786 ;; "complete" means, this is already a valid completion
6789 ; (completion-fixup-function ; Emacs
6790 ; (lambda () (and (eq (preceding-char) ?>)
6791 ; (re-search-backward " <" beg t)))))
6799 idlwave-complete-empty-string-as-lower-case)
6805 x)
6806 list)))
6808 t))))
6811 "Complete a class at point."
6813 ;; Call `idlwave-routines' to make sure the class list will be available
6815 ;; Check for the special case of completing empty string after pro/function
6824 ;; Yank the full class specification
6826 ;; Do the completion, using list gathered from `idlwave-routines'
6835 idlwave-completion-help-links))
6836 x))
6837 list)))))
6840 ;; Attach the proper class list to a LIST of completion items.
6841 ;; TYPE, when 'kwd, shows classes for method keywords, when
6842 ;; 'class-tag, for class tags, and otherwise for methods.
6843 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6849 ;; In these cases, we do not have to do anything
6850 list
6854 ;; (do-dots (featurep 'xemacs))
6860 classes nclasses class-info space)
6863 ;; get the classes
6865 ;; Just one class for tags
6869 ;; Multiple classes for method or method-keyword
6873 method-selector x type-selector)
6879 classes)))))
6881 ;; Make the separator between item and class-info
6886 ;; We do want info in the buffer
6889 space
6894 ;; We do want properties
6898 x))
6901 x))
6902 list))))
6905 ;; Call idlwave-attach-classes with method parameters
6908 ;; Call idlwave-attach-classes with keyword parameters
6911 ;; Call idlwave-attach-classes with class structure tags
6915 ;;----------------------------------------------------------------------
6916 ;;----------------------------------------------------------------------
6917 ;;----------------------------------------------------------------------
6918 ;;----------------------------------------------------------------------
6919 ;;----------------------------------------------------------------------
6925 "Select an item in LIST with a popup menu.
6926 TITLE is the title to put atop the popup. If SORT is non-nil,
6927 sort the list before displaying"
6929 rtn menu resp)
6939 x)))
6940 list)))
6953 rtn))
6956 "Split the MENU into submenus of maximum length N."
6958 ;; No splitting needed
6959 menu
6974 nextmenu))
6976 nextmenu nil
6981 "Split the MENU into submenus of maximum length N."
6983 ;; No splitting needed
6984 menu
7000 nextmenu))
7002 nextmenu nil
7006 menu)))
7011 "Scroll the completion window on this frame."
7029 "Display the completions in LIST in the completions buffer and echo MESSAGE."
7037 list)
7040 ;; Store a special value in `this-command'. When `idlwave-complete'
7041 ;; finds this in `last-command', it will scroll the *Completions* buffer.
7044 ;; Mark the completions buffer as created by cib
7047 ;; Fontify the classes
7052 ;; Run the hook
7055 ;; Display the message
7059 "Call FUNCTION as a completion chooser and pass ARGS to it."
7065 ;; For the shell, remove the fontification of the word before point
7080 "Restore the old (before completion) window configuration."
7082 idlwave-before-completion-wconf
7086 "Make the user select an element from the alist in the variable SYM.
7087 The keys of the alist are expected to be strings. The function returns the
7088 car of the selected association.
7089 To do this, PROMPT is displayed and the user must hit a letter key to
7090 select an entry. If the user does not reply within DELAY seconds, a help
7091 window with the options is displayed automatically.
7092 The key which is associated with each option is generated automatically.
7094 If these don't exist, a letter in the string is automatically selected."
7098 keys-alist char)
7099 ;; First check the cache
7102 ;; Need to make new list
7106 ;; Display prompt and wait for quick reply
7111 ;; No quick reply: Show help
7117 keys-alist))
7121 ;; Return the selected result
7124 ;; Used for, e.g., electric debug super-examine.
7126 "Make an alist for single key selection."
7134 ;; First check if the configuration predetermined a key
7141 ;; Then check for capital letters
7151 t t name))
7154 ;; Now check for lowercase letters
7164 t t name))
7167 ;; Bummer, nothing found! Use a stupid number
7174 "Set the buffer-local value of VAR in BUFFER to VALUE."
7180 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
7186 ;; In XEmacs, we can use :activate-callback directly to advice the
7187 ;; choose functions. We use the private keymap only for the online
7188 ;; help feature.
7197 cl-args))
7207 "Execute `default-choose-completion' and then restore the win-conf."
7211 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7214 (define-key new-map [button3] (lambda ()
7215 (interactive)
7216 (setq this-command last-command)))
7217 new-map))
7219 ;; In Emacs we also replace keybindings in the completion
7220 ;; map in order to install our wrappers.
7222 (defun idlwave-display-completion-list-emacs (list)
7223 "Display completion list and install the choose wrappers."
7224 (with-output-to-temp-buffer "*Completions*"
7225 (display-completion-list list))
7226 (save-excursion
7227 (set-buffer "*Completions*")
7228 (use-local-map
7229 (or idlwave-completion-map
7230 (setq idlwave-completion-map
7231 (idlwave-make-modified-completion-map-emacs
7232 (current-local-map)))))))
7234 (defun idlwave-make-modified-completion-map-emacs (old-map)
7235 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7236 (let ((new-map (copy-keymap old-map)))
7237 (substitute-key-definition
7238 'choose-completion 'idlwave-choose-completion new-map)
7239 (substitute-key-definition
7240 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
7241 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
7242 new-map))
7244 (defun idlwave-choose-completion (&rest args)
7245 "Choose the completion that point is in or next to."
7246 (interactive)
7247 (apply 'idlwave-choose 'choose-completion args))
7249 (defun idlwave-mouse-choose-completion (&rest args)
7250 "Click on an alternative in the `*Completions*' buffer to choose it."
7251 (interactive "e")
7252 (apply 'idlwave-choose 'mouse-choose-completion args))
7254 ;;----------------------------------------------------------------------
7255 ;;----------------------------------------------------------------------
7257 ;;; ------------------------------------------------------------------------
7258 ;;; Stucture parsing code, and code to manage class info
7260 ;;
7261 ;; - Go again over the documentation how to write a completion
7262 ;; plugin. It is in self.el, but currently still very bad.
7263 ;; This could be in a separate file in the distribution, or
7264 ;; in an appendix for the manual.
7266 (defvar idlwave-struct-skip
7268 "Regexp for skipping continued blank or comment-only lines in
7269 structures")
7271 (defvar idlwave-struct-tag-regexp
7272 (concat "[{,]" ;leading comma/brace
7273 idlwave-struct-skip ; 4 groups
7276 "Regexp for structure tags.")
7278 (defun idlwave-struct-tags ()
7279 "Return a list of all tags in the structure defined at point.
7280 Point is expected just before the opening `{' of the struct definition."
7281 (save-excursion
7282 (let* ((borders (idlwave-struct-borders))
7283 (beg (car borders))
7284 (end (cdr borders))
7285 tags)
7286 (goto-char beg)
7287 (save-restriction
7288 (narrow-to-region beg end)
7289 (while (re-search-forward idlwave-struct-tag-regexp end t)
7290 ;; Check if we are still on the top level of the structure.
7291 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7292 (= (point) beg))
7293 (push (match-string-no-properties 5) tags))
7294 (goto-char (match-end 0))))
7295 (nreverse tags))))
7297 (defun idlwave-find-struct-tag (tag)
7298 "Find a given TAG in the structure defined at point."
7299 (let* ((borders (idlwave-struct-borders))
7300 (beg (car borders))
7301 (end (cdr borders))
7302 (case-fold-search t))
7304 end t)))
7306 (defun idlwave-struct-inherits ()
7307 "Return a list of all `inherits' names in the struct at point.
7308 Point is expected just before the opening `{' of the struct definition."
7309 (save-excursion
7310 (let* ((borders (idlwave-struct-borders))
7311 (beg (car borders))
7312 (end (cdr borders))
7313 (case-fold-search t)
7314 names)
7315 (goto-char beg)
7316 (save-restriction
7317 (narrow-to-region beg end)
7318 (while (re-search-forward
7319 (concat "[{,]" ;leading comma/brace
7320 idlwave-struct-skip ; 4 groups
7321 "inherits" ; The INHERITS tag
7322 idlwave-struct-skip ; 4 more
7324 end t)
7325 ;; Check if we are still on the top level of the structure.
7326 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7327 (= (point) beg))
7328 (push (match-string-no-properties 9) names))
7329 (goto-char (match-end 0))))
7330 (nreverse names))))
7332 (defun idlwave-in-structure ()
7333 "Return t if point is inside an IDL structure definition."
7334 (let ((beg (point)))
7335 (save-excursion
7336 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
7337 (if (idlwave-find-structure-definition nil nil 'back)
7338 (let ((borders (idlwave-struct-borders)))
7339 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
7340 (and (> beg (car borders)) (< beg (cdr borders))))))))))
7342 (defun idlwave-struct-borders ()
7343 "Return the borders of the {...} after point as a cons cell."
7344 (let (beg)
7345 (save-excursion
7346 (skip-chars-forward "^{")
7347 (setq beg (point))
7348 (condition-case nil (forward-list 1)
7349 (error (goto-char beg)))
7350 (cons beg (point)))))
7352 (defun idlwave-find-structure-definition (&optional var name bound)
7353 "Search forward for a structure definition. If VAR is non-nil,
7354 search for a structure assigned to variable VAR. If NAME is non-nil,
7355 search for a named structure NAME, if a string, or a generic named
7356 structure otherwise. If BOUND is an integer, limit the search. If
7357 BOUND is the symbol `all', we search first back and then forward
7358 through the entire file. If BOUND is the symbol `back' we search only
7359 backward."
7361 (case-fold-search t)
7362 (lim (if (integerp bound) bound nil))
7363 (re (concat
7364 (if var
7368 (if name
7369 (if (stringp name)
7371 ;; Just a generic name
7373 ""))))
7374 (if (or (and (or (eq bound 'all) (eq bound 'back))
7375 (re-search-backward re nil t))
7376 (and (not (eq bound 'back)) (re-search-forward re lim t)))
7377 (progn
7378 (goto-char (match-beginning 3))
7379 (match-string-no-properties 5)))))
7381 (defvar idlwave-class-info nil)
7382 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
7384 (add-hook 'idlwave-update-rinfo-hook
7385 (lambda () (setq idlwave-class-reset t)))
7386 (add-hook 'idlwave-after-load-rinfo-hook
7387 (lambda () (setq idlwave-class-info nil)))
7389 (defun idlwave-class-info (class)
7390 (let (list entry)
7391 (if idlwave-class-info
7392 (if idlwave-class-reset
7393 (setq
7394 idlwave-class-reset nil
7395 idlwave-class-info ; Remove any visited in a buffer
7396 (delq nil (mapcar
7397 (lambda (x)
7398 (let ((filebuf
7399 (idlwave-class-file-or-buffer
7400 (or (cdr (assq 'found-in x)) (car x)))))
7401 (if (cdr filebuf)
7402 nil
7403 x)))
7404 idlwave-class-info))))
7405 ;; Info is nil, put in the system stuff to start.
7406 (setq idlwave-class-info idlwave-system-class-info)
7407 (setq list idlwave-class-info)
7408 (while (setq entry (pop list))
7409 (idlwave-sintern-class-info entry)))
7410 (setq class (idlwave-sintern-class class))
7411 (or (assq class idlwave-class-info)
7412 (progn (idlwave-scan-class-info class)
7413 (assq class idlwave-class-info)))))
7415 (defun idlwave-sintern-class-info (entry)
7416 "Sintern the class names in a class-info entry."
7417 (let ((taglist (assq 'tags entry))
7418 (inherits (assq 'inherits entry)))
7419 (setcar entry (idlwave-sintern-class (car entry) 'set))
7420 (if inherits
7421 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
7422 (cdr inherits))))))
7424 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
7425 "Find class structure definition(s)
7426 If ALL-HOOK is set, find all named structure definitions in a given
7427 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
7428 set, look for the name__define pro, and inside of it, for the ALT-CLASS
7429 class/struct definition"
7430 (let ((case-fold-search t) end-lim list name)
7431 (when (re-search-forward
7433 (if all-hook
7434 (progn
7435 ;; For everything there
7436 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
7437 (while (setq name
7438 (idlwave-find-structure-definition nil t end-lim))
7439 (funcall all-hook name)))
7440 (idlwave-find-structure-definition nil (or alt-class class))))))
7443 (defun idlwave-class-file-or-buffer (class)
7444 "Find buffer visiting CLASS definition"
7445 (let* ((pro (concat (downcase class) "__define"))
7446 (file (idlwave-routine-source-file
7447 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
7448 (idlwave-routines))))))
7449 (cons file (if file (idlwave-get-buffer-visiting file)))))
7452 (defun idlwave-scan-class-info (class)
7453 "Scan all class and named structure info in the class__define pro"
7454 (let* ((idlwave-auto-routine-info-updates nil)
7455 (filebuf (idlwave-class-file-or-buffer class))
7456 (file (car filebuf))
7457 (buf (cdr filebuf))
7458 (class (idlwave-sintern-class class)))
7459 (if (or
7460 (not file)
7461 (and ;; neither a regular file nor a visited buffer
7462 (not buf)
7463 (not (file-regular-p file))))
7464 nil ; Cannot find the file/buffer to get any info
7465 (save-excursion
7466 (if buf (set-buffer buf)
7467 ;; Read the file in temporarily
7468 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
7469 (erase-buffer)
7470 (unless (eq major-mode 'idlwave-mode)
7471 (idlwave-mode))
7472 (insert-file-contents file))
7473 (save-excursion
7474 (goto-char 1)
7475 (idlwave-find-class-definition class
7476 ;; Scan all of the structures found there
7477 (lambda (name)
7478 (let* ((this-class (idlwave-sintern-class name))
7479 (entry
7480 (list this-class
7481 (cons 'tags (idlwave-struct-tags))
7482 (cons 'inherits (idlwave-struct-inherits)))))
7483 (if (not (eq this-class class))
7484 (setq entry (nconc entry (list (cons 'found-in class)))))
7485 (idlwave-sintern-class-info entry)
7486 (push entry idlwave-class-info)))))))))
7488 (defun idlwave-class-found-in (class)
7489 "Return the FOUND-IN property of the class."
7490 (cdr (assq 'found-in (idlwave-class-info class))))
7491 (defun idlwave-class-tags (class)
7492 "Return the native tags in CLASS."
7493 (cdr (assq 'tags (idlwave-class-info class))))
7494 (defun idlwave-class-inherits (class)
7495 "Return the direct superclasses of CLASS."
7496 (cdr (assq 'inherits (idlwave-class-info class))))
7499 (defun idlwave-all-class-tags (class)
7500 "Return a list of native and inherited tags in CLASS."
7501 (condition-case err
7502 (apply 'append (mapcar 'idlwave-class-tags
7503 (cons class (idlwave-all-class-inherits class))))
7504 (error
7505 (idlwave-class-tag-reset)
7506 (error "%s" (error-message-string err)))))
7509 (defun idlwave-all-class-inherits (class)
7510 "Return a list of all superclasses of CLASS (recursively expanded).
7511 The list is cached in `idlwave-class-info' for faster access."
7512 (cond
7513 ((not idlwave-support-inheritance) nil)
7514 ((eq class nil) nil)
7515 ((eq class t) nil)
7516 (t
7517 (let ((info (idlwave-class-info class))
7518 entry)
7519 (if (setq entry (assq 'all-inherits info))
7520 (cdr entry)
7521 ;; Save the depth of inheritance scan to check for circular references
7522 (let ((inherits (mapcar (lambda (x) (cons x 0))
7523 (idlwave-class-inherits class)))
7524 rtn all-inherits cl)
7525 (while inherits
7526 (setq cl (pop inherits)
7527 rtn (cons (car cl) rtn)
7528 inherits (append (mapcar (lambda (x)
7529 (cons x (1+ (cdr cl))))
7530 (idlwave-class-inherits (car cl)))
7531 inherits))
7532 (if (> (cdr cl) 999)
7533 (error
7534 "Class scan: inheritance depth exceeded. Circular inheritance?")
7535 ))
7536 (setq all-inherits (nreverse rtn))
7537 (nconc info (list (cons 'all-inherits all-inherits)))
7538 all-inherits))))))
7540 (defun idlwave-entry-keywords (entry &optional record-link)
7541 "Return the flat entry keywords alist from routine-info entry.
7542 If RECORD-LINK is non-nil, the keyword text is copied and a text
7543 property indicating the link is added."
7544 (let (kwds)
7545 (mapc
7546 (lambda (key-list)
7547 (let ((file (car key-list)))
7548 (mapcar (lambda (key-cons)
7549 (let ((key (car key-cons))
7550 (link (cdr key-cons)))
7551 (when (and record-link file)
7552 (setq key (copy-sequence key))
7553 (put-text-property
7554 0 (length key)
7555 'link
7556 (concat
7557 file
7558 (if link
7559 (concat idlwave-html-link-sep
7560 (number-to-string link))))
7561 key))
7562 (push (list key) kwds)))
7563 (cdr key-list))))
7564 (nthcdr 5 entry))
7565 (nreverse kwds)))
7567 (defun idlwave-entry-find-keyword (entry keyword)
7568 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set"
7569 (catch 'exit
7570 (mapc
7571 (lambda (key-list)
7572 (let ((file (car key-list))
7573 (kwd (assoc keyword (cdr key-list))))
7574 (when kwd
7575 (setq kwd (cons (car kwd)
7576 (if (and file (cdr kwd))
7577 (concat file
7578 idlwave-html-link-sep
7579 (number-to-string (cdr kwd)))
7580 (cdr kwd))))
7581 (throw 'exit kwd))))
7582 (nthcdr 5 entry))))
7584 ;;==========================================================================
7585 ;;
7586 ;; Completing class structure tags. This is a completion plugin.
7587 ;; The necessary taglist is constructed dynamically
7589 (defvar idlwave-current-tags-class nil)
7590 (defvar idlwave-current-class-tags nil)
7591 (defvar idlwave-current-native-class-tags nil)
7592 (defvar idlwave-sint-class-tags nil)
7593 (declare-function idlwave-sintern-class-tag "idlwave" t t)
7594 (idlwave-new-sintern-type 'class-tag)
7595 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7596 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7598 (defun idlwave-complete-class-structure-tag ()
7599 "Complete a structure tag on a `self' argument in an object method."
7600 (interactive)
7601 (let ((pos (point))
7602 (case-fold-search t))
7603 (if (save-excursion
7604 ;; Check if the context is right
7605 (skip-chars-backward "a-zA-Z0-9._$")
7606 (and (< (point) (- pos 4))
7608 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7609 (super-classes (idlwave-all-class-inherits class-selector)))
7610 ;; Check if we are in a class routine
7611 (unless class-selector
7612 (error "Not in a method procedure or function"))
7613 ;; Check if we need to update the "current" class
7614 (if (not (equal class-selector idlwave-current-tags-class))
7615 (idlwave-prepare-class-tag-completion class-selector))
7616 (setq idlwave-completion-help-info
7617 (list 'idlwave-complete-class-structure-tag-help
7618 (idlwave-sintern-routine
7619 (concat class-selector "__define"))
7620 nil))
7621 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7622 (idlwave-complete-in-buffer
7623 'class-tag 'class-tag
7624 idlwave-current-class-tags nil
7625 (format "Select a tag of class %s" class-selector)
7626 "class tag"
7627 'idlwave-attach-class-tag-classes))
7628 t) ; return t to skip other completions
7629 nil)))
7631 (defun idlwave-class-tag-reset ()
7632 (setq idlwave-current-tags-class nil))
7634 (defun idlwave-prepare-class-tag-completion (class)
7635 "Find and parse the necessary class definitions for class structure tags."
7636 (setq idlwave-sint-class-tags nil)
7637 (setq idlwave-current-tags-class class)
7638 (setq idlwave-current-class-tags
7639 (mapcar (lambda (x)
7640 (list (idlwave-sintern-class-tag x 'set)))
7641 (idlwave-all-class-tags class)))
7642 (setq idlwave-current-native-class-tags
7643 (mapcar 'downcase (idlwave-class-tags class))))
7645 ;===========================================================================
7646 ;;
7647 ;; Completing system variables and their structure fields
7648 ;; This is also a plugin.
7650 (defvar idlwave-sint-sysvars nil)
7651 (defvar idlwave-sint-sysvartags nil)
7652 (declare-function idlwave-sintern-sysvar "idlwave" t t)
7653 (declare-function idlwave-sintern-sysvartag "idlwave" t t)
7654 (idlwave-new-sintern-type 'sysvar)
7655 (idlwave-new-sintern-type 'sysvartag)
7656 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7657 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7658 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7661 (defun idlwave-complete-sysvar-or-tag ()
7662 "Complete a system variable."
7663 (interactive)
7664 (let ((pos (point))
7665 (case-fold-search t))
7666 (cond ((save-excursion
7667 ;; Check if the context is right for system variable
7668 (skip-chars-backward "[a-zA-Z0-9_$]")
7669 (equal (char-before) ?!))
7670 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7671 (idlwave-complete-in-buffer 'sysvar 'sysvar
7672 idlwave-system-variables-alist nil
7673 "Select a system variable"
7674 "system variable")
7675 t) ; return t to skip other completions
7676 ((save-excursion
7677 ;; Check if the context is right for sysvar tag
7678 (skip-chars-backward "a-zA-Z0-9_$.")
7679 (and (equal (char-before) ?!)
7681 (<= (match-end 0) pos)))
7682 ;; Complete a system variable tag
7683 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7684 (entry (assq var idlwave-system-variables-alist))
7685 (tags (cdr (assq 'tags entry))))
7686 (or entry (error "!%s is not a known system variable" var))
7687 (or tags (error "System variable !%s is not a structure" var))
7688 (setq idlwave-completion-help-info
7689 (list 'idlwave-complete-sysvar-tag-help var))
7690 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7691 tags nil
7692 "Select a system variable tag"
7693 "system variable tag")
7694 t)) ; return t to skip other completions
7695 (t nil))))
7697 (defvar link) ;dynamic variables set by help callback
7698 (defvar props)
7699 (defun idlwave-complete-sysvar-help (mode word)
7700 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7701 (entry (assoc word idlwave-system-variables-alist)))
7702 (cond
7703 ((eq mode 'test)
7704 (and (stringp word) entry (nth 1 (assq 'link entry))))
7705 ((eq mode 'set)
7706 (if entry (setq link (nth 1 (assq 'link entry))))) ;; setting dynamic!!!
7707 (t (error "This should not happen")))))
7709 (defun idlwave-complete-sysvar-tag-help (mode word)
7710 (let* ((var (nth 1 idlwave-completion-help-info))
7711 (entry (assoc var idlwave-system-variables-alist))
7712 (tags (cdr (assq 'tags entry)))
7713 (main (nth 1 (assq 'link entry)))
7714 target main-base)
7715 (cond
7716 ((eq mode 'test) ; we can at least link the main
7717 (and (stringp word) entry main))
7718 ((eq mode 'set)
7719 (if entry
7720 (setq link
7721 (if (setq target (cdr (assoc-string word tags t)))
7722 (idlwave-substitute-link-target main target)
7723 main)))) ;; setting dynamic!!!
7724 (t (error "This should not happen")))))
7726 (defun idlwave-split-link-target (link)
7727 "Split a given link into link file and anchor."
7728 (if (string-match idlwave-html-link-sep link)
7729 (cons (substring link 0 (match-beginning 0))
7730 (string-to-number (substring link (match-end 0))))))
7732 (defun idlwave-substitute-link-target (link target)
7733 "Substitute the target anchor for the given link."
7734 (let (main-base)
7735 (setq main-base (if (string-match "#" link)
7736 (substring link 0 (match-beginning 0))
7737 link))
7738 (if target
7739 (concat main-base idlwave-html-link-sep (number-to-string target))
7740 link)))
7742 ;; Fake help in the source buffer for class structure tags.
7743 ;; KWD AND NAME ARE GLOBAL-VARIABLES HERE.
7744 (defvar name)
7745 (defvar kwd)
7746 (defvar idlwave-help-do-class-struct-tag nil)
7747 (defun idlwave-complete-class-structure-tag-help (mode word)
7748 (cond
7749 ((eq mode 'test) ; nothing gets fontified for class tags
7750 nil)
7751 ((eq mode 'set)
7752 (let (class-with found-in)
7753 (when (setq class-with
7754 (idlwave-class-or-superclass-with-tag
7755 idlwave-current-tags-class
7756 word))
7757 (if (assq (idlwave-sintern-class class-with)
7758 idlwave-system-class-info)
7759 (error "No help available for system class tags"))
7760 (if (setq found-in (idlwave-class-found-in class-with))
7761 (setq name (cons (concat found-in "__define") class-with))
7762 (setq name (concat class-with "__define")))))
7763 (setq kwd word
7764 idlwave-help-do-class-struct-tag t))
7765 (t (error "This should not happen"))))
7767 (defun idlwave-class-or-superclass-with-tag (class tag)
7768 "Find and return the CLASS or one of its superclass with the
7769 associated TAG, if any."
7770 (let ((sclasses (cons class (idlwave-all-class-inherits class)))
7771 cl)
7772 (catch 'exit
7773 (while sclasses
7774 (setq cl (pop sclasses))
7775 (let ((tags (idlwave-class-tags cl)))
7776 (while tags
7777 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7778 (throw 'exit cl))
7779 (setq tags (cdr tags))))))))
7782 (defun idlwave-sysvars-reset ()
7783 (if (and (fboundp 'idlwave-shell-is-running)
7784 (idlwave-shell-is-running)
7785 idlwave-idlwave_routine_info-compiled)
7786 (idlwave-shell-send-command "idlwave_get_sysvars"
7787 'idlwave-process-sysvars 'hide)))
7789 (defun idlwave-process-sysvars ()
7790 (idlwave-shell-filter-sysvars)
7791 (setq idlwave-sint-sysvars nil
7792 idlwave-sint-sysvartags nil)
7793 (idlwave-sintern-sysvar-alist))
7795 (defun idlwave-sintern-sysvar-alist ()
7796 (let ((list idlwave-system-variables-alist) entry tags)
7797 (while (setq entry (pop list))
7798 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7799 (setq tags (assq 'tags entry))
7800 (if tags
7801 (setcdr tags
7802 (mapcar (lambda (x)
7803 (cons (idlwave-sintern-sysvartag (car x) 'set)
7804 (cdr x)))
7805 (cdr tags)))))))
7807 (defvar idlwave-shell-command-output)
7808 (defun idlwave-shell-filter-sysvars ()
7809 "Get any new system variables and tags."
7810 (let ((text idlwave-shell-command-output)
7811 (start 0)
7812 (old idlwave-system-variables-alist)
7813 var tags type name class link old-entry)
7814 (setq idlwave-system-variables-alist nil)
7816 text start)
7817 (setq start (match-end 0)
7818 var (match-string 1 text)
7819 tags (if (match-end 3)
7820 (idlwave-split-string (match-string 3 text))))
7821 ;; Maintain old links, if present
7822 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7823 (setq link (assq 'link old-entry))
7824 (setq idlwave-system-variables-alist
7825 (cons (list var
7826 (cons
7827 'tags
7828 (mapcar (lambda (x)
7829 (cons x
7830 (cdr (assq
7831 (idlwave-sintern-sysvartag x)
7832 (cdr (assq 'tags old-entry))))))
7833 tags)) link)
7834 idlwave-system-variables-alist)))
7835 ;; Keep the old value if query was not successful
7836 (setq idlwave-system-variables-alist
7837 (or idlwave-system-variables-alist old))))
7839 (defun idlwave-completion-fontify-classes ()
7840 "Goto the *Completions* buffer and fontify the class info."
7841 (when (featurep 'font-lock)
7842 (save-excursion
7843 (set-buffer "*Completions*")
7844 (save-excursion
7845 (goto-char (point-min))
7846 (let ((buffer-read-only nil))
7848 (put-text-property (match-beginning 0) (match-end 0)
7849 'face 'font-lock-string-face)))))))
7851 (defun idlwave-uniquify (list)
7852 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7853 (delq nil
7854 (mapcar (lambda (x)
7855 (unless (gethash x ht)
7856 (puthash x t ht)
7857 x))
7858 list))))
7860 (defun idlwave-after-successful-completion (type slash &optional verify)
7861 "Add `=' or `(' after successful completion of keyword and function.
7862 Restore the pre-completion window configuration if possible."
7863 (cond
7864 ((eq type 'procedure)
7865 nil)
7866 ((eq type 'function)
7867 (cond
7868 ((equal idlwave-function-completion-adds-paren nil) nil)
7869 ((or (equal idlwave-function-completion-adds-paren t)
7870 (equal idlwave-function-completion-adds-paren 1))
7871 (insert "("))
7872 ((equal idlwave-function-completion-adds-paren 2)
7873 (insert "()")
7874 (backward-char 1))
7875 (t nil)))
7876 ((eq type 'keyword)
7877 (if (and idlwave-keyword-completion-adds-equal
7878 (not slash))
7879 (progn (insert "=") t)
7880 nil)))
7882 ;; Restore the pre-completion window configuration if this is safe.
7884 (if (or (eq verify 'force) ; force
7885 (and
7886 (get-buffer-window "*Completions*") ; visible
7887 (idlwave-local-value 'idlwave-completion-p
7888 "*Completions*") ; cib-buffer
7889 (eq (marker-buffer idlwave-completion-mark)
7890 (current-buffer)) ; buffer OK
7891 (equal (marker-position idlwave-completion-mark)
7892 verify))) ; pos OK
7893 (idlwave-restore-wconf-after-completion))
7894 (move-marker idlwave-completion-mark nil)
7895 (setq idlwave-before-completion-wconf nil))
7897 (defun idlwave-mouse-context-help (ev &optional arg)
7898 "Call `idlwave-context-help' on the clicked location."
7899 (interactive "eP")
7900 (mouse-set-point ev)
7901 (idlwave-context-help arg))
7903 (defvar idlwave-last-context-help-pos nil)
7904 (defun idlwave-context-help (&optional arg)
7905 "Display IDL Online Help on context.
7906 If point is on a keyword, help for that keyword will be shown. If
7907 point is on a routine name or in the argument list of a routine, help
7908 for that routine will be displayed. Works for system routines and
7909 keywords, it pulls up text help. For other routies and keywords,
7910 visits the source file, finding help in the header (if
7911 `idlwave-help-source-try-header' is non-nil) or the routine definition
7912 itself."
7913 (interactive "P")
7914 (idlwave-do-context-help arg))
7916 (defun idlwave-mouse-completion-help (ev)
7917 "Display online help about the completion at point."
7918 (interactive "eP")
7919 ;; Restore last-command for next command, to make
7920 ;; scrolling/cancelling of completions work.
7921 (setq this-command last-command)
7922 (idlwave-do-mouse-completion-help ev))
7924 (defun idlwave-routine-info (&optional arg external)
7925 "Display a routines calling sequence and list of keywords. When
7926 point is on the name a function or procedure, or in the argument list
7927 of a function or procedure, this command displays a help buffer with
7928 the information. When called with prefix arg, enforce class query.
7930 When point is on an object operator `->', display the class stored in
7931 this arrow, if any (see `idlwave-store-inquired-class'). With a
7932 prefix arg, the class property is cleared out."
7934 (interactive "P")
7935 (idlwave-routines)
7936 (if (string-match "->" (buffer-substring
7937 (max (point-min) (1- (point)))
7938 (min (+ 2 (point)) (point-max))))
7939 ;; Cursor is on an arrow
7940 (if (get-text-property (point) 'idlwave-class)
7941 ;; arrow has class property
7942 (if arg
7943 ;; Remove property
7944 (save-excursion
7945 (backward-char 1)
7947 (remove-text-properties (match-beginning 1) (match-end 1)
7948 '(idlwave-class nil face nil))
7949 (message "Class property removed from arrow")))
7950 ;; Echo class property
7951 (message "Arrow has text property identifying object to be class %s"
7952 (get-text-property (point) 'idlwave-class)))
7953 ;; No property found
7954 (message "Arrow has no class text property"))
7956 ;; Not on an arrow...
7957 (let* ((idlwave-query-class nil)
7958 (idlwave-force-class-query (equal arg '(4)))
7959 (module (idlwave-what-module)))
7960 (if (car module)
7961 (apply 'idlwave-display-calling-sequence
7962 (idlwave-fix-module-if-obj_new module))
7963 (error "Don't know which calling sequence to show")))))
7965 (defun idlwave-resolve (&optional arg)
7966 "Call RESOLVE_ROUTINE on the module name at point.
7967 Like `idlwave-routine-info', this looks for a routine call at point.
7968 After confirmation in the minibuffer, it will use the shell to issue
7969 a RESOLVE call for this routine, to attempt to make it defined and its
7970 routine info available for IDLWAVE. If the routine is a method call,
7971 both `class__method' and `class__define' will be tried.
7972 With ARG, enforce query for the class of object methods."
7973 (interactive "P")
7974 (let* ((idlwave-query-class nil)
7975 (idlwave-force-class-query (equal arg '(4)))
7976 (module (idlwave-what-module))
7977 (name (idlwave-make-full-name (nth 2 module) (car module)))
7978 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7979 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7980 (kwd "")
7981 class)
7983 resolve)
7984 (setq type (match-string 1 resolve)
7985 class (if (match-beginning 2)
7986 (match-string 3 resolve)
7987 nil)
7988 name (match-string 4 resolve)))
7989 (if (string= (downcase type) "function")
7990 (setq kwd ",/is_function"))
7992 (cond
7993 ((null class)
7994 (idlwave-shell-send-command
7995 (format "resolve_routine,'%s'%s" (downcase name) kwd)
7996 'idlwave-update-routine-info
7997 nil t))
7998 (t
7999 (idlwave-shell-send-command
8000 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
8001 (list 'idlwave-shell-send-command
8002 (format "resolve_routine,'%s__%s'%s"
8003 (downcase class) (downcase name) kwd)
8004 '(idlwave-update-routine-info)
8005 nil t))))))
8007 (defun idlwave-find-module-this-file ()
8008 (interactive)
8009 (idlwave-find-module '(4)))
8011 (defun idlwave-find-module (&optional arg)
8012 "Find the source code of an IDL module.
8013 Works for modules for which IDLWAVE has routine info available. The
8014 function offers as default the module name `idlwave-routine-info'
8015 would use. With ARG limit to this buffer. With two prefix ARG's
8016 force class query for object methods."
8017 (interactive "P")
8018 (let* ((idlwave-query-class nil)
8019 (idlwave-force-class-query (equal arg '(16)))
8020 (this-buffer (equal arg '(4)))
8021 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
8022 (default (if module
8023 (concat (idlwave-make-full-name
8024 (nth 2 module) (car module))
8025 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
8026 "none"))
8027 (list
8028 (idlwave-uniquify
8029 (delq nil
8030 (mapcar (lambda (x)
8031 (if (eq 'system (car-safe (nth 3 x)))
8032 ;; Take out system routines with no source.
8033 nil
8034 (list
8035 (concat (idlwave-make-full-name
8036 (nth 2 x) (car x))
8037 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
8038 (if this-buffer
8039 (idlwave-save-buffer-update)
8040 (idlwave-routines))))))
8041 (name (idlwave-completing-read
8042 (if (or (not this-buffer)
8043 (assoc default list))
8044 (format "Module (Default %s): " default)
8045 (format "Module in this file: "))
8046 list))
8047 type class)
8049 ;; Nothing, use the default.
8050 (setq name default))
8051 (if (string-match "<[fp]>" name)
8052 (setq type (substring name -2 -1)
8053 name (substring name 0 -3)))
8055 (setq class (match-string 1 name)
8056 name (match-string 2 name)))
8057 (setq name (idlwave-sintern-routine-or-method name class)
8058 class (idlwave-sintern-class class)
8059 type (cond ((equal type "f") 'fun)
8060 ((equal type "p") 'pro)
8061 (t t)))
8062 (idlwave-do-find-module name type class nil this-buffer)))
8064 (defun idlwave-do-find-module (name type class
8065 &optional force-source this-buffer)
8066 (let ((name1 (idlwave-make-full-name class name))
8067 source buf1 entry
8068 (buf (current-buffer))
8069 (pos (point))
8070 file name2)
8071 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
8072 'WITH-FILE)
8073 source (or force-source (nth 3 entry))
8074 name2 (if (nth 2 entry)
8075 (idlwave-make-full-name (nth 2 entry) name)
8076 name1))
8077 (if source
8078 (setq file (idlwave-routine-source-file source)))
8079 (unless file ; Try to find it on the path.
8080 (setq file
8081 (idlwave-expand-lib-file-name
8082 (if class
8083 (format "%s__define.pro" (downcase class))
8084 (format "%s.pro" (downcase name))))))
8085 (cond
8086 ((or (null name) (equal name ""))
8087 (error "Abort"))
8088 ((eq (car source) 'system)
8089 (error "Source code for system routine %s is not available"
8090 name2))
8091 ((or (not file) (not (file-regular-p file)))
8092 (error "Source code for routine %s is not available"
8093 name2))
8094 (t
8095 (when (not this-buffer)
8096 (setq buf1
8097 (idlwave-find-file-noselect file 'find))
8098 (pop-to-buffer buf1 t))
8099 (goto-char (point-max))
8100 (let ((case-fold-search t))
8101 (if (re-search-backward
8103 (cond ((eq type 'fun) "function")
8104 ((eq type 'pro) "pro")
8107 (regexp-quote (downcase name2))
8108 "[^a-zA-Z0-9_$]")
8109 nil t)
8110 (goto-char (match-beginning 0))
8111 (pop-to-buffer buf)
8112 (goto-char pos)
8113 (error "Could not find routine %s" name2)))))))
8115 (defun idlwave-what-module ()
8116 "Return a default module for stuff near point.
8117 Used by `idlwave-routine-info' and `idlwave-find-module'."
8118 (idlwave-routines)
8119 (if (let ((case-fold-search t))
8120 (save-excursion
8121 (idlwave-beginning-of-statement)
8122 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
8123 ;; This is a function or procedure definition statement
8124 ;; We return the defined routine as module.
8125 (list
8126 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
8127 (match-string-no-properties 2))
8128 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
8129 (idlwave-sintern-class (match-string 3)))
8131 ;; Not a definition statement - analyze precise position.
8132 (let* ((where (idlwave-where))
8133 (cw (nth 2 where))
8134 (pro (car (nth 0 where)))
8135 (func (car (nth 1 where)))
8136 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
8137 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
8138 (following-char)))
8139 )
8140 (cond
8141 ((and (eq cw 'procedure)
8142 (not (equal this-word "")))
8143 (setq this-word (idlwave-sintern-routine-or-method
8144 this-word (nth 2 (nth 3 where))))
8145 (list this-word 'pro
8146 (idlwave-determine-class
8147 (cons this-word (cdr (nth 3 where)))
8148 'pro)))
8149 ((and (eq cw 'function)
8150 (not (equal this-word ""))
8151 (or (eq next-char ?\() ; exclude arrays, vars.
8153 (setq this-word (idlwave-sintern-routine-or-method
8154 this-word (nth 2 (nth 3 where))))
8155 (list this-word 'fun
8156 (idlwave-determine-class
8157 (cons this-word (cdr (nth 3 where)))
8158 'fun)))
8159 ((and (memq cw '(function-keyword procedure-keyword))
8160 (not (equal this-word ""))
8161 (eq next-char ?\()) ; A function!
8162 (setq this-word (idlwave-sintern-routine this-word))
8163 (list this-word 'fun nil))
8164 (func
8165 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
8166 (pro
8167 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
8168 (t nil)))))
8170 (defun idlwave-what-module-find-class ()
8171 "Call idlwave-what-module and find the inherited class if necessary."
8172 (let* ((module (idlwave-what-module))
8173 (class (nth 2 module))
8174 classes)
8175 (if (and (= (length module) 3)
8176 (stringp class))
8177 (list (car module)
8178 (nth 1 module)
8179 (apply 'idlwave-find-inherited-class module))
8180 module)))
8182 (defun idlwave-find-inherited-class (name type class)
8183 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
8184 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
8185 (if entry
8186 (nth 2 entry)
8187 class)))
8189 (defun idlwave-fix-module-if-obj_new (module)
8190 "Check if MODULE points to obj_new.
8191 If yes, and if the cursor is in the keyword region, change to the
8192 appropriate Init method."
8193 (let* ((name (car module))
8194 (pos (point))
8195 (case-fold-search t)
8196 string)
8197 (if (and (stringp name)
8198 (equal (downcase name) "obj_new")
8199 (save-excursion
8200 (idlwave-beginning-of-statement)
8201 (setq string (buffer-substring (point) pos))
8203 string)))
8204 (let ((name "Init")
8205 (class (match-string 1 string)))
8206 (setq module (list (idlwave-sintern-method "Init")
8207 'fun
8208 (idlwave-sintern-class class)))))
8209 module))
8211 (defun idlwave-fix-keywords (name type class keywords
8212 &optional super-classes system)
8213 "Update a list of keywords.
8214 Translate OBJ_NEW, adding all super-class keywords, or all keywords
8215 from all classes if class equals t. If SYSTEM is non-nil, don't
8216 demand _EXTRA in the keyword list."
8217 (let ((case-fold-search t))
8219 ;; If this is the OBJ_NEW function, try to figure out the class and use
8220 ;; the keywords from the corresponding INIT method.
8221 (if (and (equal (upcase name) "OBJ_NEW")
8222 (or (eq major-mode 'idlwave-mode)
8223 (eq major-mode 'idlwave-shell-mode)))
8224 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
8225 (string (buffer-substring bos (point)))
8226 (case-fold-search t)
8227 class)
8229 string)
8230 (setq class (idlwave-sintern-class (match-string 1 string)))
8231 (setq idlwave-current-obj_new-class class)
8232 (setq keywords
8233 (append keywords
8234 (idlwave-entry-keywords
8235 (idlwave-rinfo-assq
8236 (idlwave-sintern-method "INIT")
8237 'fun
8238 class
8239 (idlwave-routines)) 'do-link))))))
8241 ;; If the class is `t', combine all keywords of all methods NAME
8242 (when (eq class t)
8243 (mapc (lambda (entry)
8244 (and
8245 (nth 2 entry) ; non-nil class
8246 (eq (nth 1 entry) type) ; correct type
8247 (setq keywords
8248 (append keywords
8249 (idlwave-entry-keywords entry 'do-link)))))
8250 (idlwave-all-assq name (idlwave-routines)))
8251 (setq keywords (idlwave-uniquify keywords)))
8253 ;; If we have inheritance, add all keywords from superclasses, if
8254 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
8255 (when (and
8256 super-classes
8257 idlwave-keyword-class-inheritance
8258 (stringp class)
8259 (or
8260 system
8261 (assq (idlwave-sintern-keyword "_extra") keywords)
8262 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
8263 ;; Check if one of the keyword-class regexps matches the name
8264 (let ((regexps idlwave-keyword-class-inheritance) re)
8265 (catch 'exit
8266 (while (setq re (pop regexps))
8267 (if (string-match re name) (throw 'exit t))))))
8269 (loop for entry in (idlwave-routines) do
8270 (and (nth 2 entry) ; non-nil class
8271 (memq (nth 2 entry) super-classes) ; an inherited class
8272 (eq (nth 1 entry) type) ; correct type
8273 (eq (car entry) name) ; correct name
8274 (mapc (lambda (k) (add-to-list 'keywords k))
8275 (idlwave-entry-keywords entry 'do-link))))
8276 (setq keywords (idlwave-uniquify keywords)))
8278 ;; Return the final list
8279 keywords))
8281 (defun idlwave-expand-keyword (keyword module)
8282 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
8283 KEYWORD may be an exact match or an abbreviation of a keyword.
8284 If the match is exact, KEYWORD itself is returned, even if there may be other
8285 keywords of which KEYWORD is an abbreviation. This is necessary because some
8286 system routines have keywords which are prefixes of other keywords.
8287 If KEYWORD is an abbreviation of several keywords, a list of all possible
8288 completions is returned.
8289 If the abbreviation was unique, the correct keyword is returned.
8290 If it cannot be a keyword, the function return nil.
8291 If we do not know about MODULE, just return KEYWORD literally."
8292 (let* ((name (car module))
8293 (type (nth 1 module))
8294 (class (nth 2 module))
8295 (kwd (idlwave-sintern-keyword keyword))
8296 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
8297 (kwd-alist (idlwave-entry-keywords entry))
8298 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
8299 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
8300 (completion-ignore-case t)
8301 candidates)
8302 (cond ((assq kwd kwd-alist)
8303 kwd)
8304 ((setq candidates (all-completions kwd kwd-alist))
8305 (if (= (length candidates) 1)
8306 (car candidates)
8307 candidates))
8308 ((and entry extra)
8309 ;; Inheritance may cause this keyword to be correct
8310 keyword)
8311 (entry
8312 ;; We do know the function, which does not have the keyword.
8313 nil)
8314 (t
8315 ;; We do not know the function, so this just might be a correct
8316 ;; keyword - return it as it is.
8317 keyword))))
8319 (defvar idlwave-rinfo-mouse-map (make-sparse-keymap))
8320 (defvar idlwave-rinfo-map (make-sparse-keymap))
8321 (define-key idlwave-rinfo-mouse-map
8322 (if (featurep 'xemacs) [button2] [mouse-2])
8323 'idlwave-mouse-active-rinfo)
8324 (define-key idlwave-rinfo-mouse-map
8325 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
8326 'idlwave-mouse-active-rinfo-shift)
8327 (define-key idlwave-rinfo-mouse-map
8328 (if (featurep 'xemacs) [button3] [mouse-3])
8329 'idlwave-mouse-active-rinfo-right)
8330 (define-key idlwave-rinfo-mouse-map " " 'idlwave-active-rinfo-space)
8331 (define-key idlwave-rinfo-map "q" 'idlwave-quit-help)
8332 (define-key idlwave-rinfo-mouse-map "q" 'idlwave-quit-help)
8333 (defvar idlwave-popup-source nil)
8334 (defvar idlwave-rinfo-marker (make-marker))
8336 (defun idlwave-quit-help ()
8337 (interactive)
8338 (let ((ri-window (get-buffer-window "*Help*"))
8339 (olh-window (get-buffer-window "*IDLWAVE Help*")))
8340 (when (and olh-window
8341 (fboundp 'idlwave-help-quit))
8342 (select-window olh-window)
8343 (idlwave-help-quit))
8344 (when (window-live-p ri-window)
8345 (delete-window ri-window))))
8347 (defun idlwave-display-calling-sequence (name type class
8348 &optional initial-class)
8349 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
8350 (let* ((initial-class (or initial-class class))
8351 (entry (or (idlwave-best-rinfo-assq name type class
8352 (idlwave-routines))
8353 (idlwave-rinfo-assq name type class
8354 idlwave-unresolved-routines)))
8355 (name (or (car entry) name))
8356 (class (or (nth 2 entry) class))
8357 (superclasses (idlwave-all-class-inherits initial-class))
8358 (twins (idlwave-routine-twins entry))
8359 (dtwins (idlwave-study-twins twins))
8360 (all dtwins)
8361 (system (eq (car (nth 3 entry)) 'system))
8362 (calling-seq (nth 4 entry))
8363 (keywords (idlwave-entry-keywords entry 'do-link))
8364 (html-file (car (nth 5 entry)))
8365 (help-echo-kwd
8366 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
8367 (help-echo-use
8368 "Button2/3: Online Help")
8369 (help-echo-src
8370 "Button2: Jump to source and back | Button3: Source in Help window.")
8371 (help-echo-class
8372 "Button2: Display info about same method in superclass")
8373 (col 0)
8374 (data (list name type class (current-buffer) nil initial-class))
8375 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8376 (face 'idlwave-help-link)
8377 beg props win cnt total)
8378 ;; Fix keywords, but don't add chained super-classes, since these
8379 ;; are shown separately for that super-class
8380 (setq keywords (idlwave-fix-keywords name type class keywords))
8381 (cond
8382 ((null entry)
8383 (error "No %s %s known %s" type name
8384 (if initial-class (concat "in class " initial-class) "")))
8385 ((or (null name) (equal name ""))
8386 (error "No function or procedure call at point"))
8387 ((null calling-seq)
8388 (error "Calling sequence of %s %s not available" type name))
8389 (t
8390 (save-excursion
8391 (move-marker idlwave-rinfo-marker (point))
8392 (set-buffer (get-buffer-create "*Help*"))
8393 (use-local-map idlwave-rinfo-map)
8394 (setq buffer-read-only nil)
8395 (erase-buffer)
8396 (set (make-local-variable 'idlwave-popup-source) nil)
8397 (set (make-local-variable 'idlwave-current-obj_new-class)
8398 idlwave-current-obj_new-class)
8399 (when superclasses
8400 (setq props (list 'mouse-face 'highlight
8401 km-prop idlwave-rinfo-mouse-map
8402 'help-echo help-echo-class
8403 'data (cons 'class data)))
8404 (let ((classes (cons initial-class superclasses)) c)
8405 (insert "Classes: ")
8406 (while (setq c (pop classes))
8407 (insert " ")
8408 (setq beg (point))
8409 (insert c)
8410 (if (equal (downcase c) (downcase class))
8411 (add-text-properties beg (point) (list 'face 'bold))
8412 ;; If Method exists in a different class link it
8413 (if (idlwave-rinfo-assq name type c (idlwave-routines))
8414 (add-text-properties beg (point) props))))
8416 (setq props (list 'mouse-face 'highlight
8417 km-prop idlwave-rinfo-mouse-map
8418 'help-echo help-echo-use
8419 'data (cons 'usage data)))
8420 (if html-file (setq props (append (list 'face face 'link html-file)
8421 props)))
8422 (insert "Usage: ")
8423 (setq beg (point))
8424 (insert (if class
8425 (format calling-seq class name class name class name)
8426 (format calling-seq name name name name))
8428 (add-text-properties beg (point) props)
8430 (insert "Keywords:")
8431 (if (null keywords)
8432 (insert " No keywords accepted.")
8433 (setq col 9)
8434 (mapc
8435 (lambda (x)
8436 (if (>= (+ col 1 (length (car x)))
8437 (window-width))
8438 (progn
8440 (setq col 9)))
8441 (insert " ")
8442 (setq beg (point)
8443 ;; Relevant keywords already have link property attached
8444 props (list 'mouse-face 'highlight
8445 km-prop idlwave-rinfo-mouse-map
8446 'data (cons 'keyword data)
8447 'help-echo help-echo-kwd
8448 'keyword (car x)))
8449 (if system (setq props (append (list 'face face) props)))
8450 (insert (car x))
8451 (add-text-properties beg (point) props)
8452 (setq col (+ col 1 (length (car x)))))
8453 keywords))
8455 (setq cnt 1 total (length all))
8456 ;; Here entry is (key file (list of type-conses))
8457 (while (setq entry (pop all))
8458 (setq props (list 'mouse-face 'highlight
8459 km-prop idlwave-rinfo-mouse-map
8460 'help-echo help-echo-src
8461 'source (list (car (car (nth 2 entry))) ;type
8462 (nth 1 entry)
8463 nil
8464 (cdr (car (nth 2 entry))))
8465 'data (cons 'source data)))
8466 (idlwave-insert-source-location
8468 (if (equal cnt 1)
8469 (if (> total 1) "Sources:" "Source:")
8470 "")
8471 (if (> total 1) "- " ""))
8472 entry props)
8473 (incf cnt)
8474 (when (and all (> cnt idlwave-rinfo-max-source-lines))
8475 ;; No more source lines, please
8476 (insert (format
8478 idlwave-rinfo-max-source-lines))
8479 (setq all nil)))
8480 (goto-char (point-min))
8481 (setq buffer-read-only t))
8482 (display-buffer "*Help*")
8483 (if (and (setq win (get-buffer-window "*Help*"))
8484 idlwave-resize-routine-help-window)
8485 (progn
8486 (let ((ww (selected-window)))
8487 (unwind-protect
8488 (progn
8489 (select-window win)
8490 (enlarge-window (- (/ (frame-height) 2)
8491 (window-height)))
8492 (shrink-window-if-larger-than-buffer))
8493 (select-window ww)))))))))
8495 (defun idlwave-insert-source-location (prefix entry &optional file-props)
8496 "Insert a source location into the routine info buffer.
8497 Start line with PREFIX. If a file name is inserted, add FILE-PROPS to
8498 it."
8499 (let* ((key (car entry))
8500 (file (nth 1 entry))
8501 (types (nth 2 entry))
8502 (shell-flag (assq 'compiled types))
8503 (buffer-flag (assq 'buffer types))
8504 (user-flag (assq 'user types))
8505 (lib-flag (assq 'lib types))
8506 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
8507 (and user-flag (idlwave-count-memq 'user types))
8508 (and lib-flag (idlwave-count-memq 'lib types))
8509 1))
8510 (doflags t)
8511 beg special)
8513 (insert prefix)
8515 (cond
8516 ((eq key 'system)
8517 (setq doflags nil)
8518 (insert "System "))
8520 ((eq key 'builtin)
8521 (setq doflags nil)
8522 (insert "Builtin "))
8524 ((and (not file) shell-flag)
8525 (insert "Unresolved"))
8527 ((null file)
8528 (insert "ERROR"))
8530 ((idlwave-syslib-p file)
8531 (if (string-match "obsolete" (file-name-directory file))
8532 (insert "Obsolete ")
8533 (insert "SystemLib ")))
8535 ;; New special syntax: taken directly from routine-info for
8536 ;; library catalog routines
8537 ((setq special (or (cdr lib-flag) (cdr user-flag)))
8538 (insert (format "%-10s" special)))
8540 ;; Old special syntax: a matching regexp
8541 ((setq special (idlwave-special-lib-test file))
8542 (insert (format "%-10s" special)))
8544 ;; Catch-all with file
8545 ((idlwave-lib-p file) (insert "Library "))
8547 ;; Sanity catch all
8548 (t (insert "Other ")))
8550 (when doflags
8551 (insert (concat
8552 " ["
8553 (if lib-flag "L" "-")
8554 (if user-flag "C" "-")
8555 (if shell-flag "S" "-")
8556 (if buffer-flag "B" "-")
8557 "] ")))
8558 (when (> ndupl 1)
8559 (setq beg (point))
8560 (insert (format "(%dx) " ndupl))
8561 (add-text-properties beg (point) (list 'face 'bold)))
8562 (when (and file (not (equal file "")))
8563 (setq beg (point))
8564 (insert (apply 'abbreviate-file-name
8565 (if (featurep 'xemacs) (list file t) (list file))))
8566 (if file-props
8567 (add-text-properties beg (point) file-props)))))
8569 (defun idlwave-special-lib-test (file)
8570 "Check the path of FILE against the regexps which define special libs.
8571 Return the name of the special lib if there is a match."
8572 (let ((alist idlwave-special-lib-alist)
8573 entry rtn)
8574 (cond
8575 ((stringp file)
8576 (while (setq entry (pop alist))
8577 (if (string-match (car entry) file)
8578 (setq rtn (cdr entry)
8579 alist nil)))
8580 rtn)
8581 (t nil))))
8583 (defun idlwave-mouse-active-rinfo-right (ev)
8584 (interactive "e")
8585 (idlwave-mouse-active-rinfo ev 'right))
8587 (defun idlwave-mouse-active-rinfo-shift (ev)
8588 (interactive "e")
8589 (idlwave-mouse-active-rinfo ev nil 'shift))
8591 (defun idlwave-active-rinfo-space ()
8592 (interactive)
8593 (idlwave-mouse-active-rinfo nil 'right))
8595 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8596 "Does the mouse actions in the routine info buffer.
8597 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8598 was pressed."
8599 (interactive "e")
8600 (if ev (mouse-set-point ev))
8601 (let (data id name type class buf bufwin source link keyword
8602 word initial-class)
8603 (setq data (get-text-property (point) 'data)
8604 source (get-text-property (point) 'source)
8605 keyword (get-text-property (point) 'keyword)
8606 link (get-text-property (point) 'link)
8607 id (car data)
8608 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8609 buf (nth 4 data)
8610 initial-class (nth 6 data)
8611 word (idlwave-this-word)
8612 bufwin (get-buffer-window buf t))
8614 (cond ((eq id 'class) ; Switch class being displayed
8615 (if (window-live-p bufwin) (select-window bufwin))
8616 (idlwave-display-calling-sequence
8617 (idlwave-sintern-method name)
8618 type (idlwave-sintern-class word)
8619 initial-class))
8620 ((eq id 'usage) ; Online help on this routine
8621 (idlwave-online-help link name type class))
8622 ((eq id 'source) ; Source in help or buffer
8623 (if right ; In help
8624 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8625 (idlwave-help-source-try-header nil)
8626 ;; Fake idlwave-routines so help will find the right entry
8627 (idlwave-routines
8628 (list (list name type class source ""))))
8629 (idlwave-help-get-special-help name type class nil))
8630 ;; Otherwise just pop to the source
8631 (setq idlwave-popup-source (not idlwave-popup-source))
8632 (if idlwave-popup-source
8633 (condition-case err
8634 (idlwave-do-find-module name type class source)
8635 (error
8636 (setq idlwave-popup-source nil)
8637 (if (window-live-p bufwin) (select-window bufwin))
8638 (error (nth 1 err))))
8639 (if bufwin
8640 (select-window bufwin)
8641 (pop-to-buffer buf))
8642 (goto-char (marker-position idlwave-rinfo-marker)))))
8643 ((eq id 'keyword)
8644 (if right
8645 (idlwave-online-help link name type class keyword)
8646 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8648 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8649 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8650 (let ((bwin (get-buffer-window buffer)))
8651 (if idlwave-complete-empty-string-as-lower-case
8652 (setq keyword (downcase keyword)))
8653 (if bwin
8654 (select-window bwin)
8655 (pop-to-buffer buffer)
8656 (setq bwin (get-buffer-window buffer)))
8657 (if (eq (preceding-char) ?/)
8658 (insert keyword)
8659 (unless (save-excursion
8660 (re-search-backward
8662 (min (- (point) 100) (point-min)) t))
8663 (insert ", "))
8664 (if shift (insert "/"))
8665 (insert keyword)
8666 (if (and (not shift)
8667 idlwave-keyword-completion-adds-equal)
8668 (insert "=")))))
8670 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8671 "List the load path shadows of all routines defined in current buffer."
8672 (interactive "P")
8673 (idlwave-routines)
8674 (if (eq major-mode 'idlwave-mode)
8675 (idlwave-list-load-path-shadows
8676 nil (idlwave-update-current-buffer-info 'save-buffer)
8677 "in current buffer")
8678 (error "Current buffer is not in idlwave-mode")))
8680 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8681 "List the load path shadows of all routines compiled under the shell.
8682 This is very useful for checking an IDL application. Just compile the
8683 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8684 routines and update IDLWAVE internal info. Then check for shadowing
8685 with this command."
8686 (interactive "P")
8687 (cond
8688 ((or (not (fboundp 'idlwave-shell-is-running))
8689 (not (idlwave-shell-is-running)))
8690 (error "Shell is not running"))
8691 ((null idlwave-compiled-routines)
8692 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8693 (t
8694 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8695 "in the shell"))))
8697 (defun idlwave-list-all-load-path-shadows (&optional arg)
8698 "List the load path shadows of all routines known to IDLWAVE."
8699 (interactive "P")
8700 (idlwave-list-load-path-shadows nil nil "globally"))
8702 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8703 "List the routines which are defined multiple times.
8704 Search the information IDLWAVE has about IDL routines for multiple
8705 definitions.
8706 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8708 When IDL hits a routine call which is not defined, it will search on
8709 the load path in order to find a definition. The output of this
8710 command can be used to detect possible name clashes during this process."
8711 (idlwave-routines) ; Make sure everything is loaded.
8712 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8713 (or (y-or-n-p
8714 "You don't have any user or library catalogs. Continue anyway? ")
8715 (error "Abort")))
8716 (let* ((routines (append idlwave-system-routines
8717 idlwave-compiled-routines
8718 idlwave-library-catalog-routines
8719 idlwave-user-catalog-routines
8720 idlwave-buffer-routines
8721 nil))
8722 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8723 (keymap (make-sparse-keymap))
8724 (props (list 'mouse-face 'highlight
8725 km-prop keymap
8726 'help-echo "Mouse2: Find source"))
8727 (nroutines (length (or special-routines routines)))
8728 (step (/ nroutines 100))
8729 (n 0)
8730 (cnt 0)
8731 (idlwave-sort-prefer-buffer-info nil)
8732 routine twins dtwins twin done props1 lroutines)
8734 (if special-routines
8735 ;; Just looking for shadows of a few special routines
8736 (setq lroutines routines
8737 routines special-routines))
8739 (message "Sorting routines...")
8740 (setq routines (sort routines
8741 (lambda (a b)
8742 (string< (downcase (idlwave-make-full-name
8743 (nth 2 a) (car a)))
8744 (downcase (idlwave-make-full-name
8745 (nth 2 b) (car b)))))))
8746 (message "Sorting routines...done")
8748 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8749 (lambda (ev)
8750 (interactive "e")
8751 (mouse-set-point ev)
8752 (apply 'idlwave-do-find-module
8753 (get-text-property (point) 'find-args))))
8754 (define-key keymap [(return)]
8755 (lambda ()
8756 (interactive)
8757 (apply 'idlwave-do-find-module
8758 (get-text-property (point) 'find-args))))
8759 (message "Compiling list...( 0%%)")
8760 (save-excursion
8761 (set-buffer (get-buffer-create "*Shadows*"))
8762 (setq buffer-read-only nil)
8763 (erase-buffer)
8764 (while (setq routine (pop routines))
8765 (if (= (mod (setq n (1+ n)) step) 0)
8766 (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines)))
8768 ;; Get a list of all twins
8769 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8770 (if (memq routine done)
8771 (setq dtwins nil)
8772 (setq dtwins (idlwave-study-twins twins)))
8773 ;; Mark all twins as dealt with
8774 (setq done (append twins done))
8775 (when (or (> (length dtwins) 1)
8776 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8777 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8778 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8779 (incf cnt)
8781 (idlwave-make-full-name (nth 2 routine)
8782 (car routine))
8783 (if (eq (nth 1 routine) 'fun) "()" "")))
8784 (while (setq twin (pop dtwins))
8785 (setq props1 (append (list 'find-args
8786 (list (nth 0 routine)
8787 (nth 1 routine)
8788 (nth 2 routine)))
8789 props))
8791 (goto-char (point-min))
8792 (setq buffer-read-only t))
8793 (setq loc (or loc ""))
8794 (if (> cnt 0)
8795 (progn
8796 (display-buffer (get-buffer "*Shadows*"))
8797 (message "%d case%s of shadowing found %s"
8798 cnt (if (= cnt 1) "" "s") loc))
8799 (message "No shadowing conflicts found %s" loc))))
8801 (defun idlwave-print-source (routine)
8802 (let* ((source (nth 3 routine))
8803 (stype (car source))
8804 (sfile (idlwave-routine-source-file source)))
8805 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8806 (if (and (eq stype 'compiled)
8807 (or (not (stringp sfile))
8809 (setq stype 'unresolved))
8811 stype
8812 (if sfile sfile "No source code available")))))
8814 (defun idlwave-routine-twins (entry &optional list)
8815 "Return all twin entries of ENTRY in LIST.
8816 LIST defaults to `idlwave-routines'.
8817 Twin entries are those which have the same name, type, and class.
8818 ENTRY will also be returned, as the first item of this list."
8819 (let* ((name (car entry))
8820 (type (nth 1 entry))
8821 (class (nth 2 entry))
8822 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8823 twins candidate)
8824 (while (setq candidate (pop candidates))
8825 (if (and (not (eq candidate entry))
8826 (eq type (nth 1 candidate))
8827 (eq class (nth 2 candidate)))
8828 (push candidate twins)))
8829 (if (setq candidate (idlwave-rinfo-assq name type class
8830 idlwave-unresolved-routines))
8831 (push candidate twins))
8832 (cons entry (nreverse twins))))
8834 (defun idlwave-study-twins (entries)
8835 "Return dangerous twins of first entry in ENTRIES.
8836 Dangerous twins are routines with same name, but in different files on
8837 the load path. If a file is in the system library and has an entry in
8838 the `idlwave-system-routines' list, we omit the latter as
8839 non-dangerous because many IDL routines are implemented as library
8840 routines, and may have been scanned."
8841 (let* ((entry (car entries))
8842 (name (car entry)) ;
8843 (type (nth 1 entry)) ; Must be bound for
8844 (class (nth 2 entry)) ; idlwave-routine-twin-compare
8845 (cnt 0)
8846 source type type-cons file alist syslibp key)
8847 (while (setq entry (pop entries))
8848 (incf cnt)
8849 (setq source (nth 3 entry)
8850 type (car source)
8851 type-cons (cons type (nth 3 source))
8852 file (idlwave-routine-source-file source))
8854 ;; Make KEY to index entry properly
8855 (setq key (cond ((eq type 'system) type)
8856 (file (file-truename file))
8857 (t 'unresolved)))
8859 ;; Check for an entry in the system library
8860 (if (and file
8861 (not syslibp)
8862 (idlwave-syslib-p file))
8863 (setq syslibp t))
8865 ;; If there's more than one matching entry for the same file, just
8866 ;; append the type-cons to the type list.
8867 (if (setq entry (assoc key alist))
8868 (push type-cons (nth 2 entry))
8869 (push (list key file (list type-cons)) alist)))
8871 (setq alist (nreverse alist))
8873 (when syslibp
8874 ;; File is in system *library* - remove any 'system entry
8875 (setq alist (delq (assq 'system alist) alist)))
8877 ;; If 'system remains and we've scanned the syslib, it's a builtin
8878 ;; (rather than a !DIR/lib/.pro file bundled as source).
8879 (when (and (idlwave-syslib-scanned-p)
8880 (setq entry (assoc 'system alist)))
8881 (setcar entry 'builtin))
8882 (sort alist 'idlwave-routine-twin-compare)))
8884 (defvar type)
8885 (defvar class)
8886 (defvar idlwave-sort-prefer-buffer-info t
8887 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8889 (defmacro idlwave-xor (a b)
8890 `(and (or ,a ,b)
8891 (not (and ,a ,b))))
8893 (defun idlwave-routine-entry-compare (a b)
8894 "Compare two routine info entries for sortiung. This is the general case.
8895 It first compates class, names, and type. If it turns out that A and B
8896 are twins (same name, class, and type), calls another routine which
8897 compares twins on the basis of their file names and path locations."
8898 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8899 (cond
8900 ((not (equal (idlwave-downcase-safe class)
8901 (idlwave-downcase-safe (nth 2 b))))
8902 ;; Class decides
8903 (cond ((null (nth 2 b)) nil)
8904 ((null class) t)
8905 (t (string< (downcase class) (downcase (nth 2 b))))))
8906 ((not (equal (downcase name) (downcase (car b))))
8907 ;; Name decides
8908 (string< (downcase name) (downcase (car b))))
8909 ((not (eq type (nth 1 b)))
8910 ;; Type decides
8911 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8912 (t
8913 ;; A and B are twins - so the decision is more complicated.
8914 ;; Call twin-compare with the proper arguments.
8915 (idlwave-routine-entry-compare-twins a b)))))
8917 (defun idlwave-routine-entry-compare-twins (a b)
8918 "Compare two routine entries, under the assumption that they are
8919 twins. This basically calls `idlwave-routine-twin-compare' with the
8920 correct args."
8921 (let* ((name (car a)) (type (nth 1 a)) (class (nth 2 a)) ; needed outside
8922 (asrc (nth 3 a))
8923 (atype (car asrc))
8924 (bsrc (nth 3 b))
8925 (btype (car bsrc))
8926 (afile (idlwave-routine-source-file asrc))
8927 (bfile (idlwave-routine-source-file bsrc)))
8928 (idlwave-routine-twin-compare
8929 (if (stringp afile)
8930 (list (file-truename afile) afile (list atype))
8931 (list atype afile (list atype)))
8932 (if (stringp bfile)
8933 (list (file-truename bfile) bfile (list btype))
8934 (list btype bfile (list btype))))
8935 ))
8937 (defun idlwave-routine-twin-compare (a b)
8938 "Compare two routine twin entries for sorting.
8939 In here, A and B are not normal routine info entries, but special
8940 lists (KEY FILENAME (TYPES...)).
8941 This expects NAME TYPE CLASS to be bound to the right values."
8942 (let* (;; Dis-assemble entries
8943 (akey (car a)) (bkey (car b))
8944 (afile (nth 1 a)) (bfile (nth 1 b))
8945 (atypes (nth 2 a)) (btypes (nth 2 b))
8946 ;; System routines?
8947 (asysp (memq akey '(builtin system)))
8948 (bsysp (memq bkey '(builtin system)))
8949 ;; Compiled routines?
8950 (acompp (memq 'compiled atypes))
8951 (bcompp (memq 'compiled btypes))
8952 ;; Unresolved?
8953 (aunresp (or (eq akey 'unresolved)
8954 (and acompp (not afile))))
8955 (bunresp (or (eq bkey 'unresolved)
8956 (and bcompp (not bfile))))
8957 ;; Buffer info available?
8958 (abufp (memq 'buffer atypes))
8959 (bbufp (memq 'buffer btypes))
8960 ;; On search path?
8961 (tpath-alist (idlwave-true-path-alist))
8962 (apathp (and (stringp akey)
8963 (assoc (file-name-directory akey) tpath-alist)))
8964 (bpathp (and (stringp bkey)
8965 (assoc (file-name-directory bkey) tpath-alist)))
8966 ;; How early on search path? High number means early since we
8967 ;; measure the tail of the path list
8968 (anpath (length (memq apathp tpath-alist)))
8969 (bnpath (length (memq bpathp tpath-alist)))
8970 ;; Look at file names
8971 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8972 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8974 (regexp-quote (downcase class))
8975 (regexp-quote (downcase name)))
8977 ;; Is file name derived from the routine name?
8978 ;; Method file or class definition file?
8979 (anamep (string-match fname-re aname))
8980 (adefp (and class anamep (string= "define" (match-string 1 aname))))
8981 (bnamep (string-match fname-re bname))
8982 (bdefp (and class bnamep (string= "define" (match-string 1 bname)))))
8984 ;; Now: follow JD's ideas about sorting. Looks really simple now,
8985 ;; doesn't it? The difficult stuff is hidden above...
8986 (cond
8987 ((idlwave-xor asysp bsysp) asysp) ; System entries first
8988 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
8989 ((and idlwave-sort-prefer-buffer-info
8990 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
8991 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
8992 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
8993 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
8994 ((and class anamep bnamep ; both file names match ->
8995 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
8996 ((> anpath bnpath) t) ; Who is first on path?
8997 (t nil)))) ; Default
8999 (defun idlwave-routine-source-file (source)
9000 (if (nth 2 source)
9001 (expand-file-name (nth 1 source) (nth 2 source))
9002 (nth 1 source)))
9004 (defun idlwave-downcase-safe (string)
9005 "Donwcase if string, else return unchanged."
9006 (if (stringp string)
9007 (downcase string)
9008 string))
9010 (defun idlwave-count-eq (elt list)
9011 "How often is ELT in LIST?"
9012 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
9014 (defun idlwave-count-memq (elt alist)
9015 "How often is ELT a key in ALIST?"
9016 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
9018 (defun idlwave-syslib-p (file)
9019 "Non-nil if FILE is in the system library."
9020 (let* ((true-syslib (file-name-as-directory
9021 (file-truename
9022 (expand-file-name "lib" (idlwave-sys-dir)))))
9023 (true-file (file-truename file)))
9024 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
9026 (defun idlwave-lib-p (file)
9027 "Non-nil if file is in the library"
9028 (let ((true-dir (file-name-directory (file-truename file))))
9029 (assoc true-dir (idlwave-true-path-alist))))
9031 (defun idlwave-path-alist-add-flag (list-entry flag)
9032 "Add a flag to the path list entry, if not set."
9033 (let ((flags (cdr list-entry)))
9034 (add-to-list 'flags flag)
9035 (setcdr list-entry flags)))
9037 (defun idlwave-path-alist-remove-flag (list-entry flag)
9038 "Remove a flag to the path list entry, if set."
9039 (let ((flags (delq flag (cdr list-entry))))
9040 (setcdr list-entry flags)))
9042 (defun idlwave-true-path-alist ()
9043 "Return `idlwave-path-alist' alist with true-names.
9044 Info is cached, but relies on the functions setting `idlwave-path-alist'
9045 to reset the variable `idlwave-true-path-alist' to nil."
9046 (or idlwave-true-path-alist
9047 (setq idlwave-true-path-alist
9048 (mapcar (lambda(x) (cons
9049 (file-name-as-directory
9050 (file-truename
9051 (directory-file-name
9052 (car x))))
9053 (cdr x)))
9054 idlwave-path-alist))))
9056 (defun idlwave-syslib-scanned-p ()
9057 "Non-nil if the system lib file !DIR/lib has been scanned."
9058 (let* ((true-syslib (file-name-as-directory
9059 (file-truename
9060 (expand-file-name "lib" (idlwave-sys-dir))))))
9061 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
9063 ;; ----------------------------------------------------------------------------
9064 ;;
9065 ;; Online Help display
9068 ;; ----------------------------------------------------------------------------
9069 ;;
9070 ;; Additions for use with imenu.el and func-menu.el
9071 ;; (pop-up a list of IDL units in the current file).
9072 ;;
9074 (defun idlwave-prev-index-position ()
9075 "Search for the previous procedure or function.
9076 Return nil if not found. For use with imenu.el."
9077 (save-match-data
9078 (cond
9080 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
9081 (t nil))))
9083 (defun idlwave-unit-name ()
9084 "Return the unit name.
9085 Assumes that point is at the beginning of the unit as found by
9086 `idlwave-prev-index-position'."
9087 (forward-sexp 2)
9088 (forward-sexp -1)
9089 (let ((begin (point)))
9090 (re-search-forward
9092 (if (fboundp 'buffer-substring-no-properties)
9093 (buffer-substring-no-properties begin (point))
9094 (buffer-substring begin (point)))))
9096 (defalias 'idlwave-function-menu
9097 (condition-case nil
9098 (progn
9099 (require 'func-menu)
9100 'function-menu)
9101 (error (condition-case nil
9102 (progn
9103 (require 'imenu)
9104 'imenu)
9105 (error nil)))))
9107 ;; Here we hack func-menu.el in order to support this new mode.
9108 ;; The latest versions of func-menu.el already have this stuff in, so
9109 ;; we hack only if it is not already there.
9110 (when (fboundp 'eval-after-load)
9111 (eval-after-load "func-menu"
9112 '(progn
9113 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
9114 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
9115 (setq fume-function-name-regexp-alist
9116 (cons '(idlwave-mode . fume-function-name-regexp-idl)
9117 fume-function-name-regexp-alist)))
9118 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
9119 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
9120 (setq fume-find-function-name-method-alist
9121 (cons '(idlwave-mode . fume-find-next-idl-function-name)
9122 fume-find-function-name-method-alist))))))
9124 (defun idlwave-edit-in-idlde ()
9125 "Edit the current file in IDL Development environment."
9126 (interactive)
9127 (start-process "idldeclient" nil
9128 idlwave-shell-explicit-file-name "-c" "-e"
9129 (buffer-file-name)))
9131 (defvar idlwave-help-use-assistant)
9132 (defun idlwave-launch-idlhelp ()
9133 "Start the IDLhelp application."
9134 (interactive)
9135 (if idlwave-help-use-assistant
9136 (idlwave-help-assistant-raise)
9137 (start-process "idlhelp" nil idlwave-help-application)))
9139 ;; Menus - using easymenu.el
9140 (defvar idlwave-mode-menu-def
9141 `("IDLWAVE"
9142 ["PRO/FUNC menu" idlwave-function-menu t]
9143 ("Motion"
9144 ["Subprogram Start" idlwave-beginning-of-subprogram t]
9145 ["Subprogram End" idlwave-end-of-subprogram t]
9146 ["Block Start" idlwave-beginning-of-block t]
9147 ["Block End" idlwave-end-of-block t]
9148 ["Up Block" idlwave-backward-up-block t]
9149 ["Down Block" idlwave-down-block t]
9150 ["Skip Block Backward" idlwave-backward-block t]
9151 ["Skip Block Forward" idlwave-forward-block t])
9152 ("Mark"
9153 ["Subprogram" idlwave-mark-subprogram t]
9154 ["Block" idlwave-mark-block t]
9155 ["Header" idlwave-mark-doclib t])
9156 ("Format"
9157 ["Indent Entire Statement" idlwave-indent-statement
9159 ["Indent Subprogram" idlwave-indent-subprogram t]
9160 ["(Un)Comment Region" idlwave-toggle-comment-region t]
9161 ["Continue/Split line" idlwave-split-line t]
9162 "--"
9163 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
9164 :selected (symbol-value idlwave-fill-function)])
9165 ("Templates"
9166 ["Procedure" idlwave-procedure t]
9167 ["Function" idlwave-function t]
9168 ["Doc Header" idlwave-doc-header t]
9169 ["Log" idlwave-doc-modification t]
9170 "--"
9171 ["Case" idlwave-case t]
9172 ["For" idlwave-for t]
9173 ["Repeat" idlwave-repeat t]
9174 ["While" idlwave-while t]
9175 "--"
9176 ["Close Block" idlwave-close-block t])
9177 ("Completion"
9178 ["Complete" idlwave-complete t]
9179 ("Complete Specific"
9180 ["1 Procedure Name" (idlwave-complete 'procedure) t]
9181 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
9182 "--"
9183 ["3 Function Name" (idlwave-complete 'function) t]
9184 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
9185 "--"
9186 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
9187 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
9188 "--"
9189 ["7 Function Method Name" (idlwave-complete 'function-method) t]
9190 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
9191 "--"
9192 ["9 Class Name" idlwave-complete-class t]))
9193 ("Routine Info"
9194 ["Show Routine Info" idlwave-routine-info t]
9195 ["Online Context Help" idlwave-context-help t]
9196 "--"
9197 ["Find Routine Source" idlwave-find-module t]
9198 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
9199 "--"
9200 ["Update Routine Info" idlwave-update-routine-info t]
9201 ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t]
9202 "--"
9203 "IDL User Catalog"
9204 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
9205 ["Scan Directories" (idlwave-update-routine-info '(16))
9206 (and idlwave-path-alist (not idlwave-catalog-process))]
9207 ["Scan Directories &" (idlwave-update-routine-info '(64))
9208 (and idlwave-path-alist (not idlwave-catalog-process))]
9209 "--"
9210 "Routine Shadows"
9211 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
9212 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
9213 ["Check Everything" idlwave-list-all-load-path-shadows t])
9214 ("Misc"
9215 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
9216 "--"
9217 ["Insert TAB character" idlwave-hard-tab t])
9218 "--"
9219 ("External"
9220 ["Start IDL shell" idlwave-shell t]
9221 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
9222 ["Launch IDL Help" idlwave-launch-idlhelp t])
9223 "--"
9224 ("Customize"
9225 ["Browse IDLWAVE Group" idlwave-customize t]
9226 "--"
9227 ["Build Full Customize Menu" idlwave-create-customize-menu
9228 (fboundp 'customize-menu-create)])
9229 ("Documentation"
9230 ["Describe Mode" describe-mode t]
9231 ["Abbreviation List" idlwave-list-abbrevs t]
9232 "--"
9233 ["Commentary in idlwave.el" idlwave-show-commentary t]
9234 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
9235 "--"
9236 ["Info" idlwave-info t]
9237 "--"
9238 ["Help with Topic" idlwave-help-assistant-help-with-topic
9239 idlwave-help-use-assistant]
9240 ["Launch IDL Help" idlwave-launch-idlhelp t])))
9242 (defvar idlwave-mode-debug-menu-def
9243 '("Debug"
9244 ["Start IDL shell" idlwave-shell t]
9245 ["Save and .RUN buffer" idlwave-shell-save-and-run
9246 (and (boundp 'idlwave-shell-automatic-start)
9247 idlwave-shell-automatic-start)]))
9249 (if (or (featurep 'easymenu) (load "easymenu" t))
9250 (progn
9251 (easy-menu-define idlwave-mode-menu idlwave-mode-map
9252 "IDL and WAVE CL editing menu"
9253 idlwave-mode-menu-def)
9254 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
9255 "IDL and WAVE CL editing menu"
9256 idlwave-mode-debug-menu-def)))
9258 (defun idlwave-customize ()
9259 "Call the customize function with idlwave as argument."
9260 (interactive)
9261 ;; Try to load the code for the shell, so that we can customize it
9262 ;; as well.
9263 (or (featurep 'idlw-shell)
9264 (load "idlw-shell" t))
9265 (customize-browse 'idlwave))
9267 (defun idlwave-create-customize-menu ()
9268 "Create a full customization menu for IDLWAVE, insert it into the menu."
9269 (interactive)
9270 (if (fboundp 'customize-menu-create)
9271 (progn
9272 ;; Try to load the code for the shell, so that we can customize it
9273 ;; as well.
9274 (or (featurep 'idlw-shell)
9275 (load "idlw-shell" t))
9276 (easy-menu-change
9277 '("IDLWAVE") "Customize"
9278 `(["Browse IDLWAVE group" idlwave-customize t]
9279 "--"
9280 ,(customize-menu-create 'idlwave)
9281 ["Set" Custom-set t]
9282 ["Save" Custom-save t]
9283 ["Reset to Current" Custom-reset-current t]
9284 ["Reset to Saved" Custom-reset-saved t]
9285 ["Reset to Standard Settings" Custom-reset-standard t]))
9287 (error "Cannot expand menu (outdated version of cus-edit.el)")))
9289 (defun idlwave-show-commentary ()
9290 "Use the finder to view the file documentation from `idlwave.el'."
9291 (interactive)
9292 (finder-commentary "idlwave.el"))
9294 (defun idlwave-shell-show-commentary ()
9295 "Use the finder to view the file documentation from `idlw-shell.el'."
9296 (interactive)
9297 (finder-commentary "idlw-shell.el"))
9299 (defun idlwave-info ()
9300 "Read documentation for IDLWAVE in the info system."
9301 (interactive)
9302 (info "idlwave"))
9304 (defun idlwave-list-abbrevs (arg)
9305 "Show the code abbreviations define in IDLWAVE mode.
9306 This lists all abbrevs where the replacement text differs from the input text.
9307 These are the ones the users want to learn to speed up their writing.
9309 The function does *not* list abbrevs which replace a word with itself
9310 to call a hook. These hooks are used to change the case of words or
9311 to blink the matching `begin', and the user does not need to know them.
9313 With arg, list all abbrevs with the corresponding hook.
9315 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
9317 (interactive "P")
9318 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
9319 abbrevs
9320 str rpl func fmt (len-str 0) (len-rpl 0))
9321 (mapatoms
9322 (lambda (sym)
9323 (if (symbol-value sym)
9324 (progn
9325 (setq str (symbol-name sym)
9326 rpl (symbol-value sym)
9327 func (symbol-function sym))
9328 (if arg
9329 (setq func (prin1-to-string func))
9330 (if (and (listp func) (stringp (nth 2 func)))
9331 (setq rpl (concat "EVAL: " (nth 2 func))
9332 func "")
9333 (setq func "")))
9334 (if (or arg (not (string= rpl str)))
9335 (progn
9336 (setq len-str (max len-str (length str)))
9337 (setq len-rpl (max len-rpl (length rpl)))
9338 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
9339 table)
9340 ;; sort the list
9341 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
9342 ;; Make the format
9344 (with-output-to-temp-buffer "*Help*"
9345 (if arg
9346 (progn
9349 (princ (format fmt "KEY" "REPLACE" "HOOK"))
9350 (princ (format fmt "---" "-------" "----")))
9353 (princ (format fmt "KEY" "ACTION" ""))
9354 (princ (format fmt "---" "------" "")))
9355 (mapcar
9356 (lambda (list)
9357 (setq str (car list)
9358 rpl (nth 1 list)
9359 func (nth 2 list))
9360 (princ (format fmt str rpl func)))
9361 abbrevs)))
9362 ;; Make sure each abbreviation uses only one display line
9363 (save-excursion
9364 (set-buffer "*Help*")
9365 (setq truncate-lines t)))
9367 ;; Add .pro files to speedbar for support, if it's loaded
9368 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
9370 ;; Set an idle timer to load the routine info.
9371 ;; Will only work on systems which support this.
9372 (or idlwave-routines (idlwave-start-load-rinfo-timer))
9376 ;; Run the hook
9377 (run-hooks 'idlwave-load-hook)
9379 (provide 'idlwave)
9381 ;; arch-tag: f77f3b0c-c37c-424f-a328-0886fd42b6fb
9382 ;;; idlwave.el ends here