| blob | 8066e1c3a7f3da3427c98e74c824471b6e3d3a77 |
1 ;; idlwave.el --- IDL editing mode for GNU Emacs
3 ;; Copyright (C) 1999-2011 Free Software Foundation, Inc.
5 ;; Authors: J.D. Smith <jdsmith@as.arizona.edu>
6 ;; Carsten Dominik <dominik@science.uva.nl>
7 ;; Chris Chase <chase@att.com>
8 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
9 ;; Version: 6.1.22
10 ;; Keywords: languages
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software: you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation, either version 3 of the License, or
17 ;; (at your option) any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Commentary:
29 ;; IDLWAVE enables feature-rich development and interaction with IDL,
30 ;; the Interactive Data Language. It provides a compelling,
31 ;; full-featured alternative to the IDLDE development environment
32 ;; bundled with IDL.
34 ;; In the remotely distant past, based on pascal.el, though bears
35 ;; little resemblance to it now.
36 ;;
37 ;; Incorporates many ideas, such as abbrevs, action routines, and
38 ;; continuation line indenting, from wave.el.
39 ;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder.
40 ;;
41 ;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode")
42 ;; for features, key bindings, and info.
43 ;; Also, Info format documentation is available with `M-x idlwave-info'
44 ;;
45 ;; New versions of IDLWAVE, documentation, and more information
46 ;; available from:
47 ;; http://idlwave.org
48 ;;
49 ;; INSTALLATION
50 ;; ============
51 ;;
52 ;; Follow the instructions in the INSTALL file of the distribution.
53 ;; In short, put this file on your load path and add the following
54 ;; lines to your .emacs file:
55 ;;
56 ;; (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
57 ;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
58 ;; (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
59 ;;
60 ;;
61 ;; SOURCE
62 ;; ======
63 ;;
64 ;; The newest version of this file is available from the maintainer's
65 ;; Webpage:
66 ;;
67 ;; http://idlwave.org
68 ;;
69 ;; DOCUMENTATION
70 ;; =============
71 ;;
72 ;; IDLWAVE is documented online in info format. A printable version
73 ;; of the documentation is available from the maintainers webpage (see
74 ;; SOURCE).
75 ;;
76 ;;
77 ;; ACKNOWLEDGMENTS
78 ;; ===============
79 ;;
80 ;; Thanks to the following people for their contributions and comments:
81 ;;
82 ;; Ulrik Dickow <dickow_at_nbi.dk>
83 ;; Eric E. Dors <edors_at_lanl.gov>
84 ;; Stein Vidar H. Haugan <s.v.h.haugan_at_astro.uio.no>
85 ;; David Huenemoerder <dph_at_space.mit.edu>
86 ;; Kevin Ivory <Kevin.Ivory_at_linmpi.mpg.de>
87 ;; Dick Jackson <dick_at_d-jackson.com>
88 ;; Xuyong Liu <liu_at_stsci.edu>
89 ;; Simon Marshall <Simon.Marshall_at_esrin.esa.it>
90 ;; Laurent Mugnier <mugnier_at_onera.fr>
91 ;; Lubos Pochman <lubos_at_rsinc.com>
92 ;; Bob Portmann <portmann_at_al.noaa.gov>
93 ;; Patrick M. Ryan <pat_at_jaameri.gsfc.nasa.gov>
94 ;; Marty Ryba <ryba_at_ll.mit.edu>
95 ;; Paul Sorenson <aardvark62_at_msn.com>
96 ;; Phil Sterne <sterne_at_dublin.llnl.gov>
97 ;; Phil Williams <williams_at_irc.chmcc.org>
98 ;;
99 ;; CUSTOMIZATION:
100 ;; =============
101 ;;
102 ;; IDLWAVE has extensive customize support; to learn about the
103 ;; variables which control the mode's behavior, use `M-x
104 ;; idlwave-customize'.
105 ;;
106 ;; You can set your own preferred values with Customize, or with Lisp
107 ;; code in .emacs. For an example of what to put into .emacs, check
108 ;; the TexInfo documentation or see a complete .emacs available at the
109 ;; website.
110 ;;
111 ;; KNOWN PROBLEMS:
112 ;; ==============
113 ;;
114 ;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual
115 ;; Numerics, Inc. is growing less and less complete as the two
116 ;; languages grow increasingly apart. The mode probably shouldn't
117 ;; even have "WAVE" in its title, but it's catchy, and was required
118 ;; to avoid conflict with the CORBA idl.el mode. Caveat WAVEor.
119 ;;
120 ;; Moving the point backwards in conjunction with abbrev expansion
121 ;; does not work as I would like it, but this is a problem with
122 ;; emacs abbrev expansion done by the self-insert-command. It ends
123 ;; up inserting the character that expanded the abbrev after moving
124 ;; point backward, e.g., "\cl" expanded with a space becomes
125 ;; "LONG( )" with point before the close paren. This is solved by
126 ;; using a temporary function in `post-command-hook' - not pretty,
127 ;; but it works.
128 ;;
129 ;; Tabs and spaces are treated equally as whitespace when filling a
130 ;; comment paragraph. To accomplish this, tabs are permanently
131 ;; replaced by spaces in the text surrounding the paragraph, which
132 ;; may be an undesirable side-effect. Replacing tabs with spaces is
133 ;; limited to comments only and occurs only when a comment
134 ;; paragraph is filled via `idlwave-fill-paragraph'.
135 ;;
136 ;; Muti-statement lines (using "&") on block begin and end lines can
137 ;; ruin the formatting. For example, multiple end statements on a
138 ;; line: endif & endif. Using "&" outside of block begin/end lines
139 ;; should be okay.
140 ;;
141 ;; Determining the expression at point for printing and other
142 ;; examination commands is somewhat rough: currently only fairly
143 ;; simple entities are found. You can always drag-select or examine
144 ;; a pre-selected region.
145 ;;
146 ;; When forcing completion of method keywords, the initial
147 ;; query for a method has multiple entries for some methods. Would
148 ;; be too difficult to fix this hardly used case.
149 ;;
150 \f
151 ;;; Code:
157 ;; For XEmacs
179 "Major mode for editing IDL .pro files."
191 ;;; Variables for indentation behavior ---------------------------------------
194 "Indentation and formatting options for IDLWAVE mode."
198 "*Extra indentation for the main block of code.
199 That is the block between the FUNCTION/PRO statement and the END
200 statement for that program unit."
205 "*Extra indentation applied to block lines.
206 If you change this, you probably also want to change `idlwave-end-offset'."
211 "*Extra indentation applied to block END lines.
212 A value equal to negative `idlwave-block-indent' will make END lines
213 line up with the block BEGIN lines."
218 "*Extra indentation applied to continuation lines.
219 This extra offset applies to the first of a set of continuation lines.
220 The following lines receive the same indentation as the first."
225 "*Maximum additional indentation for special continuation indent.
226 Several special indentations are tried to help line up continuation
227 lines in routine calls or definitions, other statements with
228 parentheses, or assignment statements. This variable specifies a
229 maximum amount by which this special indentation can exceed the
230 standard continuation indentation, otherwise defaulting to a fixed
231 offset. Set to 0 to effectively disable all special continuation
232 indentation, or to a large number (like 100) to enable it in all
233 cases. See also `idlwave-indent-to-open-paren', which can override
234 this variable."
239 "*Non-nil means, indent continuation lines to innermost open parenthesis.
240 This indentation occurs even if otherwise disallowed by
241 `idlwave-max-extra-continuation-indent'. Matching parens and the
242 interleaving args are lined up. Example:
244 x = function_a(function_b(function_c( a, b, [1,2,3, $
245 4,5,6 $
246 ], $
247 c, d $
248 )))
250 When this variable is nil, paren alignment may still occur, based on
251 the value of `idlwave-max-extra-continuation-indent', which, if zero,
252 would yield:
254 x = function_a(function_b(function_c( a, b, [1,2,3, $
255 4,5,6 $
256 ], $
257 c, d $
258 )))"
263 "*Non-nil means, indent continuation lines with parens by nesting
264 lines at consecutively deeper levels."
270 "*If set non-nil then comment paragraphs are indented under the
271 hanging indent given by `idlwave-hang-indent-regexp' match in the first line
272 of the paragraph."
277 "*Regular expression matching the position of the hanging indent
278 in the first line of a comment paragraph. The size of the indent
279 extends to the end of the match for the regular expression."
284 "*If non-nil then use last match on line for `idlwave-indent-regexp'."
289 "*If non-nil then auto fill will only operate on comment lines."
294 "*If non-nil then auto fill will split strings with the IDL `+' operator.
295 When the line end falls within a string, string concatenation with the
296 '+' operator will be used to distribute a long string over lines.
297 If nil and a string is split then a terminal beep and warning are issued.
299 This variable is ignored when `idlwave-fill-comment-line-only' is
300 non-nil, since in this case code is not auto-filled."
305 "*If non-nil then `idlwave-split-line' will split strings with `+'.
306 When the splitting point of a line falls inside a string, split the string
307 using the `+' string concatenation operator. If nil and a string is
308 split then a terminal beep and warning are issued."
313 "*The indentation of a comment that starts with this regular
314 expression will not be changed. Note that the indentation of a comment
315 at the beginning of a line is never changed."
320 "*A comment anchored at the beginning of line.
321 A comment matching this regular expression will not have its
330 "*A comment that starts with this regular expression on a line by
331 itself is indented as if it is a part of IDL code. As a result if
332 the comment is not preceded by whitespace it is unchanged."
336 ;; Comments not matching any of the above will be indented as a
337 ;; right-margin comment, i.e., to a minimum of `comment-column'.
339 ;;; Routine Info and Completion ---------------------------------------
342 "Routine Info options for IDLWAVE mode."
346 "*Non-nil means search the IDL path for library catalog files.
348 These files, named .idlwave_catalog, document routine information for
349 individual directories and libraries of IDL .pro files. Many popular
350 libraries come with catalog files by default, so leaving this on is
351 usually a good idea."
356 "*Seconds of idle time before routine info is automatically initialized.
357 Initializing the routine info can take a long time, in particular if a
358 large number of library catalogs are involved. When Emacs is idle for
359 more than the number of seconds specified by this variable, it starts
360 the initialization. The process is split into five steps, in order to
361 keep work interruption as short as possible. If one of the steps
362 finishes, and no user input has arrived in the mean time, initialization
363 proceeds immediately to the next step. A good value for this variable
364 is about 1/3 of the time initialization take in your setup. So if you
365 have a fast machine and no problems with a slow network connection,
366 don't hesitate to set this to 2 seconds. A value of 0 means, don't
367 initialize automatically, but instead wait until routine information is
368 needed, and initialize then."
373 "*Non-nil means, scan buffers for IDL programs when updating info.
374 The scanning is done by the command `idlwave-update-routine-info'.
375 The following values are allowed:
377 nil Don't scan any buffers.
378 t Scan all `idlwave-mode' buffers in the current editing session.
379 current Scan only the current buffer, but no other buffers."
387 "*Non-nil means query the shell for info about compiled routines.
388 Querying the shell is useful to get information about compiled modules,
389 and it is turned on by default. However, when you have a complete library
390 scan, this is not necessary."
396 "*Controls under what circumstances routine info is updated automatically.
397 Possible values:
398 nil Never
399 t All available
400 \(...) A list of circumstances. Allowed members are:
401 find-file Add info for new IDLWAVE buffers.
402 save-buffer Update buffer info when buffer is saved
403 kill-buffer Remove buffer info when buffer gets killed
404 compile-buffer Update shell info after `idlwave-shell-save-and...'"
416 "*Maximum number of source files displayed in the Routine Info window.
417 When an integer, it is the maximum number of source files displayed.
418 A value of t means to show all source files."
423 "Library path for Windows and MacOS (OS9). Not needed under UNIX.
424 When selecting the directories to scan for IDL user catalog routine
425 info, IDLWAVE can, under UNIX, query the shell for the exact search
426 path \(the value of !PATH). However, under Windows and MacOS
427 \(pre-OSX), the IDLWAVE shell does not work. In this case, this
428 variable can be set to specify the paths where IDLWAVE can find PRO
429 files. The shell will only be asked for a list of paths when this
430 variable is nil. The value is a list of directories. A directory
431 preceded by a `+' will be searched recursively. If you set this
432 variable on a UNIX system, the shell will not be queried. See also
433 `idlwave-system-directory'."
438 "The IDL system directory for Windows and MacOS. Not needed under
439 UNIX. Set this to the value of the `!DIR' system variable in IDL.
440 IDLWAVE uses this to find out which of the library routines belong to
441 the official system library. All files inside the `lib' subdirectory
442 are considered system library files - so don't install private stuff
443 in this directory. On UNIX systems, IDLWAVE queries the shell for the
444 value of `!DIR'. See also `idlwave-library-path'."
448 ;; Configuration files
451 "*Directory for configuration files and user-library catalog."
463 "Alist of regular expressions matching special library directories.
464 When listing routine source locations, IDLWAVE gives a short hint where
465 the file defining the routine is located. By default it lists `SystemLib'
466 for routines in the system library `!DIR/lib' and `Library' for anything
467 else. This variable can define additional types. The car of each entry
468 is a regular expression matching the file name (they normally will match
469 on the path). The cdr is the string to be used as identifier. Max 10
470 chars are allowed."
476 "Write out path (!PATH) and system directory (!DIR) info automatically.
477 Path info is needed to locate library catalog files. If non-nil,
478 whenever the path-list changes as a result of shell-query, etc., it is
480 used to force a write."
485 "Completion options for IDLWAVE mode."
502 "Association list setting the case of completed words.
504 This variable determines the case (UPPER/lower/Capitalized...) of
505 words inserted into the buffer by completion. The preferred case can
506 be specified separately for routine names, keywords, classes and
507 methods.
508 This alist should therefore have entries for `routine' (normal
509 functions and procedures, i.e. non-methods), `keyword', `class', and
510 `method'. Plausible values are
512 upcase upcase whole word, like `BOX_CURSOR'
513 downcase downcase whole word, like `read_ppm'
514 capitalize capitalize each part, like `Widget_Control'
515 preserve preserve case as is, like `IDLgrView'
517 The value can also be any Emacs Lisp function which transforms the
518 case of characters in a string.
520 A value of `preserve' means that the case of the completed word is
521 identical to the way it was written in the definition statement of the
522 routine. This was implemented to allow for mixed-case completion, in
523 particular of object classes and methods.
524 If a completable word is defined in multiple locations, the meaning of
525 `preserve' is not unique since the different definitions might be
526 cased differently. Therefore IDLWAVE always takes the case of the
527 *first* definition it encounters during routine info collection and
528 uses the case derived from it consistently.
530 Note that a lowercase-only string in the buffer will always be completed in
531 lower case (but see the variable `idlwave-completion-force-default-case').
533 After changing this variable, you need to either restart Emacs or press
534 `C-u C-c C-i' to update the internal lists."
541 "*Non-nil means, completion will always honor `idlwave-completion-case'.
542 When nil, only the completion of a mixed case or upper case string
543 will honor the default settings in `idlwave-completion-case', while
544 the completion of lower case strings will be completed entirely in
545 lower case."
550 "*Non-nil means, the empty string is considered downcase for completion.
551 The case of what is already in the buffer determines the case of completions.
552 When this variable is non-nil, the empty string is considered to be downcase.
553 Completing on the empty string then offers downcase versions of the possible
554 completions."
559 "Obsolete variable. See `idlwave-complete-empty-string-as-lower-case' and
563 "*Non-nil means, the case of tokens in buffers dominates over system stuff.
564 To make this possible, we need to re-case everything each time we update
565 the routine info from the buffers. This is slow.
566 The default is to consider the case given in the system and library files
567 first which makes updating much faster."
572 "*Non-nil means, highlight completions for which system help is available.
573 Help can then be accessed with mouse-3.
574 This option is only effective when the online help system is installed."
579 "Non-nil means, treat inheritance with completion, online help etc.
580 When nil, IDLWAVE only knows about the native methods and tags of a class,
581 not about inherited ones."
586 "List of regular expressions for class-driven keyword inheritance.
588 up the class tree. While it cannot be assumed that the presence of an
589 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
590 certain methods this assumption is almost always true. The methods
591 for which to assume this can be set here."
597 "*Number of classes to show when completing object methods and keywords.
598 When completing methods or keywords for an object with unknown class,
599 the *Completions* buffer will show the valid classes for each completion
600 like this:
602 MyMethod <Class1,Class2,Class3>
604 The value of this variable may be nil to inhibit display, or an integer to
605 indicate the maximum number of classes to display.
607 On XEmacs, a full list of classes will also be placed into a `help-echo'
608 property on the competion items, so that the list of classes for the current
609 item is displayed in the echo area. If the value of this variable is a
610 negative integer, the `help-echo' property will be suppressed."
616 "*Non-nil means, fontify the classes in completions buffer.
617 This makes it easier to distinguish the completion items from the extra
618 class info listed. See `idlwave-completion-show-classes'."
624 "Association list governing specification of object classes for completion.
626 When IDLWAVE tries to complete object-oriented methods, it usually
627 cannot determine the class of a given object from context. In order
628 to provide the user with a correct list of methods or keywords, it
629 needs to determine the appropriate class. IDLWAVE has two ways of
630 doing this (well, three ways if you count the shell... see
631 `idlwave-shell-query-for-class'):
633 1. Combine the items of all available classes which contain this
634 method for the purpose of completion. So when completing a method,
635 all methods of all known classes are available, and when completing
636 a keyword, all keywords allowed for this method in any class are
637 shown. This behavior is very much like normal completion and is
638 therefore the default. It works much better than one might think -
639 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
640 become uncomfortably long. See also
641 `idlwave-completion-show-classes'.
643 2. The second possibility is to ask the user on each occasion. To
644 make this less interruptive, IDLWAVE can store the class as a text
645 property on the object operator `->'. For a given object in the
646 source code, class selection will then be needed only once
647 - for example to complete the method. Keywords to the method can
648 then be completed directly, because the class is already known.
649 You will have to turn on the storage of the selected class
650 explicitly with the variable `idlwave-store-inquired-class'.
652 This variable allows you to configure IDLWAVE's method and
653 method-keyword completion behavior. Its value is an alist, which
654 should contain at least two elements: (method-default . VALUE) and
655 \(keyword-default . VALUE), where VALUE is either t or nil. These
656 specify if the class should be found during method and keyword
657 completion, respectively.
659 The alist may have additional entries specifying exceptions from the
660 keyword completion rule for specific methods, like INIT or
661 GETPROPERTY. In order to turn on class specification for the INIT
671 :inline t
676 "*Non-nil means, store class of a method call as text property on `->'.
677 IDLWAVE sometimes has to ask the user for the class associated with a
678 particular object method call. This happens during the commands
679 `idlwave-routine-info' and `idlwave-complete', depending upon the
680 value of the variable `idlwave-query-class'.
682 When you specify a class, this information can be stored as a text
683 property on the `->' arrow in the source code, so that during the same
684 editing session, IDLWAVE will not have to ask again. When this
685 variable is non-nil, IDLWAVE will store and reuse the class information.
687 on the arrow.
689 The default of this variable is nil, since the result of commands then
690 is more predictable. However, if you know what you are doing, it can
691 be nice to turn this on.
693 An arrow which knows the class will be highlighted with
695 displays (with prefix arg: deletes) the class stored on the arrow
696 at point."
701 "*Face to highlight object operator arrows `->' which carry a class property.
702 When IDLWAVE stores a class name as text property on an object arrow
703 \(see variable `idlwave-store-inquired-class', it highlights the arrow
704 with this font in order to remind the user that this arrow is special."
709 "*Non-nil means, resize the Routine-info *Help* window to fit the content."
714 "*Non-nil means, completion automatically adds `=' after completed keywords."
719 "*Non-nil means, completion automatically adds `(' after completed function.
720 nil means, don't add anything.
721 A value of `2' means, also add the closing parenthesis and position cursor
722 between the two."
729 "*Non-nil means, try to restore the window configuration after completion.
730 When completion is not unique, Emacs displays a list of completions.
731 This messes up your window configuration. With this variable set, IDLWAVE
732 restores the old configuration after successful completion."
736 ;;; Variables for abbrev and action behavior -----------------------------
739 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
740 The variables in this group govern this."
744 "*Non-nil means performs actions when indenting.
745 The actions that can be performed are listed in `idlwave-indent-action-table'."
750 "*A single character string used to start abbreviations in abbrev mode.
751 Possible characters to chose from: ~`\%
752 or even '?'. '.' is not a good choice because it can make structure
753 field names act like abbrevs in certain circumstances.
755 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
756 must set it directly using `setq' in the .emacs file before idlwave.el
757 is loaded."
762 "*Non-nil means, enable `idlwave-surround'.
763 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
764 `idlwave-surround'.
765 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
767 Also see the default key bindings for keys using `idlwave-surround'.
768 Keys are bound and made into actions calling `idlwave-surround' with
769 `idlwave-action-and-binding'.
770 See help for `idlwave-action-and-binding' for examples.
772 Also see help for `idlwave-surround'."
777 "*Non-nil means pad '=' in keywords (routine calls or defs) like assignment.
778 Whenever `idlwave-surround' is non-nil then this affects how '=' is
779 padded for keywords and for variables. If t, pad the same as for
780 assignments. If nil then spaces are removed. With any other value,
781 spaces are left unchanged."
789 "*Non-nil means point blinks to block beginning for `idlwave-show-begin'."
794 "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
799 "*Non-nil means re-indent line after END was typed."
804 "*Non-nil means the abbrev hook can move point.
805 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
806 definitions, use the command `list-abbrevs', for abbrevs that move
807 point. Moving point is useful, for example, to place point between
808 parentheses of expanded functions.
810 See `idlwave-check-abbrev'."
815 "*Non-nil means all abbrevs will be forced to either upper or lower case.
816 If the value t, all expanded abbrevs will be upper case.
817 If the value is 'down then abbrevs will be forced to lower case.
818 If nil, the case will not change.
819 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
820 upper case, regardless of this variable."
825 "*Non-nil means, reserved words will be made upper case via abbrev expansion.
826 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
827 Has effect only if in abbrev-mode."
831 ;;; Action/Expand Tables.
832 ;;
833 ;; The average user may have difficulty modifying this directly. It
834 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
835 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
836 ;; examples of how to add an action.
837 ;;
838 ;; The action table is used by `idlwave-indent-line' whereas both the
839 ;; action and expand tables are used by `idlwave-indent-and-action'. In
840 ;; general, the expand table is only used when a line is explicitly
841 ;; indented. Whereas, in addition to being used when the expand table
842 ;; is used, the action table is used when a line is indirectly
843 ;; indented via line splitting, auto-filling or a new line creation.
844 ;;
845 ;; Example actions:
846 ;;
847 ;; Capitalize system vars
848 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
849 ;;
850 ;; Capitalize procedure name
851 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
852 ;; '(capitalize-word 1) t)
853 ;;
854 ;; Capitalize common block name
855 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
856 ;; '(capitalize-word 1) t)
857 ;; Capitalize label
858 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
859 ;; '(capitalize-word -1) t)
862 "*Associated array containing action lists of search string (car),
863 and function as a cdr. This table is used by `idlwave-indent-line'.
864 See documentation for `idlwave-do-action' for a complete description of
865 the action lists.
867 Additions to the table are made with `idlwave-action-and-binding' when a
868 binding is not requested.
872 "*Associated array containing action lists of search string (car),
873 and function as a cdr. The table is used by the
874 `idlwave-indent-and-action' function. See documentation for
875 `idlwave-do-action' for a complete description of the action lists.
877 Additions to the table are made with `idlwave-action-and-binding' when a
878 binding is requested.
881 ;;; Documentation header and history keyword ---------------------------------
884 "Options for documenting IDLWAVE files."
887 ;; FIXME: make defcustom?
890 ";+
891 ; NAME:
892 ;
893 ;
894 ;
895 ; PURPOSE:
896 ;
897 ;
898 ;
899 ; CATEGORY:
900 ;
901 ;
902 ;
903 ; CALLING SEQUENCE:
904 ;
905 ;
906 ;
907 ; INPUTS:
908 ;
909 ;
910 ;
911 ; OPTIONAL INPUTS:
912 ;
913 ;
914 ;
915 ; KEYWORD PARAMETERS:
916 ;
917 ;
918 ;
919 ; OUTPUTS:
920 ;
921 ;
922 ;
923 ; OPTIONAL OUTPUTS:
924 ;
925 ;
926 ;
927 ; COMMON BLOCKS:
928 ;
929 ;
930 ;
931 ; SIDE EFFECTS:
932 ;
933 ;
934 ;
935 ; RESTRICTIONS:
936 ;
937 ;
938 ;
939 ; PROCEDURE:
940 ;
941 ;
942 ;
943 ; EXAMPLE:
944 ;
945 ;
946 ;
947 ; MODIFICATION HISTORY:
948 ;
949 ;-
951 "*A list (PATHNAME STRING) specifying the doc-header template to use for
952 summarizing a file. If PATHNAME is non-nil then this file will be included.
953 Otherwise STRING is used. If nil, the file summary will be omitted.
954 For example you might set PATHNAME to the path for the
958 "*Non-nil means, the documentation header will always be at start of file.
959 When nil, the header is positioned between the PRO/FUNCTION line of
960 the current routine and the code, allowing several routine headers in
961 a file."
966 "*The hook function used to update the timestamp of a function."
971 "*The modifications keyword to use with the log documentation commands.
972 A ':' is added to the keyword end.
973 Inserted by doc-header and used to position logs by doc-modification.
974 If nil it will not be inserted."
979 "*Regexp matching the start of a document library header."
984 "*Regexp matching the end of a document library header."
988 ;;; External Programs -------------------------------------------------------
991 "Path locations of external commands used by IDLWAVE."
995 "*If non-nil, this is the command to run IDL.
996 Should be an absolute file path or path relative to the current environment
997 execution search path. If you want to specify command line switches
998 for the IDL program, use `idlwave-shell-command-line-options'.
1000 I know the name of this variable is badly chosen, but I cannot change
1001 it without compromising backwards-compatibility."
1006 "*A list of command line options for calling the IDL program.
1007 Since IDL is executed directly without going through a shell like /bin/sh,
1009 string for each argument. But you may also give a single string which
1010 contains the options whitespace-separated. Emacs will be kind enough to
1011 split it for you."
1013 string
1018 "*The external application providing reference help for programming.
1019 Obsolete, if the IDL Assistant is being used for help."
1023 ;;; Some Shell variables which must be defined here.-----------------------
1026 "List of modifiers to be used for the debugging commands.
1027 Will be used to bind debugging commands in the shell buffer and in all
1028 source buffers. These are additional convenience bindings, the debugging
1029 commands are always available with the `C-c C-d' prefix.
1030 If you set this to '(control shift), this means setting a breakpoint will
1031 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1032 are `control', `meta', `super', `hyper', `alt', and `shift'."
1043 "*If non-nil attempt invoke `idlwave-shell' if not already running.
1044 This is checked when an attempt to send a command to an
1045 IDL process is made."
1049 ;;; Miscellaneous variables -------------------------------------------------
1052 "Miscellaneous options for IDLWAVE mode."
1057 "*Non-nil displays a startup message when `idlwave-mode' is first called."
1063 common-blocks class-arrows)
1064 "Items which should be fontified on the default fontification level 2.
1065 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1066 is everything and level 2 is specified by this list.
1067 This variable must be set before IDLWAVE gets loaded.
1068 It is a list of symbols; the following symbols are allowed:
1070 pros-and-functions Procedure and Function definitions
1071 batch-files Batch Files
1072 idlwave-idl-keywords IDL Keywords
1073 label Statement Labels
1074 goto Goto Statements
1075 common-blocks Common Blocks
1076 keyword-parameters Keyword Parameters in routine definitions and calls
1077 system-variables System Variables
1078 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1079 class-arrows Object Arrows with class property"
1097 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1102 "Normal hook. Executed when idlwave.el is loaded."
1107 "Non-nil means turn on a few experimental features.
1108 This variable is only for the maintainer, to test difficult stuff,
1109 while still distributing stable releases.
1112 ;;;
1113 ;;; End customization variables section
1114 ;;;
1116 ;;; Non customization variables
1118 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1119 ;;; Simon Marshall <simon_at_gnu.ai.mit.edu>
1120 ;;; and Carsten Dominik...
1122 ;; The following are the reserved words in IDL. Maybe we should
1123 ;; highlight some more stuff as well?
1124 ;; Procedure declarations. Fontify keyword plus procedure name.
1126 ;; To update this regexp, update the list of keywords and
1127 ;; evaluate the form.
1128 ;; (insert
1129 ;; (prin1-to-string
1130 ;; (concat
1131 ;; "\\<\\("
1132 ;; (regexp-opt
1133 ;; '("||" "&&" "and" "or" "xor" "not"
1134 ;; "eq" "ge" "gt" "le" "lt" "ne"
1135 ;; "for" "do" "endfor"
1136 ;; "if" "then" "endif" "else" "endelse"
1137 ;; "case" "of" "endcase"
1138 ;; "switch" "break" "continue" "endswitch"
1139 ;; "begin" "end"
1140 ;; "repeat" "until" "endrep"
1141 ;; "while" "endwhile"
1142 ;; "goto" "return"
1143 ;; "inherits" "mod"
1144 ;; "compile_opt" "forward_function"
1145 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1146 ;; "\\)\\>")))
1147 "\\<\\(&&\\|and\\|b\\(egin\\|reak\\)\\|c\\(ase\\|o\\(mpile_opt\\|ntinue\\)\\)\\|do\\|e\\(lse\\|nd\\(case\\|else\\|for\\|if\\|rep\\|switch\\|while\\)?\\|q\\)\\|for\\(ward_function\\)?\\|g\\(oto\\|[et]\\)\\|i\\(f\\|nherits\\)\\|l[et]\\|mod\\|n\\(e\\|ot\\)\\|o\\(n_\\(error\\|ioerror\\)\\|[fr]\\)\\|re\\(peat\\|turn\\)\\|switch\\|then\\|until\\|while\\|xor\\|||\\)\\>")
1151 ;; Function declarations. Fontify keyword plus function name.
1157 ;; Common blocks
1163 ;; Start with point after block name and comma
1165 nil
1167 )))
1169 ;; Batch files
1173 ;; FIXME warning.
1177 ;; Labels
1181 ;; The goto statement and its label
1187 ;; Tags in structure definitions. Note that this definition
1188 ;; actually collides with labels, so we have to use the same
1189 ;; face. It also matches named subscript ranges,
1190 ;; e.g. vec{bottom:top]. No good way around this.
1194 ;; Structure names
1199 ;; Keyword parameters, like /xlog or ,xrange=[]
1200 ;; This is anchored to the comma preceding the keyword.
1201 ;; Treats continuation lines, works only during whole buffer
1202 ;; fontification. Slow, use it only in fancy fontification.
1204 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\([ \t]*\\(;.*\\)?\n\\)*[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1207 ;; System variables start with a bang.
1212 ;; Special and unusual operators (not used because too noisy)
1213 ;; (special-operators
1214 ;; '("[<>#]" (0 font-lock-keyword-face)))
1216 ;; All operators (not used because too noisy)
1217 ;; (all-operators
1218 ;; '("[-*^#+<>/]" (0 font-lock-keyword-face)))
1220 ;; Arrows with text property `idlwave-class'
1234 batch-files
1235 idlwave-idl-keywords
1236 label goto
1237 structtag
1238 structname
1239 common-blocks
1240 keyword-parameters
1241 system-variables
1242 class-arrows)
1246 ;; Match an object arrow with class property
1256 idlwave-font-lock-keywords-1
1257 idlwave-font-lock-keywords-2
1258 idlwave-font-lock-keywords-3)
1259 nil t
1261 beginning-of-line))
1267 "Regexp to match the start of a full-line comment.
1268 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1273 "Regular expression to find the beginning of a block.
1277 "Regular expression to find the beginning of a unit.
1281 "Regular expression to find the line that indicates the end of unit.
1282 This line is the end of buffer or the start of another unit.
1290 "Regular expression to find the end of a block.
1303 "Matches between statements and the corresponding END variant.
1304 The cars are the reserved words starting a block. If the block really
1305 begins with BEGIN, the cars are the reserved words before the begin
1306 which can be used to identify the block type.
1307 This is used to check for the correct END type, to close blocks and
1312 "Regular expression matching reserved words which can stand before
1313 blocks starting with a BEGIN statement. The matches must have associations
1330 ))
1334 ;; "endif else" is the only possible "end" that can be
1335 ;; followed by a statement on the same line.
1337 ;; all other "end"s can not be followed by a statement.
1350 idlwave-identifier
1354 idlwave-identifier
1359 "Associated list of statement matching regular expressions.
1360 Each regular expression matches the start of an IDL statement.
1361 The first element of each association is a symbol giving the statement
1362 type. The associated value is a list. The first element of this list
1363 is a regular expression matching the start of an IDL statement for
1364 identifying the statement type. The second element of this list is a
1365 regular expression for finding a substatement for the type. The
1366 substatement starts after the end of the found match modulo
1367 whitespace. If it is nil then the statement has no substatement. The
1368 list order matters since matching an assignment statement exactly is
1369 not possible without parsing. Thus assignment statement become just
1372 ;; FIXME: This var seems to only ever be set, but never actually used!
1379 ;; Note that this is documented in the v18 manuals as being a string
1380 ;; of length one rather than a single character.
1381 ;; The code in this file accepts either format for compatibility.
1383 "Character to be inserted for IDL comment indentation.
1387 "Character which is inserted as a last character on previous line by
1393 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1397 ;; If I take the time I can replace idlwave-keyword-abbrev with
1398 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1399 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1400 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1401 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1404 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1405 Specifically, if the abbrev is in a comment or string it is unexpanded.
1406 Otherwise ARGS forms a list that is evaluated."
1407 ;; FIXME: it would probably be better to rely on the new :enable-function
1408 ;; to enforce the "don't expand in comments or strings".
1433 ;;(define-key map "\C-c\C- " 'idlwave-hard-tab)
1452 ;; (define-key map "\r" 'idlwave-newline)
1453 ;; (define-key map "\t" 'idlwave-indent-line)
1464 ;; Bind the debug commands also with the special modifiers.
1481 ;; (define-key map "\C-c\C-f" 'idlwave-function)
1482 ;; (define-key map "\C-c\C-p" 'idlwave-procedure)
1495 ;; Pickup both forms of Esc/Meta binding
1504 map)
1530 st)
1539 st)
1543 "Execute BODY with a different syntax table."
1551 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1552 ; "Execute BODY with a different syntax table."
1553 ; `(let ((saved-syntax (syntax-table)))
1554 ; (unwind-protect
1555 ; (progn
1556 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1557 ; ,@body)
1558 ; (set-syntax-table saved-syntax))))
1561 "KEY and CMD are made into a key binding and an indent action.
1562 KEY is a string - same as for the `define-key' function. CMD is a
1563 function of no arguments or a list to be evaluated. CMD is bound to
1564 KEY in `idlwave-mode-map' by defining an anonymous function calling
1565 `self-insert-command' followed by CMD. If KEY contains more than one
1566 character a binding will only be set if SELECT is 'both.
1568 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1569 replacing any previous value for KEY. If a binding is not set then it
1570 will instead be placed in `idlwave-indent-action-table'.
1572 If the optional argument SELECT is nil then an action and binding are
1573 created. If SELECT is 'noaction, then a binding is always set and no
1574 action is created. If SELECT is 'both then an action and binding
1575 will both be created even if KEY contains more than one character.
1576 Otherwise, if SELECT is non-nil then only an action is created.
1578 Some examples:
1579 No spaces before and 1 after a comma
1581 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1583 Capitalize system variables - action only
1584 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1586 ;; Add action
1592 ;; Replace action command
1594 ;; New action
1596 ;; Make key binding for action
1606 ;; Set action and key bindings.
1607 ;; See description of the function `idlwave-action-and-binding'.
1608 ;; Automatically add spaces for the following characters
1610 ;; Actions for & are complicated by &&
1613 ;; Automatically add spaces to equal sign if not keyword. This needs
1614 ;; to go ahead of > and <, so >= and <= will be treated correctly
1617 ;; Actions for > and < are complicated by >=, <=, and ->...
1624 ;;;
1625 ;;; Abbrev Section
1626 ;;;
1627 ;;; When expanding abbrevs and the abbrev hook moves backward, an extra
1628 ;;; space is inserted (this is the space typed by the user to expanded
1629 ;;; the abbrev).
1630 ;;;
1636 "Define-abbrev with backward compatibility.
1638 If NOPREFIX is non-nil, don't prepend prefix character. Installs into
1639 `idlwave-mode-abbrev-table' unless TABLE is non-nil."
1643 expansion
1644 hook)))
1654 ;;
1655 ;; Templates
1656 ;;
1666 ;;
1667 ;; Keywords, system functions, conversion routines
1668 ;;
1726 ;; This section is reserved words only. (From IDL user manual)
1727 ;;
1773 ;; defined later - so just make the compiler hush
1777 ;;;###autoload
1779 "Major mode for editing IDL source files (version 6.1_em22).
1781 The main features of this mode are
1783 1. Indentation and Formatting
1784 --------------------------
1785 Like other Emacs programming modes, C-j inserts a newline and indents.
1786 TAB is used for explicit indentation of the current line.
1789 function can also be used in the middle of a line to split the line
1790 at that point. When used inside a long constant string, the string
1791 is split at that point with the `+' concatenation operator.
1793 Comments are indented as follows:
1795 `;;;' Indentation remains unchanged.
1796 `;;' Indent like the surrounding code
1797 `;' Indent to a minimum column.
1799 The indentation of comments starting in column 0 is never changed.
1802 comment. The indentation of the second line of the paragraph
1803 relative to the first will be retained. Use
1805 comments. When the variable `idlwave-fill-comment-line-only' is
1806 nil, code can also be auto-filled and auto-indented.
1808 To convert pre-existing IDL code to your formatting style, mark the
1813 2. Routine Info
1814 ------------
1815 IDLWAVE displays information about the calling sequence and the
1816 accepted keyword parameters of a procedure or function with
1818 source file of a module. These commands know about system
1819 routines, all routines in idlwave-mode buffers and (when the
1820 idlwave-shell is active) about all modules currently compiled under
1821 this shell. It also makes use of pre-compiled or custom-scanned
1822 user and library catalogs many popular libraries ship with by
1824 information, which is also used for completion (see item 4).
1826 3. Online IDL Help
1827 ---------------
1830 for the system variable, keyword, or routines at point. A single
1831 key stroke gets you directly to the right place in the docs. See
1832 the manual to configure where and how the HTML help is displayed.
1834 4. Completion
1835 ----------
1837 class names, keyword parameters, system variables and tags, class
1838 tags, structure tags, filenames and much more. It is context
1839 sensitive and figures out what is expected at point. Lower case
1840 strings are completed in lower case, other strings in mixed or
1841 upper case.
1843 5. Code Templates and Abbreviations
1844 --------------------------------
1845 Many Abbreviations are predefined to expand to code fragments and templates.
1860 have direct keybindings - see the list of keybindings below.
1863 beginning of the current program unit (pro, function or main).
1864 Change log entries can be added to the current program unit with
1867 6. Automatic Case Conversion
1868 -------------------------
1869 The case of reserved words and some abbrevs is controlled by
1870 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1872 7. Automatic END completion
1873 ------------------------
1874 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1875 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1877 8. Hooks
1878 -----
1879 Loading idlwave.el runs `idlwave-load-hook'.
1880 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1882 9. Documentation and Customization
1883 -------------------------------
1884 Info documentation for this package is available. Use
1886 not work). For Postscript, PDF, and HTML versions of the
1887 documentation, check IDLWAVE's homepage at URL `http://idlwave.org'.
1888 IDLWAVE has customize support - see the group `idlwave'.
1890 10.Keybindings
1891 -----------
1892 Here is a list of all keybindings of this mode.
1894 followed by the key sequence to see what the key sequence does.
1897 :abbrev-table idlwave-mode-abbrev-table
1930 ;; ChangeLog
1934 ;; Set tag table list to use IDLTAGS as file name.
1938 ;; Font-lock additions
1939 ;; Following line is for Emacs - XEmacs uses the corresponding property
1940 ;; on the `idlwave-mode' symbol.
1947 ;; Imenu setup
1955 ;; HideShow setup
1958 idlwave-begin-block-reg
1959 idlwave-end-block-reg
1960 ";"
1963 ;; Make a local post-command-hook and add our hook to it
1964 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1965 ;; (make-local-hook 'post-command-hook)
1968 ;; Make local hooks for buffer updates
1969 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1970 ;; (make-local-hook 'kill-buffer-hook)
1972 ;; (make-local-hook 'after-save-hook)
1976 ;; Setup directories and file, if necessary
1979 ;; Update the routine info with info about current buffer?
1982 ;; Check help location
1992 idlwave-user-catalog-file
1993 idlwave-config-directory)
1994 idlwave-xml-system-rinfo-converted-file
1996 idlwave-xml-system-rinfo-converted-file
1997 idlwave-config-directory)
1999 idlwave-path-file
2000 idlwave-config-directory))
2005 "Fontify continuation lines correctly."
2016 ;;
2017 ;; Code Formatting ----------------------------------------------------
2018 ;;
2021 "Insert TAB in buffer in current position."
2025 ;;; This stuff is experimental
2028 "If non-nil, a list that can be evaluated using `eval'.
2029 It is evaluated in the lisp function `idlwave-command-hook' which is
2033 "Command run after every command.
2034 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
2035 sets the variable to zero afterwards."
2043 ;;; End experiment
2045 ;; It would be better to use expand.el for better abbrev handling and
2046 ;; versatility.
2049 "Reverse abbrev expansion if in comment or string.
2050 Argument ARG is the number of characters to move point
2051 backward if `idlwave-abbrev-move' is non-nil.
2052 If optional argument RESERVED is non-nil then the expansion
2053 consists of reserved words, which will be capitalized if
2054 `idlwave-reserved-word-upcase' is non-nil.
2055 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2056 is non-nil, unless its value is \`down in which case the abbrev will be
2057 made into all lowercase.
2058 Returns non-nil if abbrev is left expanded."
2061 nil)
2073 t))
2076 "Return t if point is inside a comment, nil otherwise."
2082 "Move to start of comment delimiter on current line.
2083 Moves to end of line if there is no comment delimiter.
2084 Ignores comment delimiters in strings.
2085 Returns point if comment found and nil otherwise."
2088 found)
2089 ;; Look for first comment delimiter not in a string
2101 "Should we operate on an active region?"
2107 "Insert quote and show matching quote if this is end of a string."
2118 ;; Not the end of a string
2122 "Ensure that the previous word was a token before `idlwave-show-begin'.
2123 An END token must be preceded by whitespace."
2133 "Find the start of current block and blinks to it for a second.
2134 Also checks if the correct END statement has been used."
2135 ;; All end statements are reserved words
2136 ;; Re-indent end line
2137 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2138 ;;(backward-char 1)
2142 begin-pos end-pos end end1 )
2146 idlwave-show-block)
2148 ;; Move inside current block
2161 end-pos))
2169 ;; A generic end
2180 end1 end)
2182 ;;(delete-char 1))
2196 ;; seems to be a case thing
2200 idlwave-block-matches))
2202 ;; Just a normal block
2207 "Terminate the current block with the correct END statement."
2209 ;; Start new line if we are not in a new line
2220 "Surround &, leaving room for && (which surround as well)."
2230 "Surround > and < by blanks, leaving room for >= and <=, and considering ->."
2236 ;; Key binding: pad only on left, to save for possible >=/<=
2240 "Surround the LENGTH characters before point with blanks.
2241 LENGTH defaults to 1.
2242 Optional arguments BEFORE and AFTER affect the behavior before and
2243 after the characters (see also description of `idlwave-make-space'):
2245 nil do nothing
2246 0 force no spaces
2247 integer > 0 force exactly n spaces
2248 integer < 0 at least |n| spaces
2250 The function does nothing if any of the following conditions is true:
2251 - `idlwave-surround-by-blank' is nil
2252 - the character before point is inside a string or comment"
2260 ;; avoid clobbering indent
2270 ;; Check to see if the line should auto wrap
2276 "Make space at point.
2277 The space affected is all the spaces and tabs around point.
2278 If n is non-nil then point is left abs(n) spaces from the beginning of
2279 the contiguous space.
2280 The amount of space at point is determined by N.
2281 If the value of N is:
2282 nil - do nothing.
2283 > 0 - exactly N spaces.
2284 < 0 - a minimum of -N spaces, i.e., do not change if there are
2285 already -N spaces.
2286 0 - no spaces (i.e. remove any existing space)."
2300 ;; n = 0, done
2301 ))))
2304 "Insert a newline and indent the current and previous line."
2306 ;;
2307 ;; Handle unterminated single and double quotes
2308 ;; If not in a comment and in a string then insertion of a newline
2309 ;; will mean unbalanced quotes.
2310 ;;
2315 ;;
2316 ;; The current line is being split, the cursor should be at the
2317 ;; beginning of the new line skipping the leading indentation.
2318 ;;
2319 ;; The reason we insert the new line before indenting is that the
2320 ;; indenting could be confused by keywords (e.g. END) on the line
2321 ;; after the split point. This prevents us from just using
2322 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2323 ;;
2329 ;;
2330 ;; Use global variable 'comment-column' to set parallel comment
2331 ;;
2332 ;; Modeled on lisp.el
2333 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2335 "Compute indent for the beginning of the IDL comment delimiter."
2341 ;; On line by itself, indent as code
2344 ;; after code - do not change
2348 comment-column))))
2351 "Continue line by breaking line at point and indent the lines.
2352 For a code line insert continuation marker. If the line is a line comment
2353 then the new line will contain a comment with the same indentation.
2354 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2355 non-nil."
2357 ;; Expand abbreviation, just like normal RET would.
2361 ;; For code line add continuation.
2362 ;; Check if splitting a string.
2366 ;; Split the string.
2368 idlwave-continuation-char beg)
2372 ;; Do not split the string.
2376 ;; Not splitting a string.
2382 ;; Indent previous line
2387 ;; Reindent new line
2391 "Move point to the beginning of the current program unit.
2392 If NOMARK is non-nil, do not push mark."
2397 "Move point to the start of the next program unit.
2398 If NOMARK is non-nil, do not push mark."
2404 "Mark current IDL statement."
2412 "Mark containing block."
2424 "Put mark at beginning of program, point at end.
2425 The marks are pushed."
2435 "Move to beginning of enclosing block if prefix ARG >= 0.
2436 If prefix ARG < 0 then move forward to enclosing block end."
2441 "Go to the beginning of the current block."
2447 "Go to the beginning of the current block."
2453 "Move across next nested block."
2460 "Move backward across previous nested block."
2466 "Go down a block.
2467 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2468 Returns non-nil if successfull."
2472 ;; Backward
2480 ;; Forward
2488 status))
2491 "Put point at beginning of doc library header, mark at end.
2492 The marks are pushed."
2513 "Return (NAME TYPE CLASS) of current routine."
2517 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2526 "Move to beginning of the current statement.
2527 Skips back past statement continuations.
2528 Point is placed at the beginning of the line whether or not this is an
2529 actual statement."
2541 "Move point to beginning of the previous statement.
2542 Returns t if the current line before moving is the beginning of
2543 the first non-comment statement in the file, and nil otherwise."
2547 ;; first line in file
2548 t
2549 ;; skip blank lines, label lines, include lines and line comments
2551 ;; The current statement is the first statement until we
2552 ;; reach another statement.
2560 ;; skip continuation lines
2566 first-statement)))
2569 "Move point to the end of the current IDL statement.
2570 If not in a statement just moves to end of line. Returns position."
2580 "Move point to the end of the current IDL statement.
2581 If not in a statement just moves to end of line. Returns position."
2589 "Move point to beginning of the next IDL statement.
2590 Returns t if that statement is the last non-comment IDL statement
2591 in the file, and nil otherwise."
2595 ;; skip blank lines, label lines, include lines and line comments
2597 ;; The current statement is the last statement until
2598 ;; we reach a new statement.
2605 last-statement))
2608 "Skip past multiple commands on a line (with `&')."
2618 "Skip label or case statement element.
2619 Returns position after label.
2620 If there is no label point is not moved and nil is returned."
2621 ;; Case expressions and labels are terminated by a colon.
2622 ;; So we find the first colon in the line and make sure
2623 ;; - no `?' is before it (might be a ? b : c)
2624 ;; - it is not in a comment
2625 ;; - not in a string constant
2626 ;; - not in parenthesis (like a[0:3])
2627 ;; - not followed by another ":" in explicit class, ala a->b::c
2628 ;; As many in this mode, this function is heuristic and not an exact
2629 ;; parser.
2641 nil)))
2644 "Move to start of next IDL substatement after point.
2645 Uses the type of the current IDL statement to determine if the next
2646 statement is on a new line or is a subpart of the current statement.
2647 Returns point at start of substatement modulo whitespace.
2648 If optional argument is non-nil move to beginning of current
2649 substatement."
2653 st nst last)
2659 ;; Continue looking for substatements until we are past orig
2673 ;; If a continuation line starts here, move to next line
2679 "Return the type of the current IDL statement.
2680 Uses `idlwave-statement-match' to return a cons of (type . point) with
2681 point the ending position where the type was determined. Type is the
2682 association from `idlwave-statement-match', i.e. the cons cell from the
2683 list not just the type symbol. Returns nil if not an identifiable
2684 statement."
2686 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2687 ;; and possibly comments
2699 "Pad '=' with spaces.
2700 Two cases: Assignment statement, and keyword assignment.
2701 Which case is determined using `idlwave-start-of-substatement' and
2702 `idlwave-statement-type'. The equal sign will be surrounded by BEFORE
2703 and AFTER blanks. If `idlwave-pad-keyword' is t then keyword assignment
2704 is treated just like assignment statements. When nil, spaces are
2705 removed for keyword assignment. Any other value keeps the current space
2706 around the `='. Limits in for loops are treated as keyword assignment.
2708 Starting with IDL 6.0, a number of op= assignments are available.
2709 Since ambiguities of the form:
2711 r and= b
2712 rand= b
2714 can occur, alphanumeric operator assignment will never be pre-padded,
2715 only post-padded. You must use a space before these to disambiguate
2716 \(not just for padding, but for proper parsing by IDL too!). Other
2717 operators, such as ##=, ^=, etc., will be pre-padded.
2719 IS-ACTION is ignored.
2721 See `idlwave-surround'."
2734 ;; Why doesn't ##? work for both?
2738 ;(setq begin nil) ; won't modify begin
2742 ;; Everything gets padded equally
2744 ;; Treating keywords/for variables specially...
2762 "Call `idlwave-indent-line' and do expand actions.
2763 With prefix ARG non-nil, indent the entire sub-statement."
2771 ;;Expand the END abbreviation, just as RET or Space would have.
2782 "Indent current IDL line as code or as a comment.
2783 The actions in `idlwave-indent-action-table' are performed.
2784 If the optional argument EXPAND is non-nil then the actions in
2785 `idlwave-indent-expand-table' are performed."
2787 ;; Move point out of left margin.
2796 ;; Indentation for a line comment
2800 ;;
2801 ;; Code Line
2802 ;;
2803 ;; Before indenting, run action routines.
2804 ;;
2807 ;;
2810 ;;
2811 ;; No longer expand abbrevs on the line. The user can do this
2812 ;; manually using expand-region-abbrevs.
2813 ;;
2814 ;; Indent for code line
2815 ;;
2818 ;; a label line
2820 ;; a batch command
2822 ;; leave flush left
2823 nil
2824 ;; indent the line
2826 ;; Adjust parallel comment
2829 ;; Emacs 21 is too smart with fill-column on comment indent
2832 fill-column)))
2835 ;; Get rid of marker
2839 "Perform an action repeatedly on a line.
2840 ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is
2841 either a function name to be called with `funcall' or a list to be
2842 evaluated with `eval'. The action performed by FUNC should leave
2843 point after the match for REG - otherwise an infinite loop may be
2844 entered. FUNC is always passed a final argument of 'is-action, so it
2845 can discriminate between being run as an action, or a key binding."
2855 "Indent from point with spaces until column COL.
2856 Inserts space before markers at point."
2862 "Indent the current line to column COL.
2863 Indents such that first non-whitespace character is at column COL
2864 Inserts spaces before markers at point."
2871 "Indent program unit which contains point."
2883 "Indent current statement, including all continuation lines."
2892 "Return appropriate indentation for current line as IDL code."
2896 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2897 ;; function
2900 ;; Check for continuation line
2905 ;; calculate indent based on previous and current statements
2908 ;; calculate indent based on previous statement
2911 ;; Beginning of file
2916 ;; Main block
2919 idlwave-main-block-indent))
2920 ;; Begin block
2923 idlwave-block-indent))
2924 ;; End Block
2927 ;; Match to the *beginning* of the block opener
2931 ;; idlwave-end-offset
2932 ;; idlwave-block-indent))
2934 ;; Default to current indent
2936 ;; adjust the indentation based on the current statement
2938 ;; End block
2943 ;;
2944 ;; Parentheses indent
2945 ;;
2948 "Calculate the continuation indent inside a paren group.
2949 Returns a cons-cell with (open . indent), where open is the
2950 location of the open paren."
2952 ;; Found an innermost open paren.
2955 ;; Line up with next word unless this is a closing paren.
2958 ;; Plain Kernighan-style nested indent
2962 ;; This is a closed paren - line up under open paren.
2966 ;; Empty (or just comment) follows -- revert to basic indent
2968 ;; Skip paren
2971 nil)
2973 ;; Line up with first word after any blank space
2979 "Calculates the IDL continuation indent column from the previous statement.
2980 Note that here previous statement usually means the beginning of the
2981 current statement if this statement is a continuation of the previous
2982 line. Various special types of continuations, including assignments,
2983 routine definitions, and parenthetical groupings, are treated separately."
2994 idlwave-continuation-indent))
2995 fancy-nonparen-indent fancy-paren-indent)
2997 ;; Align then with its matching if, etc.
3004 match cont-re)
3019 ;; Indent in from the previous line for continuing statements
3024 match)
3036 ;; Parenthetical indent, either traditional or Kernighan style
3043 indent-cons)
3046 beg-reg end-reg close-exp))
3047 ;; First permitted containing paren
3049 idlwave-indent-to-open-paren
3050 idlwave-indent-parens-nested
3053 idlwave-max-extra-continuation-indent))
3056 fancy-paren-indent)
3058 ;; A continued assignment, or procedure call/definition
3066 ;; A continued Procedure call or definition
3069 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3071 ;; Comment only, or blank line with "$"? Basic indent.
3073 nil
3076 ;; Continued assignment (with =):
3090 idlwave-max-extra-continuation-indent))
3093 fancy-nonparen-indent))
3095 ;; Basic indent, by default
3101 "Move to next match of the regular expression KEY-RE.
3102 Matches inside comments or string constants will be ignored.
3103 If DIR is negative, the search will be backwards.
3104 At a successful match, the mark is pushed unless NOMARK is non-nil.
3105 Searches are limited to LIMIT.
3106 Searches are case-insensitive and use a special syntax table which
3107 treats `$' and `_' as word characters.
3108 Return value is the beginning of the match or (in case of failure) nil."
3112 found)
3126 found)
3127 nil)))
3130 "When optional argument DIR is non-negative, move forward to end of
3131 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3132 regular expressions. When DIR is negative, move backwards to block beginning.
3133 Recursively calls itself to skip over nested blocks. DIR defaults to
3134 forward. Calls `push-mark' unless the optional argument NOMARK is
3135 non-nil. Movement is limited by the start of program units because of
3136 possibility of unbalanced blocks."
3143 idlwave-begin-block-reg
3144 idlwave-end-block-reg))
3145 found
3147 idlwave-end-block-reg))
3151 idlwave-begin-unit-reg dir t limit)
3154 idlwave-end-unit-reg dir t limit)))
3155 limit)))
3167 "The minimum indent in the current statement."
3178 min
3182 "Return indentation of the current statement.
3183 If in a statement, moves to beginning of statement before finding indent."
3190 "Return the column of the indentation of the current line.
3191 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3195 ;; if we are at the end of blank line return 0
3200 "Test if current line is continuation line.
3201 Blank or comment-only lines following regular continuation lines (with
3202 `$') count as continuations too."
3213 "Test if the current line is a comment line."
3219 "Test if the current line is a comment line."
3225 "Search current line from current point for REGEXP.
3226 If optional argument CONT is non-nil, searches to the end of
3227 the current statement.
3228 If optional arg BEG is non-nil, search starts from the beginning of the
3229 current statement.
3230 Ignores matches that end in a comment or inside a string expression.
3231 Returns point if successful, nil otherwise.
3232 This function produces unexpected results if REGEXP contains quotes or
3233 a comment delimiter. The search is case insensitive.
3234 If successful leaves point after the match, otherwise, does not move point."
3240 found)
3246 found))
3249 "Fill paragraphs in comments.
3250 A paragraph is made up of all contiguous lines having the same comment
3251 leader (the leading whitespace before the comment delimiter and the
3252 comment delimiter). In addition, paragraphs are separated by blank
3253 line comments. The indentation is given by the hanging indent of the
3254 first line, otherwise by the minimum indentation of the lines after
3255 the first line. The indentation of the first line does not change.
3256 Does not effect code lines. Does not fill comments on the same line
3257 with code. The hanging indent is given by the end of the first match
3258 matching `idlwave-hang-indent-regexp' on the paragraph's first line.
3259 If the optional argument NOHANG is non-nil then the hanging indent is
3260 ignored."
3262 ;; check if this is a line comment
3269 pre here diff fill-prefix-reg bcl first-indent
3270 hang start end)
3271 ;; Change tabs to spaces in the surrounding paragraph.
3272 ;; The surrounding paragraph will be the largest containing block of
3273 ;; contiguous line comments. Thus, we may be changing tabs in
3274 ;; a much larger area than is needed, but this is the easiest
3275 ;; brute force way to do it.
3276 ;;
3277 ;; This has the undesirable side effect of replacing the tabs
3278 ;; permanently without the user's request or knowledge.
3286 ;;
3292 ;; Get the comment leader on the line and its length
3294 ;; the comment leader is the indentation plus exactly the
3295 ;; number of consecutive ";".
3302 ;; Mark the beginning and end of the paragraph
3308 ;; Move to first line of paragraph
3322 ;; if at end of buffer add a newline (need this because
3323 ;; fill-region needs END to be at the beginning of line after
3324 ;; the paragraph or it will add a line).
3327 ;; Set END to the beginning of line after the paragraph
3328 ;; END is calculated as distance from end of buffer
3330 ;;
3331 ;; Calculate the indentation for the paragraph.
3332 ;;
3333 ;; In the following while statements, after one iteration
3334 ;; point will be at the beginning of a line in which case
3335 ;; the while will not be executed for the
3336 ;; the first paragraph line and thus will not affect the
3337 ;; indentation.
3338 ;;
3339 ;; First check to see if indentation is based on hanging indent.
3345 ;; Adjust lines of paragraph by inserting spaces so that
3346 ;; each line's indent is at least as great as the hanging
3347 ;; indent. This is needed for fill-paragraph to work with
3348 ;; a fill-prefix.
3357 ;; adjust the original location for the
3358 ;; inserted text.
3362 )
3364 ;; No hang. Instead find minimum indentation of paragraph
3365 ;; after first line.
3366 ;; For the following while statement, since START is at the
3367 ;; beginning of line and END is at the end of line
3368 ;; point is greater than START at least once (which would
3369 ;; be the case for a single line paragraph).
3380 ?\ )))
3381 ;; first-line indent
3387 indent))
3389 ;; try to keep point at its original place
3392 ;; In place of the more modern fill-region-as-paragraph, a hack
3393 ;; to keep whitespace untouched on the first line within the
3394 ;; indent length and to preserve any indent on the first line
3395 ;; (first indent).
3401 start
3404 nil)
3408 ;; When we want the point at the beginning of the comment
3409 ;; body fill-region will put it at the beginning of the line.
3414 "Calculate the position of the hanging indent for the comment paragraph.
3415 The hanging indent position is given by the first match with the
3416 `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3417 non-nil then use last occurrence matching `idlwave-hang-indent-regexp'
3418 on the line.
3419 If not found returns nil."
3431 "Called to break lines in auto fill mode.
3432 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3433 non-nil. Places a continuation character at the end of the line if
3434 not in a comment. Splits strings with IDL concatenation operator `+'
3435 if `idlwave-auto-fill-split-string' is non-nil."
3437 nil ; do not to fill
3440 ;; Check for comment line
3445 ;; Prevent actions do-auto-fill which calls indent-line-function.
3450 idlwave-auto-fill-split-string)
3453 ))))
3457 ;; Indent the split line
3462 ;; A continued line comment
3463 ;; We treat continued line comments as part of a comment
3464 ;; paragraph. So we check for a hanging indent.
3472 ;; Remove whitespace between comment delimiter and
3473 ;; text, insert spaces for appropriate indentation.
3479 ;; Split code or comment?
3483 ;; Splitting a non-full-line comment.
3484 ;; Insert the comment delimiter from split line
3489 ;; Insert blank to keep off beginning of line
3498 ;; Split code line - add continuation character
3501 ;; Check to see if we split a string
3503 idlwave-auto-fill-split-string)
3504 ;; Split the string and concatenate.
3505 ;; The first extra space is for the space
3506 ;; the line was split. That space was removed.
3511 ;; Make the second part of continued string
3516 ;; Warning
3519 ;; Although do-auto-fill (via indent-new-comment-line) calls
3520 ;; idlwave-indent-line for the new line, re-indent again
3521 ;; because of the addition of the continuation character.
3523 )))))
3526 "Toggle auto-fill mode for IDL mode.
3527 With arg, turn auto-fill mode on if arg is positive.
3528 In auto-fill mode, inserting a space at a column beyond `fill-column'
3529 automatically breaks the line at a previous space."
3535 'idlwave-auto-fill
3536 nil))
3537 ;; update mode-line
3540 ;(defun idlwave-fill-routine-call ()
3541 ; "Fill a routine definition or statement, indenting appropriately."
3542 ; (let ((where (idlwave-where)))))
3546 "Insert a documentation header at the beginning of the unit.
3547 Inserts the value of the variable `idlwave-file-header'. Sets mark
3548 before moving to do insertion unless the optional prefix argument
3549 NOMARK is non-nil."
3552 ;; make sure we catch the current line if it begins the unit
3558 ;; skip function or procedure line
3572 "Default timestamp insertion function."
3578 ;; Remove extra spaces from line
3580 ;; Insert a blank line comment to separate from the date entry -
3581 ;; will keep the entry from flowing onto date line if re-filled.
3585 "Insert a brief modification log at the beginning of the current program.
3586 Looks for an occurrence of the value of user variable
3587 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user
3588 name and places the point for the user to add a log. Before moving, saves
3589 location on mark ring so that the user can return to previous point."
3604 end t)
3615 ;; CJC 3/16/93
3616 ;; Interface to expand-region-abbrevs which did not work when the
3617 ;; abbrev hook associated with an abbrev moves point backwards
3618 ;; after abbrev expansion, e.g., as with the abbrev '.n'.
3619 ;; The original would enter an infinite loop in attempting to expand
3620 ;; .n (it would continually expand and unexpand the abbrev without expanding
3621 ;; because the point would keep going back to the beginning of the
3622 ;; abbrev instead of to the end of the abbrev). We now keep the
3623 ;; abbrev hook from moving backwards.
3624 ;;;
3626 "Expand each abbrev occurrence in the region.
3627 Calling from a program, arguments are START END."
3636 "Return t if point is in a comment or quoted string.
3637 Returns nil otherwise."
3641 "Return location of the opening quote
3642 if point is in a IDL string constant, nil otherwise.
3643 Ignores comment delimiters on the current line.
3644 Properly handles nested quotation marks and octal
3645 constants - a double quote followed by an octal digit."
3646 ;; Treat an octal inside an apostrophe to be a normal string. Treat a
3647 ;; double quote followed by an octal digit to be an octal constant
3648 ;; rather than a string. Therefore, there is no terminating double
3649 ;; quote.
3651 ;; Because single and double quotes can quote each other we must
3652 ;; search for the string start from the beginning of line.
3658 delim
3659 found)
3661 ;; Find string start
3662 ;; Don't find an octal constant beginning with a double quote
3664 ;; Find the string end.
3665 ;; In IDL, two consecutive delimiters after the start of a
3666 ;; string act as an
3667 ;; escape for the delimiter in the string.
3668 ;; Two consecutive delimiters alone (i.e., not after the
3669 ;; start of a string) is the null string.
3671 ;; Move to position after quote
3674 ;; Get the string delimiter
3676 ;; Check for null string
3679 ;; Look for next unpaired delimiter
3685 ))
3688 ;; return string beginning position or nil
3692 "Determine if the character after point is a pointer dereference *."
3702 ;; Statement templates
3704 ;; Replace these with a general template function, something like
3705 ;; expand.el (I think there was also something with a name similar to
3706 ;; dmacro.el)
3709 "Build a template with optional prompt expression.
3711 Opens a line if point is not followed by a newline modulo intervening
3712 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3713 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3714 adjusted according to `idlwave-abbrev-change-case'. If optional
3715 argument PROMPT is a string then it is displayed as a message in the
3716 minibuffer. The PROMPT serves as a reminder to the user of an
3717 expression to enter.
3719 The lines containing S1 and S2 are reindented using `indent-region'
3720 unless the optional second argument NOINDENT is non-nil."
3722 ;; This is a gross hack to avoit template abbrev expansion
3723 ;; in the shell. FIXME: This is a dirty hack.
3733 end)
3746 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3749 string))
3752 "Build skeleton IDL if-else block."
3760 "Build skeleton IDL case statement."
3768 "Build skeleton IDL switch statement."
3776 "Build skeleton IDL loop statement."
3784 "Build skeleton IDL if statement."
3820 "Return a list of substrings of STRING which are separated by PATTERN.
3834 end)
3842 ;; Return the buffer currently visiting FILE
3852 "List of buffers pulled up by IDLWAVE for special reasons.
3856 ;; Return a buffer visiting file.
3860 buf)))
3863 "Kill buffers created automatically by IDLWAVE.
3864 Function prompts for a letter to identify the buffers to kill.
3865 Possible letters are:
3868 clicks in the routine info window.
3869 s Buffers created by the IDLWAVE Shell to display where execution
3870 stopped or an error was found.
3871 a Both of the above.
3873 Buffers containing unsaved changes require confirmation before they are killed."
3877 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3891 "How many outlawed buffers have tag TAG?"
3895 idlwave-outlawed-buffers))))
3898 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3901 entry)
3915 "Remove BUFFER from the buffers which may be killed.
3916 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3917 Intended for `after-save-hook'."
3920 ;; Revoke license
3924 ;; Remove this function from the hook.
3929 ;; Find FILE on the scanned lib path and return a buffer visiting it
3931 dir efile)
3939 ;; Find FILE on the scanned lib path and return a buffer visiting it
3940 ;; This is for, e.g., finding source with no user catalog
3947 "Create the IDL tags file IDLTAGS in the current directory from
3948 the list of directories specified in the minibuffer. Directories may be
3949 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
3950 specified top directories are searched if the directory name is prefixed
3951 by @. Specify @ directories with care, it may take a long, long time if
3952 you specify /."
3955 buffer save_buffer files numfiles item errbuf)
3957 ;;
3958 ;; Read list of directories
3961 ;;
3962 ;; Set etags command, vars
3968 ;;
3969 ;; For each directory
3973 ;;
3974 ;; Find the subdirectories
3996 ;;
3997 ;; For each subdirectory
4001 ;;
4002 ;; Call etags
4011 0
4013 ;;
4014 ;; Append additional tags
4021 )))
4033 ))
4036 "Comment the lines in the region if the first non-blank line is
4037 commented, and conversely, uncomment region. If optional prefix arg
4038 N is non-nil, then for N positive, add N comment delimiters or for N
4039 negative, remove N comment delimiters.
4040 Uses `comment-region' which does not place comment delimiters on
4041 blank lines."
4048 ;; skip blank lines
4060 ;; ----------------------------------------------------------------------------
4061 ;; ----------------------------------------------------------------------------
4062 ;; ----------------------------------------------------------------------------
4063 ;; ----------------------------------------------------------------------------
4064 ;;
4065 ;; Completion and Routine Info
4066 ;;
4068 ;; String "intern" functions
4070 ;; For the completion and routine info function, we want to normalize
4071 ;; the case of procedure names etc. We do this by "interning" these
4072 ;; string is a hand-crafted way. Hashes are used to map the downcase
4073 ;; version of the strings to the cased versions. Most *-sint-*
4074 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4075 ;; system hash. The former is re-scanned, and the latter takes case
4076 ;; precedence.
4077 ;;
4078 ;; Since these cased versions are really lisp objects, we can use `eq'
4079 ;; to search, which is a large performance boost. All new strings
4080 ;; need to be "sinterned". We do this as early as possible after
4081 ;; getting these strings from completion or buffer substrings. So
4082 ;; most of the code can simply assume to deal with "sinterned"
4083 ;; strings. The only exception is that the functions which scan whole
4084 ;; buffers for routine information do not intern the grabbed strings.
4085 ;; This is only done afterwards. Therefore in these functions it is
4086 ;; *not* safe to assume the strings can be compared with `eq' and be
4087 ;; fed into the routine assq functions.
4089 ;; Here we define the hashing functions.
4091 ;; The variables which hold the hashes.
4100 "Reset all sintern hashes."
4101 ;; Make sure the hash functions are accessible.
4112 ;; Make sure these are lists
4117 ;; Reset the system & library hash
4125 idlwave-sint-libnames nil))
4127 ;; Reset the buffer & shell hash
4143 ;;(defmacro idlwave-sintern (type var)
4144 ;; `(cond ((not (stringp name)) name)
4145 ;; ((gethash (downcase name) (cdr ,var)))
4146 ;; ((gethash (downcase name) (car ,var)))
4147 ;; (set (idlwave-sintern-set name ,type ,var set))
4148 ;; (name)))
4188 iname))
4191 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4195 kwd-list)
4198 "Sintern all strings in the rinfo LIST.
4199 With optional parameter SET: also set new patterns. Probably this
4200 will always have to be t. If DEFAULT-DIR is passed, it is used as
4201 the base of the directory."
4213 ;; The class and name
4221 ;; The source
4234 ;; The keywords
4237 kwds))
4239 ;; Build a canonicalized list
4244 ;; Creating new sintern tables
4247 "Define a variable and a function to sintern the new type TAG.
4248 This defines the function `idlwave-sintern-TAG' and the variable
4249 `idlwave-sint-TAGs'."
4261 name)
4265 "Reset the sintern variable associated with TAG."
4268 ;;---------------------------------------------------------------------------
4271 ;; The variables which hold the information
4287 "Alist with !PATH directories and zero or more flags if the dir has
4288 been scanned in a user catalog ('user) or discovered in a library
4304 ;;
4305 ;; The code to get routine info from different sources.
4312 "Provide a list of IDL routines.
4313 This routine loads the builtin routines on the first call.
4314 Later it only returns the value of the variable."
4324 ;; Keep it running...
4325 )
4327 ;; Something is wrong, get rid of the process
4336 ;; return the current value
4337 idlwave-routines)))
4340 "List of functions which should run after a global rinfo update.
4344 "Rescan the previously selected directories. For batch processing."
4348 "Dispatch another Emacs instance to update the idlwave catalog.
4349 After the process finishes normally, the first access to routine info
4350 will re-read the catalog."
4374 nil emacs args)))
4377 process
4381 idlwave-system-routines nil
4382 idlwave-catalog-process nil)
4388 ;; Format for all routine info user catalog, library catalogs, etc.:
4389 ;;
4390 ;; ("ROUTINE" type class
4391 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4392 ;; (buffer pro_file dir) | (compiled pro_file dir)
4393 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4394 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4395 ;;
4396 ;; DIR will be supplied dynamically while loading library catalogs,
4397 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4398 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4399 ;; be nil, as can LINK1, etc., if no HTML help is available.
4406 "Update the internal routine-info lists.
4409 about individual routines.
4411 The information can come from 4 sources:
4412 1. IDL programs in the current editing session
4413 2. Compiled modules in an IDL shell running as Emacs subprocess
4414 3. A list which covers the IDL system routines.
4415 4. A list which covers the prescanned library files.
4417 Scans all IDLWAVE-mode buffers of the current editing session (see
4418 `idlwave-scan-all-buffers-for-routine-info').
4419 When an IDL shell is running, this command also queries the IDL program
4420 for currently compiled routines.
4422 With prefix ARG, also reload the system and library lists.
4423 With two prefix ARG's, also rescans the chosen user catalog tree.
4424 With three prefix args, dispatch asynchronous process to do the update.
4426 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4427 lists, but instead wait for the shell query to complete and
4428 asynchronously finish updating routine info. This is set
4429 automatically when called interactively. When you need routine
4430 information updated immediately, leave NO-CONCATENATE nil."
4432 ;; Stop any idle processing
4440 ;; Start a background process which updates the catalog.
4443 ;; Update the user catalog now, and wait for them.
4447 idlwave-buffer-case-takes-precedence
4449 ;; The override-idle means, even if the idle timer has done some
4450 ;; preparing work, load and renormalize everything anyway.
4454 idlwave-compiled-routines nil
4455 idlwave-unresolved-routines nil)
4456 ;; Reset the appropriate hashes
4458 ;; reset was already done in idle time, so skip this step now once
4465 ;; We can safely scan the buffer stuff first
4469 ;; We first do the system info, and then the buffers
4473 ;; Let's see if there is a shell
4477 idlwave-query-shell-for-routine-info)))
4479 ;; Load the library catalogs again, first re-scanning the path
4491 ;; 1. If we are not going to ask the shell, we need to do the
4492 ;; concatenation now.
4493 ;; 2. When this function is called non-interactively, it
4494 ;; means that someone needs routine info *now*. The
4495 ;; shell update causes the concatenation to be
4496 ;; *delayed*, so not in time for the current command.
4497 ;; Therefore, we do a concatenation now, even though
4498 ;; the shell might do it again.
4502 ;; Ask the shell about the routines it knows of.
4525 idlwave-init-rinfo-when-idle-after
4531 ;;------ XML Help routine info system
4533 ;; Load the system routine info from the cached routine info file,
4534 ;; which, if necessary, will be re-created from the XML file on
4535 ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo
4536 ;; file distributed with older IDLWAVE versions (<6.0)
4540 ;; See if we can create it from XML source
4560 idlwave-xml-system-rinfo-converted-file
4561 catalog-file)))
4565 "Alist of system variables and the associated structure tags.
4573 ;; From a list of syntax statements, shorten with %s and group with "or"
4582 x)
4587 ;; Create a class list entry from the xml parsed list., returning a
4588 ;; cons of form (class-entry method-entries).
4594 class-entry
4595 method methods-entry extra-kwds
4596 props get-props set-props init-props inherits
4597 pelem ptype)
4627 init-props)
4630 get-props)
4633 set-props)
4637 methods-entry)))
4640 ;;(unless (get 'init-props 'matched)
4641 ;; (message "Failed to match Init in class %s" class))
4642 ;;(unless (get 'get-props 'matched)
4643 ;; (message "Failed to match GetProperty in class %s" class))
4644 ;;(unless (get 'set-props 'matched)
4645 ;; (message "Failed to match SetProperty in class %s" class))
4653 ;; Create correctly structured list elements from ROUTINE or METHOD
4654 ;; XML list structures. Return a list of list elements, with more
4655 ;; than one sub-list possible if a routine can serve as both
4656 ;; procedure and function (e.g. call_method).
4663 syntax kwd klink pref-list kwds pelem ptype props result type)
4698 ;; Debug
4699 ;; (if (and (null (aref syntax-vec 0))
4700 ;; (null (aref syntax-vec 1))
4701 ;; (null (aref syntax-vec 2)))
4702 ;; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints")
4703 ;; (if class
4704 ;; (insert (format "Missing SYNTAX entry for %s::%s\n" class name))
4705 ;; (insert (message "Missing SYNTAX entry for %s\n" name)))))
4707 ;; Executive commands are treated specially
4719 result)))
4723 ;; Group keywords by link file, as a list with elements
4724 ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2))
4736 ;; Ensure the master link is there
4739 linkfiles
4744 ;; Clean up the syntax of routines which are actually aliases by
4745 ;; removing the "OR" from the statements
4754 ;; Duplicate and trim original routine aliases from rinfo list
4755 ;; This if for, e.g. OPENR/OPENW/OPENU
4765 ;; Add any missing aliases (separate by slashes)
4780 ;; Duplicate and trim original routine aliases from rinfo list
4781 ;; This if for, e.g. !X, !Y, !Z.
4794 ;; Create a sysvar list entry from the xml parsed list.
4802 pelem ptype props tags)
4813 tags))))
4827 ;; Automatically generated from source file:
4832 idlwave-xml-routine-info-file))
4850 "Convert XML supplied IDL routine info into internal form.
4851 Cache to disk for quick recovery."
4857 props rinfo msg-cnt elem type nelem class-result alias
4858 routines routine-aliases statement-aliases sysvar-aliases)
4868 ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff.
4878 idlwave-system-variables-alist nil
4879 idlwave-system-class-info nil
4880 idlwave-executive-commands-alist nil
4881 idlwave-help-special-topic-words nil)
4897 routine-aliases)
4902 ;; a cons cell is an executive commands
4914 idlwave-help-special-topic-words)
4915 ;; Save the links to those which are statement aliases (not routines)
4924 sysvar-aliases)
4926 idlwave-system-variables-alist)))
4937 ;; ("ROUTINE" type class
4938 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4939 ;; (buffer pro_file dir) | (compiled pro_file dir)
4940 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4941 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4951 ;;(load "idlw-rinfo" 'noerror 'nomessage)
4973 ;; Check for the old style catalog and warn
4976 idlwave-library-routines)
4981 idlwave-user-catalog-file))
5008 ;; restart the timer
5013 idlwave-init-rinfo-when-idle-after
5019 ;; Load and case-treat the system, user catalog, and library routine
5020 ;; info files.
5022 ;; System
5024 ;;(load "idlw-rinfo" 'noerror 'nomessage))
5036 ;; User catalog
5045 idlwave-library-routines)
5048 idlwave-user-catalog-file))
5057 ;; Library catalog
5068 ;; Scan all buffers, current buffer last
5073 ;; Don't scan any buffers
5076 ;; Just scan this buffer
5082 ;; Put the result into the correct variable
5087 "Put the different sources for routine information together."
5088 ;; The sequence here is important because earlier definitions shadow
5089 ;; later ones. We assume that if things in the buffers are newer
5090 ;; then in the shell of the system, they are meant to be different.
5093 idlwave-compiled-routines
5094 idlwave-library-catalog-routines
5095 idlwave-user-catalog-routines))
5098 ;; Give a message with information about the number of routines we have.
5101 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
5111 "Return the class alist - make it if necessary."
5118 idlwave-class-alist)))
5120 ;; Three functions for the hooks
5129 "Update `idlwave-routines' for current buffer.
5130 Can run from `after-save-hook'."
5134 idlwave-scan-all-buffers-for-routine-info
5135 idlwave-routines)
5141 nil
5147 routines)
5151 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
5153 found)
5155 ;; The following test uses eq to make sure it works correctly
5156 ;; when two buffers visit the same file. Then the file names
5157 ;; will be equal, but not eq.
5163 ;; End of that section reached. Jump.
5169 ;;----- Scanning buffers -------------------
5172 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
5178 buffer-file-name)
5179 ;; yes, this buffer has the right mode.
5184 ;; Concatenate the individual lists and return the result
5188 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
5190 routine-list string entry)
5204 routine-list))
5209 "Parse a module definition."
5211 start name args type keywords class)
5212 ;; Remove comments
5215 ;; Remove the continuation line stuff
5220 ;; Match the name and type.
5228 ;; Match normal args and keyword args
5231 string start)
5236 ;; Normalize and sort.
5240 ;; Make and return the entry
5241 ;; We don't know which argument are optional, so this information
5242 ;; will not be contained in the calling sequence.
5245 class
5248 ; ((string= (downcase
5249 ; (file-name-sans-extension
5250 ; (file-name-nondirectory (buffer-file-name))))
5251 ; (downcase name))
5252 ; (list 'lib))
5253 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
5259 "%s"
5267 nil))))
5270 ;;----- Scanning the user catalog -------------------
5273 "Return the syslib directory, or a dummy that never matches."
5277 idlwave-system-directory)
5283 "Scan all files on selected dirs of IDL search path for routine information.
5285 A widget checklist will allow you to choose the directories. Write
5286 the result as a file `idlwave-user-catalog-file'. When this file
5287 exists, it will be automatically loaded to give routine information
5288 about library routines. With ARG, just rescan the same directories
5289 as last time - so no widget will pop up."
5291 ;; Make sure the file is loaded if it exists.
5297 ;; Make sure the file name makes sense
5303 idlwave-user-catalog-file))))
5307 ;; Rescan the known directories
5312 ;; Expand the directories from library-path and run the widget
5316 ;; Propagate any flags on the existing path-alist
5319 idlwave-true-path-alist)))
5326 ;; Ask the shell for the path and then run the widget
5335 ;; Parse shell path information and select among it.
5337 ;; Command hook used by `idlwave-create-user-catalog-file'.
5339 ;; Scan immediately
5341 ;; Set the path and display the widget
5347 "This is the front-end to the creation of the IDLWAVE user catalog.
5348 Please select the directories on IDL's search path from which you
5349 would like to extract routine information, to be stored in the file:
5351 %s
5353 If this is not the correct file, first set variable
5354 `idlwave-user-catalog-file', and call this command again.
5356 N.B. Many libraries include pre-scanned catalog files
5358 not be scanned. You can scan your own libraries off-line using the
5359 perl script `idlwave_catalog'.
5361 After selecting the directories, choose [Scan & Save] to scan the library
5362 directories and save the routine info.
5368 "Create the widget to select IDL search path directories for scanning."
5380 idlwave-user-catalog-file))
5391 :notify
5401 :notify
5419 'checklist
5423 dirs-list))
5424 :greedy t
5446 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
5451 dir-entry)
5457 selected-dirs)
5464 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5468 dirs-alist dir files file)
5470 idlwave-path-alist path-alist ; for library-path instead
5471 idlwave-true-path-alist nil)
5492 idlwave-user-catalog-routines)))))))))
5500 font-lock-mode)
5506 ;; Define the routine info list
5513 idlwave-user-catalog-routines))
5517 ;; Save the buffer
5523 idlwave-user-catalog-file)
5541 font-lock-mode)
5546 ;; Define the variable which knows the value of "!DIR"
5548 idlwave-system-directory))
5550 ;; Define the variable which contains a list of all scanned directories
5557 idlwave-path-alist))
5564 ;; Expand parts of path starting with '+' recursively into directory list.
5565 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5575 ;; Expand recursively
5577 ;; Keep unchanged
5583 ;; Return a list of all directories below DIR, including DIR itself
5592 path1))
5595 ;;----- Scanning the library catalogs ------------------
5601 "Scan for library catalog files (.idlwave_catalog) and ingest.
5603 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5604 instead, if present) are searched. Print MESSAGE-BASE along with the
5605 libraries being loaded, if passed, and skip loading/normalizing if
5606 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5607 be set to nil to disable library catalog scanning."
5614 dir-entry dir catalog all-routines)
5622 ;; Load the catalog file
5627 message-base
5629 old-libname)))
5631 idlwave-library-catalog-libname))
5638 all-routines))))
5640 ;; Add a 'lib flag if on path-alist
5647 ;;----- Communicating with the Shell -------------------
5649 ;; First, here is the idl program which can be used to query IDL for
5650 ;; defined routines.
5652 "
5653 ;; START OF IDLWAVE SUPPORT ROUTINES
5654 pro idlwave_print_safe,item,limit
5655 catch,err
5656 if err ne 0 then begin
5657 print,'Could not print item.'
5658 return
5659 endif
5660 if n_elements(item) gt limit then $
5661 print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $
5662 else print,item
5663 end
5665 pro idlwave_print_info_entry,name,func=func,separator=sep
5666 ;; See if it's an object method
5667 if name eq '' then return
5668 func = keyword_set(func)
5669 methsep = strpos(name,'::')
5670 meth = methsep ne -1
5672 ;; Get routine info
5673 pars = routine_info(name,/parameters,functions=func)
5674 source = routine_info(name,/source,functions=func)
5675 nargs = pars.num_args
5676 nkw = pars.num_kw_args
5677 if nargs gt 0 then args = pars.args
5678 if nkw gt 0 then kwargs = pars.kw_args
5680 ;; Trim the class, and make the name
5681 if meth then begin
5682 class = strmid(name,0,methsep)
5683 name = strmid(name,methsep+2,strlen(name)-1)
5684 if nargs gt 0 then begin
5685 ;; remove the self argument
5686 wh = where(args ne 'SELF',nargs)
5687 if nargs gt 0 then args = args[wh]
5688 endif
5689 endif else begin
5690 ;; No class, just a normal routine.
5692 endelse
5694 ;; Calling sequence
5696 if func then cs = 'Result = '
5697 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5698 cs = cs + '%s'
5699 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5700 if nargs gt 0 then begin
5701 for j=0,nargs-1 do begin
5702 cs = cs + args[j]
5703 if j lt nargs-1 then cs = cs + ', '
5704 endfor
5705 end
5706 if func then cs = cs + ')'
5707 ;; Keyword arguments
5708 kwstring = ''
5709 if nkw gt 0 then begin
5710 for j=0,nkw-1 do begin
5711 kwstring = kwstring + ' ' + kwargs[j]
5712 endfor
5713 endif
5715 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5717 print,ret + ': ' + name + sep + class + sep + source[0].path $
5718 + sep + cs + sep + kwstring
5719 end
5721 pro idlwave_routine_info,file
5722 on_error,1
5723 sep = '<@>'
5725 all = routine_info()
5726 fileQ=n_elements(file) ne 0
5727 if fileQ then file=strtrim(file,2)
5728 for i=0L,n_elements(all)-1L do begin
5729 if fileQ then begin
5730 if (routine_info(all[i],/SOURCE)).path eq file then $
5731 idlwave_print_info_entry,all[i],separator=sep
5732 endif else idlwave_print_info_entry,all[i],separator=sep
5733 endfor
5734 all = routine_info(/functions)
5735 for i=0L,n_elements(all)-1L do begin
5736 if fileQ then begin
5737 if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $
5738 idlwave_print_info_entry,all[i],separator=sep,/FUNC
5739 endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC
5740 endfor
5741 print,'>>>END OF IDLWAVE ROUTINE INFO'
5742 end
5744 pro idlwave_get_sysvars
5745 on_error,1
5746 catch,error_status
5747 if error_status ne 0 then begin
5748 print, 'Cannot get info about system variables'
5749 endif else begin
5750 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5751 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5752 v = strsplit(s,' +',/regex,/extract) ; get variables
5753 for i=0L,n_elements(v)-1 do begin
5754 t = [''] ; get tag list
5755 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5756 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5757 endfor
5758 endelse
5759 end
5761 pro idlwave_get_class_tags, class
5762 res = execute('tags=tag_names({'+class+'})')
5763 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5764 end
5765 ;; END OF IDLWAVE SUPPORT ROUTINES
5766 "
5787 (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5792 ;; Restore if necessary. Must use execute to hide lame routine_info
5793 ;; errors on undefinded routine
5795 (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'"
5796 idlwave-shell-temp-rinfo-save-file
5797 idlwave-shell-temp-rinfo-save-file)
5802 "Query the shell for routine_info of compiled modules and update the lists."
5803 ;; Save and compile the procedure. The compiled procedure is then
5804 ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may
5805 ;; need to test for and possibly RESTORE the procedure each time we
5806 ;; use it, since the user may have killed or redefined it. In
5807 ;; particular, .RESET_SESSION will kill all user procedures. If
5808 ;; FILE is set, only update routine info for routines in that file.
5811 ; execute the routine_info procedure, and analyze the output
5819 ;; ---------------------------------------------------------------------------
5820 ;;
5821 ;; Completion and displaying routine calling sequences
5833 "Complete a function, procedure or keyword name at point.
5834 This function is smart and figures out what can be completed
5835 at this point.
5836 - At the beginning of a statement it completes procedure names.
5837 - In the middle of a statement it completes function names.
5838 - After a `(' or `,' in the argument list of a function or procedure,
5839 it completes a keyword of the relevant function or procedure.
5840 - In the first arg of `OBJ_NEW', it completes a class name.
5842 When several completions are possible, a list will be displayed in
5843 the *Completions* buffer. If this list is too long to fit into the
5844 window, scrolling can be achieved by repeatedly pressing
5847 The function also knows about object methods. When it needs a class
5848 name, the action depends upon `idlwave-query-class', which see. You
5849 can force IDLWAVE to ask you for a class name with a
5852 See also the variables `idlwave-keyword-completion-adds-equal' and
5853 `idlwave-function-completion-adds-paren'.
5855 The optional ARG can be used to specify the completion type in order
5856 to override IDLWAVE's idea of what should be completed at point.
5857 Possible values are:
5859 0 <=> query for the completion type
5860 1 <=> 'procedure
5861 2 <=> 'procedure-keyword
5862 3 <=> 'function
5863 4 <=> 'function-keyword
5864 5 <=> 'procedure-method
5865 6 <=> 'procedure-method-keyword
5866 7 <=> 'function-method
5867 8 <=> 'function-method-keyword
5868 9 <=> 'class
5870 As a special case, the universal argument C-u forces completion of
5871 function names in places where the default would be a keyword.
5873 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5874 completion.
5876 For Lisp programmers only:
5877 When we force a keyword, optional argument MODULE can contain the module name.
5878 When we force a method or a method keyword, CLASS can specify the class."
5905 ;; Complete a filename in quotes
5910 ;; Check for any special completion functions
5917 ;; Complete a class
5923 ;; Complete a procedure name
5936 isa
5942 isa
5946 ;; Complete a function name
5959 isa
5965 isa
5973 ;; Complete a procedure keyword
5990 super-classes system))
6002 isa
6006 ;; Complete a function keyword
6019 msg-name)
6024 super-classes system))
6025 ;; OBJ_NEW: Messages mention the proper Init method
6032 msg-name))
6041 isa
6047 "List of special completion functions.
6048 These functions are called for each completion. Each function must
6049 check if its own special completion context is present. If yes, it
6050 should use `idlwave-complete-in-buffer' to do some completion and
6051 return t. If such a function returns t, *no further* attempts to
6052 complete other contexts will be done. If the function returns nil,
6057 fun ret)
6062 nil)))
6065 ;; Return an artificial WHERE specification to force the completion
6066 ;; routine to complete a specific item independent of context.
6067 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
6068 ;; MODULE and CLASS can be used to specify the routine name and class.
6069 ;; The class name will also be found in MODULE if that is like "class::mod".
6087 what)
6160 ;; Completing read, case insensitive
6170 "Use the comint stuff to complete a file name."
6178 idlwave-shell-default-directory
6179 default-directory)))
6183 ;; Make a fully qualified module name including the class name
6187 "Like `idlwave-rinfo-assq', but sintern strings first."
6193 ;; Works like assq, but also checks type and class
6204 ;; Return the first matching method on the inheritance list
6206 class rtn)
6210 rtn))
6213 keep-system)
6214 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
6215 If WITH-FILE is passed, find the best rinfo entry with a file
6216 included. If KEEP-SYSTEM is set, don't prune system for compiled
6217 syslib files."
6220 list))
6221 syslibp)
6228 ;; Its a compiled syslib, so we need to remove the system entry
6234 twins)))))
6238 keep-system)
6239 "Like `idlwave-best-rinfo-assq', but sintern strings first."
6245 "Does the entry list ENTRIES contain a syslib entry?
6246 If yes, return the index (>=1)."
6255 nil)))
6258 "Return a list of all associations of Key in LIST."
6266 "Return all classes which have a method METHOD.
6267 TYPE is 'fun or 'pro.
6268 When TYPE is not specified, both procedures and functions will be considered."
6281 "Return all classes which have a method METHOD with keyword KEYWORD.
6282 TYPE is 'fun or 'pro.
6283 When TYPE is not specified, both procedures and functions will be considered."
6286 nil
6298 "Return list of all elements in LIST which are also in CLUB."
6307 "Return list of all elements in LIST which are not in CLUB."
6311 nil
6317 "Return whether or not the class is listed explicitly, ala a->b::c.
6318 INFO is as returned by `idlwave-what-function' or `-procedure'."
6325 "List of special functions for determining class.
6329 ;; Determine the class of a routine call.
6330 ;; INFO is the `cw-list' structure as returned by idlwave-where.
6331 ;; The second element in this structure is the class. When nil, we
6332 ;; return nil. When t, try to get the class from text properties at
6333 ;; the arrow. When the object is "self", we use the class of the
6334 ;; current routine. otherwise prompt the user for a class name.
6335 ;; Also stores the selected class as a text property at the arrow.
6336 ;; TYPE is 'fun or 'pro.
6342 idlwave-query-class))
6344 idlwave-query-class))
6356 store special-class class-alist)
6360 ;; There is an object which would like to know its class
6362 idlwave-store-inquired-class
6369 ;; Before prompting, try any special class determination routines
6371 idlwave-determine-class-special
6377 store idlwave-store-inquired-class)))
6379 ;; Prompt for a class, if we need to
6400 ;; Store it, if requested
6402 ;; We have a real class here
6408 rear-nonsticky t))
6411 ;; Return the class
6412 class)
6413 ;; Default as fallback
6423 ;; Record a file link, if any, for the tested names during selection.
6427 sel))
6431 "Find out where we are.
6432 The return value is a list with the following stuff:
6433 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
6435 PRO-LIST (PRO POINT CLASS ARROW)
6436 FUNC-LIST (FUNC POINT CLASS ARROW)
6437 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
6438 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
6439 be completed here.
6440 LAST-CHAR last relevant character before point (non-white non-comment,
6441 not part of current identifier or leading slash).
6443 In the lists, we have these meanings:
6444 PRO: Procedure name
6445 FUNC: Function name
6446 POINT: Where is this
6447 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
6448 ARROW: Location of the arrow"
6466 cw cw-mod cw-arrow cw-class cw-point)
6470 match-string)
6476 match-string))
6478 cw-arrow pro-arrow))
6480 match-string)
6481 nil)
6483 match-string)
6486 match-string)
6493 cw-class func-class cw-arrow func-arrow))
6496 cw-class pro-class cw-arrow pro-arrow))
6497 ; ((member last-char '(?\' ?\) ?\] ?!))
6498 ; ;; after these chars, a function makes no sense
6499 ; ;; FIXME: I am sure there can be more in this list
6500 ; ;; FIXME: Do we want to do this at all?
6501 ; nil)
6502 ;; Everywhere else we try a function.
6506 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t)
6510 t))))))
6513 cw
6515 last-char)))
6518 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6526 ;; Find out if point is within the argument list of a function.
6527 ;; The return value is ("function-name" class arrow-start (point) level).
6528 ;; Level is 1 on the top level parentheses, higher further down.
6530 ;; If the optional BOUND is an integer, bound backwards directed
6531 ;; searches to this point.
6535 func-point
6537 func arrow-start class)
6542 ;; move back out of the current parenthesis
6551 bound t))
6554 pos func-point)
6560 'exit
6564 arrow-start func-point cnt)))
6569 ;; Find out if point is within the argument list of a procedure.
6570 ;; The return value is ("procedure-name" class arrow-pos (point)).
6572 ;; If the optional BOUND is an integer, bound backwards directed
6573 ;; searches to this point.
6575 pro class arrow-start string)
6577 ;;(idlwave-beginning-of-statement)
6587 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6588 string))
6593 pos)
6598 arrow-start
6599 pro-point)))
6602 ;; If there is an object at point, move over it and return t.
6612 nil)
6630 nil)))
6633 "Return the last character before point which is not white or a comment
6634 and also not part of the current identifier. Since we do this in
6635 order to identify places where keywords are, we consider the initial
6636 `/' of a keyword as part of the identifier.
6637 This function is not general, can only be used for completion stuff."
6640 ;; skip the current identifier
6642 ;; also skip a leading slash which might be belong to the keyword
6645 ;; FIXME: does not check if this is a valid identifier
6653 ;; continuation line
6667 &optional prepare-display-function
6668 special-selector)
6669 "Perform TYPE completion of word before point against LIST.
6670 SELECTOR is the PREDICATE argument for the completion function. Show
6671 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6672 'procedure, 'class-tag, 'keyword, 'sysvar, etc. SPECIAL-SELECTOR is
6673 used only once, for `all-completions', and can be used to, e.g.,
6674 accumulate information on matching completions."
6677 dpart dcompletion)
6682 ;; What is already in the buffer?
6687 idlwave-complete-after-success-form
6690 idlwave-complete-after-success-form-force
6694 ;; Try a completion
6700 idlwave-completion-help-links nil)
6703 ;; nothing available.
6707 ;; We can add something
6711 idlwave-complete-empty-string-as-lower-case)
6713 dcompletion
6714 completion))
6716 ;; Now this is a unique match
6718 t)
6724 selector))))))
6726 ;; This is already complete
6729 nil)
6731 ;; We cannot add something - offer a list.
6739 idlwave-completion-help-links))))
6740 list))
6742 ;; "complete" means, this is already a valid completion
6745 ;; (completion-fixup-function ; Emacs
6746 ;; (lambda () (and (eq (preceding-char) ?>)
6747 ;; (re-search-backward " <" beg t)))))
6755 idlwave-complete-empty-string-as-lower-case)
6761 x)
6762 list)))
6764 t))))
6767 "Complete a class at point."
6769 ;; Call `idlwave-routines' to make sure the class list will be available
6771 ;; Check for the special case of completing empty string after pro/function
6780 ;; Yank the full class specification
6782 ;; Do the completion, using list gathered from `idlwave-routines'
6791 idlwave-completion-help-links))
6792 x))
6793 list)))))
6796 ;; Attach the proper class list to a LIST of completion items.
6797 ;; TYPE, when 'kwd, shows classes for method keywords, when
6798 ;; 'class-tag, for class tags, and otherwise for methods.
6799 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6805 ;; In these cases, we do not have to do anything
6806 list
6810 ;; (do-dots (featurep 'xemacs))
6816 classes nclasses class-info space)
6819 ;; get the classes
6821 ;; Just one class for tags
6825 ;; Multiple classes for method or method-keyword
6829 method-selector x type-selector)
6835 classes)))))
6837 ;; Make the separator between item and class-info
6842 ;; We do want info in the buffer
6845 space
6850 ;; We do want properties
6854 x))
6857 x))
6858 list))))
6861 ;; Call idlwave-attach-classes with method parameters
6864 ;; Call idlwave-attach-classes with keyword parameters
6867 ;; Call idlwave-attach-classes with class structure tags
6871 ;;----------------------------------------------------------------------
6872 ;;----------------------------------------------------------------------
6873 ;;----------------------------------------------------------------------
6874 ;;----------------------------------------------------------------------
6875 ;;----------------------------------------------------------------------
6882 "Select an item in LIST with a popup menu.
6883 TITLE is the title to put atop the popup. If SORT is non-nil,
6884 sort the list before displaying."
6886 rtn menu)
6896 x)))
6897 list)))
6910 rtn))
6913 "Split the MENU into submenus of maximum length N."
6915 ;; No splitting needed
6916 menu
6931 nextmenu))
6933 nextmenu nil
6938 "Split the MENU into submenus of maximum length N."
6940 ;; No splitting needed
6941 menu
6957 nextmenu))
6959 nextmenu nil
6963 menu)))
6968 "Scroll the completion window on this frame."
6986 "Display the completions in LIST in the completions buffer and echo MESSAGE."
6994 list)
6997 ;; Store a special value in `this-command'. When `idlwave-complete'
6998 ;; finds this in `last-command', it will scroll the *Completions* buffer.
7001 ;; Mark the completions buffer as created by cib
7004 ;; Fontify the classes
7009 ;; Run the hook
7012 ;; Display the message
7016 "Call FUNCTION as a completion chooser and pass ARGS to it."
7022 ;; For the shell, remove the fontification of the word before point
7037 "Restore the old (before completion) window configuration."
7039 idlwave-before-completion-wconf
7043 "Make the user select an element from the alist in the variable SYM.
7044 The keys of the alist are expected to be strings. The function returns the
7045 car of the selected association.
7046 To do this, PROMPT is displayed and the user must hit a letter key to
7047 select an entry. If the user does not reply within DELAY seconds, a help
7048 window with the options is displayed automatically.
7049 The key which is associated with each option is generated automatically.
7051 If these don't exist, a letter in the string is automatically selected."
7055 keys-alist char)
7056 ;; First check the cache
7059 ;; Need to make new list
7063 ;; Display prompt and wait for quick reply
7068 ;; No quick reply: Show help
7077 ;; Return the selected result
7080 ;; Used for, e.g., electric debug super-examine.
7082 "Make an alist for single key selection."
7090 ;; First check if the configuration predetermined a key
7097 ;; Then check for capital letters
7107 t t name))
7110 ;; Now check for lowercase letters
7120 t t name))
7123 ;; Bummer, nothing found! Use a stupid number
7130 "Set the buffer-local value of VAR in BUFFER to VALUE."
7135 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
7140 ;; In XEmacs, we can use :activate-callback directly to advice the
7141 ;; choose functions. We use the private keymap only for the online
7142 ;; help feature.
7151 cl-args))
7160 "Execute `default-choose-completion' and then restore the win-conf."
7164 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7167 (define-key new-map [button3] (lambda ()
7168 (interactive)
7169 (setq this-command last-command)))
7170 new-map))
7172 ;; In Emacs we also replace keybindings in the completion
7173 ;; map in order to install our wrappers.
7175 (defun idlwave-display-completion-list-emacs (list)
7176 "Display completion list and install the choose wrappers."
7177 (with-output-to-temp-buffer "*Completions*"
7178 (display-completion-list list))
7179 (with-current-buffer "*Completions*"
7180 (use-local-map
7181 (or idlwave-completion-map
7182 (setq idlwave-completion-map
7183 (idlwave-make-modified-completion-map-emacs
7184 (current-local-map)))))))
7186 (defun idlwave-make-modified-completion-map-emacs (old-map)
7187 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7188 (let ((new-map (copy-keymap old-map)))
7189 (substitute-key-definition
7190 'choose-completion 'idlwave-choose-completion new-map)
7191 (substitute-key-definition
7192 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
7193 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
7194 new-map))
7196 (defun idlwave-choose-completion (&rest args)
7197 "Choose the completion that point is in or next to."
7198 (interactive)
7199 (apply 'idlwave-choose 'choose-completion args))
7201 (defun idlwave-mouse-choose-completion (&rest args)
7202 "Click on an alternative in the `*Completions*' buffer to choose it."
7203 (interactive "e")
7204 (apply 'idlwave-choose 'mouse-choose-completion args))
7206 ;;----------------------------------------------------------------------
7207 ;;----------------------------------------------------------------------
7209 ;;; ------------------------------------------------------------------------
7210 ;;; Stucture parsing code, and code to manage class info
7212 ;;
7213 ;; - Go again over the documentation how to write a completion
7214 ;; plugin. It is in self.el, but currently still very bad.
7215 ;; This could be in a separate file in the distribution, or
7216 ;; in an appendix for the manual.
7218 (defvar idlwave-struct-skip
7220 "Regexp for skipping continued blank or comment-only lines in structures.")
7222 (defvar idlwave-struct-tag-regexp
7223 (concat "[{,]" ;leading comma/brace
7224 idlwave-struct-skip ; 4 groups
7227 "Regexp for structure tags.")
7229 (defun idlwave-struct-tags ()
7230 "Return a list of all tags in the structure defined at point.
7231 Point is expected just before the opening `{' of the struct definition."
7232 (save-excursion
7233 (let* ((borders (idlwave-struct-borders))
7234 (beg (car borders))
7235 (end (cdr borders))
7236 tags)
7237 (goto-char beg)
7238 (save-restriction
7239 (narrow-to-region beg end)
7240 (while (re-search-forward idlwave-struct-tag-regexp end t)
7241 ;; Check if we are still on the top level of the structure.
7242 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7243 (= (point) beg))
7244 (push (match-string-no-properties 5) tags))
7245 (goto-char (match-end 0))))
7246 (nreverse tags))))
7248 (defun idlwave-find-struct-tag (tag)
7249 "Find a given TAG in the structure defined at point."
7250 (let* ((borders (idlwave-struct-borders))
7251 (end (cdr borders))
7252 (case-fold-search t))
7254 end t)))
7256 (defun idlwave-struct-inherits ()
7257 "Return a list of all `inherits' names in the struct at point.
7258 Point is expected just before the opening `{' of the struct definition."
7259 (save-excursion
7260 (let* ((borders (idlwave-struct-borders))
7261 (beg (car borders))
7262 (end (cdr borders))
7263 (case-fold-search t)
7264 names)
7265 (goto-char beg)
7266 (save-restriction
7267 (narrow-to-region beg end)
7268 (while (re-search-forward
7269 (concat "[{,]" ;leading comma/brace
7270 idlwave-struct-skip ; 4 groups
7271 "inherits" ; The INHERITS tag
7272 idlwave-struct-skip ; 4 more
7274 end t)
7275 ;; Check if we are still on the top level of the structure.
7276 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7277 (= (point) beg))
7278 (push (match-string-no-properties 9) names))
7279 (goto-char (match-end 0))))
7280 (nreverse names))))
7282 (defun idlwave-in-structure ()
7283 "Return t if point is inside an IDL structure definition."
7284 (let ((beg (point)))
7285 (save-excursion
7286 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
7287 (if (idlwave-find-structure-definition nil nil 'back)
7288 (let ((borders (idlwave-struct-borders)))
7289 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
7290 (and (> beg (car borders)) (< beg (cdr borders))))))))))
7292 (defun idlwave-struct-borders ()
7293 "Return the borders of the {...} after point as a cons cell."
7294 (let (beg)
7295 (save-excursion
7296 (skip-chars-forward "^{")
7297 (setq beg (point))
7298 (condition-case nil (forward-list 1)
7299 (error (goto-char beg)))
7300 (cons beg (point)))))
7302 (defun idlwave-find-structure-definition (&optional var name bound)
7303 "Search forward for a structure definition.
7304 If VAR is non-nil, search for a structure assigned to variable VAR.
7305 If NAME is non-nil, search for a named structure NAME, if a string,
7306 or a generic named structure otherwise. If BOUND is an integer, limit
7307 the search. If BOUND is the symbol `all', we search first back and
7308 then forward through the entire file. If BOUND is the symbol `back'
7309 we search only backward."
7311 (case-fold-search t)
7312 (lim (if (integerp bound) bound nil))
7313 (re (concat
7314 (if var
7318 (if name
7319 (if (stringp name)
7321 ;; Just a generic name
7323 ""))))
7324 (if (or (and (or (eq bound 'all) (eq bound 'back))
7325 (re-search-backward re nil t))
7326 (and (not (eq bound 'back)) (re-search-forward re lim t)))
7327 (progn
7328 (goto-char (match-beginning 3))
7329 (match-string-no-properties 5)))))
7331 (defvar idlwave-class-info nil)
7332 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
7334 (add-hook 'idlwave-update-rinfo-hook
7335 (lambda () (setq idlwave-class-reset t)))
7336 (add-hook 'idlwave-after-load-rinfo-hook
7337 (lambda () (setq idlwave-class-info nil)))
7339 (defun idlwave-class-info (class)
7340 (let (list entry)
7341 (if idlwave-class-info
7342 (if idlwave-class-reset
7343 (setq
7344 idlwave-class-reset nil
7345 idlwave-class-info ; Remove any visited in a buffer
7346 (delq nil (mapcar
7347 (lambda (x)
7348 (let ((filebuf
7349 (idlwave-class-file-or-buffer
7350 (or (cdr (assq 'found-in x)) (car x)))))
7351 (if (cdr filebuf)
7352 nil
7353 x)))
7354 idlwave-class-info))))
7355 ;; Info is nil, put in the system stuff to start.
7356 (setq idlwave-class-info idlwave-system-class-info)
7357 (setq list idlwave-class-info)
7358 (while (setq entry (pop list))
7359 (idlwave-sintern-class-info entry)))
7360 (setq class (idlwave-sintern-class class))
7361 (or (assq class idlwave-class-info)
7362 (progn (idlwave-scan-class-info class)
7363 (assq class idlwave-class-info)))))
7365 (defun idlwave-sintern-class-info (entry)
7366 "Sintern the class names in a class-info entry."
7367 (let ((inherits (assq 'inherits entry)))
7368 (setcar entry (idlwave-sintern-class (car entry) 'set))
7369 (if inherits
7370 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
7371 (cdr inherits))))))
7373 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
7374 "Find class structure definition(s).
7375 If ALL-HOOK is set, find all named structure definitions in a given
7376 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
7377 set, look for the name__define pro, and inside of it, for the ALT-CLASS
7378 class/struct definition."
7379 (let ((case-fold-search t) end-lim name)
7380 (when (re-search-forward
7382 (if all-hook
7383 (progn
7384 ;; For everything there
7385 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
7386 (while (setq name
7387 (idlwave-find-structure-definition nil t end-lim))
7388 (funcall all-hook name)))
7389 (idlwave-find-structure-definition nil (or alt-class class))))))
7392 (defun idlwave-class-file-or-buffer (class)
7393 "Find buffer visiting CLASS definition."
7394 (let* ((pro (concat (downcase class) "__define"))
7395 (file (idlwave-routine-source-file
7396 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
7397 (idlwave-routines))))))
7398 (cons file (if file (idlwave-get-buffer-visiting file)))))
7401 (defun idlwave-scan-class-info (class)
7402 "Scan all class and named structure info in the class__define pro."
7403 (let* ((idlwave-auto-routine-info-updates nil)
7404 (filebuf (idlwave-class-file-or-buffer class))
7405 (file (car filebuf))
7406 (buf (cdr filebuf))
7407 (class (idlwave-sintern-class class)))
7408 (if (or
7409 (not file)
7410 (and ;; neither a regular file nor a visited buffer
7411 (not buf)
7412 (not (file-regular-p file))))
7413 nil ; Cannot find the file/buffer to get any info
7414 (save-excursion
7415 (if buf (set-buffer buf)
7416 ;; Read the file in temporarily
7417 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
7418 (erase-buffer)
7419 (unless (derived-mode-p 'idlwave-mode)
7420 (idlwave-mode))
7421 (insert-file-contents file))
7422 (save-excursion
7423 (goto-char 1)
7424 (idlwave-find-class-definition class
7425 ;; Scan all of the structures found there
7426 (lambda (name)
7427 (let* ((this-class (idlwave-sintern-class name))
7428 (entry
7429 (list this-class
7430 (cons 'tags (idlwave-struct-tags))
7431 (cons 'inherits (idlwave-struct-inherits)))))
7432 (if (not (eq this-class class))
7433 (setq entry (nconc entry (list (cons 'found-in class)))))
7434 (idlwave-sintern-class-info entry)
7435 (push entry idlwave-class-info)))))))))
7437 (defun idlwave-class-found-in (class)
7438 "Return the FOUND-IN property of the CLASS."
7439 (cdr (assq 'found-in (idlwave-class-info class))))
7440 (defun idlwave-class-tags (class)
7441 "Return the native tags in CLASS."
7442 (cdr (assq 'tags (idlwave-class-info class))))
7443 (defun idlwave-class-inherits (class)
7444 "Return the direct superclasses of CLASS."
7445 (cdr (assq 'inherits (idlwave-class-info class))))
7448 (defun idlwave-all-class-tags (class)
7449 "Return a list of native and inherited tags in CLASS."
7450 (condition-case err
7451 (apply 'append (mapcar 'idlwave-class-tags
7452 (cons class (idlwave-all-class-inherits class))))
7453 (error
7454 (idlwave-class-tag-reset)
7455 (error "%s" (error-message-string err)))))
7458 (defun idlwave-all-class-inherits (class)
7459 "Return a list of all superclasses of CLASS (recursively expanded).
7460 The list is cached in `idlwave-class-info' for faster access."
7461 (cond
7462 ((not idlwave-support-inheritance) nil)
7463 ((eq class nil) nil)
7464 ((eq class t) nil)
7465 (t
7466 (let ((info (idlwave-class-info class))
7467 entry)
7468 (if (setq entry (assq 'all-inherits info))
7469 (cdr entry)
7470 ;; Save the depth of inheritance scan to check for circular references
7471 (let ((inherits (mapcar (lambda (x) (cons x 0))
7472 (idlwave-class-inherits class)))
7473 rtn all-inherits cl)
7474 (while inherits
7475 (setq cl (pop inherits)
7476 rtn (cons (car cl) rtn)
7477 inherits (append (mapcar (lambda (x)
7478 (cons x (1+ (cdr cl))))
7479 (idlwave-class-inherits (car cl)))
7480 inherits))
7481 (if (> (cdr cl) 999)
7482 (error
7483 "Class scan: inheritance depth exceeded. Circular inheritance?")
7484 ))
7485 (setq all-inherits (nreverse rtn))
7486 (nconc info (list (cons 'all-inherits all-inherits)))
7487 all-inherits))))))
7489 (defun idlwave-entry-keywords (entry &optional record-link)
7490 "Return the flat entry keywords alist from routine-info entry.
7491 If RECORD-LINK is non-nil, the keyword text is copied and a text
7492 property indicating the link is added."
7493 (let (kwds)
7494 (mapc
7495 (lambda (key-list)
7496 (let ((file (car key-list)))
7497 (mapcar (lambda (key-cons)
7498 (let ((key (car key-cons))
7499 (link (cdr key-cons)))
7500 (when (and record-link file)
7501 (setq key (copy-sequence key))
7502 (put-text-property
7503 0 (length key)
7504 'link
7505 (concat
7506 file
7507 (if link
7508 (concat idlwave-html-link-sep
7509 (number-to-string link))))
7510 key))
7511 (push (list key) kwds)))
7512 (cdr key-list))))
7513 (nthcdr 5 entry))
7514 (nreverse kwds)))
7516 (defun idlwave-entry-find-keyword (entry keyword)
7517 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set."
7518 (catch 'exit
7519 (mapc
7520 (lambda (key-list)
7521 (let ((file (car key-list))
7522 (kwd (assoc keyword (cdr key-list))))
7523 (when kwd
7524 (setq kwd (cons (car kwd)
7525 (if (and file (cdr kwd))
7526 (concat file
7527 idlwave-html-link-sep
7528 (number-to-string (cdr kwd)))
7529 (cdr kwd))))
7530 (throw 'exit kwd))))
7531 (nthcdr 5 entry))))
7533 ;;==========================================================================
7534 ;;
7535 ;; Completing class structure tags. This is a completion plugin.
7536 ;; The necessary taglist is constructed dynamically
7538 (defvar idlwave-current-tags-class nil)
7539 (defvar idlwave-current-class-tags nil)
7540 (defvar idlwave-current-native-class-tags nil)
7541 (defvar idlwave-sint-class-tags nil)
7542 (declare-function idlwave-sintern-class-tag "idlwave" t t)
7543 (idlwave-new-sintern-type 'class-tag)
7544 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7545 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7547 (defun idlwave-complete-class-structure-tag ()
7548 "Complete a structure tag on a `self' argument in an object method."
7549 (interactive)
7550 (let ((pos (point))
7551 (case-fold-search t))
7552 (if (save-excursion
7553 ;; Check if the context is right
7554 (skip-chars-backward "a-zA-Z0-9._$")
7555 (and (< (point) (- pos 4))
7557 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7558 (super-classes (idlwave-all-class-inherits class-selector)))
7559 ;; Check if we are in a class routine
7560 (unless class-selector
7561 (error "Not in a method procedure or function"))
7562 ;; Check if we need to update the "current" class
7563 (if (not (equal class-selector idlwave-current-tags-class))
7564 (idlwave-prepare-class-tag-completion class-selector))
7565 (setq idlwave-completion-help-info
7566 (list 'idlwave-complete-class-structure-tag-help
7567 (idlwave-sintern-routine
7568 (concat class-selector "__define"))
7569 nil))
7570 ;; FIXME: idlwave-cpl-bold doesn't seem used anywhere.
7571 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7572 (idlwave-complete-in-buffer
7573 'class-tag 'class-tag
7574 idlwave-current-class-tags nil
7575 (format "Select a tag of class %s" class-selector)
7576 "class tag"
7577 'idlwave-attach-class-tag-classes))
7578 t) ; return t to skip other completions
7579 nil)))
7581 (defun idlwave-class-tag-reset ()
7582 (setq idlwave-current-tags-class nil))
7584 (defun idlwave-prepare-class-tag-completion (class)
7585 "Find and parse the necessary class definitions for class structure tags."
7586 (setq idlwave-sint-class-tags nil)
7587 (setq idlwave-current-tags-class class)
7588 (setq idlwave-current-class-tags
7589 (mapcar (lambda (x)
7590 (list (idlwave-sintern-class-tag x 'set)))
7591 (idlwave-all-class-tags class)))
7592 (setq idlwave-current-native-class-tags
7593 (mapcar 'downcase (idlwave-class-tags class))))
7595 ;===========================================================================
7596 ;;
7597 ;; Completing system variables and their structure fields
7598 ;; This is also a plugin.
7600 (defvar idlwave-sint-sysvars nil)
7601 (defvar idlwave-sint-sysvartags nil)
7602 (declare-function idlwave-sintern-sysvar "idlwave" t t)
7603 (declare-function idlwave-sintern-sysvartag "idlwave" t t)
7604 (idlwave-new-sintern-type 'sysvar)
7605 (idlwave-new-sintern-type 'sysvartag)
7606 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7607 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7608 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7611 (defun idlwave-complete-sysvar-or-tag ()
7612 "Complete a system variable."
7613 (interactive)
7614 (let ((pos (point))
7615 (case-fold-search t))
7616 (cond ((save-excursion
7617 ;; Check if the context is right for system variable
7618 (skip-chars-backward "[a-zA-Z0-9_$]")
7619 (equal (char-before) ?!))
7620 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7621 (idlwave-complete-in-buffer 'sysvar 'sysvar
7622 idlwave-system-variables-alist nil
7623 "Select a system variable"
7624 "system variable")
7625 t) ; return t to skip other completions
7626 ((save-excursion
7627 ;; Check if the context is right for sysvar tag
7628 (skip-chars-backward "a-zA-Z0-9_$.")
7629 (and (equal (char-before) ?!)
7631 (<= (match-end 0) pos)))
7632 ;; Complete a system variable tag
7633 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7634 (entry (assq var idlwave-system-variables-alist))
7635 (tags (cdr (assq 'tags entry))))
7636 (or entry (error "!%s is not a known system variable" var))
7637 (or tags (error "System variable !%s is not a structure" var))
7638 (setq idlwave-completion-help-info
7639 (list 'idlwave-complete-sysvar-tag-help var))
7640 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7641 tags nil
7642 "Select a system variable tag"
7643 "system variable tag")
7644 t)) ; return t to skip other completions
7645 (t nil))))
7647 (defvar idlw-help-link) ;dynamic variables set by help callback
7648 (defun idlwave-complete-sysvar-help (mode word)
7649 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7650 (entry (assoc word idlwave-system-variables-alist)))
7651 (cond
7652 ((eq mode 'test)
7653 (and (stringp word) entry (nth 1 (assq 'link entry))))
7654 ((eq mode 'set)
7655 ;; Setting dynamic!!!
7656 (if entry (setq idlw-help-link (nth 1 (assq 'link entry)))))
7657 (t (error "This should not happen")))))
7659 (defun idlwave-complete-sysvar-tag-help (mode word)
7660 (let* ((var (nth 1 idlwave-completion-help-info))
7661 (entry (assoc var idlwave-system-variables-alist))
7662 (tags (cdr (assq 'tags entry)))
7663 (main (nth 1 (assq 'link entry)))
7664 target)
7665 (cond
7666 ((eq mode 'test) ; we can at least link the main
7667 (and (stringp word) entry main))
7668 ((eq mode 'set)
7669 (if entry
7670 (setq idlw-help-link
7671 (if (setq target (cdr (assoc-string word tags t)))
7672 (idlwave-substitute-link-target main target)
7673 main)))) ;; setting dynamic!!!
7674 (t (error "This should not happen")))))
7676 (defun idlwave-split-link-target (link)
7677 "Split a given LINK into link file and anchor."
7678 (if (string-match idlwave-html-link-sep link)
7679 (cons (substring link 0 (match-beginning 0))
7680 (string-to-number (substring link (match-end 0))))))
7682 (defun idlwave-substitute-link-target (link target)
7683 "Substitute the TARGET anchor for the given LINK."
7684 (let (main-base)
7685 (setq main-base (if (string-match "#" link)
7686 (substring link 0 (match-beginning 0))
7687 link))
7688 (if target
7689 (concat main-base idlwave-html-link-sep (number-to-string target))
7690 link)))
7692 ;; Fake help in the source buffer for class structure tags.
7693 ;; IDLW-HELP-LINK AND IDLW-HELP-NAME ARE GLOBAL-VARIABLES HERE.
7694 ;; (from idlwave-do-mouse-completion-help)
7695 (defvar idlw-help-name)
7696 (defvar idlw-help-link)
7697 (defvar idlwave-help-do-class-struct-tag nil)
7698 (defun idlwave-complete-class-structure-tag-help (mode word)
7699 (cond
7700 ((eq mode 'test) ; nothing gets fontified for class tags
7701 nil)
7702 ((eq mode 'set)
7703 (let (class-with found-in)
7704 (when (setq class-with
7705 (idlwave-class-or-superclass-with-tag
7706 idlwave-current-tags-class
7707 word))
7708 (if (assq (idlwave-sintern-class class-with)
7709 idlwave-system-class-info)
7710 (error "No help available for system class tags"))
7711 (if (setq found-in (idlwave-class-found-in class-with))
7712 (setq idlw-help-name (cons (concat found-in "__define") class-with))
7713 (setq idlw-help-name (concat class-with "__define")))))
7714 (setq idlw-help-link word
7715 idlwave-help-do-class-struct-tag t))
7716 (t (error "This should not happen"))))
7718 (defun idlwave-class-or-superclass-with-tag (class tag)
7719 "Find and return the CLASS or one of its superclass with the
7720 associated TAG, if any."
7721 (let ((sclasses (cons class (idlwave-all-class-inherits class)))
7722 cl)
7723 (catch 'exit
7724 (while sclasses
7725 (setq cl (pop sclasses))
7726 (let ((tags (idlwave-class-tags cl)))
7727 (while tags
7728 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7729 (throw 'exit cl))
7730 (setq tags (cdr tags))))))))
7733 (defun idlwave-sysvars-reset ()
7734 (if (and (fboundp 'idlwave-shell-is-running)
7735 (idlwave-shell-is-running)
7736 idlwave-idlwave_routine_info-compiled)
7737 (idlwave-shell-send-command "idlwave_get_sysvars"
7738 'idlwave-process-sysvars 'hide)))
7740 (defun idlwave-process-sysvars ()
7741 (idlwave-shell-filter-sysvars)
7742 (setq idlwave-sint-sysvars nil
7743 idlwave-sint-sysvartags nil)
7744 (idlwave-sintern-sysvar-alist))
7746 (defun idlwave-sintern-sysvar-alist ()
7747 (let ((list idlwave-system-variables-alist) entry tags)
7748 (while (setq entry (pop list))
7749 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7750 (setq tags (assq 'tags entry))
7751 (if tags
7752 (setcdr tags
7753 (mapcar (lambda (x)
7754 (cons (idlwave-sintern-sysvartag (car x) 'set)
7755 (cdr x)))
7756 (cdr tags)))))))
7758 (defvar idlwave-shell-command-output)
7759 (defun idlwave-shell-filter-sysvars ()
7760 "Get any new system variables and tags."
7761 (let ((text idlwave-shell-command-output)
7762 (start 0)
7763 (old idlwave-system-variables-alist)
7764 var tags type name class link old-entry)
7765 (setq idlwave-system-variables-alist nil)
7767 text start)
7768 (setq start (match-end 0)
7769 var (match-string 1 text)
7770 tags (if (match-end 3)
7771 (idlwave-split-string (match-string 3 text))))
7772 ;; Maintain old links, if present
7773 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7774 (setq link (assq 'link old-entry))
7775 (setq idlwave-system-variables-alist
7776 (cons (list var
7777 (cons
7778 'tags
7779 (mapcar (lambda (x)
7780 (cons x
7781 (cdr (assq
7782 (idlwave-sintern-sysvartag x)
7783 (cdr (assq 'tags old-entry))))))
7784 tags)) link)
7785 idlwave-system-variables-alist)))
7786 ;; Keep the old value if query was not successful
7787 (setq idlwave-system-variables-alist
7788 (or idlwave-system-variables-alist old))))
7790 (defun idlwave-completion-fontify-classes ()
7791 "Goto the *Completions* buffer and fontify the class info."
7792 (when (featurep 'font-lock)
7793 (with-current-buffer "*Completions*"
7794 (save-excursion
7795 (goto-char (point-min))
7796 (let ((buffer-read-only nil))
7798 (put-text-property (match-beginning 0) (match-end 0)
7799 'face 'font-lock-string-face)))))))
7801 (defun idlwave-uniquify (list)
7802 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7803 (delq nil
7804 (mapcar (lambda (x)
7805 (unless (gethash x ht)
7806 (puthash x t ht)
7807 x))
7808 list))))
7810 (defun idlwave-after-successful-completion (type slash &optional verify)
7811 "Add `=' or `(' after successful completion of keyword and function.
7812 Restore the pre-completion window configuration if possible."
7813 (cond
7814 ((eq type 'procedure)
7815 nil)
7816 ((eq type 'function)
7817 (cond
7818 ((equal idlwave-function-completion-adds-paren nil) nil)
7819 ((or (equal idlwave-function-completion-adds-paren t)
7820 (equal idlwave-function-completion-adds-paren 1))
7821 (insert "("))
7822 ((equal idlwave-function-completion-adds-paren 2)
7823 (insert "()")
7824 (backward-char 1))
7825 (t nil)))
7826 ((eq type 'keyword)
7827 (if (and idlwave-keyword-completion-adds-equal
7828 (not slash))
7829 (progn (insert "=") t)
7830 nil)))
7832 ;; Restore the pre-completion window configuration if this is safe.
7834 (if (or (eq verify 'force) ; force
7835 (and
7836 (get-buffer-window "*Completions*") ; visible
7837 (idlwave-local-value 'idlwave-completion-p
7838 "*Completions*") ; cib-buffer
7839 (eq (marker-buffer idlwave-completion-mark)
7840 (current-buffer)) ; buffer OK
7841 (equal (marker-position idlwave-completion-mark)
7842 verify))) ; pos OK
7843 (idlwave-restore-wconf-after-completion))
7844 (move-marker idlwave-completion-mark nil)
7845 (setq idlwave-before-completion-wconf nil))
7847 (defun idlwave-mouse-context-help (ev &optional arg)
7848 "Call `idlwave-context-help' on the clicked location."
7849 (interactive "eP")
7850 (mouse-set-point ev)
7851 (idlwave-context-help arg))
7853 (defvar idlwave-last-context-help-pos nil)
7854 (defun idlwave-context-help (&optional arg)
7855 "Display IDL Online Help on context.
7856 If point is on a keyword, help for that keyword will be shown. If
7857 point is on a routine name or in the argument list of a routine, help
7858 for that routine will be displayed. Works for system routines and
7859 keywords, it pulls up text help. For other routies and keywords,
7860 visits the source file, finding help in the header (if
7861 `idlwave-help-source-try-header' is non-nil) or the routine definition
7862 itself."
7863 (interactive "P")
7864 (idlwave-do-context-help arg))
7866 (defun idlwave-mouse-completion-help (ev)
7867 "Display online help about the completion at point."
7868 (interactive "eP")
7869 ;; Restore last-command for next command, to make
7870 ;; scrolling/cancelling of completions work.
7871 (setq this-command last-command)
7872 (idlwave-do-mouse-completion-help ev))
7874 (defun idlwave-routine-info (&optional arg external)
7875 "Display a routines calling sequence and list of keywords.
7876 When point is on the name a function or procedure, or in the argument
7877 list of a function or procedure, this command displays a help buffer with
7878 the information. When called with prefix arg, enforce class query.
7880 When point is on an object operator `->', display the class stored in
7881 this arrow, if any (see `idlwave-store-inquired-class'). With a prefix
7882 arg, the class property is cleared out."
7884 (interactive "P")
7885 (idlwave-routines)
7886 (if (string-match "->" (buffer-substring
7887 (max (point-min) (1- (point)))
7888 (min (+ 2 (point)) (point-max))))
7889 ;; Cursor is on an arrow
7890 (if (get-text-property (point) 'idlwave-class)
7891 ;; arrow has class property
7892 (if arg
7893 ;; Remove property
7894 (save-excursion
7895 (backward-char 1)
7897 (remove-text-properties (match-beginning 1) (match-end 1)
7898 '(idlwave-class nil face nil))
7899 (message "Class property removed from arrow")))
7900 ;; Echo class property
7901 (message "Arrow has text property identifying object to be class %s"
7902 (get-text-property (point) 'idlwave-class)))
7903 ;; No property found
7904 (message "Arrow has no class text property"))
7906 ;; Not on an arrow...
7907 (let* ((idlwave-query-class nil)
7908 (idlwave-force-class-query (equal arg '(4)))
7909 (module (idlwave-what-module)))
7910 (if (car module)
7911 (apply 'idlwave-display-calling-sequence
7912 (idlwave-fix-module-if-obj_new module))
7913 (error "Don't know which calling sequence to show")))))
7915 (defun idlwave-resolve (&optional arg)
7916 "Call RESOLVE_ROUTINE on the module name at point.
7917 Like `idlwave-routine-info', this looks for a routine call at point.
7918 After confirmation in the minibuffer, it will use the shell to issue
7919 a RESOLVE call for this routine, to attempt to make it defined and its
7920 routine info available for IDLWAVE. If the routine is a method call,
7921 both `class__method' and `class__define' will be tried.
7922 With ARG, enforce query for the class of object methods."
7923 (interactive "P")
7924 (let* ((idlwave-query-class nil)
7925 (idlwave-force-class-query (equal arg '(4)))
7926 (module (idlwave-what-module))
7927 (name (idlwave-make-full-name (nth 2 module) (car module)))
7928 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7929 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7930 (kwd "")
7931 class)
7933 resolve)
7934 (setq type (match-string 1 resolve)
7935 class (if (match-beginning 2)
7936 (match-string 3 resolve)
7937 nil)
7938 name (match-string 4 resolve)))
7939 (if (string= (downcase type) "function")
7940 (setq kwd ",/is_function"))
7942 (cond
7943 ((null class)
7944 (idlwave-shell-send-command
7945 (format "resolve_routine,'%s'%s" (downcase name) kwd)
7946 'idlwave-update-routine-info
7947 nil t))
7948 (t
7949 (idlwave-shell-send-command
7950 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
7951 (list 'idlwave-shell-send-command
7952 (format "resolve_routine,'%s__%s'%s"
7953 (downcase class) (downcase name) kwd)
7954 '(idlwave-update-routine-info)
7955 nil t))))))
7957 (defun idlwave-find-module-this-file ()
7958 (interactive)
7959 (idlwave-find-module '(4)))
7961 (defun idlwave-find-module (&optional arg)
7962 "Find the source code of an IDL module.
7963 Works for modules for which IDLWAVE has routine info available.
7964 The function offers as default the module name `idlwave-routine-info'
7965 would use. With ARG limit to this buffer. With two prefix ARG's
7966 force class query for object methods."
7967 (interactive "P")
7968 (let* ((idlwave-query-class nil)
7969 (idlwave-force-class-query (equal arg '(16)))
7970 (this-buffer (equal arg '(4)))
7971 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
7972 (default (if module
7973 (concat (idlwave-make-full-name
7974 (nth 2 module) (car module))
7975 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
7976 "none"))
7977 (list
7978 (idlwave-uniquify
7979 (delq nil
7980 (mapcar (lambda (x)
7981 (if (eq 'system (car-safe (nth 3 x)))
7982 ;; Take out system routines with no source.
7983 nil
7984 (list
7985 (concat (idlwave-make-full-name
7986 (nth 2 x) (car x))
7987 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
7988 (if this-buffer
7989 (idlwave-save-buffer-update)
7990 (idlwave-routines))))))
7991 (name (idlwave-completing-read
7992 (if (or (not this-buffer)
7993 (assoc default list))
7994 (format "Module (Default %s): " default)
7995 (format "Module in this file: "))
7996 list))
7997 type class)
7999 ;; Nothing, use the default.
8000 (setq name default))
8001 (if (string-match "<[fp]>" name)
8002 (setq type (substring name -2 -1)
8003 name (substring name 0 -3)))
8005 (setq class (match-string 1 name)
8006 name (match-string 2 name)))
8007 (setq name (idlwave-sintern-routine-or-method name class)
8008 class (idlwave-sintern-class class)
8009 type (cond ((equal type "f") 'fun)
8010 ((equal type "p") 'pro)
8011 (t t)))
8012 (idlwave-do-find-module name type class nil this-buffer)))
8014 (defun idlwave-do-find-module (name type class
8015 &optional force-source this-buffer)
8016 (let ((name1 (idlwave-make-full-name class name))
8017 source buf1 entry
8018 (buf (current-buffer))
8019 (pos (point))
8020 file name2)
8021 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
8022 'WITH-FILE)
8023 source (or force-source (nth 3 entry))
8024 name2 (if (nth 2 entry)
8025 (idlwave-make-full-name (nth 2 entry) name)
8026 name1))
8027 (if source
8028 (setq file (idlwave-routine-source-file source)))
8029 (unless file ; Try to find it on the path.
8030 (setq file
8031 (idlwave-expand-lib-file-name
8032 (if class
8033 (format "%s__define.pro" (downcase class))
8034 (format "%s.pro" (downcase name))))))
8035 (cond
8036 ((or (null name) (equal name ""))
8037 (error "Abort"))
8038 ((eq (car source) 'system)
8039 (error "Source code for system routine %s is not available"
8040 name2))
8041 ((or (not file) (not (file-regular-p file)))
8042 (error "Source code for routine %s is not available"
8043 name2))
8044 (t
8045 (when (not this-buffer)
8046 (setq buf1
8047 (idlwave-find-file-noselect file 'find))
8048 (pop-to-buffer buf1 t))
8049 (goto-char (point-max))
8050 (let ((case-fold-search t))
8051 (if (re-search-backward
8053 (cond ((eq type 'fun) "function")
8054 ((eq type 'pro) "pro")
8057 (regexp-quote (downcase name2))
8058 "[^a-zA-Z0-9_$]")
8059 nil t)
8060 (goto-char (match-beginning 0))
8061 (pop-to-buffer buf)
8062 (goto-char pos)
8063 (error "Could not find routine %s" name2)))))))
8065 (defun idlwave-what-module ()
8066 "Return a default module for stuff near point.
8067 Used by `idlwave-routine-info' and `idlwave-find-module'."
8068 (idlwave-routines)
8069 (if (let ((case-fold-search t))
8070 (save-excursion
8071 (idlwave-beginning-of-statement)
8072 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
8073 ;; This is a function or procedure definition statement
8074 ;; We return the defined routine as module.
8075 (list
8076 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
8077 (match-string-no-properties 2))
8078 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
8079 (idlwave-sintern-class (match-string 3)))
8081 ;; Not a definition statement - analyze precise position.
8082 (let* ((where (idlwave-where))
8083 (cw (nth 2 where))
8084 (pro (car (nth 0 where)))
8085 (func (car (nth 1 where)))
8086 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
8087 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
8088 (following-char)))
8089 )
8090 (cond
8091 ((and (eq cw 'procedure)
8092 (not (equal this-word "")))
8093 (setq this-word (idlwave-sintern-routine-or-method
8094 this-word (nth 2 (nth 3 where))))
8095 (list this-word 'pro
8096 (idlwave-determine-class
8097 (cons this-word (cdr (nth 3 where)))
8098 'pro)))
8099 ((and (eq cw 'function)
8100 (not (equal this-word ""))
8101 (or (eq next-char ?\() ; exclude arrays, vars.
8103 (setq this-word (idlwave-sintern-routine-or-method
8104 this-word (nth 2 (nth 3 where))))
8105 (list this-word 'fun
8106 (idlwave-determine-class
8107 (cons this-word (cdr (nth 3 where)))
8108 'fun)))
8109 ((and (memq cw '(function-keyword procedure-keyword))
8110 (not (equal this-word ""))
8111 (eq next-char ?\()) ; A function!
8112 (setq this-word (idlwave-sintern-routine this-word))
8113 (list this-word 'fun nil))
8114 (func
8115 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
8116 (pro
8117 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
8118 (t nil)))))
8120 (defun idlwave-what-module-find-class ()
8121 "Call `idlwave-what-module' and find the inherited class if necessary."
8122 (let* ((module (idlwave-what-module))
8123 (class (nth 2 module)))
8124 (if (and (= (length module) 3)
8125 (stringp class))
8126 (list (car module)
8127 (nth 1 module)
8128 (apply 'idlwave-find-inherited-class module))
8129 module)))
8131 (defun idlwave-find-inherited-class (name type class)
8132 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
8133 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
8134 (if entry
8135 (nth 2 entry)
8136 class)))
8138 (defun idlwave-fix-module-if-obj_new (module)
8139 "Check if MODULE points to obj_new.
8140 If yes, and if the cursor is in the keyword region, change to the
8141 appropriate Init method."
8142 (let* ((name (car module))
8143 (pos (point))
8144 (case-fold-search t)
8145 string)
8146 (if (and (stringp name)
8147 (equal (downcase name) "obj_new")
8148 (save-excursion
8149 (idlwave-beginning-of-statement)
8150 (setq string (buffer-substring (point) pos))
8152 string)))
8153 (let ((name "Init")
8154 (class (match-string 1 string)))
8155 (setq module (list (idlwave-sintern-method "Init")
8156 'fun
8157 (idlwave-sintern-class class)))))
8158 module))
8160 (defun idlwave-fix-keywords (name type class keywords
8161 &optional super-classes system)
8162 "Update a list of keywords.
8163 Translate OBJ_NEW, adding all super-class keywords, or all keywords
8164 from all classes if CLASS equals t. If SYSTEM is non-nil, don't
8165 demand _EXTRA in the keyword list."
8166 (let ((case-fold-search t))
8168 ;; If this is the OBJ_NEW function, try to figure out the class and use
8169 ;; the keywords from the corresponding INIT method.
8170 (if (and (equal (upcase name) "OBJ_NEW")
8171 (derived-mode-p 'idlwave-mode 'idlwave-shell-mode))
8172 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
8173 (string (buffer-substring bos (point)))
8174 (case-fold-search t)
8175 class)
8177 string)
8178 (setq class (idlwave-sintern-class (match-string 1 string)))
8179 (setq idlwave-current-obj_new-class class)
8180 (setq keywords
8181 (append keywords
8182 (idlwave-entry-keywords
8183 (idlwave-rinfo-assq
8184 (idlwave-sintern-method "INIT")
8185 'fun
8186 class
8187 (idlwave-routines)) 'do-link))))))
8189 ;; If the class is `t', combine all keywords of all methods NAME
8190 (when (eq class t)
8191 (mapc (lambda (entry)
8192 (and
8193 (nth 2 entry) ; non-nil class
8194 (eq (nth 1 entry) type) ; correct type
8195 (setq keywords
8196 (append keywords
8197 (idlwave-entry-keywords entry 'do-link)))))
8198 (idlwave-all-assq name (idlwave-routines)))
8199 (setq keywords (idlwave-uniquify keywords)))
8201 ;; If we have inheritance, add all keywords from superclasses, if
8202 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
8203 (when (and
8204 super-classes
8205 idlwave-keyword-class-inheritance
8206 (stringp class)
8207 (or
8208 system
8209 (assq (idlwave-sintern-keyword "_extra") keywords)
8210 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
8211 ;; Check if one of the keyword-class regexps matches the name
8212 (let ((regexps idlwave-keyword-class-inheritance) re)
8213 (catch 'exit
8214 (while (setq re (pop regexps))
8215 (if (string-match re name) (throw 'exit t))))))
8217 (loop for entry in (idlwave-routines) do
8218 (and (nth 2 entry) ; non-nil class
8219 (memq (nth 2 entry) super-classes) ; an inherited class
8220 (eq (nth 1 entry) type) ; correct type
8221 (eq (car entry) name) ; correct name
8222 (mapc (lambda (k) (add-to-list 'keywords k))
8223 (idlwave-entry-keywords entry 'do-link))))
8224 (setq keywords (idlwave-uniquify keywords)))
8226 ;; Return the final list
8227 keywords))
8229 (defun idlwave-expand-keyword (keyword module)
8230 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
8231 KEYWORD may be an exact match or an abbreviation of a keyword.
8232 If the match is exact, KEYWORD itself is returned, even if there may be other
8233 keywords of which KEYWORD is an abbreviation. This is necessary because some
8234 system routines have keywords which are prefixes of other keywords.
8235 If KEYWORD is an abbreviation of several keywords, a list of all possible
8236 completions is returned.
8237 If the abbreviation was unique, the correct keyword is returned.
8238 If it cannot be a keyword, the function return nil.
8239 If we do not know about MODULE, just return KEYWORD literally."
8240 (let* ((name (car module))
8241 (type (nth 1 module))
8242 (class (nth 2 module))
8243 (kwd (idlwave-sintern-keyword keyword))
8244 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
8245 (kwd-alist (idlwave-entry-keywords entry))
8246 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
8247 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
8248 (completion-ignore-case t)
8249 candidates)
8250 (cond ((assq kwd kwd-alist)
8251 kwd)
8252 ((setq candidates (all-completions kwd kwd-alist))
8253 (if (= (length candidates) 1)
8254 (car candidates)
8255 candidates))
8256 ((and entry extra)
8257 ;; Inheritance may cause this keyword to be correct
8258 keyword)
8259 (entry
8260 ;; We do know the function, which does not have the keyword.
8261 nil)
8262 (t
8263 ;; We do not know the function, so this just might be a correct
8264 ;; keyword - return it as it is.
8265 keyword))))
8267 (defvar idlwave-rinfo-mouse-map
8268 (let ((map (make-sparse-keymap)))
8269 (define-key map
8270 (if (featurep 'xemacs) [button2] [mouse-2])
8271 'idlwave-mouse-active-rinfo)
8272 (define-key map
8273 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
8274 'idlwave-mouse-active-rinfo-shift)
8275 (define-key map
8276 (if (featurep 'xemacs) [button3] [mouse-3])
8277 'idlwave-mouse-active-rinfo-right)
8278 (define-key map " " 'idlwave-active-rinfo-space)
8279 (define-key map "q" 'idlwave-quit-help)
8280 map))
8282 (defvar idlwave-rinfo-map
8283 (let ((map (make-sparse-keymap)))
8284 (define-key map "q" 'idlwave-quit-help)
8285 map))
8287 (defvar idlwave-popup-source nil)
8288 (defvar idlwave-rinfo-marker (make-marker))
8290 (defun idlwave-quit-help ()
8291 (interactive)
8292 (let ((ri-window (get-buffer-window "*Help*"))
8293 (olh-window (get-buffer-window "*IDLWAVE Help*")))
8294 (when (and olh-window
8295 (fboundp 'idlwave-help-quit))
8296 (select-window olh-window)
8297 (idlwave-help-quit))
8298 (when (window-live-p ri-window)
8299 (delete-window ri-window))))
8301 (defun idlwave-display-calling-sequence (name type class
8302 &optional initial-class)
8303 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
8304 (let* ((initial-class (or initial-class class))
8305 (entry (or (idlwave-best-rinfo-assq name type class
8306 (idlwave-routines))
8307 (idlwave-rinfo-assq name type class
8308 idlwave-unresolved-routines)))
8309 (name (or (car entry) name))
8310 (class (or (nth 2 entry) class))
8311 (superclasses (idlwave-all-class-inherits initial-class))
8312 (twins (idlwave-routine-twins entry))
8313 (dtwins (idlwave-study-twins twins))
8314 (all dtwins)
8315 (system (eq (car (nth 3 entry)) 'system))
8316 (calling-seq (nth 4 entry))
8317 (keywords (idlwave-entry-keywords entry 'do-link))
8318 (html-file (car (nth 5 entry)))
8319 (help-echo-kwd
8320 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
8321 (help-echo-use
8322 "Button2/3: Online Help")
8323 (help-echo-src
8324 "Button2: Jump to source and back | Button3: Source in Help window.")
8325 (help-echo-class
8326 "Button2: Display info about same method in superclass")
8327 (col 0)
8328 (data (list name type class (current-buffer) nil initial-class))
8329 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8330 (face 'idlwave-help-link)
8331 beg props win cnt total)
8332 ;; Fix keywords, but don't add chained super-classes, since these
8333 ;; are shown separately for that super-class
8334 (setq keywords (idlwave-fix-keywords name type class keywords))
8335 (cond
8336 ((null entry)
8337 (error "No %s %s known %s" type name
8338 (if initial-class (concat "in class " initial-class) "")))
8339 ((or (null name) (equal name ""))
8340 (error "No function or procedure call at point"))
8341 ((null calling-seq)
8342 (error "Calling sequence of %s %s not available" type name))
8343 (t
8344 (move-marker idlwave-rinfo-marker (point))
8345 (with-current-buffer (get-buffer-create "*Help*")
8346 (use-local-map idlwave-rinfo-map)
8347 (setq buffer-read-only nil)
8348 (erase-buffer)
8349 (set (make-local-variable 'idlwave-popup-source) nil)
8350 (set (make-local-variable 'idlwave-current-obj_new-class)
8351 idlwave-current-obj_new-class)
8352 (when superclasses
8353 (setq props (list 'mouse-face 'highlight
8354 km-prop idlwave-rinfo-mouse-map
8355 'help-echo help-echo-class
8356 'data (cons 'class data)))
8357 (let ((classes (cons initial-class superclasses)) c)
8358 (insert "Classes: ")
8359 (while (setq c (pop classes))
8360 (insert " ")
8361 (setq beg (point))
8362 (insert c)
8363 (if (equal (downcase c) (downcase class))
8364 (add-text-properties beg (point) (list 'face 'bold))
8365 ;; If Method exists in a different class link it
8366 (if (idlwave-rinfo-assq name type c (idlwave-routines))
8367 (add-text-properties beg (point) props))))
8369 (setq props (list 'mouse-face 'highlight
8370 km-prop idlwave-rinfo-mouse-map
8371 'help-echo help-echo-use
8372 'data (cons 'usage data)))
8373 (if html-file (setq props (append (list 'face face 'link html-file)
8374 props)))
8375 (insert "Usage: ")
8376 (setq beg (point))
8377 (insert (if class
8378 (format calling-seq class name class name class name)
8379 (format calling-seq name name name name))
8381 (add-text-properties beg (point) props)
8383 (insert "Keywords:")
8384 (if (null keywords)
8385 (insert " No keywords accepted.")
8386 (setq col 9)
8387 (mapc
8388 (lambda (x)
8389 (if (>= (+ col 1 (length (car x)))
8390 (window-width))
8391 (progn
8393 (setq col 9)))
8394 (insert " ")
8395 (setq beg (point)
8396 ;; Relevant keywords already have link property attached
8397 props (list 'mouse-face 'highlight
8398 km-prop idlwave-rinfo-mouse-map
8399 'data (cons 'keyword data)
8400 'help-echo help-echo-kwd
8401 'keyword (car x)))
8402 (if system (setq props (append (list 'face face) props)))
8403 (insert (car x))
8404 (add-text-properties beg (point) props)
8405 (setq col (+ col 1 (length (car x)))))
8406 keywords))
8408 (setq cnt 1 total (length all))
8409 ;; Here entry is (key file (list of type-conses))
8410 (while (setq entry (pop all))
8411 (setq props (list 'mouse-face 'highlight
8412 km-prop idlwave-rinfo-mouse-map
8413 'help-echo help-echo-src
8414 'source (list (car (car (nth 2 entry))) ;type
8415 (nth 1 entry)
8416 nil
8417 (cdr (car (nth 2 entry))))
8418 'data (cons 'source data)))
8419 (idlwave-insert-source-location
8421 (if (equal cnt 1)
8422 (if (> total 1) "Sources:" "Source:")
8423 "")
8424 (if (> total 1) "- " ""))
8425 entry props)
8426 (incf cnt)
8427 (when (and all (> cnt idlwave-rinfo-max-source-lines))
8428 ;; No more source lines, please
8429 (insert (format
8431 idlwave-rinfo-max-source-lines))
8432 (setq all nil)))
8433 (goto-char (point-min))
8434 (setq buffer-read-only t))
8435 (display-buffer "*Help*")
8436 (if (and (setq win (get-buffer-window "*Help*"))
8437 idlwave-resize-routine-help-window)
8438 (progn
8439 (let ((ww (selected-window)))
8440 (unwind-protect
8441 (progn
8442 (select-window win)
8443 (enlarge-window (- (/ (frame-height) 2)
8444 (window-height)))
8445 (shrink-window-if-larger-than-buffer))
8446 (select-window ww)))))))))
8448 (defun idlwave-insert-source-location (prefix entry &optional file-props)
8449 "Insert a source location into the routine info buffer.
8450 Start line with PREFIX. If a file name is inserted, add FILE-PROPS
8451 to it."
8452 (let* ((key (car entry))
8453 (file (nth 1 entry))
8454 (types (nth 2 entry))
8455 (shell-flag (assq 'compiled types))
8456 (buffer-flag (assq 'buffer types))
8457 (user-flag (assq 'user types))
8458 (lib-flag (assq 'lib types))
8459 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
8460 (and user-flag (idlwave-count-memq 'user types))
8461 (and lib-flag (idlwave-count-memq 'lib types))
8462 1))
8463 (doflags t)
8464 beg special)
8466 (insert prefix)
8468 (cond
8469 ((eq key 'system)
8470 (setq doflags nil)
8471 (insert "System "))
8473 ((eq key 'builtin)
8474 (setq doflags nil)
8475 (insert "Builtin "))
8477 ((and (not file) shell-flag)
8478 (insert "Unresolved"))
8480 ((null file)
8481 (insert "ERROR"))
8483 ((idlwave-syslib-p file)
8484 (if (string-match "obsolete" (file-name-directory file))
8485 (insert "Obsolete ")
8486 (insert "SystemLib ")))
8488 ;; New special syntax: taken directly from routine-info for
8489 ;; library catalog routines
8490 ((setq special (or (cdr lib-flag) (cdr user-flag)))
8491 (insert (format "%-10s" special)))
8493 ;; Old special syntax: a matching regexp
8494 ((setq special (idlwave-special-lib-test file))
8495 (insert (format "%-10s" special)))
8497 ;; Catch-all with file
8498 ((idlwave-lib-p file) (insert "Library "))
8500 ;; Sanity catch all
8501 (t (insert "Other ")))
8503 (when doflags
8504 (insert (concat
8505 " ["
8506 (if lib-flag "L" "-")
8507 (if user-flag "C" "-")
8508 (if shell-flag "S" "-")
8509 (if buffer-flag "B" "-")
8510 "] ")))
8511 (when (> ndupl 1)
8512 (setq beg (point))
8513 (insert (format "(%dx) " ndupl))
8514 (add-text-properties beg (point) (list 'face 'bold)))
8515 (when (and file (not (equal file "")))
8516 (setq beg (point))
8517 (insert (apply 'abbreviate-file-name
8518 (if (featurep 'xemacs) (list file t) (list file))))
8519 (if file-props
8520 (add-text-properties beg (point) file-props)))))
8522 (defun idlwave-special-lib-test (file)
8523 "Check the path of FILE against the regexps which define special libs.
8524 Return the name of the special lib if there is a match."
8525 (let ((alist idlwave-special-lib-alist)
8526 entry rtn)
8527 (cond
8528 ((stringp file)
8529 (while (setq entry (pop alist))
8530 (if (string-match (car entry) file)
8531 (setq rtn (cdr entry)
8532 alist nil)))
8533 rtn)
8534 (t nil))))
8536 (defun idlwave-mouse-active-rinfo-right (ev)
8537 (interactive "e")
8538 (idlwave-mouse-active-rinfo ev 'right))
8540 (defun idlwave-mouse-active-rinfo-shift (ev)
8541 (interactive "e")
8542 (idlwave-mouse-active-rinfo ev nil 'shift))
8544 (defun idlwave-active-rinfo-space ()
8545 (interactive)
8546 (idlwave-mouse-active-rinfo nil 'right))
8548 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8549 "Do the mouse actions in the routine info buffer.
8550 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8551 was pressed."
8552 (interactive "e")
8553 (if ev (mouse-set-point ev))
8554 (let (data id name type class buf bufwin source link keyword
8555 word initial-class)
8556 (setq data (get-text-property (point) 'data)
8557 source (get-text-property (point) 'source)
8558 keyword (get-text-property (point) 'keyword)
8559 link (get-text-property (point) 'link)
8560 id (car data)
8561 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8562 buf (nth 4 data)
8563 initial-class (nth 6 data)
8564 word (idlwave-this-word)
8565 bufwin (get-buffer-window buf t))
8567 (cond ((eq id 'class) ; Switch class being displayed
8568 (if (window-live-p bufwin) (select-window bufwin))
8569 (idlwave-display-calling-sequence
8570 (idlwave-sintern-method name)
8571 type (idlwave-sintern-class word)
8572 initial-class))
8573 ((eq id 'usage) ; Online help on this routine
8574 (idlwave-online-help link name type class))
8575 ((eq id 'source) ; Source in help or buffer
8576 (if right ; In help
8577 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8578 (idlwave-help-source-try-header nil)
8579 ;; Fake idlwave-routines so help will find the right entry
8580 (idlwave-routines
8581 (list (list name type class source ""))))
8582 (idlwave-help-get-special-help name type class nil))
8583 ;; Otherwise just pop to the source
8584 (setq idlwave-popup-source (not idlwave-popup-source))
8585 (if idlwave-popup-source
8586 (condition-case err
8587 (idlwave-do-find-module name type class source)
8588 (error
8589 (setq idlwave-popup-source nil)
8590 (if (window-live-p bufwin) (select-window bufwin))
8591 (error (nth 1 err))))
8592 (if bufwin
8593 (select-window bufwin)
8594 (pop-to-buffer buf))
8595 (goto-char (marker-position idlwave-rinfo-marker)))))
8596 ((eq id 'keyword)
8597 (if right
8598 (idlwave-online-help link name type class keyword)
8599 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8601 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8602 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8603 (let ((bwin (get-buffer-window buffer)))
8604 (if idlwave-complete-empty-string-as-lower-case
8605 (setq keyword (downcase keyword)))
8606 (if bwin
8607 (select-window bwin)
8608 (pop-to-buffer buffer)
8609 (setq bwin (get-buffer-window buffer)))
8610 (if (eq (preceding-char) ?/)
8611 (insert keyword)
8612 (unless (save-excursion
8613 (re-search-backward
8615 (min (- (point) 100) (point-min)) t))
8616 (insert ", "))
8617 (if shift (insert "/"))
8618 (insert keyword)
8619 (if (and (not shift)
8620 idlwave-keyword-completion-adds-equal)
8621 (insert "=")))))
8623 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8624 "List the load path shadows of all routines defined in current buffer."
8625 (interactive "P")
8626 (idlwave-routines)
8627 (if (derived-mode-p 'idlwave-mode)
8628 (idlwave-list-load-path-shadows
8629 nil (idlwave-update-current-buffer-info 'save-buffer)
8630 "in current buffer")
8631 (error "Current buffer is not in idlwave-mode")))
8633 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8634 "List the load path shadows of all routines compiled under the shell.
8635 This is very useful for checking an IDL application. Just compile the
8636 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8637 routines and update IDLWAVE internal info. Then check for shadowing
8638 with this command."
8639 (interactive "P")
8640 (cond
8641 ((or (not (fboundp 'idlwave-shell-is-running))
8642 (not (idlwave-shell-is-running)))
8643 (error "Shell is not running"))
8644 ((null idlwave-compiled-routines)
8645 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8646 (t
8647 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8648 "in the shell"))))
8650 (defun idlwave-list-all-load-path-shadows (&optional arg)
8651 "List the load path shadows of all routines known to IDLWAVE."
8652 (interactive "P")
8653 (idlwave-list-load-path-shadows nil nil "globally"))
8655 (defvar idlwave-sort-prefer-buffer-info t
8656 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8658 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8659 "List the routines which are defined multiple times.
8660 Search the information IDLWAVE has about IDL routines for multiple
8661 definitions.
8662 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8664 When IDL hits a routine call which is not defined, it will search on
8665 the load path in order to find a definition. The output of this command
8666 can be used to detect possible name clashes during this process."
8667 (idlwave-routines) ; Make sure everything is loaded.
8668 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8669 (or (y-or-n-p
8670 "You don't have any user or library catalogs. Continue anyway? ")
8671 (error "Abort")))
8672 (let* ((routines (append idlwave-system-routines
8673 idlwave-compiled-routines
8674 idlwave-library-catalog-routines
8675 idlwave-user-catalog-routines
8676 idlwave-buffer-routines
8677 nil))
8678 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8679 (keymap (make-sparse-keymap))
8680 (props (list 'mouse-face 'highlight
8681 km-prop keymap
8682 'help-echo "Mouse2: Find source"))
8683 (nroutines (length (or special-routines routines)))
8684 (step (/ nroutines 100))
8685 (n 0)
8686 (cnt 0)
8687 (idlwave-sort-prefer-buffer-info nil)
8688 routine twins dtwins twin done props1 lroutines)
8690 (if special-routines
8691 ;; Just looking for shadows of a few special routines
8692 (setq lroutines routines
8693 routines special-routines))
8695 (message "Sorting routines...")
8696 (setq routines (sort routines
8697 (lambda (a b)
8698 (string< (downcase (idlwave-make-full-name
8699 (nth 2 a) (car a)))
8700 (downcase (idlwave-make-full-name
8701 (nth 2 b) (car b)))))))
8702 (message "Sorting routines...done")
8704 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8705 (lambda (ev)
8706 (interactive "e")
8707 (mouse-set-point ev)
8708 (apply 'idlwave-do-find-module
8709 (get-text-property (point) 'find-args))))
8710 (define-key keymap [(return)]
8711 (lambda ()
8712 (interactive)
8713 (apply 'idlwave-do-find-module
8714 (get-text-property (point) 'find-args))))
8715 (message "Compiling list...( 0%%)")
8716 (with-current-buffer (get-buffer-create "*Shadows*")
8717 (setq buffer-read-only nil)
8718 (erase-buffer)
8719 (while (setq routine (pop routines))
8720 (if (= (mod (setq n (1+ n)) step) 0)
8721 (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines)))
8723 ;; Get a list of all twins
8724 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8725 (if (memq routine done)
8726 (setq dtwins nil)
8727 (setq dtwins (idlwave-study-twins twins)))
8728 ;; Mark all twins as dealt with
8729 (setq done (append twins done))
8730 (when (or (> (length dtwins) 1)
8731 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8732 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8733 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8734 (incf cnt)
8736 (idlwave-make-full-name (nth 2 routine)
8737 (car routine))
8738 (if (eq (nth 1 routine) 'fun) "()" "")))
8739 (while (setq twin (pop dtwins))
8740 (setq props1 (append (list 'find-args
8741 (list (nth 0 routine)
8742 (nth 1 routine)
8743 (nth 2 routine)))
8744 props))
8746 (goto-char (point-min))
8747 (setq buffer-read-only t))
8748 (setq loc (or loc ""))
8749 (if (> cnt 0)
8750 (progn
8751 (display-buffer (get-buffer "*Shadows*"))
8752 (message "%d case%s of shadowing found %s"
8753 cnt (if (= cnt 1) "" "s") loc))
8754 (message "No shadowing conflicts found %s" loc))))
8756 (defun idlwave-print-source (routine)
8757 (let* ((source (nth 3 routine))
8758 (stype (car source))
8759 (sfile (idlwave-routine-source-file source)))
8760 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8761 (if (and (eq stype 'compiled)
8762 (or (not (stringp sfile))
8764 (setq stype 'unresolved))
8766 stype
8767 (if sfile sfile "No source code available")))))
8769 (defun idlwave-routine-twins (entry &optional list)
8770 "Return all twin entries of ENTRY in LIST.
8771 LIST defaults to `idlwave-routines'.
8772 Twin entries are those which have the same name, type, and class.
8773 ENTRY will also be returned, as the first item of this list."
8774 (let* ((name (car entry))
8775 (type (nth 1 entry))
8776 (class (nth 2 entry))
8777 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8778 twins candidate)
8779 (while (setq candidate (pop candidates))
8780 (if (and (not (eq candidate entry))
8781 (eq type (nth 1 candidate))
8782 (eq class (nth 2 candidate)))
8783 (push candidate twins)))
8784 (if (setq candidate (idlwave-rinfo-assq name type class
8785 idlwave-unresolved-routines))
8786 (push candidate twins))
8787 (cons entry (nreverse twins))))
8789 (defun idlwave-study-twins (entries)
8790 "Return dangerous twins of first entry in ENTRIES.
8791 Dangerous twins are routines with same name, but in different files on
8792 the load path. If a file is in the system library and has an entry in
8793 the `idlwave-system-routines' list, we omit the latter as
8794 non-dangerous because many IDL routines are implemented as library
8795 routines, and may have been scanned."
8796 (let* ((entry (car entries))
8797 (idlwave-twin-name (car entry)) ;
8798 (type (nth 1 entry)) ; Must be bound for
8799 (idlwave-twin-class (nth 2 entry)) ; idlwave-routine-twin-compare
8800 (cnt 0)
8801 source type type-cons file alist syslibp key)
8802 (while (setq entry (pop entries))
8803 (incf cnt)
8804 (setq source (nth 3 entry)
8805 type (car source)
8806 type-cons (cons type (nth 3 source))
8807 file (idlwave-routine-source-file source))
8809 ;; Make KEY to index entry properly
8810 (setq key (cond ((eq type 'system) type)
8811 (file (file-truename file))
8812 (t 'unresolved)))
8814 ;; Check for an entry in the system library
8815 (if (and file
8816 (not syslibp)
8817 (idlwave-syslib-p file))
8818 (setq syslibp t))
8820 ;; If there's more than one matching entry for the same file, just
8821 ;; append the type-cons to the type list.
8822 (if (setq entry (assoc key alist))
8823 (push type-cons (nth 2 entry))
8824 (push (list key file (list type-cons)) alist)))
8826 (setq alist (nreverse alist))
8828 (when syslibp
8829 ;; File is in system *library* - remove any 'system entry
8830 (setq alist (delq (assq 'system alist) alist)))
8832 ;; If 'system remains and we've scanned the syslib, it's a builtin
8833 ;; (rather than a !DIR/lib/.pro file bundled as source).
8834 (when (and (idlwave-syslib-scanned-p)
8835 (setq entry (assoc 'system alist)))
8836 (setcar entry 'builtin))
8837 (sort alist 'idlwave-routine-twin-compare)))
8839 ;; FIXME: Dynamically scoped vars need to use the `idlwave-' prefix.
8840 ;; (defvar type)
8841 (defmacro idlwave-xor (a b)
8842 `(and (or ,a ,b)
8843 (not (and ,a ,b))))
8845 (defun idlwave-routine-entry-compare (a b)
8846 "Compare two routine info entries for sorting.
8847 This is the general case. It first compares class, names, and type.
8848 If it turns out that A and B are twins (same name, class, and type),
8849 calls another routine which compares twins on the basis of their file
8850 names and path locations."
8851 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8852 (cond
8853 ((not (equal (idlwave-downcase-safe class)
8854 (idlwave-downcase-safe (nth 2 b))))
8855 ;; Class decides
8856 (cond ((null (nth 2 b)) nil)
8857 ((null class) t)
8858 (t (string< (downcase class) (downcase (nth 2 b))))))
8859 ((not (equal (downcase name) (downcase (car b))))
8860 ;; Name decides
8861 (string< (downcase name) (downcase (car b))))
8862 ((not (eq type (nth 1 b)))
8863 ;; Type decides
8864 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8865 (t
8866 ;; A and B are twins - so the decision is more complicated.
8867 ;; Call twin-compare with the proper arguments.
8868 (idlwave-routine-entry-compare-twins a b)))))
8870 (defun idlwave-routine-entry-compare-twins (a b)
8871 "Compare two routine entries, under the assumption that they are twins.
8872 This basically calls `idlwave-routine-twin-compare' with the correct args."
8873 (let* ((idlwave-twin-name (car a))
8874 (type (nth 1 a))
8875 (idlwave-twin-class (nth 2 a)) ; used in idlwave-routine-twin-compare
8876 (asrc (nth 3 a))
8877 (atype (car asrc))
8878 (bsrc (nth 3 b))
8879 (btype (car bsrc))
8880 (afile (idlwave-routine-source-file asrc))
8881 (bfile (idlwave-routine-source-file bsrc)))
8882 (idlwave-routine-twin-compare
8883 (if (stringp afile)
8884 (list (file-truename afile) afile (list atype))
8885 (list atype afile (list atype)))
8886 (if (stringp bfile)
8887 (list (file-truename bfile) bfile (list btype))
8888 (list btype bfile (list btype))))))
8890 ;; Bound in idlwave-study-twins,idlwave-routine-entry-compare-twins.
8891 (defvar idlwave-twin-class)
8892 (defvar idlwave-twin-name)
8894 (defun idlwave-routine-twin-compare (a b)
8895 "Compare two routine twin entries for sorting.
8896 In here, A and B are not normal routine info entries, but special
8897 lists (KEY FILENAME (TYPES...)).
8898 This expects NAME TYPE IDLWAVE-TWIN-CLASS to be bound to the right values."
8899 (let* (;; Dis-assemble entries
8900 (akey (car a)) (bkey (car b))
8901 (afile (nth 1 a)) (bfile (nth 1 b))
8902 (atypes (nth 2 a)) (btypes (nth 2 b))
8903 ;; System routines?
8904 (asysp (memq akey '(builtin system)))
8905 (bsysp (memq bkey '(builtin system)))
8906 ;; Compiled routines?
8907 (acompp (memq 'compiled atypes))
8908 (bcompp (memq 'compiled btypes))
8909 ;; Unresolved?
8910 (aunresp (or (eq akey 'unresolved)
8911 (and acompp (not afile))))
8912 (bunresp (or (eq bkey 'unresolved)
8913 (and bcompp (not bfile))))
8914 ;; Buffer info available?
8915 (abufp (memq 'buffer atypes))
8916 (bbufp (memq 'buffer btypes))
8917 ;; On search path?
8918 (tpath-alist (idlwave-true-path-alist))
8919 (apathp (and (stringp akey)
8920 (assoc (file-name-directory akey) tpath-alist)))
8921 (bpathp (and (stringp bkey)
8922 (assoc (file-name-directory bkey) tpath-alist)))
8923 ;; How early on search path? High number means early since we
8924 ;; measure the tail of the path list
8925 (anpath (length (memq apathp tpath-alist)))
8926 (bnpath (length (memq bpathp tpath-alist)))
8927 ;; Look at file names
8928 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8929 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8930 (fname-re (if idlwave-twin-class
8932 (regexp-quote (downcase idlwave-twin-class))
8933 (regexp-quote (downcase idlwave-twin-name)))
8935 ;; Is file name derived from the routine name?
8936 ;; Method file or class definition file?
8937 (anamep (string-match fname-re aname))
8938 (adefp (and idlwave-twin-class anamep
8939 (string= "define" (match-string 1 aname))))
8940 (bnamep (string-match fname-re bname))
8941 (bdefp (and idlwave-twin-class bnamep
8942 (string= "define" (match-string 1 bname)))))
8944 ;; Now: follow JD's ideas about sorting. Looks really simple now,
8945 ;; doesn't it? The difficult stuff is hidden above...
8946 (cond
8947 ((idlwave-xor asysp bsysp) asysp) ; System entries first
8948 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
8949 ((and idlwave-sort-prefer-buffer-info
8950 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
8951 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
8952 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
8953 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
8954 ((and idlwave-twin-class anamep bnamep ; both file names match ->
8955 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
8956 ((> anpath bnpath) t) ; Who is first on path?
8957 (t nil)))) ; Default
8959 (defun idlwave-routine-source-file (source)
8960 (if (nth 2 source)
8961 (expand-file-name (nth 1 source) (nth 2 source))
8962 (nth 1 source)))
8964 (defun idlwave-downcase-safe (string)
8965 "Donwcase if string, else return unchanged."
8966 (if (stringp string)
8967 (downcase string)
8968 string))
8970 (defun idlwave-count-eq (elt list)
8971 "How often is ELT in LIST?"
8972 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
8974 (defun idlwave-count-memq (elt alist)
8975 "How often is ELT a key in ALIST?"
8976 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
8978 (defun idlwave-syslib-p (file)
8979 "Non-nil if FILE is in the system library."
8980 (let* ((true-syslib (file-name-as-directory
8981 (file-truename
8982 (expand-file-name "lib" (idlwave-sys-dir)))))
8983 (true-file (file-truename file)))
8984 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
8986 (defun idlwave-lib-p (file)
8987 "Non-nil if FILE is in the library."
8988 (let ((true-dir (file-name-directory (file-truename file))))
8989 (assoc true-dir (idlwave-true-path-alist))))
8991 (defun idlwave-path-alist-add-flag (list-entry flag)
8992 "Add a flag to the path list entry, if not set."
8993 (let ((flags (cdr list-entry)))
8994 (add-to-list 'flags flag)
8995 (setcdr list-entry flags)))
8997 (defun idlwave-path-alist-remove-flag (list-entry flag)
8998 "Remove a flag to the path list entry, if set."
8999 (let ((flags (delq flag (cdr list-entry))))
9000 (setcdr list-entry flags)))
9002 (defun idlwave-true-path-alist ()
9003 "Return `idlwave-path-alist' alist with true-names.
9004 Info is cached, but relies on the functions setting `idlwave-path-alist'
9005 to reset the variable `idlwave-true-path-alist' to nil."
9006 (or idlwave-true-path-alist
9007 (setq idlwave-true-path-alist
9008 (mapcar (lambda(x) (cons
9009 (file-name-as-directory
9010 (file-truename
9011 (directory-file-name
9012 (car x))))
9013 (cdr x)))
9014 idlwave-path-alist))))
9016 (defun idlwave-syslib-scanned-p ()
9017 "Non-nil if the system lib file !DIR/lib has been scanned."
9018 (let* ((true-syslib (file-name-as-directory
9019 (file-truename
9020 (expand-file-name "lib" (idlwave-sys-dir))))))
9021 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
9023 ;; ----------------------------------------------------------------------------
9024 ;;
9025 ;; Online Help display
9028 ;; ----------------------------------------------------------------------------
9029 ;;
9030 ;; Additions for use with imenu.el and func-menu.el
9031 ;; (pop-up a list of IDL units in the current file).
9032 ;;
9034 (defun idlwave-prev-index-position ()
9035 "Search for the previous procedure or function.
9036 Return nil if not found. For use with imenu.el."
9037 (save-match-data
9038 (cond
9040 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
9041 (t nil))))
9043 (defun idlwave-unit-name ()
9044 "Return the unit name.
9045 Assumes that point is at the beginning of the unit as found by
9046 `idlwave-prev-index-position'."
9047 (forward-sexp 2)
9048 (forward-sexp -1)
9049 (let ((begin (point)))
9050 (re-search-forward
9052 (if (fboundp 'buffer-substring-no-properties)
9053 (buffer-substring-no-properties begin (point))
9054 (buffer-substring begin (point)))))
9056 (defalias 'idlwave-function-menu
9057 (condition-case nil
9058 (progn
9059 (require 'func-menu)
9060 'function-menu)
9061 (error (condition-case nil
9062 (progn
9063 (require 'imenu)
9064 'imenu)
9065 (error nil)))))
9067 ;; Here we hack func-menu.el in order to support this new mode.
9068 ;; The latest versions of func-menu.el already have this stuff in, so
9069 ;; we hack only if it is not already there.
9070 (when (fboundp 'eval-after-load)
9071 (eval-after-load "func-menu"
9072 '(progn
9073 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
9074 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
9075 (setq fume-function-name-regexp-alist
9076 (cons '(idlwave-mode . fume-function-name-regexp-idl)
9077 fume-function-name-regexp-alist)))
9078 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
9079 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
9080 (setq fume-find-function-name-method-alist
9081 (cons '(idlwave-mode . fume-find-next-idl-function-name)
9082 fume-find-function-name-method-alist))))))
9084 (defun idlwave-edit-in-idlde ()
9085 "Edit the current file in IDL Development environment."
9086 (interactive)
9087 (start-process "idldeclient" nil
9088 idlwave-shell-explicit-file-name "-c" "-e"
9089 (buffer-file-name)))
9091 (defvar idlwave-help-use-assistant)
9092 (defun idlwave-launch-idlhelp ()
9093 "Start the IDLhelp application."
9094 (interactive)
9095 (if idlwave-help-use-assistant
9096 (idlwave-help-assistant-raise)
9097 (start-process "idlhelp" nil idlwave-help-application)))
9099 ;; Menus - using easymenu.el
9100 (defvar idlwave-mode-menu-def
9101 `("IDLWAVE"
9102 ["PRO/FUNC menu" idlwave-function-menu t]
9103 ("Motion"
9104 ["Subprogram Start" idlwave-beginning-of-subprogram t]
9105 ["Subprogram End" idlwave-end-of-subprogram t]
9106 ["Block Start" idlwave-beginning-of-block t]
9107 ["Block End" idlwave-end-of-block t]
9108 ["Up Block" idlwave-backward-up-block t]
9109 ["Down Block" idlwave-down-block t]
9110 ["Skip Block Backward" idlwave-backward-block t]
9111 ["Skip Block Forward" idlwave-forward-block t])
9112 ("Mark"
9113 ["Subprogram" idlwave-mark-subprogram t]
9114 ["Block" idlwave-mark-block t]
9115 ["Header" idlwave-mark-doclib t])
9116 ("Format"
9117 ["Indent Entire Statement" idlwave-indent-statement
9119 ["Indent Subprogram" idlwave-indent-subprogram t]
9120 ["(Un)Comment Region" idlwave-toggle-comment-region t]
9121 ["Continue/Split line" idlwave-split-line t]
9122 "--"
9123 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
9124 :selected (symbol-value idlwave-fill-function)])
9125 ("Templates"
9126 ["Procedure" idlwave-procedure t]
9127 ["Function" idlwave-function t]
9128 ["Doc Header" idlwave-doc-header t]
9129 ["Log" idlwave-doc-modification t]
9130 "--"
9131 ["Case" idlwave-case t]
9132 ["For" idlwave-for t]
9133 ["Repeat" idlwave-repeat t]
9134 ["While" idlwave-while t]
9135 "--"
9136 ["Close Block" idlwave-close-block t])
9137 ("Completion"
9138 ["Complete" idlwave-complete t]
9139 ("Complete Specific"
9140 ["1 Procedure Name" (idlwave-complete 'procedure) t]
9141 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
9142 "--"
9143 ["3 Function Name" (idlwave-complete 'function) t]
9144 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
9145 "--"
9146 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
9147 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
9148 "--"
9149 ["7 Function Method Name" (idlwave-complete 'function-method) t]
9150 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
9151 "--"
9152 ["9 Class Name" idlwave-complete-class t]))
9153 ("Routine Info"
9154 ["Show Routine Info" idlwave-routine-info t]
9155 ["Online Context Help" idlwave-context-help t]
9156 "--"
9157 ["Find Routine Source" idlwave-find-module t]
9158 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
9159 "--"
9160 ["Update Routine Info" idlwave-update-routine-info t]
9161 ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t]
9162 "--"
9163 "IDL User Catalog"
9164 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
9165 ["Scan Directories" (idlwave-update-routine-info '(16))
9166 (and idlwave-path-alist (not idlwave-catalog-process))]
9167 ["Scan Directories &" (idlwave-update-routine-info '(64))
9168 (and idlwave-path-alist (not idlwave-catalog-process))]
9169 "--"
9170 "Routine Shadows"
9171 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
9172 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
9173 ["Check Everything" idlwave-list-all-load-path-shadows t])
9174 ("Misc"
9175 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
9176 "--"
9177 ["Insert TAB character" idlwave-hard-tab t])
9178 "--"
9179 ("External"
9180 ["Start IDL shell" idlwave-shell t]
9181 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
9182 ["Launch IDL Help" idlwave-launch-idlhelp t])
9183 "--"
9184 ("Customize"
9185 ["Browse IDLWAVE Group" idlwave-customize t]
9186 "--"
9187 ["Build Full Customize Menu" idlwave-create-customize-menu
9188 (fboundp 'customize-menu-create)])
9189 ("Documentation"
9190 ["Describe Mode" describe-mode t]
9191 ["Abbreviation List" idlwave-list-abbrevs t]
9192 "--"
9193 ["Commentary in idlwave.el" idlwave-show-commentary t]
9194 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
9195 "--"
9196 ["Info" idlwave-info t]
9197 "--"
9198 ["Help with Topic" idlwave-help-assistant-help-with-topic
9199 idlwave-help-use-assistant]
9200 ["Launch IDL Help" idlwave-launch-idlhelp t])))
9202 (defvar idlwave-mode-debug-menu-def
9203 '("Debug"
9204 ["Start IDL shell" idlwave-shell t]
9205 ["Save and .RUN buffer" idlwave-shell-save-and-run
9206 (and (boundp 'idlwave-shell-automatic-start)
9207 idlwave-shell-automatic-start)]))
9209 (if (or (featurep 'easymenu) (load "easymenu" t))
9210 (progn
9211 (easy-menu-define idlwave-mode-menu idlwave-mode-map
9212 "IDL and WAVE CL editing menu"
9213 idlwave-mode-menu-def)
9214 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
9215 "IDL and WAVE CL editing menu"
9216 idlwave-mode-debug-menu-def)))
9218 (defun idlwave-customize ()
9219 "Call the customize function with `idlwave' as argument."
9220 (interactive)
9221 ;; Try to load the code for the shell, so that we can customize it
9222 ;; as well.
9223 (or (featurep 'idlw-shell)
9224 (load "idlw-shell" t))
9225 (customize-browse 'idlwave))
9227 (defun idlwave-create-customize-menu ()
9228 "Create a full customization menu for IDLWAVE, insert it into the menu."
9229 (interactive)
9230 (if (fboundp 'customize-menu-create)
9231 (progn
9232 ;; Try to load the code for the shell, so that we can customize it
9233 ;; as well.
9234 (or (featurep 'idlw-shell)
9235 (load "idlw-shell" t))
9236 (easy-menu-change
9237 '("IDLWAVE") "Customize"
9238 `(["Browse IDLWAVE group" idlwave-customize t]
9239 "--"
9240 ,(customize-menu-create 'idlwave)
9241 ["Set" Custom-set t]
9242 ["Save" Custom-save t]
9243 ["Reset to Current" Custom-reset-current t]
9244 ["Reset to Saved" Custom-reset-saved t]
9245 ["Reset to Standard Settings" Custom-reset-standard t]))
9247 (error "Cannot expand menu (outdated version of cus-edit.el)")))
9249 (defun idlwave-show-commentary ()
9250 "Use the finder to view the file documentation from `idlwave.el'."
9251 (interactive)
9252 (finder-commentary "idlwave.el"))
9254 (defun idlwave-shell-show-commentary ()
9255 "Use the finder to view the file documentation from `idlw-shell.el'."
9256 (interactive)
9257 (finder-commentary "idlw-shell.el"))
9259 (defun idlwave-info ()
9260 "Read documentation for IDLWAVE in the info system."
9261 (interactive)
9262 (info "idlwave"))
9264 (defun idlwave-list-abbrevs (arg)
9265 "Show the code abbreviations define in IDLWAVE mode.
9266 This lists all abbrevs where the replacement text differs from the input text.
9267 These are the ones the users want to learn to speed up their writing.
9269 The function does *not* list abbrevs which replace a word with itself
9270 to call a hook. These hooks are used to change the case of words or
9271 to blink the matching `begin', and the user does not need to know them.
9273 With arg, list all abbrevs with the corresponding hook.
9275 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
9277 (interactive "P")
9278 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
9279 abbrevs
9280 str rpl func fmt (len-str 0) (len-rpl 0))
9281 (mapatoms
9282 (lambda (sym)
9283 (if (symbol-value sym)
9284 (progn
9285 (setq str (symbol-name sym)
9286 rpl (symbol-value sym)
9287 func (symbol-function sym))
9288 (if arg
9289 (setq func (prin1-to-string func))
9290 (if (and (listp func) (stringp (nth 2 func)))
9291 (setq rpl (concat "EVAL: " (nth 2 func))
9292 func "")
9293 (setq func "")))
9294 (if (or arg (not (string= rpl str)))
9295 (progn
9296 (setq len-str (max len-str (length str)))
9297 (setq len-rpl (max len-rpl (length rpl)))
9298 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
9299 table)
9300 ;; sort the list
9301 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
9302 ;; Make the format
9304 (with-output-to-temp-buffer "*Help*"
9305 (if arg
9306 (progn
9309 (princ (format fmt "KEY" "REPLACE" "HOOK"))
9310 (princ (format fmt "---" "-------" "----")))
9313 (princ (format fmt "KEY" "ACTION" ""))
9314 (princ (format fmt "---" "------" "")))
9315 (dolist (list abbrevs)
9316 (setq str (car list)
9317 rpl (nth 1 list)
9318 func (nth 2 list))
9319 (princ (format fmt str rpl func)))))
9320 ;; Make sure each abbreviation uses only one display line
9321 (with-current-buffer "*Help*"
9322 (setq truncate-lines t)))
9324 ;; Add .pro files to speedbar for support, if it's loaded
9325 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
9327 ;; Set an idle timer to load the routine info.
9328 ;; Will only work on systems which support this.
9329 (or idlwave-routines (idlwave-start-load-rinfo-timer))
9331 ;; Run the hook
9332 (run-hooks 'idlwave-load-hook)
9334 (provide 'idlwave)
9336 ;;; idlwave.el ends here