| blob | b2858f1479df0fbeacd4a3c901a18c828e9bda63 |
1 ;; idlwave.el --- IDL editing mode for GNU Emacs
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4 ;; 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Authors: J.D. Smith <jdsmith@as.arizona.edu>
7 ;; Carsten Dominik <dominik@science.uva.nl>
8 ;; Chris Chase <chase@att.com>
9 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
10 ;; Version: 6.1_em22
11 ;; Keywords: languages
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software: you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation, either version 3 of the License, or
18 ;; (at your option) any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;;; Commentary:
30 ;; IDLWAVE enables feature-rich development and interaction with IDL,
31 ;; the Interactive Data Language. It provides a compelling,
32 ;; full-featured alternative to the IDLDE development environment
33 ;; bundled with IDL.
35 ;; In the remotely distant past, based on pascal.el, though bears
36 ;; little resemblance to it now.
37 ;;
38 ;; Incorporates many ideas, such as abbrevs, action routines, and
39 ;; continuation line indenting, from wave.el.
40 ;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder.
41 ;;
42 ;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode")
43 ;; for features, key bindings, and info.
44 ;; Also, Info format documentation is available with `M-x idlwave-info'
45 ;;
46 ;; New versions of IDLWAVE, documentation, and more information
47 ;; available from:
48 ;; http://idlwave.org
49 ;;
50 ;; INSTALLATION
51 ;; ============
52 ;;
53 ;; Follow the instructions in the INSTALL file of the distribution.
54 ;; In short, put this file on your load path and add the following
55 ;; lines to your .emacs file:
56 ;;
57 ;; (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
58 ;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
59 ;; (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
60 ;;
61 ;;
62 ;; SOURCE
63 ;; ======
64 ;;
65 ;; The newest version of this file is available from the maintainer's
66 ;; Webpage:
67 ;;
68 ;; http://idlwave.org
69 ;;
70 ;; DOCUMENTATION
71 ;; =============
72 ;;
73 ;; IDLWAVE is documented online in info format. A printable version
74 ;; of the documentation is available from the maintainers webpage (see
75 ;; SOURCE).
76 ;;
77 ;;
78 ;; ACKNOWLEDGMENTS
79 ;; ===============
80 ;;
81 ;; Thanks to the following people for their contributions and comments:
82 ;;
83 ;; Ulrik Dickow <dickow_at_nbi.dk>
84 ;; Eric E. Dors <edors_at_lanl.gov>
85 ;; Stein Vidar H. Haugan <s.v.h.haugan_at_astro.uio.no>
86 ;; David Huenemoerder <dph_at_space.mit.edu>
87 ;; Kevin Ivory <Kevin.Ivory_at_linmpi.mpg.de>
88 ;; Dick Jackson <dick_at_d-jackson.com>
89 ;; Xuyong Liu <liu_at_stsci.edu>
90 ;; Simon Marshall <Simon.Marshall_at_esrin.esa.it>
91 ;; Laurent Mugnier <mugnier_at_onera.fr>
92 ;; Lubos Pochman <lubos_at_rsinc.com>
93 ;; Bob Portmann <portmann_at_al.noaa.gov>
94 ;; Patrick M. Ryan <pat_at_jaameri.gsfc.nasa.gov>
95 ;; Marty Ryba <ryba_at_ll.mit.edu>
96 ;; Paul Sorenson <aardvark62_at_msn.com>
97 ;; Phil Sterne <sterne_at_dublin.llnl.gov>
98 ;; Phil Williams <williams_at_irc.chmcc.org>
99 ;;
100 ;; CUSTOMIZATION:
101 ;; =============
102 ;;
103 ;; IDLWAVE has extensive customize support; to learn about the
104 ;; variables which control the mode's behavior, use `M-x
105 ;; idlwave-customize'.
106 ;;
107 ;; You can set your own preferred values with Customize, or with Lisp
108 ;; code in .emacs. For an example of what to put into .emacs, check
109 ;; the TexInfo documentation or see a complete .emacs available at the
110 ;; website.
111 ;;
112 ;; KNOWN PROBLEMS:
113 ;; ==============
114 ;;
115 ;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual
116 ;; Numerics, Inc. is growing less and less complete as the two
117 ;; languages grow increasingly apart. The mode probably shouldn't
118 ;; even have "WAVE" in its title, but it's catchy, and was required
119 ;; to avoid conflict with the CORBA idl.el mode. Caveat WAVEor.
120 ;;
121 ;; Moving the point backwards in conjunction with abbrev expansion
122 ;; does not work as I would like it, but this is a problem with
123 ;; emacs abbrev expansion done by the self-insert-command. It ends
124 ;; up inserting the character that expanded the abbrev after moving
125 ;; point backward, e.g., "\cl" expanded with a space becomes
126 ;; "LONG( )" with point before the close paren. This is solved by
127 ;; using a temporary function in `post-command-hook' - not pretty,
128 ;; but it works.
129 ;;
130 ;; Tabs and spaces are treated equally as whitespace when filling a
131 ;; comment paragraph. To accomplish this, tabs are permanently
132 ;; replaced by spaces in the text surrounding the paragraph, which
133 ;; may be an undesirable side-effect. Replacing tabs with spaces is
134 ;; limited to comments only and occurs only when a comment
135 ;; paragraph is filled via `idlwave-fill-paragraph'.
136 ;;
137 ;; Muti-statement lines (using "&") on block begin and end lines can
138 ;; ruin the formatting. For example, multiple end statements on a
139 ;; line: endif & endif. Using "&" outside of block begin/end lines
140 ;; should be okay.
141 ;;
142 ;; Determining the expression at point for printing and other
143 ;; examination commands is somewhat rough: currently only fairly
144 ;; simple entities are found. You can always drag-select or examine
145 ;; a pre-selected region.
146 ;;
147 ;; When forcing completion of method keywords, the initial
148 ;; query for a method has multiple entries for some methods. Would
149 ;; be too difficult to fix this hardly used case.
150 ;;
151 \f
152 ;;; Code:
158 ;; For XEmacs
180 "Major mode for editing IDL .pro files."
192 ;;; Variables for indentation behavior ---------------------------------------
195 "Indentation and formatting options for IDLWAVE mode."
199 "*Extra indentation for the main block of code.
200 That is the block between the FUNCTION/PRO statement and the END
201 statement for that program unit."
206 "*Extra indentation applied to block lines.
207 If you change this, you probably also want to change `idlwave-end-offset'."
212 "*Extra indentation applied to block END lines.
213 A value equal to negative `idlwave-block-indent' will make END lines
214 line up with the block BEGIN lines."
219 "*Extra indentation applied to continuation lines.
220 This extra offset applies to the first of a set of continuation lines.
221 The following lines receive the same indentation as the first."
226 "*Maximum additional indentation for special continuation indent.
227 Several special indentations are tried to help line up continuation
228 lines in routine calls or definitions, other statements with
229 parentheses, or assignment statements. This variable specifies a
230 maximum amount by which this special indentation can exceed the
231 standard continuation indentation, otherwise defaulting to a fixed
232 offset. Set to 0 to effectively disable all special continuation
233 indentation, or to a large number (like 100) to enable it in all
234 cases. See also `idlwave-indent-to-open-paren', which can override
235 this variable."
240 "*Non-nil means, indent continuation lines to innermost open parenthesis.
241 This indentation occurs even if otherwise disallowed by
242 `idlwave-max-extra-continuation-indent'. Matching parens and the
243 interleaving args are lined up. Example:
245 x = function_a(function_b(function_c( a, b, [1,2,3, $
246 4,5,6 $
247 ], $
248 c, d $
249 )))
251 When this variable is nil, paren alignment may still occur, based on
252 the value of `idlwave-max-extra-continuation-indent', which, if zero,
253 would yield:
255 x = function_a(function_b(function_c( a, b, [1,2,3, $
256 4,5,6 $
257 ], $
258 c, d $
259 )))"
264 "*Non-nil means, indent continuation lines with parens by nesting
265 lines at consecutively deeper levels."
271 "*If set non-nil then comment paragraphs are indented under the
272 hanging indent given by `idlwave-hang-indent-regexp' match in the first line
273 of the paragraph."
278 "*Regular expression matching the position of the hanging indent
279 in the first line of a comment paragraph. The size of the indent
280 extends to the end of the match for the regular expression."
285 "*If non-nil then use last match on line for `idlwave-indent-regexp'."
290 "*If non-nil then auto fill will only operate on comment lines."
295 "*If non-nil then auto fill will split strings with the IDL `+' operator.
296 When the line end falls within a string, string concatenation with the
297 '+' operator will be used to distribute a long string over lines.
298 If nil and a string is split then a terminal beep and warning are issued.
300 This variable is ignored when `idlwave-fill-comment-line-only' is
301 non-nil, since in this case code is not auto-filled."
306 "*If non-nil then `idlwave-split-line' will split strings with `+'.
307 When the splitting point of a line falls inside a string, split the string
308 using the `+' string concatenation operator. If nil and a string is
309 split then a terminal beep and warning are issued."
314 "*The indentation of a comment that starts with this regular
315 expression will not be changed. Note that the indentation of a comment
316 at the beginning of a line is never changed."
321 "*A comment anchored at the beginning of line.
322 A comment matching this regular expression will not have its
331 "*A comment that starts with this regular expression on a line by
332 itself is indented as if it is a part of IDL code. As a result if
333 the comment is not preceded by whitespace it is unchanged."
337 ;; Comments not matching any of the above will be indented as a
338 ;; right-margin comment, i.e., to a minimum of `comment-column'.
340 ;;; Routine Info and Completion ---------------------------------------
343 "Routine Info options for IDLWAVE mode."
347 "*Non-nil means search the IDL path for library catalog files.
349 These files, named .idlwave_catalog, document routine information for
350 individual directories and libraries of IDL .pro files. Many popular
351 libraries come with catalog files by default, so leaving this on is
352 usually a good idea."
357 "*Seconds of idle time before routine info is automatically initialized.
358 Initializing the routine info can take a long time, in particular if a
359 large number of library catalogs are involved. When Emacs is idle for
360 more than the number of seconds specified by this variable, it starts
361 the initialization. The process is split into five steps, in order to
362 keep work interruption as short as possible. If one of the steps
363 finishes, and no user input has arrived in the mean time, initialization
364 proceeds immediately to the next step. A good value for this variable
365 is about 1/3 of the time initialization take in your setup. So if you
366 have a fast machine and no problems with a slow network connection,
367 don't hesitate to set this to 2 seconds. A value of 0 means, don't
368 initialize automatically, but instead wait until routine information is
369 needed, and initialize then."
374 "*Non-nil means, scan buffers for IDL programs when updating info.
375 The scanning is done by the command `idlwave-update-routine-info'.
376 The following values are allowed:
378 nil Don't scan any buffers.
379 t Scan all `idlwave-mode' buffers in the current editing session.
380 current Scan only the current buffer, but no other buffers."
388 "*Non-nil means query the shell for info about compiled routines.
389 Querying the shell is useful to get information about compiled modules,
390 and it is turned on by default. However, when you have a complete library
391 scan, this is not necessary."
397 "*Controls under what circumstances routine info is updated automatically.
398 Possible values:
399 nil Never
400 t All available
401 \(...) A list of circumstances. Allowed members are:
402 find-file Add info for new IDLWAVE buffers.
403 save-buffer Update buffer info when buffer is saved
404 kill-buffer Remove buffer info when buffer gets killed
405 compile-buffer Update shell info after `idlwave-shell-save-and...'"
417 "*Maximum number of source files displayed in the Routine Info window.
418 When an integer, it is the maximum number of source files displayed.
419 A value of t means to show all source files."
424 "Library path for Windows and MacOS (OS9). Not needed under UNIX.
425 When selecting the directories to scan for IDL user catalog routine
426 info, IDLWAVE can, under UNIX, query the shell for the exact search
427 path \(the value of !PATH). However, under Windows and MacOS
428 \(pre-OSX), the IDLWAVE shell does not work. In this case, this
429 variable can be set to specify the paths where IDLWAVE can find PRO
430 files. The shell will only be asked for a list of paths when this
431 variable is nil. The value is a list of directories. A directory
432 preceeded by a `+' will be searched recursively. If you set this
433 variable on a UNIX system, the shell will not be queried. See also
434 `idlwave-system-directory'."
439 "The IDL system directory for Windows and MacOS. Not needed under
440 UNIX. Set this to the value of the `!DIR' system variable in IDL.
441 IDLWAVE uses this to find out which of the library routines belong to
442 the official system library. All files inside the `lib' subdirectory
443 are considered system library files - so don't install private stuff
444 in this directory. On UNIX systems, IDLWAVE queries the shell for the
445 value of `!DIR'. See also `idlwave-library-path'."
449 ;; Configuration files
452 "*Directory for configuration files and user-library catalog."
464 "Alist of regular expressions matching special library directories.
465 When listing routine source locations, IDLWAVE gives a short hint where
466 the file defining the routine is located. By default it lists `SystemLib'
467 for routines in the system library `!DIR/lib' and `Library' for anything
468 else. This variable can define additional types. The car of each entry
469 is a regular expression matching the file name (they normally will match
470 on the path). The cdr is the string to be used as identifier. Max 10
471 chars are allowed."
477 "Write out path (!PATH) and system directory (!DIR) info automatically.
478 Path info is needed to locate library catalog files. If non-nil,
479 whenever the path-list changes as a result of shell-query, etc., it is
481 used to force a write."
486 "Completion options for IDLWAVE mode."
503 "Association list setting the case of completed words.
505 This variable determines the case (UPPER/lower/Capitalized...) of
506 words inserted into the buffer by completion. The preferred case can
507 be specified separately for routine names, keywords, classes and
508 methods.
509 This alist should therefore have entries for `routine' (normal
510 functions and procedures, i.e. non-methods), `keyword', `class', and
511 `method'. Plausible values are
513 upcase upcase whole word, like `BOX_CURSOR'
514 downcase downcase whole word, like `read_ppm'
515 capitalize capitalize each part, like `Widget_Control'
516 preserve preserve case as is, like `IDLgrView'
518 The value can also be any Emacs Lisp function which transforms the
519 case of characters in a string.
521 A value of `preserve' means that the case of the completed word is
522 identical to the way it was written in the definition statement of the
523 routine. This was implemented to allow for mixed-case completion, in
524 particular of object classes and methods.
525 If a completable word is defined in multiple locations, the meaning of
526 `preserve' is not unique since the different definitions might be
527 cased differently. Therefore IDLWAVE always takes the case of the
528 *first* definition it encounters during routine info collection and
529 uses the case derived from it consistently.
531 Note that a lowercase-only string in the buffer will always be completed in
532 lower case (but see the variable `idlwave-completion-force-default-case').
534 After changing this variable, you need to either restart Emacs or press
535 `C-u C-c C-i' to update the internal lists."
542 "*Non-nil means, completion will always honor `idlwave-completion-case'.
543 When nil, only the completion of a mixed case or upper case string
544 will honor the default settings in `idlwave-completion-case', while
545 the completion of lower case strings will be completed entirely in
546 lower case."
551 "*Non-nil means, the empty string is considered downcase for completion.
552 The case of what is already in the buffer determines the case of completions.
553 When this variable is non-nil, the empty string is considered to be downcase.
554 Completing on the empty string then offers downcase versions of the possible
555 completions."
560 "Obsolete variable. See `idlwave-complete-empty-string-as-lower-case' and
564 "*Non-nil means, the case of tokens in buffers dominates over system stuff.
565 To make this possible, we need to re-case everything each time we update
566 the routine info from the buffers. This is slow.
567 The default is to consider the case given in the system and library files
568 first which makes updating much faster."
573 "*Non-nil means, highlight completions for which system help is available.
574 Help can then be accessed with mouse-3.
575 This option is only effective when the online help system is installed."
580 "Non-nil means, treat inheritance with completion, online help etc.
581 When nil, IDLWAVE only knows about the native methods and tags of a class,
582 not about inherited ones."
587 "List of regular expressions for class-driven keyword inheritance.
589 up the class tree. While it cannot be assumed that the presence of an
590 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
591 certain methods this assumption is almost always true. The methods
592 for which to assume this can be set here."
598 "*Number of classes to show when completing object methods and keywords.
599 When completing methods or keywords for an object with unknown class,
600 the *Completions* buffer will show the valid classes for each completion
601 like this:
603 MyMethod <Class1,Class2,Class3>
605 The value of this variable may be nil to inhibit display, or an integer to
606 indicate the maximum number of classes to display.
608 On XEmacs, a full list of classes will also be placed into a `help-echo'
609 property on the competion items, so that the list of classes for the current
610 item is displayed in the echo area. If the value of this variable is a
611 negative integer, the `help-echo' property will be suppressed."
617 "*Non-nil means, fontify the classes in completions buffer.
618 This makes it easier to distinguish the completion items from the extra
619 class info listed. See `idlwave-completion-show-classes'."
625 "Association list governing specification of object classes for completion.
627 When IDLWAVE tries to complete object-oriented methods, it usually
628 cannot determine the class of a given object from context. In order
629 to provide the user with a correct list of methods or keywords, it
630 needs to determine the appropriate class. IDLWAVE has two ways of
631 doing this (well, three ways if you count the shell... see
632 `idlwave-shell-query-for-class'):
634 1. Combine the items of all available classes which contain this
635 method for the purpose of completion. So when completing a method,
636 all methods of all known classes are available, and when completing
637 a keyword, all keywords allowed for this method in any class are
638 shown. This behavior is very much like normal completion and is
639 therefore the default. It works much better than one might think -
640 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
641 become uncomfortably long. See also
642 `idlwave-completion-show-classes'.
644 2. The second possibility is to ask the user on each occasion. To
645 make this less interruptive, IDLWAVE can store the class as a text
646 property on the object operator `->'. For a given object in the
647 source code, class selection will then be needed only once
648 - for example to complete the method. Keywords to the method can
649 then be completed directly, because the class is already known.
650 You will have to turn on the storage of the selected class
651 explicitly with the variable `idlwave-store-inquired-class'.
653 This variable allows you to configure IDLWAVE's method and
654 method-keyword completion behavior. Its value is an alist, which
655 should contain at least two elements: (method-default . VALUE) and
656 \(keyword-default . VALUE), where VALUE is either t or nil. These
657 specify if the class should be found during method and keyword
658 completion, respectively.
660 The alist may have additional entries specifying exceptions from the
661 keyword completion rule for specific methods, like INIT or
662 GETPROPERTY. In order to turn on class specification for the INIT
672 :inline t
677 "*Non-nil means, store class of a method call as text property on `->'.
678 IDLWAVE sometimes has to ask the user for the class associated with a
679 particular object method call. This happens during the commands
680 `idlwave-routine-info' and `idlwave-complete', depending upon the
681 value of the variable `idlwave-query-class'.
683 When you specify a class, this information can be stored as a text
684 property on the `->' arrow in the source code, so that during the same
685 editing session, IDLWAVE will not have to ask again. When this
686 variable is non-nil, IDLWAVE will store and reuse the class information.
688 on the arrow.
690 The default of this variable is nil, since the result of commands then
691 is more predictable. However, if you know what you are doing, it can
692 be nice to turn this on.
694 An arrow which knows the class will be highlighted with
696 displays (with prefix arg: deletes) the class stored on the arrow
697 at point."
702 "*Face to highlight object operator arrows `->' which carry a class property.
703 When IDLWAVE stores a class name as text property on an object arrow
704 \(see variable `idlwave-store-inquired-class', it highlights the arrow
705 with this font in order to remind the user that this arrow is special."
710 "*Non-nil means, resize the Routine-info *Help* window to fit the content."
715 "*Non-nil means, completion automatically adds `=' after completed keywords."
720 "*Non-nil means, completion automatically adds `(' after completed function.
721 nil means, don't add anything.
722 A value of `2' means, also add the closing parenthesis and position cursor
723 between the two."
730 "*Non-nil means, try to restore the window configuration after completion.
731 When completion is not unique, Emacs displays a list of completions.
732 This messes up your window configuration. With this variable set, IDLWAVE
733 restores the old configuration after successful completion."
737 ;;; Variables for abbrev and action behavior -----------------------------
740 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
741 The variables in this group govern this."
745 "*Non-nil means performs actions when indenting.
746 The actions that can be performed are listed in `idlwave-indent-action-table'."
751 "*A single character string used to start abbreviations in abbrev mode.
752 Possible characters to chose from: ~`\%
753 or even '?'. '.' is not a good choice because it can make structure
754 field names act like abbrevs in certain circumstances.
756 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
757 must set it directly using `setq' in the .emacs file before idlwave.el
758 is loaded."
763 "*Non-nil means, enable `idlwave-surround'.
764 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
765 `idlwave-surround'.
766 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
768 Also see the default key bindings for keys using `idlwave-surround'.
769 Keys are bound and made into actions calling `idlwave-surround' with
770 `idlwave-action-and-binding'.
771 See help for `idlwave-action-and-binding' for examples.
773 Also see help for `idlwave-surround'."
778 "*Non-nil means pad '=' in keywords (routine calls or defs) like assignment.
779 Whenever `idlwave-surround' is non-nil then this affects how '=' is
780 padded for keywords and for variables. If t, pad the same as for
781 assignments. If nil then spaces are removed. With any other value,
782 spaces are left unchanged."
790 "*Non-nil means point blinks to block beginning for `idlwave-show-begin'."
795 "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
800 "*Non-nil means re-indent line after END was typed."
805 "*Non-nil means the abbrev hook can move point.
806 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
807 definitions, use the command `list-abbrevs', for abbrevs that move
808 point. Moving point is useful, for example, to place point between
809 parentheses of expanded functions.
811 See `idlwave-check-abbrev'."
816 "*Non-nil means all abbrevs will be forced to either upper or lower case.
817 If the value t, all expanded abbrevs will be upper case.
818 If the value is 'down then abbrevs will be forced to lower case.
819 If nil, the case will not change.
820 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
821 upper case, regardless of this variable."
826 "*Non-nil means, reserved words will be made upper case via abbrev expansion.
827 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
828 Has effect only if in abbrev-mode."
832 ;;; Action/Expand Tables.
833 ;;
834 ;; The average user may have difficulty modifying this directly. It
835 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
836 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
837 ;; examples of how to add an action.
838 ;;
839 ;; The action table is used by `idlwave-indent-line' whereas both the
840 ;; action and expand tables are used by `idlwave-indent-and-action'. In
841 ;; general, the expand table is only used when a line is explicitly
842 ;; indented. Whereas, in addition to being used when the expand table
843 ;; is used, the action table is used when a line is indirectly
844 ;; indented via line splitting, auto-filling or a new line creation.
845 ;;
846 ;; Example actions:
847 ;;
848 ;; Capitalize system vars
849 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
850 ;;
851 ;; Capitalize procedure name
852 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
853 ;; '(capitalize-word 1) t)
854 ;;
855 ;; Capitalize common block name
856 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
857 ;; '(capitalize-word 1) t)
858 ;; Capitalize label
859 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
860 ;; '(capitalize-word -1) t)
863 "*Associated array containing action lists of search string (car),
864 and function as a cdr. This table is used by `idlwave-indent-line'.
865 See documentation for `idlwave-do-action' for a complete description of
866 the action lists.
868 Additions to the table are made with `idlwave-action-and-binding' when a
869 binding is not requested.
873 "*Associated array containing action lists of search string (car),
874 and function as a cdr. The table is used by the
875 `idlwave-indent-and-action' function. See documentation for
876 `idlwave-do-action' for a complete description of the action lists.
878 Additions to the table are made with `idlwave-action-and-binding' when a
879 binding is requested.
882 ;;; Documentation header and history keyword ---------------------------------
885 "Options for documenting IDLWAVE files."
888 ;; FIXME: make defcustom?
891 ";+
892 ; NAME:
893 ;
894 ;
895 ;
896 ; PURPOSE:
897 ;
898 ;
899 ;
900 ; CATEGORY:
901 ;
902 ;
903 ;
904 ; CALLING SEQUENCE:
905 ;
906 ;
907 ;
908 ; INPUTS:
909 ;
910 ;
911 ;
912 ; OPTIONAL INPUTS:
913 ;
914 ;
915 ;
916 ; KEYWORD PARAMETERS:
917 ;
918 ;
919 ;
920 ; OUTPUTS:
921 ;
922 ;
923 ;
924 ; OPTIONAL OUTPUTS:
925 ;
926 ;
927 ;
928 ; COMMON BLOCKS:
929 ;
930 ;
931 ;
932 ; SIDE EFFECTS:
933 ;
934 ;
935 ;
936 ; RESTRICTIONS:
937 ;
938 ;
939 ;
940 ; PROCEDURE:
941 ;
942 ;
943 ;
944 ; EXAMPLE:
945 ;
946 ;
947 ;
948 ; MODIFICATION HISTORY:
949 ;
950 ;-
952 "*A list (PATHNAME STRING) specifying the doc-header template to use for
953 summarizing a file. If PATHNAME is non-nil then this file will be included.
954 Otherwise STRING is used. If nil, the file summary will be omitted.
955 For example you might set PATHNAME to the path for the
959 "*Non-nil means, the documentation header will always be at start of file.
960 When nil, the header is positioned between the PRO/FUNCTION line of
961 the current routine and the code, allowing several routine headers in
962 a file."
967 "*The hook function used to update the timestamp of a function."
972 "*The modifications keyword to use with the log documentation commands.
973 A ':' is added to the keyword end.
974 Inserted by doc-header and used to position logs by doc-modification.
975 If nil it will not be inserted."
980 "*Regexp matching the start of a document library header."
985 "*Regexp matching the end of a document library header."
989 ;;; External Programs -------------------------------------------------------
992 "Path locations of external commands used by IDLWAVE."
996 "*If non-nil, this is the command to run IDL.
997 Should be an absolute file path or path relative to the current environment
998 execution search path. If you want to specify command line switches
999 for the IDL program, use `idlwave-shell-command-line-options'.
1001 I know the name of this variable is badly chosen, but I cannot change
1002 it without compromising backwards-compatibility."
1007 "*A list of command line options for calling the IDL program.
1008 Since IDL is executed directly without going through a shell like /bin/sh,
1010 string for each argument. But you may also give a single string which
1011 contains the options whitespace-separated. Emacs will be kind enough to
1012 split it for you."
1014 string
1019 "*The external application providing reference help for programming.
1020 Obsolete, if the IDL Assistant is being used for help."
1024 ;;; Some Shell variables which must be defined here.-----------------------
1027 "List of modifiers to be used for the debugging commands.
1028 Will be used to bind debugging commands in the shell buffer and in all
1029 source buffers. These are additional convenience bindings, the debugging
1030 commands are always available with the `C-c C-d' prefix.
1031 If you set this to '(control shift), this means setting a breakpoint will
1032 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1033 are `control', `meta', `super', `hyper', `alt', and `shift'."
1044 "*If non-nil attempt invoke `idlwave-shell' if not already running.
1045 This is checked when an attempt to send a command to an
1046 IDL process is made."
1050 ;;; Miscellaneous variables -------------------------------------------------
1053 "Miscellaneous options for IDLWAVE mode."
1058 "*Non-nil displays a startup message when `idlwave-mode' is first called."
1064 common-blocks class-arrows)
1065 "Items which should be fontified on the default fontification level 2.
1066 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1067 is everything and level 2 is specified by this list.
1068 This variable must be set before IDLWAVE gets loaded.
1069 It is a list of symbols; the following symbols are allowed:
1071 pros-and-functions Procedure and Function definitions
1072 batch-files Batch Files
1073 idlwave-idl-keywords IDL Keywords
1074 label Statement Labels
1075 goto Goto Statements
1076 common-blocks Common Blocks
1077 keyword-parameters Keyword Parameters in routine definitions and calls
1078 system-variables System Variables
1079 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1080 class-arrows Object Arrows with class property"
1098 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1103 "Normal hook. Executed when idlwave.el is loaded."
1108 "Non-nil means turn on a few experimental features.
1109 This variable is only for the maintainer, to test difficult stuff,
1110 while still distributing stable releases.
1113 ;;;
1114 ;;; End customization variables section
1115 ;;;
1117 ;;; Non customization variables
1119 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1120 ;;; Simon Marshall <simon_at_gnu.ai.mit.edu>
1121 ;;; and Carsten Dominik...
1123 ;; The following are the reserved words in IDL. Maybe we should
1124 ;; highlight some more stuff as well?
1125 ;; Procedure declarations. Fontify keyword plus procedure name.
1127 ;; To update this regexp, update the list of keywords and
1128 ;; evaluate the form.
1129 ;; (insert
1130 ;; (prin1-to-string
1131 ;; (concat
1132 ;; "\\<\\("
1133 ;; (regexp-opt
1134 ;; '("||" "&&" "and" "or" "xor" "not"
1135 ;; "eq" "ge" "gt" "le" "lt" "ne"
1136 ;; "for" "do" "endfor"
1137 ;; "if" "then" "endif" "else" "endelse"
1138 ;; "case" "of" "endcase"
1139 ;; "switch" "break" "continue" "endswitch"
1140 ;; "begin" "end"
1141 ;; "repeat" "until" "endrep"
1142 ;; "while" "endwhile"
1143 ;; "goto" "return"
1144 ;; "inherits" "mod"
1145 ;; "compile_opt" "forward_function"
1146 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1147 ;; "\\)\\>")))
1148 "\\<\\(&&\\|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\\|||\\)\\>")
1152 ;; Function declarations. Fontify keyword plus function name.
1158 ;; Common blocks
1164 ;; Start with point after block name and comma
1166 nil
1168 )))
1170 ;; Batch files
1174 ;; FIXME warning.
1178 ;; Labels
1182 ;; The goto statement and its label
1188 ;; Tags in structure definitions. Note that this definition
1189 ;; actually collides with labels, so we have to use the same
1190 ;; face. It also matches named subscript ranges,
1191 ;; e.g. vec{bottom:top]. No good way around this.
1195 ;; Structure names
1200 ;; Keyword parameters, like /xlog or ,xrange=[]
1201 ;; This is anchored to the comma preceeding the keyword.
1202 ;; Treats continuation lines, works only during whole buffer
1203 ;; fontification. Slow, use it only in fancy fontification.
1205 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\([ \t]*\\(;.*\\)?\n\\)*[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1208 ;; System variables start with a bang.
1213 ;; Special and unusual operators (not used because too noisy)
1214 ;; (special-operators
1215 ;; '("[<>#]" (0 font-lock-keyword-face)))
1217 ;; All operators (not used because too noisy)
1218 ;; (all-operators
1219 ;; '("[-*^#+<>/]" (0 font-lock-keyword-face)))
1221 ;; Arrows with text property `idlwave-class'
1235 batch-files
1236 idlwave-idl-keywords
1237 label goto
1238 structtag
1239 structname
1240 common-blocks
1241 keyword-parameters
1242 system-variables
1243 class-arrows)
1247 ;; Match an object arrow with class property
1257 idlwave-font-lock-keywords-1
1258 idlwave-font-lock-keywords-2
1259 idlwave-font-lock-keywords-3)
1260 nil t
1262 beginning-of-line))
1268 "Regexp to match the start of a full-line comment.
1269 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1274 "Regular expression to find the beginning of a block.
1278 "Regular expression to find the beginning of a unit.
1282 "Regular expression to find the line that indicates the end of unit.
1283 This line is the end of buffer or the start of another unit.
1291 "Regular expression to find the end of a block.
1304 "Matches between statements and the corresponding END variant.
1305 The cars are the reserved words starting a block. If the block really
1306 begins with BEGIN, the cars are the reserved words before the begin
1307 which can be used to identify the block type.
1308 This is used to check for the correct END type, to close blocks and
1313 "Regular expression matching reserved words which can stand before
1314 blocks starting with a BEGIN statement. The matches must have associations
1331 ))
1335 ;; "endif else" is the only possible "end" that can be
1336 ;; followed by a statement on the same line.
1338 ;; all other "end"s can not be followed by a statement.
1351 idlwave-identifier
1355 idlwave-identifier
1360 "Associated list of statement matching regular expressions.
1361 Each regular expression matches the start of an IDL statement.
1362 The first element of each association is a symbol giving the statement
1363 type. The associated value is a list. The first element of this list
1364 is a regular expression matching the start of an IDL statement for
1365 identifying the statement type. The second element of this list is a
1366 regular expression for finding a substatement for the type. The
1367 substatement starts after the end of the found match modulo
1368 whitespace. If it is nil then the statement has no substatement. The
1369 list order matters since matching an assignment statement exactly is
1370 not possible without parsing. Thus assignment statement become just
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.
1940 ;; ChangeLog
1944 ;; Set tag table list to use IDLTAGS as file name.
1948 ;; Font-lock additions
1949 ;; Following line is for Emacs - XEmacs uses the corresponding property
1950 ;; on the `idlwave-mode' symbol.
1957 ;; Imenu setup
1965 ;; HideShow setup
1968 idlwave-begin-block-reg
1969 idlwave-end-block-reg
1970 ";"
1973 ;; Make a local post-command-hook and add our hook to it
1974 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1975 ;; (make-local-hook 'post-command-hook)
1978 ;; Make local hooks for buffer updates
1979 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1980 ;; (make-local-hook 'kill-buffer-hook)
1982 ;; (make-local-hook 'after-save-hook)
1986 ;; Setup directories and file, if necessary
1989 ;; Update the routine info with info about current buffer?
1992 ;; Check help location
1995 ;; Run the mode hook
2005 idlwave-user-catalog-file
2006 idlwave-config-directory)
2007 idlwave-xml-system-rinfo-converted-file
2009 idlwave-xml-system-rinfo-converted-file
2010 idlwave-config-directory)
2012 idlwave-path-file
2013 idlwave-config-directory))
2018 "Fontify continuation lines correctly."
2029 ;;
2030 ;; Code Formatting ----------------------------------------------------
2031 ;;
2034 "Insert TAB in buffer in current position."
2038 ;;; This stuff is experimental
2041 "If non-nil, a list that can be evaluated using `eval'.
2042 It is evaluated in the lisp function `idlwave-command-hook' which is
2046 "Command run after every command.
2047 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
2048 sets the variable to zero afterwards."
2056 ;;; End experiment
2058 ;; It would be better to use expand.el for better abbrev handling and
2059 ;; versatility.
2062 "Reverse abbrev expansion if in comment or string.
2063 Argument ARG is the number of characters to move point
2064 backward if `idlwave-abbrev-move' is non-nil.
2065 If optional argument RESERVED is non-nil then the expansion
2066 consists of reserved words, which will be capitalized if
2067 `idlwave-reserved-word-upcase' is non-nil.
2068 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2069 is non-nil, unless its value is \`down in which case the abbrev will be
2070 made into all lowercase.
2071 Returns non-nil if abbrev is left expanded."
2074 nil)
2086 t))
2089 "Return t if point is inside a comment, nil otherwise."
2095 "Move to start of comment delimiter on current line.
2096 Moves to end of line if there is no comment delimiter.
2097 Ignores comment delimiters in strings.
2098 Returns point if comment found and nil otherwise."
2101 found)
2102 ;; Look for first comment delimiter not in a string
2114 "Should we operate on an active region?"
2120 "Insert quote and show matching quote if this is end of a string."
2131 ;; Not the end of a string
2135 "Ensure that the previous word was a token before `idlwave-show-begin'.
2136 An END token must be preceded by whitespace."
2146 "Find the start of current block and blinks to it for a second.
2147 Also checks if the correct END statement has been used."
2148 ;; All end statements are reserved words
2149 ;; Re-indent end line
2150 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2151 ;;(backward-char 1)
2155 begin-pos end-pos end end1 )
2159 idlwave-show-block)
2161 ;; Move inside current block
2174 end-pos))
2182 ;; A generic end
2193 end1 end)
2195 ;;(delete-char 1))
2209 ;; seems to be a case thing
2213 idlwave-block-matches))
2215 ;; Just a normal block
2220 "Terminate the current block with the correct END statement."
2222 ;; Start new line if we are not in a new line
2233 "Surround &, leaving room for && (which surround as well)."
2243 "Surround > and < by blanks, leaving room for >= and <=, and considering ->."
2249 ;; Key binding: pad only on left, to save for possible >=/<=
2253 "Surround the LENGTH characters before point with blanks.
2254 LENGTH defaults to 1.
2255 Optional arguments BEFORE and AFTER affect the behavior before and
2256 after the characters (see also description of `idlwave-make-space'):
2258 nil do nothing
2259 0 force no spaces
2260 integer > 0 force exactly n spaces
2261 integer < 0 at least |n| spaces
2263 The function does nothing if any of the following conditions is true:
2264 - `idlwave-surround-by-blank' is nil
2265 - the character before point is inside a string or comment"
2273 ;; avoid clobbering indent
2283 ;; Check to see if the line should auto wrap
2289 "Make space at point.
2290 The space affected is all the spaces and tabs around point.
2291 If n is non-nil then point is left abs(n) spaces from the beginning of
2292 the contiguous space.
2293 The amount of space at point is determined by N.
2294 If the value of N is:
2295 nil - do nothing.
2296 > 0 - exactly N spaces.
2297 < 0 - a minimum of -N spaces, i.e., do not change if there are
2298 already -N spaces.
2299 0 - no spaces (i.e. remove any existing space)."
2313 ;; n = 0, done
2314 ))))
2317 "Insert a newline and indent the current and previous line."
2319 ;;
2320 ;; Handle unterminated single and double quotes
2321 ;; If not in a comment and in a string then insertion of a newline
2322 ;; will mean unbalanced quotes.
2323 ;;
2328 ;;
2329 ;; The current line is being split, the cursor should be at the
2330 ;; beginning of the new line skipping the leading indentation.
2331 ;;
2332 ;; The reason we insert the new line before indenting is that the
2333 ;; indenting could be confused by keywords (e.g. END) on the line
2334 ;; after the split point. This prevents us from just using
2335 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2336 ;;
2342 ;;
2343 ;; Use global variable 'comment-column' to set parallel comment
2344 ;;
2345 ;; Modeled on lisp.el
2346 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2348 "Compute indent for the beginning of the IDL comment delimiter."
2354 ;; On line by itself, indent as code
2357 ;; after code - do not change
2361 comment-column))))
2364 "Continue line by breaking line at point and indent the lines.
2365 For a code line insert continuation marker. If the line is a line comment
2366 then the new line will contain a comment with the same indentation.
2367 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2368 non-nil."
2370 ;; Expand abbreviation, just like normal RET would.
2374 ;; For code line add continuation.
2375 ;; Check if splitting a string.
2379 ;; Split the string.
2381 idlwave-continuation-char beg)
2385 ;; Do not split the string.
2389 ;; Not splitting a string.
2395 ;; Indent previous line
2400 ;; Reindent new line
2404 "Move point to the beginning of the current program unit.
2405 If NOMARK is non-nil, do not push mark."
2410 "Move point to the start of the next program unit.
2411 If NOMARK is non-nil, do not push mark."
2417 "Mark current IDL statement."
2425 "Mark containing block."
2437 "Put mark at beginning of program, point at end.
2438 The marks are pushed."
2448 "Move to beginning of enclosing block if prefix ARG >= 0.
2449 If prefix ARG < 0 then move forward to enclosing block end."
2454 "Go to the beginning of the current block."
2460 "Go to the beginning of the current block."
2466 "Move across next nested block."
2473 "Move backward across previous nested block."
2479 "Go down a block.
2480 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2481 Returns non-nil if successfull."
2485 ;; Backward
2493 ;; Forward
2501 status))
2504 "Put point at beginning of doc library header, mark at end.
2505 The marks are pushed."
2526 "Return (NAME TYPE CLASS) of current routine."
2530 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2539 "Move to beginning of the current statement.
2540 Skips back past statement continuations.
2541 Point is placed at the beginning of the line whether or not this is an
2542 actual statement."
2554 "Move point to beginning of the previous statement.
2555 Returns t if the current line before moving is the beginning of
2556 the first non-comment statement in the file, and nil otherwise."
2560 ;; first line in file
2561 t
2562 ;; skip blank lines, label lines, include lines and line comments
2564 ;; The current statement is the first statement until we
2565 ;; reach another statement.
2573 ;; skip continuation lines
2579 first-statement)))
2582 "Move point to the end of the current IDL statement.
2583 If not in a statement just moves to end of line. Returns position."
2593 "Move point to the end of the current IDL statement.
2594 If not in a statement just moves to end of line. Returns position."
2602 "Move point to beginning of the next IDL statement.
2603 Returns t if that statement is the last non-comment IDL statement
2604 in the file, and nil otherwise."
2608 ;; skip blank lines, label lines, include lines and line comments
2610 ;; The current statement is the last statement until
2611 ;; we reach a new statement.
2618 last-statement))
2621 "Skip past multiple commands on a line (with `&')."
2631 "Skip label or case statement element.
2632 Returns position after label.
2633 If there is no label point is not moved and nil is returned."
2634 ;; Case expressions and labels are terminated by a colon.
2635 ;; So we find the first colon in the line and make sure
2636 ;; - no `?' is before it (might be a ? b : c)
2637 ;; - it is not in a comment
2638 ;; - not in a string constant
2639 ;; - not in parenthesis (like a[0:3])
2640 ;; - not followed by another ":" in explicit class, ala a->b::c
2641 ;; As many in this mode, this function is heuristic and not an exact
2642 ;; parser.
2654 nil)))
2657 "Move to start of next IDL substatement after point.
2658 Uses the type of the current IDL statement to determine if the next
2659 statement is on a new line or is a subpart of the current statement.
2660 Returns point at start of substatement modulo whitespace.
2661 If optional argument is non-nil move to beginning of current
2662 substatement."
2666 st nst last)
2672 ;; Continue looking for substatements until we are past orig
2686 ;; If a continuation line starts here, move to next line
2692 "Return the type of the current IDL statement.
2693 Uses `idlwave-statement-match' to return a cons of (type . point) with
2694 point the ending position where the type was determined. Type is the
2695 association from `idlwave-statement-match', i.e. the cons cell from the
2696 list not just the type symbol. Returns nil if not an identifiable
2697 statement."
2699 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2700 ;; and possibly comments
2712 "Pad '=' with spaces.
2713 Two cases: Assignment statement, and keyword assignment.
2714 Which case is determined using `idlwave-start-of-substatement' and
2715 `idlwave-statement-type'. The equal sign will be surrounded by BEFORE
2716 and AFTER blanks. If `idlwave-pad-keyword' is t then keyword assignment
2717 is treated just like assignment statements. When nil, spaces are
2718 removed for keyword assignment. Any other value keeps the current space
2719 around the `='. Limits in for loops are treated as keyword assignment.
2721 Starting with IDL 6.0, a number of op= assignments are available.
2722 Since ambiguities of the form:
2724 r and= b
2725 rand= b
2727 can occur, alphanumeric operator assignment will never be pre-padded,
2728 only post-padded. You must use a space before these to disambiguate
2729 \(not just for padding, but for proper parsing by IDL too!). Other
2730 operators, such as ##=, ^=, etc., will be pre-padded.
2732 IS-ACTION is ignored.
2734 See `idlwave-surround'."
2747 ;; Why doesn't ##? work for both?
2751 ;(setq begin nil) ; won't modify begin
2755 ;; Everything gets padded equally
2757 ;; Treating keywords/for variables specially...
2775 "Call `idlwave-indent-line' and do expand actions.
2776 With prefix ARG non-nil, indent the entire sub-statement."
2784 ;;Expand the END abbreviation, just as RET or Space would have.
2795 "Indent current IDL line as code or as a comment.
2796 The actions in `idlwave-indent-action-table' are performed.
2797 If the optional argument EXPAND is non-nil then the actions in
2798 `idlwave-indent-expand-table' are performed."
2800 ;; Move point out of left margin.
2809 ;; Indentation for a line comment
2813 ;;
2814 ;; Code Line
2815 ;;
2816 ;; Before indenting, run action routines.
2817 ;;
2820 ;;
2823 ;;
2824 ;; No longer expand abbrevs on the line. The user can do this
2825 ;; manually using expand-region-abbrevs.
2826 ;;
2827 ;; Indent for code line
2828 ;;
2831 ;; a label line
2833 ;; a batch command
2835 ;; leave flush left
2836 nil
2837 ;; indent the line
2839 ;; Adjust parallel comment
2842 ;; Emacs 21 is too smart with fill-column on comment indent
2845 fill-column)))
2848 ;; Get rid of marker
2852 "Perform an action repeatedly on a line.
2853 ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is
2854 either a function name to be called with `funcall' or a list to be
2855 evaluated with `eval'. The action performed by FUNC should leave
2856 point after the match for REG - otherwise an infinite loop may be
2857 entered. FUNC is always passed a final argument of 'is-action, so it
2858 can discriminate between being run as an action, or a key binding."
2868 "Indent from point with spaces until column COL.
2869 Inserts space before markers at point."
2875 "Indent the current line to column COL.
2876 Indents such that first non-whitespace character is at column COL
2877 Inserts spaces before markers at point."
2884 "Indent program unit which contains point."
2896 "Indent current statement, including all continuation lines."
2905 "Return appropriate indentation for current line as IDL code."
2909 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2910 ;; function
2913 ;; Check for continuation line
2918 ;; calculate indent based on previous and current statements
2921 ;; calculate indent based on previous statement
2924 ;; Beginning of file
2929 ;; Main block
2932 idlwave-main-block-indent))
2933 ;; Begin block
2936 idlwave-block-indent))
2937 ;; End Block
2940 ;; Match to the *beginning* of the block opener
2944 ;; idlwave-end-offset
2945 ;; idlwave-block-indent))
2947 ;; Default to current indent
2949 ;; adjust the indentation based on the current statement
2951 ;; End block
2956 ;;
2957 ;; Parentheses indent
2958 ;;
2961 "Calculate the continuation indent inside a paren group.
2962 Returns a cons-cell with (open . indent), where open is the
2963 location of the open paren."
2965 ;; Found an innermost open paren.
2968 ;; Line up with next word unless this is a closing paren.
2971 ;; Plain Kernighan-style nested indent
2975 ;; This is a closed paren - line up under open paren.
2979 ;; Empty (or just comment) follows -- revert to basic indent
2981 ;; Skip paren
2984 nil)
2986 ;; Line up with first word after any blank space
2992 "Calculates the IDL continuation indent column from the previous statement.
2993 Note that here previous statement usually means the beginning of the
2994 current statement if this statement is a continuation of the previous
2995 line. Various special types of continuations, including assignments,
2996 routine definitions, and parenthetical groupings, are treated separately."
3007 idlwave-continuation-indent))
3008 fancy-nonparen-indent fancy-paren-indent)
3010 ;; Align then with its matching if, etc.
3017 match cont-re)
3032 ;; Indent in from the previous line for continuing statements
3037 match)
3049 ;; Parenthetical indent, either traditional or Kernighan style
3056 indent-cons)
3059 beg-reg end-reg close-exp))
3060 ;; First permitted containing paren
3062 idlwave-indent-to-open-paren
3063 idlwave-indent-parens-nested
3066 idlwave-max-extra-continuation-indent))
3069 fancy-paren-indent)
3071 ;; A continued assignment, or procedure call/definition
3079 ;; A continued Procedure call or definition
3082 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3084 ;; Comment only, or blank line with "$"? Basic indent.
3086 nil
3089 ;; Continued assignment (with =):
3103 idlwave-max-extra-continuation-indent))
3106 fancy-nonparen-indent))
3108 ;; Basic indent, by default
3114 "Move to next match of the regular expression KEY-RE.
3115 Matches inside comments or string constants will be ignored.
3116 If DIR is negative, the search will be backwards.
3117 At a successful match, the mark is pushed unless NOMARK is non-nil.
3118 Searches are limited to LIMIT.
3119 Searches are case-insensitive and use a special syntax table which
3120 treats `$' and `_' as word characters.
3121 Return value is the beginning of the match or (in case of failure) nil."
3125 found)
3139 found)
3140 nil)))
3143 "When optional argument DIR is non-negative, move forward to end of
3144 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3145 regular expressions. When DIR is negative, move backwards to block beginning.
3146 Recursively calls itself to skip over nested blocks. DIR defaults to
3147 forward. Calls `push-mark' unless the optional argument NOMARK is
3148 non-nil. Movement is limited by the start of program units because of
3149 possibility of unbalanced blocks."
3156 idlwave-begin-block-reg
3157 idlwave-end-block-reg))
3158 found
3160 idlwave-end-block-reg))
3164 idlwave-begin-unit-reg dir t limit)
3167 idlwave-end-unit-reg dir t limit)))
3168 limit)))
3180 "The minimum indent in the current statement."
3191 min
3195 "Return indentation of the current statement.
3196 If in a statement, moves to beginning of statement before finding indent."
3203 "Return the column of the indentation of the current line.
3204 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3208 ;; if we are at the end of blank line return 0
3213 "Test if current line is continuation line.
3214 Blank or comment-only lines following regular continuation lines (with
3215 `$') count as continuations too."
3226 "Test if the current line is a comment line."
3232 "Test if the current line is a comment line."
3238 "Search current line from current point for REGEXP.
3239 If optional argument CONT is non-nil, searches to the end of
3240 the current statement.
3241 If optional arg BEG is non-nil, search starts from the beginning of the
3242 current statement.
3243 Ignores matches that end in a comment or inside a string expression.
3244 Returns point if successful, nil otherwise.
3245 This function produces unexpected results if REGEXP contains quotes or
3246 a comment delimiter. The search is case insensitive.
3247 If successful leaves point after the match, otherwise, does not move point."
3253 found)
3259 found))
3262 "Fill paragraphs in comments.
3263 A paragraph is made up of all contiguous lines having the same comment
3264 leader (the leading whitespace before the comment delimiter and the
3265 comment delimiter). In addition, paragraphs are separated by blank
3266 line comments. The indentation is given by the hanging indent of the
3267 first line, otherwise by the minimum indentation of the lines after
3268 the first line. The indentation of the first line does not change.
3269 Does not effect code lines. Does not fill comments on the same line
3270 with code. The hanging indent is given by the end of the first match
3271 matching `idlwave-hang-indent-regexp' on the paragraph's first line.
3272 If the optional argument NOHANG is non-nil then the hanging indent is
3273 ignored."
3275 ;; check if this is a line comment
3282 pre here diff fill-prefix-reg bcl first-indent
3283 hang start end)
3284 ;; Change tabs to spaces in the surrounding paragraph.
3285 ;; The surrounding paragraph will be the largest containing block of
3286 ;; contiguous line comments. Thus, we may be changing tabs in
3287 ;; a much larger area than is needed, but this is the easiest
3288 ;; brute force way to do it.
3289 ;;
3290 ;; This has the undesirable side effect of replacing the tabs
3291 ;; permanently without the user's request or knowledge.
3299 ;;
3306 t)
3307 ;; Get the comment leader on the line and its length
3309 ;; the comment leader is the indentation plus exactly the
3310 ;; number of consecutive ";".
3320 ;; Mark the beginning and end of the paragraph
3326 ;; Move to first line of paragraph
3340 ;; if at end of buffer add a newline (need this because
3341 ;; fill-region needs END to be at the beginning of line after
3342 ;; the paragraph or it will add a line).
3345 ;; Set END to the beginning of line after the paragraph
3346 ;; END is calculated as distance from end of buffer
3348 ;;
3349 ;; Calculate the indentation for the paragraph.
3350 ;;
3351 ;; In the following while statements, after one iteration
3352 ;; point will be at the beginning of a line in which case
3353 ;; the while will not be executed for the
3354 ;; the first paragraph line and thus will not affect the
3355 ;; indentation.
3356 ;;
3357 ;; First check to see if indentation is based on hanging indent.
3363 ;; Adjust lines of paragraph by inserting spaces so that
3364 ;; each line's indent is at least as great as the hanging
3365 ;; indent. This is needed for fill-paragraph to work with
3366 ;; a fill-prefix.
3373 t)
3377 ;; adjust the original location for the
3378 ;; inserted text.
3382 )
3384 ;; No hang. Instead find minimum indentation of paragraph
3385 ;; after first line.
3386 ;; For the following while statement, since START is at the
3387 ;; beginning of line and END is at the end of line
3388 ;; point is greater than START at least once (which would
3389 ;; be the case for a single line paragraph).
3396 comment-start-skip
3398 t)
3401 )
3404 ?\ )))
3405 ;; first-line indent
3410 comment-start-skip
3412 t)
3414 indent))
3416 ;; try to keep point at its original place
3419 ;; In place of the more modern fill-region-as-paragraph, a hack
3420 ;; to keep whitespace untouched on the first line within the
3421 ;; indent length and to preserve any indent on the first line
3422 ;; (first indent).
3428 start
3431 nil)
3435 ;; When we want the point at the beginning of the comment
3436 ;; body fill-region will put it at the beginning of the line.
3441 "Calculate the position of the hanging indent for the comment paragraph.
3442 The hanging indent position is given by the first match with the
3443 `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3444 non-nil then use last occurrence matching `idlwave-hang-indent-regexp'
3445 on the line.
3446 If not found returns nil."
3451 idlwave-hang-indent-regexp
3453 t)
3458 idlwave-hang-indent-regexp
3460 t)
3464 "Called to break lines in auto fill mode.
3465 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3466 non-nil. Places a continuation character at the end of the line if
3467 not in a comment. Splits strings with IDL concatenation operator `+'
3468 if `idlwave-auto-fill-split-string' is non-nil."
3470 nil ; do not to fill
3473 ;; Check for comment line
3478 ;; Prevent actions do-auto-fill which calls indent-line-function.
3483 idlwave-auto-fill-split-string)
3486 ))))
3490 ;; Indent the split line
3495 ;; A continued line comment
3496 ;; We treat continued line comments as part of a comment
3497 ;; paragraph. So we check for a hanging indent.
3506 ;; Remove whitespace between comment delimiter and
3507 ;; text, insert spaces for appropriate indentation.
3510 comment-start-skip
3515 )))
3516 ;; Split code or comment?
3520 ;; Splitting a non-full-line comment.
3521 ;; Insert the comment delimiter from split line
3526 ;; Insert blank to keep off beginning of line
3535 ;; Split code line - add continuation character
3538 ;; Check to see if we split a string
3540 idlwave-auto-fill-split-string)
3541 ;; Split the string and concatenate.
3542 ;; The first extra space is for the space
3543 ;; the line was split. That space was removed.
3548 ;; Make the second part of continued string
3553 ;; Warning
3556 ;; Although do-auto-fill (via indent-new-comment-line) calls
3557 ;; idlwave-indent-line for the new line, re-indent again
3558 ;; because of the addition of the continuation character.
3560 )))))
3563 "Toggle auto-fill mode for IDL mode.
3564 With arg, turn auto-fill mode on if arg is positive.
3565 In auto-fill mode, inserting a space at a column beyond `fill-column'
3566 automatically breaks the line at a previous space."
3572 'idlwave-auto-fill
3573 nil))
3574 ;; update mode-line
3577 ;(defun idlwave-fill-routine-call ()
3578 ; "Fill a routine definition or statement, indenting appropriately."
3579 ; (let ((where (idlwave-where)))))
3583 "Insert a documentation header at the beginning of the unit.
3584 Inserts the value of the variable `idlwave-file-header'. Sets mark
3585 before moving to do insertion unless the optional prefix argument
3586 NOMARK is non-nil."
3589 ;; make sure we catch the current line if it begins the unit
3595 ;; skip function or procedure line
3609 "Default timestamp insertion function."
3615 ;; Remove extra spaces from line
3617 ;; Insert a blank line comment to separate from the date entry -
3618 ;; will keep the entry from flowing onto date line if re-filled.
3622 "Insert a brief modification log at the beginning of the current program.
3623 Looks for an occurrence of the value of user variable
3624 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user
3625 name and places the point for the user to add a log. Before moving, saves
3626 location on mark ring so that the user can return to previous point."
3641 end t)
3652 ;; CJC 3/16/93
3653 ;; Interface to expand-region-abbrevs which did not work when the
3654 ;; abbrev hook associated with an abbrev moves point backwards
3655 ;; after abbrev expansion, e.g., as with the abbrev '.n'.
3656 ;; The original would enter an infinite loop in attempting to expand
3657 ;; .n (it would continually expand and unexpand the abbrev without expanding
3658 ;; because the point would keep going back to the beginning of the
3659 ;; abbrev instead of to the end of the abbrev). We now keep the
3660 ;; abbrev hook from moving backwards.
3661 ;;;
3663 "Expand each abbrev occurrence in the region.
3664 Calling from a program, arguments are START END."
3673 "Return t if point is in a comment or quoted string.
3674 Returns nil otherwise."
3678 "Return location of the opening quote
3679 if point is in a IDL string constant, nil otherwise.
3680 Ignores comment delimiters on the current line.
3681 Properly handles nested quotation marks and octal
3682 constants - a double quote followed by an octal digit."
3683 ;; Treat an octal inside an apostrophe to be a normal string. Treat a
3684 ;; double quote followed by an octal digit to be an octal constant
3685 ;; rather than a string. Therefore, there is no terminating double
3686 ;; quote.
3688 ;; Because single and double quotes can quote each other we must
3689 ;; search for the string start from the beginning of line.
3695 delim
3696 found)
3698 ;; Find string start
3699 ;; Don't find an octal constant beginning with a double quote
3701 ;; Find the string end.
3702 ;; In IDL, two consecutive delimiters after the start of a
3703 ;; string act as an
3704 ;; escape for the delimiter in the string.
3705 ;; Two consecutive delimiters alone (i.e., not after the
3706 ;; start of a string) is the null string.
3708 ;; Move to position after quote
3711 ;; Get the string delimiter
3713 ;; Check for null string
3716 ;; Look for next unpaired delimiter
3722 ))
3725 ;; return string beginning position or nil
3729 "Determine if the character after point is a pointer dereference *."
3739 ;; Statement templates
3741 ;; Replace these with a general template function, something like
3742 ;; expand.el (I think there was also something with a name similar to
3743 ;; dmacro.el)
3746 "Build a template with optional prompt expression.
3748 Opens a line if point is not followed by a newline modulo intervening
3749 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3750 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3751 adjusted according to `idlwave-abbrev-change-case'. If optional
3752 argument PROMPT is a string then it is displayed as a message in the
3753 minibuffer. The PROMPT serves as a reminder to the user of an
3754 expression to enter.
3756 The lines containing S1 and S2 are reindented using `indent-region'
3757 unless the optional second argument NOINDENT is non-nil."
3759 ;; This is a gross hack to avoit template abbrev expansion
3760 ;; in the shell. FIXME: This is a dirty hack.
3770 end)
3783 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3786 string))
3789 "Build skeleton IDL if-else block."
3797 "Build skeleton IDL case statement."
3805 "Build skeleton IDL switch statement."
3813 "Build skeleton IDL loop statement."
3821 "Build skeleton IDL if statement."
3857 "Return a list of substrings of STRING which are separated by PATTERN.
3871 end)
3879 ;; Return the buffer currently visiting FILE
3889 "List of buffers pulled up by IDLWAVE for special reasons.
3893 ;; Return a buffer visiting file.
3897 buf)))
3900 "Kill buffers created automatically by IDLWAVE.
3901 Function prompts for a letter to identify the buffers to kill.
3902 Possible letters are:
3905 clicks in the routine info window.
3906 s Buffers created by the IDLWAVE Shell to display where execution
3907 stopped or an error was found.
3908 a Both of the above.
3910 Buffers containing unsaved changes require confirmation before they are killed."
3914 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3928 "How many outlawed buffers have tag TAG?"
3932 idlwave-outlawed-buffers))))
3935 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3938 entry)
3952 "Remove BUFFER from the buffers which may be killed.
3953 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3954 Intended for `after-save-hook'."
3957 ;; Revoke license
3961 ;; Remove this function from the hook.
3966 ;; Find FILE on the scanned lib path and return a buffer visiting it
3968 dir efile)
3976 ;; Find FILE on the scanned lib path and return a buffer visiting it
3977 ;; This is for, e.g., finding source with no user catalog
3984 "Create the IDL tags file IDLTAGS in the current directory from
3985 the list of directories specified in the minibuffer. Directories may be
3986 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
3987 specified top directories are searched if the directory name is prefixed
3988 by @. Specify @ directories with care, it may take a long, long time if
3989 you specify /."
3992 buffer save_buffer files numfiles item errbuf)
3994 ;;
3995 ;; Read list of directories
3998 ;;
3999 ;; Set etags command, vars
4005 ;;
4006 ;; For each directory
4010 ;;
4011 ;; Find the subdirectories
4033 ;;
4034 ;; For each subdirectory
4038 ;;
4039 ;; Call etags
4048 0
4050 ;;
4051 ;; Append additional tags
4058 )))
4070 ))
4073 "Comment the lines in the region if the first non-blank line is
4074 commented, and conversely, uncomment region. If optional prefix arg
4075 N is non-nil, then for N positive, add N comment delimiters or for N
4076 negative, remove N comment delimiters.
4077 Uses `comment-region' which does not place comment delimiters on
4078 blank lines."
4085 ;; skip blank lines
4097 ;; ----------------------------------------------------------------------------
4098 ;; ----------------------------------------------------------------------------
4099 ;; ----------------------------------------------------------------------------
4100 ;; ----------------------------------------------------------------------------
4101 ;;
4102 ;; Completion and Routine Info
4103 ;;
4105 ;; String "intern" functions
4107 ;; For the completion and routine info function, we want to normalize
4108 ;; the case of procedure names etc. We do this by "interning" these
4109 ;; string is a hand-crafted way. Hashes are used to map the downcase
4110 ;; version of the strings to the cased versions. Most *-sint-*
4111 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4112 ;; system hash. The former is re-scanned, and the latter takes case
4113 ;; precedence.
4114 ;;
4115 ;; Since these cased versions are really lisp objects, we can use `eq'
4116 ;; to search, which is a large performance boost. All new strings
4117 ;; need to be "sinterned". We do this as early as possible after
4118 ;; getting these strings from completion or buffer substrings. So
4119 ;; most of the code can simply assume to deal with "sinterned"
4120 ;; strings. The only exception is that the functions which scan whole
4121 ;; buffers for routine information do not intern the grabbed strings.
4122 ;; This is only done afterwards. Therefore in these functions it is
4123 ;; *not* safe to assume the strings can be compared with `eq' and be
4124 ;; fed into the routine assq functions.
4126 ;; Here we define the hashing functions.
4128 ;; The variables which hold the hashes.
4137 "Reset all sintern hashes."
4138 ;; Make sure the hash functions are accessible.
4149 ;; Make sure these are lists
4154 ;; Reset the system & library hash
4162 idlwave-sint-libnames nil))
4164 ;; Reset the buffer & shell hash
4180 ;;(defmacro idlwave-sintern (type var)
4181 ;; `(cond ((not (stringp name)) name)
4182 ;; ((gethash (downcase name) (cdr ,var)))
4183 ;; ((gethash (downcase name) (car ,var)))
4184 ;; (set (idlwave-sintern-set name ,type ,var set))
4185 ;; (name)))
4225 iname))
4228 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4232 kwd-list)
4235 "Sintern all strings in the rinfo LIST.
4236 With optional parameter SET: also set new patterns. Probably this
4237 will always have to be t. If DEFAULT-DIR is passed, it is used as
4238 the base of the directory."
4250 ;; The class and name
4258 ;; The source
4271 ;; The keywords
4274 kwds))
4276 ;; Build a canonicalized list
4281 ;; Creating new sintern tables
4284 "Define a variable and a function to sintern the new type TAG.
4285 This defines the function `idlwave-sintern-TAG' and the variable
4286 `idlwave-sint-TAGs'."
4298 name)
4302 "Reset the sintern variable associated with TAG."
4305 ;;---------------------------------------------------------------------------
4308 ;; The variables which hold the information
4324 "Alist with !PATH directories and zero or more flags if the dir has
4325 been scanned in a user catalog ('user) or discovered in a library
4341 ;;
4342 ;; The code to get routine info from different sources.
4349 "Provide a list of IDL routines.
4350 This routine loads the builtin routines on the first call.
4351 Later it only returns the value of the variable."
4361 ;; Keep it running...
4362 )
4364 ;; Something is wrong, get rid of the process
4373 ;; return the current value
4374 idlwave-routines)))
4377 "List of functions which should run after a global rinfo update.
4381 "Rescan the previously selected directories. For batch processing."
4385 "Dispatch another Emacs instance to update the idlwave catalog.
4386 After the process finishes normally, the first access to routine info
4387 will re-read the catalog."
4411 nil emacs args)))
4414 process
4418 idlwave-system-routines nil
4419 idlwave-catalog-process nil)
4425 ;; Format for all routine info user catalog, library catalogs, etc.:
4426 ;;
4427 ;; ("ROUTINE" type class
4428 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4429 ;; (buffer pro_file dir) | (compiled pro_file dir)
4430 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4431 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4432 ;;
4433 ;; DIR will be supplied dynamically while loading library catalogs,
4434 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4435 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4436 ;; be nil, as can LINK1, etc., if no HTML help is available.
4443 "Update the internal routine-info lists.
4446 about individual routines.
4448 The information can come from 4 sources:
4449 1. IDL programs in the current editing session
4450 2. Compiled modules in an IDL shell running as Emacs subprocess
4451 3. A list which covers the IDL system routines.
4452 4. A list which covers the prescanned library files.
4454 Scans all IDLWAVE-mode buffers of the current editing session (see
4455 `idlwave-scan-all-buffers-for-routine-info').
4456 When an IDL shell is running, this command also queries the IDL program
4457 for currently compiled routines.
4459 With prefix ARG, also reload the system and library lists.
4460 With two prefix ARG's, also rescans the chosen user catalog tree.
4461 With three prefix args, dispatch asynchronous process to do the update.
4463 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4464 lists, but instead wait for the shell query to complete and
4465 asynchronously finish updating routine info. This is set
4466 automatically when called interactively. When you need routine
4467 information updated immediately, leave NO-CONCATENATE nil."
4469 ;; Stop any idle processing
4477 ;; Start a background process which updates the catalog.
4480 ;; Update the user catalog now, and wait for them.
4484 idlwave-buffer-case-takes-precedence
4486 ;; The override-idle means, even if the idle timer has done some
4487 ;; preparing work, load and renormalize everything anyway.
4491 idlwave-compiled-routines nil
4492 idlwave-unresolved-routines nil)
4493 ;; Reset the appropriate hashes
4495 ;; reset was already done in idle time, so skip this step now once
4502 ;; We can safely scan the buffer stuff first
4506 ;; We first do the system info, and then the buffers
4510 ;; Let's see if there is a shell
4514 idlwave-query-shell-for-routine-info)))
4516 ;; Load the library catalogs again, first re-scanning the path
4528 ;; 1. If we are not going to ask the shell, we need to do the
4529 ;; concatenation now.
4530 ;; 2. When this function is called non-interactively, it
4531 ;; means that someone needs routine info *now*. The
4532 ;; shell update causes the concatenation to be
4533 ;; *delayed*, so not in time for the current command.
4534 ;; Therefore, we do a concatenation now, even though
4535 ;; the shell might do it again.
4539 ;; Ask the shell about the routines it knows of.
4562 idlwave-init-rinfo-when-idle-after
4568 ;;------ XML Help routine info system
4570 ;; Load the system routine info from the cached routine info file,
4571 ;; which, if necessary, will be re-created from the XML file on
4572 ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo
4573 ;; file distributed with older IDLWAVE versions (<6.0)
4577 ;; See if we can create it from XML source
4597 idlwave-xml-system-rinfo-converted-file
4598 catalog-file)))
4602 "Alist of system variables and the associated structure tags.
4610 ;; From a list of syntax statements, shorten with %s and group with "or"
4619 x)
4624 ;; Create a class list entry from the xml parsed list., returning a
4625 ;; cons of form (class-entry method-entries).
4631 class-entry
4632 method methods-entry extra-kwds
4633 props get-props set-props init-props inherits
4634 pelem ptype)
4664 init-props)
4667 get-props)
4670 set-props)
4674 methods-entry)))
4677 ;;(unless (get 'init-props 'matched)
4678 ;; (message "Failed to match Init in class %s" class))
4679 ;;(unless (get 'get-props 'matched)
4680 ;; (message "Failed to match GetProperty in class %s" class))
4681 ;;(unless (get 'set-props 'matched)
4682 ;; (message "Failed to match SetProperty in class %s" class))
4690 ;; Create correctly structured list elements from ROUTINE or METHOD
4691 ;; XML list structures. Return a list of list elements, with more
4692 ;; than one sub-list possible if a routine can serve as both
4693 ;; procedure and function (e.g. call_method).
4700 syntax kwd klink pref-list kwds pelem ptype props result type)
4735 ;; Debug
4736 ;; (if (and (null (aref syntax-vec 0))
4737 ;; (null (aref syntax-vec 1))
4738 ;; (null (aref syntax-vec 2)))
4739 ;; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints")
4740 ;; (if class
4741 ;; (insert (format "Missing SYNTAX entry for %s::%s\n" class name))
4742 ;; (insert (message "Missing SYNTAX entry for %s\n" name)))))
4744 ;; Executive commands are treated specially
4756 result)))
4760 ;; Group keywords by link file, as a list with elements
4761 ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2))
4773 ;; Ensure the master link is there
4776 linkfiles
4781 ;; Clean up the syntax of routines which are actually aliases by
4782 ;; removing the "OR" from the statements
4791 ;; Duplicate and trim original routine aliases from rinfo list
4792 ;; This if for, e.g. OPENR/OPENW/OPENU
4802 ;; Add any missing aliases (separate by slashes)
4817 ;; Duplicate and trim original routine aliases from rinfo list
4818 ;; This if for, e.g. !X, !Y, !Z.
4831 ;; Create a sysvar list entry from the xml parsed list.
4839 pelem ptype props tags)
4850 tags))))
4864 ;; Automatically generated from source file:
4869 idlwave-xml-routine-info-file))
4887 "Convert XML supplied IDL routine info into internal form.
4888 Cache to disk for quick recovery."
4894 props rinfo msg-cnt elem type nelem class-result alias
4895 routines routine-aliases statement-aliases sysvar-aliases)
4905 ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff.
4915 idlwave-system-variables-alist nil
4916 idlwave-system-class-info nil
4917 idlwave-executive-commands-alist nil
4918 idlwave-help-special-topic-words nil)
4934 routine-aliases)
4939 ;; a cons cell is an executive commands
4951 idlwave-help-special-topic-words)
4952 ;; Save the links to those which are statement aliases (not routines)
4961 sysvar-aliases)
4963 idlwave-system-variables-alist)))
4974 ;; ("ROUTINE" type class
4975 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4976 ;; (buffer pro_file dir) | (compiled pro_file dir)
4977 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4978 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4988 ;;(load "idlw-rinfo" 'noerror 'nomessage)
5010 ;; Check for the old style catalog and warn
5013 idlwave-library-routines)
5018 idlwave-user-catalog-file))
5045 ;; restart the timer
5050 idlwave-init-rinfo-when-idle-after
5056 ;; Load and case-treat the system, user catalog, and library routine
5057 ;; info files.
5059 ;; System
5061 ;;(load "idlw-rinfo" 'noerror 'nomessage))
5073 ;; User catalog
5082 idlwave-library-routines)
5085 idlwave-user-catalog-file))
5094 ;; Library catalog
5105 ;; Scan all buffers, current buffer last
5110 ;; Don't scan any buffers
5113 ;; Just scan this buffer
5119 ;; Put the result into the correct variable
5124 "Put the different sources for routine information together."
5125 ;; The sequence here is important because earlier definitions shadow
5126 ;; later ones. We assume that if things in the buffers are newer
5127 ;; then in the shell of the system, they are meant to be different.
5130 idlwave-compiled-routines
5131 idlwave-library-catalog-routines
5132 idlwave-user-catalog-routines))
5135 ;; Give a message with information about the number of routines we have.
5138 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
5148 "Return the class alist - make it if necessary."
5155 idlwave-class-alist)))
5157 ;; Three functions for the hooks
5166 "Update `idlwave-routines' for current buffer.
5167 Can run from `after-save-hook'."
5171 idlwave-scan-all-buffers-for-routine-info
5172 idlwave-routines)
5178 nil
5184 routines)
5188 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
5190 found)
5192 ;; The following test uses eq to make sure it works correctly
5193 ;; when two buffers visit the same file. Then the file names
5194 ;; will be equal, but not eq.
5200 ;; End of that section reached. Jump.
5206 ;;----- Scanning buffers -------------------
5209 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
5215 buffer-file-name)
5216 ;; yes, this buffer has the right mode.
5221 ;; Concatenate the individual lists and return the result
5225 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
5227 routine-list string entry)
5241 routine-list))
5246 "Parse a module definition."
5248 start name args type keywords class)
5249 ;; Remove comments
5252 ;; Remove the continuation line stuff
5257 ;; Match the name and type.
5265 ;; Match normal args and keyword args
5268 string start)
5273 ;; Normalize and sort.
5277 ;; Make and return the entry
5278 ;; We don't know which argument are optional, so this information
5279 ;; will not be contained in the calling sequence.
5282 class
5285 ; ((string= (downcase
5286 ; (file-name-sans-extension
5287 ; (file-name-nondirectory (buffer-file-name))))
5288 ; (downcase name))
5289 ; (list 'lib))
5290 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
5296 "%s"
5304 nil))))
5307 ;;----- Scanning the user catalog -------------------
5310 "Return the syslib directory, or a dummy that never matches."
5314 idlwave-system-directory)
5320 "Scan all files on selected dirs of IDL search path for routine information.
5322 A widget checklist will allow you to choose the directories. Write
5323 the result as a file `idlwave-user-catalog-file'. When this file
5324 exists, it will be automatically loaded to give routine information
5325 about library routines. With ARG, just rescan the same directories
5326 as last time - so no widget will pop up."
5328 ;; Make sure the file is loaded if it exists.
5334 ;; Make sure the file name makes sense
5340 idlwave-user-catalog-file))))
5344 ;; Rescan the known directories
5349 ;; Expand the directories from library-path and run the widget
5353 ;; Propagate any flags on the existing path-alist
5356 idlwave-true-path-alist)))
5363 ;; Ask the shell for the path and then run the widget
5372 ;; Parse shell path information and select among it.
5374 ;; Command hook used by `idlwave-create-user-catalog-file'.
5376 ;; Scan immediately
5378 ;; Set the path and display the widget
5384 "This is the front-end to the creation of the IDLWAVE user catalog.
5385 Please select the directories on IDL's search path from which you
5386 would like to extract routine information, to be stored in the file:
5388 %s
5390 If this is not the correct file, first set variable
5391 `idlwave-user-catalog-file', and call this command again.
5393 N.B. Many libraries include pre-scanned catalog files
5395 not be scanned. You can scan your own libraries off-line using the
5396 perl script `idlwave_catalog'.
5398 After selecting the directories, choose [Scan & Save] to scan the library
5399 directories and save the routine info.
5405 "Create the widget to select IDL search path directories for scanning."
5417 idlwave-user-catalog-file))
5428 :notify
5438 :notify
5456 'checklist
5460 dirs-list))
5461 :greedy t
5483 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
5488 dir-entry)
5494 selected-dirs)
5501 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5505 dirs-alist dir files file)
5507 idlwave-path-alist path-alist ; for library-path instead
5508 idlwave-true-path-alist nil)
5529 idlwave-user-catalog-routines)))))))))
5537 font-lock-mode)
5543 ;; Define the routine info list
5550 idlwave-user-catalog-routines))
5554 ;; Save the buffer
5560 idlwave-user-catalog-file)
5578 font-lock-mode)
5583 ;; Define the variable which knows the value of "!DIR"
5585 idlwave-system-directory))
5587 ;; Define the variable which contains a list of all scanned directories
5594 idlwave-path-alist))
5601 ;; Expand parts of path starting with '+' recursively into directory list.
5602 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5612 ;; Expand recursively
5614 ;; Keep unchanged
5620 ;; Return a list of all directories below DIR, including DIR itself
5629 path1))
5632 ;;----- Scanning the library catalogs ------------------
5638 "Scan for library catalog files (.idlwave_catalog) and ingest.
5640 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5641 instead, if present) are searched. Print MESSAGE-BASE along with the
5642 libraries being loaded, if passed, and skip loading/normalizing if
5643 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5644 be set to nil to disable library catalog scanning."
5651 dir-entry dir catalog all-routines)
5659 ;; Load the catalog file
5664 message-base
5666 old-libname)))
5668 idlwave-library-catalog-libname))
5675 all-routines))))
5677 ;; Add a 'lib flag if on path-alist
5684 ;;----- Communicating with the Shell -------------------
5686 ;; First, here is the idl program which can be used to query IDL for
5687 ;; defined routines.
5689 "
5690 ;; START OF IDLWAVE SUPPORT ROUTINES
5691 pro idlwave_print_safe,item,limit
5692 catch,err
5693 if err ne 0 then begin
5694 print,'Could not print item.'
5695 return
5696 endif
5697 if n_elements(item) gt limit then $
5698 print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $
5699 else print,item
5700 end
5702 pro idlwave_print_info_entry,name,func=func,separator=sep
5703 ;; See if it's an object method
5704 if name eq '' then return
5705 func = keyword_set(func)
5706 methsep = strpos(name,'::')
5707 meth = methsep ne -1
5709 ;; Get routine info
5710 pars = routine_info(name,/parameters,functions=func)
5711 source = routine_info(name,/source,functions=func)
5712 nargs = pars.num_args
5713 nkw = pars.num_kw_args
5714 if nargs gt 0 then args = pars.args
5715 if nkw gt 0 then kwargs = pars.kw_args
5717 ;; Trim the class, and make the name
5718 if meth then begin
5719 class = strmid(name,0,methsep)
5720 name = strmid(name,methsep+2,strlen(name)-1)
5721 if nargs gt 0 then begin
5722 ;; remove the self argument
5723 wh = where(args ne 'SELF',nargs)
5724 if nargs gt 0 then args = args[wh]
5725 endif
5726 endif else begin
5727 ;; No class, just a normal routine.
5729 endelse
5731 ;; Calling sequence
5733 if func then cs = 'Result = '
5734 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5735 cs = cs + '%s'
5736 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5737 if nargs gt 0 then begin
5738 for j=0,nargs-1 do begin
5739 cs = cs + args[j]
5740 if j lt nargs-1 then cs = cs + ', '
5741 endfor
5742 end
5743 if func then cs = cs + ')'
5744 ;; Keyword arguments
5745 kwstring = ''
5746 if nkw gt 0 then begin
5747 for j=0,nkw-1 do begin
5748 kwstring = kwstring + ' ' + kwargs[j]
5749 endfor
5750 endif
5752 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5754 print,ret + ': ' + name + sep + class + sep + source[0].path $
5755 + sep + cs + sep + kwstring
5756 end
5758 pro idlwave_routine_info,file
5759 on_error,1
5760 sep = '<@>'
5762 all = routine_info()
5763 fileQ=n_elements(file) ne 0
5764 if fileQ then file=strtrim(file,2)
5765 for i=0L,n_elements(all)-1L do begin
5766 if fileQ then begin
5767 if (routine_info(all[i],/SOURCE)).path eq file then $
5768 idlwave_print_info_entry,all[i],separator=sep
5769 endif else idlwave_print_info_entry,all[i],separator=sep
5770 endfor
5771 all = routine_info(/functions)
5772 for i=0L,n_elements(all)-1L do begin
5773 if fileQ then begin
5774 if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $
5775 idlwave_print_info_entry,all[i],separator=sep,/FUNC
5776 endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC
5777 endfor
5778 print,'>>>END OF IDLWAVE ROUTINE INFO'
5779 end
5781 pro idlwave_get_sysvars
5782 on_error,1
5783 catch,error_status
5784 if error_status ne 0 then begin
5785 print, 'Cannot get info about system variables'
5786 endif else begin
5787 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5788 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5789 v = strsplit(s,' +',/regex,/extract) ; get variables
5790 for i=0L,n_elements(v)-1 do begin
5791 t = [''] ; get tag list
5792 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5793 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5794 endfor
5795 endelse
5796 end
5798 pro idlwave_get_class_tags, class
5799 res = execute('tags=tag_names({'+class+'})')
5800 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5801 end
5802 ;; END OF IDLWAVE SUPPORT ROUTINES
5803 "
5824 (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5829 ;; Restore if necessary. Must use execute to hide lame routine_info
5830 ;; errors on undefinded routine
5832 (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'"
5833 idlwave-shell-temp-rinfo-save-file
5834 idlwave-shell-temp-rinfo-save-file)
5839 "Query the shell for routine_info of compiled modules and update the lists."
5840 ;; Save and compile the procedure. The compiled procedure is then
5841 ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may
5842 ;; need to test for and possibly RESTORE the procedure each time we
5843 ;; use it, since the user may have killed or redefined it. In
5844 ;; particular, .RESET_SESSION will kill all user procedures. If
5845 ;; FILE is set, only update routine info for routines in that file.
5848 ; execute the routine_info procedure, and analyze the output
5856 ;; ---------------------------------------------------------------------------
5857 ;;
5858 ;; Completion and displaying routine calling sequences
5870 "Complete a function, procedure or keyword name at point.
5871 This function is smart and figures out what can be completed
5872 at this point.
5873 - At the beginning of a statement it completes procedure names.
5874 - In the middle of a statement it completes function names.
5875 - After a `(' or `,' in the argument list of a function or procedure,
5876 it completes a keyword of the relevant function or procedure.
5877 - In the first arg of `OBJ_NEW', it completes a class name.
5879 When several completions are possible, a list will be displayed in
5880 the *Completions* buffer. If this list is too long to fit into the
5881 window, scrolling can be achieved by repeatedly pressing
5884 The function also knows about object methods. When it needs a class
5885 name, the action depends upon `idlwave-query-class', which see. You
5886 can force IDLWAVE to ask you for a class name with a
5889 See also the variables `idlwave-keyword-completion-adds-equal' and
5890 `idlwave-function-completion-adds-paren'.
5892 The optional ARG can be used to specify the completion type in order
5893 to override IDLWAVE's idea of what should be completed at point.
5894 Possible values are:
5896 0 <=> query for the completion type
5897 1 <=> 'procedure
5898 2 <=> 'procedure-keyword
5899 3 <=> 'function
5900 4 <=> 'function-keyword
5901 5 <=> 'procedure-method
5902 6 <=> 'procedure-method-keyword
5903 7 <=> 'function-method
5904 8 <=> 'function-method-keyword
5905 9 <=> 'class
5907 As a special case, the universal argument C-u forces completion of
5908 function names in places where the default would be a keyword.
5910 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5911 completion.
5913 For Lisp programmers only:
5914 When we force a keyword, optional argument MODULE can contain the module name.
5915 When we force a method or a method keyword, CLASS can specify the class."
5942 ;; Complete a filename in quotes
5947 ;; Check for any special completion functions
5954 ;; Complete a class
5960 ;; Complete a procedure name
5973 isa
5979 isa
5983 ;; Complete a function name
5996 isa
6002 isa
6010 ;; Complete a procedure keyword
6027 super-classes system))
6039 isa
6043 ;; Complete a function keyword
6056 msg-name)
6061 super-classes system))
6062 ;; OBJ_NEW: Messages mention the proper Init method
6069 msg-name))
6078 isa
6084 "List of special completion functions.
6085 These functions are called for each completion. Each function must
6086 check if its own special completion context is present. If yes, it
6087 should use `idlwave-complete-in-buffer' to do some completion and
6088 return t. If such a function returns t, *no further* attempts to
6089 complete other contexts will be done. If the function returns nil,
6094 fun ret)
6099 nil)))
6102 ;; Return an artificial WHERE specification to force the completion
6103 ;; routine to complete a specific item independent of context.
6104 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
6105 ;; MODULE and CLASS can be used to specify the routine name and class.
6106 ;; The class name will also be found in MODULE if that is like "class::mod".
6124 what)
6197 ;; Completing read, case insensitive
6207 "Use the comint stuff to complete a file name."
6215 idlwave-shell-default-directory
6216 default-directory)))
6220 ;; Make a fully qualified module name including the class name
6224 "Like `idlwave-rinfo-assq', but sintern strings first."
6230 ;; Works like assq, but also checks type and class
6241 ;; Return the first matching method on the inheritance list
6243 class rtn)
6247 rtn))
6250 keep-system)
6251 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
6252 If WITH-FILE is passed, find the best rinfo entry with a file
6253 included. If KEEP-SYSTEM is set, don't prune system for compiled
6254 syslib files."
6257 list))
6258 syslibp)
6265 ;; Its a compiled syslib, so we need to remove the system entry
6271 twins)))))
6275 keep-system)
6276 "Like `idlwave-best-rinfo-assq', but sintern strings first."
6282 "Does the entry list ENTRIES contain a syslib entry?
6283 If yes, return the index (>=1)."
6292 nil)))
6295 "Return a list of all associations of Key in LIST."
6303 "Return all classes which have a method METHOD.
6304 TYPE is 'fun or 'pro.
6305 When TYPE is not specified, both procedures and functions will be considered."
6318 "Return all classes which have a method METHOD with keyword KEYWORD.
6319 TYPE is 'fun or 'pro.
6320 When TYPE is not specified, both procedures and functions will be considered."
6323 nil
6335 "Return list of all elements in LIST which are also in CLUB."
6344 "Return list of all elements in LIST which are not in CLUB."
6348 nil
6354 "Return whether or not the class is listed explicitly, ala a->b::c.
6355 INFO is as returned by `idlwave-what-function' or `-procedure'."
6362 "List of special functions for determining class.
6366 ;; Determine the class of a routine call.
6367 ;; INFO is the `cw-list' structure as returned by idlwave-where.
6368 ;; The second element in this structure is the class. When nil, we
6369 ;; return nil. When t, try to get the class from text properties at
6370 ;; the arrow. When the object is "self", we use the class of the
6371 ;; current routine. otherwise prompt the user for a class name.
6372 ;; Also stores the selected class as a text property at the arrow.
6373 ;; TYPE is 'fun or 'pro.
6379 idlwave-query-class))
6381 idlwave-query-class))
6393 store special-class class-alist)
6397 ;; There is an object which would like to know its class
6399 idlwave-store-inquired-class
6406 ;; Before prompting, try any special class determination routines
6408 idlwave-determine-class-special
6414 store idlwave-store-inquired-class)))
6416 ;; Prompt for a class, if we need to
6437 ;; Store it, if requested
6439 ;; We have a real class here
6445 rear-nonsticky t))
6448 ;; Return the class
6449 class)
6450 ;; Default as fallback
6460 ;; Record a file link, if any, for the tested names during selection.
6464 sel))
6468 "Find out where we are.
6469 The return value is a list with the following stuff:
6470 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
6472 PRO-LIST (PRO POINT CLASS ARROW)
6473 FUNC-LIST (FUNC POINT CLASS ARROW)
6474 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
6475 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
6476 be completed here.
6477 LAST-CHAR last relevant character before point (non-white non-comment,
6478 not part of current identifier or leading slash).
6480 In the lists, we have these meanings:
6481 PRO: Procedure name
6482 FUNC: Function name
6483 POINT: Where is this
6484 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
6485 ARROW: Location of the arrow"
6503 cw cw-mod cw-arrow cw-class cw-point)
6507 match-string)
6513 match-string))
6515 cw-arrow pro-arrow))
6517 match-string)
6518 nil)
6520 match-string)
6523 match-string)
6530 cw-class func-class cw-arrow func-arrow))
6533 cw-class pro-class cw-arrow pro-arrow))
6534 ; ((member last-char '(?\' ?\) ?\] ?!))
6535 ; ;; after these chars, a function makes no sense
6536 ; ;; FIXME: I am sure there can be more in this list
6537 ; ;; FIXME: Do we want to do this at all?
6538 ; nil)
6539 ;; Everywhere else we try a function.
6543 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t)
6547 t))))))
6550 cw
6552 last-char)))
6555 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6563 ;; Find out if point is within the argument list of a function.
6564 ;; The return value is ("function-name" class arrow-start (point) level).
6565 ;; Level is 1 on the top level parentheses, higher further down.
6567 ;; If the optional BOUND is an integer, bound backwards directed
6568 ;; searches to this point.
6572 func-point
6574 func arrow-start class)
6579 ;; move back out of the current parenthesis
6588 bound t))
6591 pos func-point)
6597 'exit
6601 arrow-start func-point cnt)))
6606 ;; Find out if point is within the argument list of a procedure.
6607 ;; The return value is ("procedure-name" class arrow-pos (point)).
6609 ;; If the optional BOUND is an integer, bound backwards directed
6610 ;; searches to this point.
6612 pro class arrow-start string)
6614 ;;(idlwave-beginning-of-statement)
6624 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6625 string))
6630 pos)
6635 arrow-start
6636 pro-point)))
6639 ;; If there is an object at point, move over it and return t.
6649 nil)
6667 nil)))
6670 "Return the last character before point which is not white or a comment
6671 and also not part of the current identifier. Since we do this in
6672 order to identify places where keywords are, we consider the initial
6673 `/' of a keyword as part of the identifier.
6674 This function is not general, can only be used for completion stuff."
6677 ;; skip the current identifier
6679 ;; also skip a leading slash which might be belong to the keyword
6682 ;; FIXME: does not check if this is a valid identifier
6690 ;; continuation line
6704 &optional prepare-display-function
6705 special-selector)
6706 "Perform TYPE completion of word before point against LIST.
6707 SELECTOR is the PREDICATE argument for the completion function. Show
6708 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6709 'procedure, 'class-tag, 'keyword, 'sysvar, etc. SPECIAL-SELECTOR is
6710 used only once, for `all-completions', and can be used to, e.g.,
6711 accumulate information on matching completions."
6714 dpart dcompletion)
6719 ;; What is already in the buffer?
6724 idlwave-complete-after-success-form
6727 idlwave-complete-after-success-form-force
6731 ;; Try a completion
6737 idlwave-completion-help-links nil)
6740 ;; nothing available.
6744 ;; We can add something
6748 idlwave-complete-empty-string-as-lower-case)
6750 dcompletion
6751 completion))
6753 ;; Now this is a unique match
6755 t)
6761 selector))))))
6763 ;; This is already complete
6766 nil)
6768 ;; We cannot add something - offer a list.
6776 idlwave-completion-help-links))))
6777 list))
6779 ;; "complete" means, this is already a valid completion
6782 ;; (completion-fixup-function ; Emacs
6783 ;; (lambda () (and (eq (preceding-char) ?>)
6784 ;; (re-search-backward " <" beg t)))))
6792 idlwave-complete-empty-string-as-lower-case)
6798 x)
6799 list)))
6801 t))))
6804 "Complete a class at point."
6806 ;; Call `idlwave-routines' to make sure the class list will be available
6808 ;; Check for the special case of completing empty string after pro/function
6817 ;; Yank the full class specification
6819 ;; Do the completion, using list gathered from `idlwave-routines'
6828 idlwave-completion-help-links))
6829 x))
6830 list)))))
6833 ;; Attach the proper class list to a LIST of completion items.
6834 ;; TYPE, when 'kwd, shows classes for method keywords, when
6835 ;; 'class-tag, for class tags, and otherwise for methods.
6836 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6842 ;; In these cases, we do not have to do anything
6843 list
6847 ;; (do-dots (featurep 'xemacs))
6853 classes nclasses class-info space)
6856 ;; get the classes
6858 ;; Just one class for tags
6862 ;; Multiple classes for method or method-keyword
6866 method-selector x type-selector)
6872 classes)))))
6874 ;; Make the separator between item and class-info
6879 ;; We do want info in the buffer
6882 space
6887 ;; We do want properties
6891 x))
6894 x))
6895 list))))
6898 ;; Call idlwave-attach-classes with method parameters
6901 ;; Call idlwave-attach-classes with keyword parameters
6904 ;; Call idlwave-attach-classes with class structure tags
6908 ;;----------------------------------------------------------------------
6909 ;;----------------------------------------------------------------------
6910 ;;----------------------------------------------------------------------
6911 ;;----------------------------------------------------------------------
6912 ;;----------------------------------------------------------------------
6918 "Select an item in LIST with a popup menu.
6919 TITLE is the title to put atop the popup. If SORT is non-nil,
6920 sort the list before displaying."
6922 rtn menu)
6932 x)))
6933 list)))
6946 rtn))
6949 "Split the MENU into submenus of maximum length N."
6951 ;; No splitting needed
6952 menu
6967 nextmenu))
6969 nextmenu nil
6974 "Split the MENU into submenus of maximum length N."
6976 ;; No splitting needed
6977 menu
6993 nextmenu))
6995 nextmenu nil
6999 menu)))
7004 "Scroll the completion window on this frame."
7022 "Display the completions in LIST in the completions buffer and echo MESSAGE."
7030 list)
7033 ;; Store a special value in `this-command'. When `idlwave-complete'
7034 ;; finds this in `last-command', it will scroll the *Completions* buffer.
7037 ;; Mark the completions buffer as created by cib
7040 ;; Fontify the classes
7045 ;; Run the hook
7048 ;; Display the message
7052 "Call FUNCTION as a completion chooser and pass ARGS to it."
7058 ;; For the shell, remove the fontification of the word before point
7073 "Restore the old (before completion) window configuration."
7075 idlwave-before-completion-wconf
7079 "Make the user select an element from the alist in the variable SYM.
7080 The keys of the alist are expected to be strings. The function returns the
7081 car of the selected association.
7082 To do this, PROMPT is displayed and the user must hit a letter key to
7083 select an entry. If the user does not reply within DELAY seconds, a help
7084 window with the options is displayed automatically.
7085 The key which is associated with each option is generated automatically.
7087 If these don't exist, a letter in the string is automatically selected."
7091 keys-alist char)
7092 ;; First check the cache
7095 ;; Need to make new list
7099 ;; Display prompt and wait for quick reply
7104 ;; No quick reply: Show help
7110 keys-alist))
7114 ;; Return the selected result
7117 ;; Used for, e.g., electric debug super-examine.
7119 "Make an alist for single key selection."
7127 ;; First check if the configuration predetermined a key
7134 ;; Then check for capital letters
7144 t t name))
7147 ;; Now check for lowercase letters
7157 t t name))
7160 ;; Bummer, nothing found! Use a stupid number
7167 "Set the buffer-local value of VAR in BUFFER to VALUE."
7172 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
7177 ;; In XEmacs, we can use :activate-callback directly to advice the
7178 ;; choose functions. We use the private keymap only for the online
7179 ;; help feature.
7188 cl-args))
7197 "Execute `default-choose-completion' and then restore the win-conf."
7201 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7204 (define-key new-map [button3] (lambda ()
7205 (interactive)
7206 (setq this-command last-command)))
7207 new-map))
7209 ;; In Emacs we also replace keybindings in the completion
7210 ;; map in order to install our wrappers.
7212 (defun idlwave-display-completion-list-emacs (list)
7213 "Display completion list and install the choose wrappers."
7214 (with-output-to-temp-buffer "*Completions*"
7215 (display-completion-list list))
7216 (with-current-buffer "*Completions*"
7217 (use-local-map
7218 (or idlwave-completion-map
7219 (setq idlwave-completion-map
7220 (idlwave-make-modified-completion-map-emacs
7221 (current-local-map)))))))
7223 (defun idlwave-make-modified-completion-map-emacs (old-map)
7224 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7225 (let ((new-map (copy-keymap old-map)))
7226 (substitute-key-definition
7227 'choose-completion 'idlwave-choose-completion new-map)
7228 (substitute-key-definition
7229 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
7230 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
7231 new-map))
7233 (defun idlwave-choose-completion (&rest args)
7234 "Choose the completion that point is in or next to."
7235 (interactive)
7236 (apply 'idlwave-choose 'choose-completion args))
7238 (defun idlwave-mouse-choose-completion (&rest args)
7239 "Click on an alternative in the `*Completions*' buffer to choose it."
7240 (interactive "e")
7241 (apply 'idlwave-choose 'mouse-choose-completion args))
7243 ;;----------------------------------------------------------------------
7244 ;;----------------------------------------------------------------------
7246 ;;; ------------------------------------------------------------------------
7247 ;;; Stucture parsing code, and code to manage class info
7249 ;;
7250 ;; - Go again over the documentation how to write a completion
7251 ;; plugin. It is in self.el, but currently still very bad.
7252 ;; This could be in a separate file in the distribution, or
7253 ;; in an appendix for the manual.
7255 (defvar idlwave-struct-skip
7257 "Regexp for skipping continued blank or comment-only lines in structures.")
7259 (defvar idlwave-struct-tag-regexp
7260 (concat "[{,]" ;leading comma/brace
7261 idlwave-struct-skip ; 4 groups
7264 "Regexp for structure tags.")
7266 (defun idlwave-struct-tags ()
7267 "Return a list of all tags in the structure defined at point.
7268 Point is expected just before the opening `{' of the struct definition."
7269 (save-excursion
7270 (let* ((borders (idlwave-struct-borders))
7271 (beg (car borders))
7272 (end (cdr borders))
7273 tags)
7274 (goto-char beg)
7275 (save-restriction
7276 (narrow-to-region beg end)
7277 (while (re-search-forward idlwave-struct-tag-regexp end t)
7278 ;; Check if we are still on the top level of the structure.
7279 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7280 (= (point) beg))
7281 (push (match-string-no-properties 5) tags))
7282 (goto-char (match-end 0))))
7283 (nreverse tags))))
7285 (defun idlwave-find-struct-tag (tag)
7286 "Find a given TAG in the structure defined at point."
7287 (let* ((borders (idlwave-struct-borders))
7288 (end (cdr borders))
7289 (case-fold-search t))
7291 end t)))
7293 (defun idlwave-struct-inherits ()
7294 "Return a list of all `inherits' names in the struct at point.
7295 Point is expected just before the opening `{' of the struct definition."
7296 (save-excursion
7297 (let* ((borders (idlwave-struct-borders))
7298 (beg (car borders))
7299 (end (cdr borders))
7300 (case-fold-search t)
7301 names)
7302 (goto-char beg)
7303 (save-restriction
7304 (narrow-to-region beg end)
7305 (while (re-search-forward
7306 (concat "[{,]" ;leading comma/brace
7307 idlwave-struct-skip ; 4 groups
7308 "inherits" ; The INHERITS tag
7309 idlwave-struct-skip ; 4 more
7311 end t)
7312 ;; Check if we are still on the top level of the structure.
7313 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7314 (= (point) beg))
7315 (push (match-string-no-properties 9) names))
7316 (goto-char (match-end 0))))
7317 (nreverse names))))
7319 (defun idlwave-in-structure ()
7320 "Return t if point is inside an IDL structure definition."
7321 (let ((beg (point)))
7322 (save-excursion
7323 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
7324 (if (idlwave-find-structure-definition nil nil 'back)
7325 (let ((borders (idlwave-struct-borders)))
7326 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
7327 (and (> beg (car borders)) (< beg (cdr borders))))))))))
7329 (defun idlwave-struct-borders ()
7330 "Return the borders of the {...} after point as a cons cell."
7331 (let (beg)
7332 (save-excursion
7333 (skip-chars-forward "^{")
7334 (setq beg (point))
7335 (condition-case nil (forward-list 1)
7336 (error (goto-char beg)))
7337 (cons beg (point)))))
7339 (defun idlwave-find-structure-definition (&optional var name bound)
7340 "Search forward for a structure definition.
7341 If VAR is non-nil, search for a structure assigned to variable VAR.
7342 If NAME is non-nil, search for a named structure NAME, if a string,
7343 or a generic named structure otherwise. If BOUND is an integer, limit
7344 the search. If BOUND is the symbol `all', we search first back and
7345 then forward through the entire file. If BOUND is the symbol `back'
7346 we search only backward."
7348 (case-fold-search t)
7349 (lim (if (integerp bound) bound nil))
7350 (re (concat
7351 (if var
7355 (if name
7356 (if (stringp name)
7358 ;; Just a generic name
7360 ""))))
7361 (if (or (and (or (eq bound 'all) (eq bound 'back))
7362 (re-search-backward re nil t))
7363 (and (not (eq bound 'back)) (re-search-forward re lim t)))
7364 (progn
7365 (goto-char (match-beginning 3))
7366 (match-string-no-properties 5)))))
7368 (defvar idlwave-class-info nil)
7369 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
7371 (add-hook 'idlwave-update-rinfo-hook
7372 (lambda () (setq idlwave-class-reset t)))
7373 (add-hook 'idlwave-after-load-rinfo-hook
7374 (lambda () (setq idlwave-class-info nil)))
7376 (defun idlwave-class-info (class)
7377 (let (list entry)
7378 (if idlwave-class-info
7379 (if idlwave-class-reset
7380 (setq
7381 idlwave-class-reset nil
7382 idlwave-class-info ; Remove any visited in a buffer
7383 (delq nil (mapcar
7384 (lambda (x)
7385 (let ((filebuf
7386 (idlwave-class-file-or-buffer
7387 (or (cdr (assq 'found-in x)) (car x)))))
7388 (if (cdr filebuf)
7389 nil
7390 x)))
7391 idlwave-class-info))))
7392 ;; Info is nil, put in the system stuff to start.
7393 (setq idlwave-class-info idlwave-system-class-info)
7394 (setq list idlwave-class-info)
7395 (while (setq entry (pop list))
7396 (idlwave-sintern-class-info entry)))
7397 (setq class (idlwave-sintern-class class))
7398 (or (assq class idlwave-class-info)
7399 (progn (idlwave-scan-class-info class)
7400 (assq class idlwave-class-info)))))
7402 (defun idlwave-sintern-class-info (entry)
7403 "Sintern the class names in a class-info entry."
7404 (let ((inherits (assq 'inherits entry)))
7405 (setcar entry (idlwave-sintern-class (car entry) 'set))
7406 (if inherits
7407 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
7408 (cdr inherits))))))
7410 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
7411 "Find class structure definition(s).
7412 If ALL-HOOK is set, find all named structure definitions in a given
7413 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
7414 set, look for the name__define pro, and inside of it, for the ALT-CLASS
7415 class/struct definition."
7416 (let ((case-fold-search t) end-lim name)
7417 (when (re-search-forward
7419 (if all-hook
7420 (progn
7421 ;; For everything there
7422 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
7423 (while (setq name
7424 (idlwave-find-structure-definition nil t end-lim))
7425 (funcall all-hook name)))
7426 (idlwave-find-structure-definition nil (or alt-class class))))))
7429 (defun idlwave-class-file-or-buffer (class)
7430 "Find buffer visiting CLASS definition."
7431 (let* ((pro (concat (downcase class) "__define"))
7432 (file (idlwave-routine-source-file
7433 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
7434 (idlwave-routines))))))
7435 (cons file (if file (idlwave-get-buffer-visiting file)))))
7438 (defun idlwave-scan-class-info (class)
7439 "Scan all class and named structure info in the class__define pro."
7440 (let* ((idlwave-auto-routine-info-updates nil)
7441 (filebuf (idlwave-class-file-or-buffer class))
7442 (file (car filebuf))
7443 (buf (cdr filebuf))
7444 (class (idlwave-sintern-class class)))
7445 (if (or
7446 (not file)
7447 (and ;; neither a regular file nor a visited buffer
7448 (not buf)
7449 (not (file-regular-p file))))
7450 nil ; Cannot find the file/buffer to get any info
7451 (save-excursion
7452 (if buf (set-buffer buf)
7453 ;; Read the file in temporarily
7454 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
7455 (erase-buffer)
7456 (unless (eq major-mode 'idlwave-mode)
7457 (idlwave-mode))
7458 (insert-file-contents file))
7459 (save-excursion
7460 (goto-char 1)
7461 (idlwave-find-class-definition class
7462 ;; Scan all of the structures found there
7463 (lambda (name)
7464 (let* ((this-class (idlwave-sintern-class name))
7465 (entry
7466 (list this-class
7467 (cons 'tags (idlwave-struct-tags))
7468 (cons 'inherits (idlwave-struct-inherits)))))
7469 (if (not (eq this-class class))
7470 (setq entry (nconc entry (list (cons 'found-in class)))))
7471 (idlwave-sintern-class-info entry)
7472 (push entry idlwave-class-info)))))))))
7474 (defun idlwave-class-found-in (class)
7475 "Return the FOUND-IN property of the CLASS."
7476 (cdr (assq 'found-in (idlwave-class-info class))))
7477 (defun idlwave-class-tags (class)
7478 "Return the native tags in CLASS."
7479 (cdr (assq 'tags (idlwave-class-info class))))
7480 (defun idlwave-class-inherits (class)
7481 "Return the direct superclasses of CLASS."
7482 (cdr (assq 'inherits (idlwave-class-info class))))
7485 (defun idlwave-all-class-tags (class)
7486 "Return a list of native and inherited tags in CLASS."
7487 (condition-case err
7488 (apply 'append (mapcar 'idlwave-class-tags
7489 (cons class (idlwave-all-class-inherits class))))
7490 (error
7491 (idlwave-class-tag-reset)
7492 (error "%s" (error-message-string err)))))
7495 (defun idlwave-all-class-inherits (class)
7496 "Return a list of all superclasses of CLASS (recursively expanded).
7497 The list is cached in `idlwave-class-info' for faster access."
7498 (cond
7499 ((not idlwave-support-inheritance) nil)
7500 ((eq class nil) nil)
7501 ((eq class t) nil)
7502 (t
7503 (let ((info (idlwave-class-info class))
7504 entry)
7505 (if (setq entry (assq 'all-inherits info))
7506 (cdr entry)
7507 ;; Save the depth of inheritance scan to check for circular references
7508 (let ((inherits (mapcar (lambda (x) (cons x 0))
7509 (idlwave-class-inherits class)))
7510 rtn all-inherits cl)
7511 (while inherits
7512 (setq cl (pop inherits)
7513 rtn (cons (car cl) rtn)
7514 inherits (append (mapcar (lambda (x)
7515 (cons x (1+ (cdr cl))))
7516 (idlwave-class-inherits (car cl)))
7517 inherits))
7518 (if (> (cdr cl) 999)
7519 (error
7520 "Class scan: inheritance depth exceeded. Circular inheritance?")
7521 ))
7522 (setq all-inherits (nreverse rtn))
7523 (nconc info (list (cons 'all-inherits all-inherits)))
7524 all-inherits))))))
7526 (defun idlwave-entry-keywords (entry &optional record-link)
7527 "Return the flat entry keywords alist from routine-info entry.
7528 If RECORD-LINK is non-nil, the keyword text is copied and a text
7529 property indicating the link is added."
7530 (let (kwds)
7531 (mapc
7532 (lambda (key-list)
7533 (let ((file (car key-list)))
7534 (mapcar (lambda (key-cons)
7535 (let ((key (car key-cons))
7536 (link (cdr key-cons)))
7537 (when (and record-link file)
7538 (setq key (copy-sequence key))
7539 (put-text-property
7540 0 (length key)
7541 'link
7542 (concat
7543 file
7544 (if link
7545 (concat idlwave-html-link-sep
7546 (number-to-string link))))
7547 key))
7548 (push (list key) kwds)))
7549 (cdr key-list))))
7550 (nthcdr 5 entry))
7551 (nreverse kwds)))
7553 (defun idlwave-entry-find-keyword (entry keyword)
7554 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set."
7555 (catch 'exit
7556 (mapc
7557 (lambda (key-list)
7558 (let ((file (car key-list))
7559 (kwd (assoc keyword (cdr key-list))))
7560 (when kwd
7561 (setq kwd (cons (car kwd)
7562 (if (and file (cdr kwd))
7563 (concat file
7564 idlwave-html-link-sep
7565 (number-to-string (cdr kwd)))
7566 (cdr kwd))))
7567 (throw 'exit kwd))))
7568 (nthcdr 5 entry))))
7570 ;;==========================================================================
7571 ;;
7572 ;; Completing class structure tags. This is a completion plugin.
7573 ;; The necessary taglist is constructed dynamically
7575 (defvar idlwave-current-tags-class nil)
7576 (defvar idlwave-current-class-tags nil)
7577 (defvar idlwave-current-native-class-tags nil)
7578 (defvar idlwave-sint-class-tags nil)
7579 (declare-function idlwave-sintern-class-tag "idlwave" t t)
7580 (idlwave-new-sintern-type 'class-tag)
7581 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7582 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7584 (defun idlwave-complete-class-structure-tag ()
7585 "Complete a structure tag on a `self' argument in an object method."
7586 (interactive)
7587 (let ((pos (point))
7588 (case-fold-search t))
7589 (if (save-excursion
7590 ;; Check if the context is right
7591 (skip-chars-backward "a-zA-Z0-9._$")
7592 (and (< (point) (- pos 4))
7594 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7595 (super-classes (idlwave-all-class-inherits class-selector)))
7596 ;; Check if we are in a class routine
7597 (unless class-selector
7598 (error "Not in a method procedure or function"))
7599 ;; Check if we need to update the "current" class
7600 (if (not (equal class-selector idlwave-current-tags-class))
7601 (idlwave-prepare-class-tag-completion class-selector))
7602 (setq idlwave-completion-help-info
7603 (list 'idlwave-complete-class-structure-tag-help
7604 (idlwave-sintern-routine
7605 (concat class-selector "__define"))
7606 nil))
7607 ;; FIXME: idlwave-cpl-bold doesn't seem used anywhere.
7608 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7609 (idlwave-complete-in-buffer
7610 'class-tag 'class-tag
7611 idlwave-current-class-tags nil
7612 (format "Select a tag of class %s" class-selector)
7613 "class tag"
7614 'idlwave-attach-class-tag-classes))
7615 t) ; return t to skip other completions
7616 nil)))
7618 (defun idlwave-class-tag-reset ()
7619 (setq idlwave-current-tags-class nil))
7621 (defun idlwave-prepare-class-tag-completion (class)
7622 "Find and parse the necessary class definitions for class structure tags."
7623 (setq idlwave-sint-class-tags nil)
7624 (setq idlwave-current-tags-class class)
7625 (setq idlwave-current-class-tags
7626 (mapcar (lambda (x)
7627 (list (idlwave-sintern-class-tag x 'set)))
7628 (idlwave-all-class-tags class)))
7629 (setq idlwave-current-native-class-tags
7630 (mapcar 'downcase (idlwave-class-tags class))))
7632 ;===========================================================================
7633 ;;
7634 ;; Completing system variables and their structure fields
7635 ;; This is also a plugin.
7637 (defvar idlwave-sint-sysvars nil)
7638 (defvar idlwave-sint-sysvartags nil)
7639 (declare-function idlwave-sintern-sysvar "idlwave" t t)
7640 (declare-function idlwave-sintern-sysvartag "idlwave" t t)
7641 (idlwave-new-sintern-type 'sysvar)
7642 (idlwave-new-sintern-type 'sysvartag)
7643 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7644 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7645 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7648 (defun idlwave-complete-sysvar-or-tag ()
7649 "Complete a system variable."
7650 (interactive)
7651 (let ((pos (point))
7652 (case-fold-search t))
7653 (cond ((save-excursion
7654 ;; Check if the context is right for system variable
7655 (skip-chars-backward "[a-zA-Z0-9_$]")
7656 (equal (char-before) ?!))
7657 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7658 (idlwave-complete-in-buffer 'sysvar 'sysvar
7659 idlwave-system-variables-alist nil
7660 "Select a system variable"
7661 "system variable")
7662 t) ; return t to skip other completions
7663 ((save-excursion
7664 ;; Check if the context is right for sysvar tag
7665 (skip-chars-backward "a-zA-Z0-9_$.")
7666 (and (equal (char-before) ?!)
7668 (<= (match-end 0) pos)))
7669 ;; Complete a system variable tag
7670 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7671 (entry (assq var idlwave-system-variables-alist))
7672 (tags (cdr (assq 'tags entry))))
7673 (or entry (error "!%s is not a known system variable" var))
7674 (or tags (error "System variable !%s is not a structure" var))
7675 (setq idlwave-completion-help-info
7676 (list 'idlwave-complete-sysvar-tag-help var))
7677 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7678 tags nil
7679 "Select a system variable tag"
7680 "system variable tag")
7681 t)) ; return t to skip other completions
7682 (t nil))))
7684 (defvar link) ;dynamic variables set by help callback
7685 (defvar props)
7686 (defun idlwave-complete-sysvar-help (mode word)
7687 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7688 (entry (assoc word idlwave-system-variables-alist)))
7689 (cond
7690 ((eq mode 'test)
7691 (and (stringp word) entry (nth 1 (assq 'link entry))))
7692 ((eq mode 'set)
7693 (if entry (setq link (nth 1 (assq 'link entry))))) ;; setting dynamic!!!
7694 (t (error "This should not happen")))))
7696 (defun idlwave-complete-sysvar-tag-help (mode word)
7697 (let* ((var (nth 1 idlwave-completion-help-info))
7698 (entry (assoc var idlwave-system-variables-alist))
7699 (tags (cdr (assq 'tags entry)))
7700 (main (nth 1 (assq 'link entry)))
7701 target)
7702 (cond
7703 ((eq mode 'test) ; we can at least link the main
7704 (and (stringp word) entry main))
7705 ((eq mode 'set)
7706 (if entry
7707 (setq link
7708 (if (setq target (cdr (assoc-string word tags t)))
7709 (idlwave-substitute-link-target main target)
7710 main)))) ;; setting dynamic!!!
7711 (t (error "This should not happen")))))
7713 (defun idlwave-split-link-target (link)
7714 "Split a given LINK into link file and anchor."
7715 (if (string-match idlwave-html-link-sep link)
7716 (cons (substring link 0 (match-beginning 0))
7717 (string-to-number (substring link (match-end 0))))))
7719 (defun idlwave-substitute-link-target (link target)
7720 "Substitute the TARGET anchor for the given LINK."
7721 (let (main-base)
7722 (setq main-base (if (string-match "#" link)
7723 (substring link 0 (match-beginning 0))
7724 link))
7725 (if target
7726 (concat main-base idlwave-html-link-sep (number-to-string target))
7727 link)))
7729 ;; Fake help in the source buffer for class structure tags.
7730 ;; KWD AND NAME ARE GLOBAL-VARIABLES HERE.
7731 (defvar name)
7732 (defvar kwd)
7733 (defvar idlwave-help-do-class-struct-tag nil)
7734 (defun idlwave-complete-class-structure-tag-help (mode word)
7735 (cond
7736 ((eq mode 'test) ; nothing gets fontified for class tags
7737 nil)
7738 ((eq mode 'set)
7739 (let (class-with found-in)
7740 (when (setq class-with
7741 (idlwave-class-or-superclass-with-tag
7742 idlwave-current-tags-class
7743 word))
7744 (if (assq (idlwave-sintern-class class-with)
7745 idlwave-system-class-info)
7746 (error "No help available for system class tags"))
7747 (if (setq found-in (idlwave-class-found-in class-with))
7748 (setq name (cons (concat found-in "__define") class-with))
7749 (setq name (concat class-with "__define")))))
7750 (setq kwd word
7751 idlwave-help-do-class-struct-tag t))
7752 (t (error "This should not happen"))))
7754 (defun idlwave-class-or-superclass-with-tag (class tag)
7755 "Find and return the CLASS or one of its superclass with the
7756 associated TAG, if any."
7757 (let ((sclasses (cons class (idlwave-all-class-inherits class)))
7758 cl)
7759 (catch 'exit
7760 (while sclasses
7761 (setq cl (pop sclasses))
7762 (let ((tags (idlwave-class-tags cl)))
7763 (while tags
7764 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7765 (throw 'exit cl))
7766 (setq tags (cdr tags))))))))
7769 (defun idlwave-sysvars-reset ()
7770 (if (and (fboundp 'idlwave-shell-is-running)
7771 (idlwave-shell-is-running)
7772 idlwave-idlwave_routine_info-compiled)
7773 (idlwave-shell-send-command "idlwave_get_sysvars"
7774 'idlwave-process-sysvars 'hide)))
7776 (defun idlwave-process-sysvars ()
7777 (idlwave-shell-filter-sysvars)
7778 (setq idlwave-sint-sysvars nil
7779 idlwave-sint-sysvartags nil)
7780 (idlwave-sintern-sysvar-alist))
7782 (defun idlwave-sintern-sysvar-alist ()
7783 (let ((list idlwave-system-variables-alist) entry tags)
7784 (while (setq entry (pop list))
7785 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7786 (setq tags (assq 'tags entry))
7787 (if tags
7788 (setcdr tags
7789 (mapcar (lambda (x)
7790 (cons (idlwave-sintern-sysvartag (car x) 'set)
7791 (cdr x)))
7792 (cdr tags)))))))
7794 (defvar idlwave-shell-command-output)
7795 (defun idlwave-shell-filter-sysvars ()
7796 "Get any new system variables and tags."
7797 (let ((text idlwave-shell-command-output)
7798 (start 0)
7799 (old idlwave-system-variables-alist)
7800 var tags type name class link old-entry)
7801 (setq idlwave-system-variables-alist nil)
7803 text start)
7804 (setq start (match-end 0)
7805 var (match-string 1 text)
7806 tags (if (match-end 3)
7807 (idlwave-split-string (match-string 3 text))))
7808 ;; Maintain old links, if present
7809 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7810 (setq link (assq 'link old-entry))
7811 (setq idlwave-system-variables-alist
7812 (cons (list var
7813 (cons
7814 'tags
7815 (mapcar (lambda (x)
7816 (cons x
7817 (cdr (assq
7818 (idlwave-sintern-sysvartag x)
7819 (cdr (assq 'tags old-entry))))))
7820 tags)) link)
7821 idlwave-system-variables-alist)))
7822 ;; Keep the old value if query was not successful
7823 (setq idlwave-system-variables-alist
7824 (or idlwave-system-variables-alist old))))
7826 (defun idlwave-completion-fontify-classes ()
7827 "Goto the *Completions* buffer and fontify the class info."
7828 (when (featurep 'font-lock)
7829 (with-current-buffer "*Completions*"
7830 (save-excursion
7831 (goto-char (point-min))
7832 (let ((buffer-read-only nil))
7834 (put-text-property (match-beginning 0) (match-end 0)
7835 'face 'font-lock-string-face)))))))
7837 (defun idlwave-uniquify (list)
7838 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7839 (delq nil
7840 (mapcar (lambda (x)
7841 (unless (gethash x ht)
7842 (puthash x t ht)
7843 x))
7844 list))))
7846 (defun idlwave-after-successful-completion (type slash &optional verify)
7847 "Add `=' or `(' after successful completion of keyword and function.
7848 Restore the pre-completion window configuration if possible."
7849 (cond
7850 ((eq type 'procedure)
7851 nil)
7852 ((eq type 'function)
7853 (cond
7854 ((equal idlwave-function-completion-adds-paren nil) nil)
7855 ((or (equal idlwave-function-completion-adds-paren t)
7856 (equal idlwave-function-completion-adds-paren 1))
7857 (insert "("))
7858 ((equal idlwave-function-completion-adds-paren 2)
7859 (insert "()")
7860 (backward-char 1))
7861 (t nil)))
7862 ((eq type 'keyword)
7863 (if (and idlwave-keyword-completion-adds-equal
7864 (not slash))
7865 (progn (insert "=") t)
7866 nil)))
7868 ;; Restore the pre-completion window configuration if this is safe.
7870 (if (or (eq verify 'force) ; force
7871 (and
7872 (get-buffer-window "*Completions*") ; visible
7873 (idlwave-local-value 'idlwave-completion-p
7874 "*Completions*") ; cib-buffer
7875 (eq (marker-buffer idlwave-completion-mark)
7876 (current-buffer)) ; buffer OK
7877 (equal (marker-position idlwave-completion-mark)
7878 verify))) ; pos OK
7879 (idlwave-restore-wconf-after-completion))
7880 (move-marker idlwave-completion-mark nil)
7881 (setq idlwave-before-completion-wconf nil))
7883 (defun idlwave-mouse-context-help (ev &optional arg)
7884 "Call `idlwave-context-help' on the clicked location."
7885 (interactive "eP")
7886 (mouse-set-point ev)
7887 (idlwave-context-help arg))
7889 (defvar idlwave-last-context-help-pos nil)
7890 (defun idlwave-context-help (&optional arg)
7891 "Display IDL Online Help on context.
7892 If point is on a keyword, help for that keyword will be shown. If
7893 point is on a routine name or in the argument list of a routine, help
7894 for that routine will be displayed. Works for system routines and
7895 keywords, it pulls up text help. For other routies and keywords,
7896 visits the source file, finding help in the header (if
7897 `idlwave-help-source-try-header' is non-nil) or the routine definition
7898 itself."
7899 (interactive "P")
7900 (idlwave-do-context-help arg))
7902 (defun idlwave-mouse-completion-help (ev)
7903 "Display online help about the completion at point."
7904 (interactive "eP")
7905 ;; Restore last-command for next command, to make
7906 ;; scrolling/cancelling of completions work.
7907 (setq this-command last-command)
7908 (idlwave-do-mouse-completion-help ev))
7910 (defun idlwave-routine-info (&optional arg external)
7911 "Display a routines calling sequence and list of keywords.
7912 When point is on the name a function or procedure, or in the argument
7913 list of a function or procedure, this command displays a help buffer with
7914 the information. When called with prefix arg, enforce class query.
7916 When point is on an object operator `->', display the class stored in
7917 this arrow, if any (see `idlwave-store-inquired-class'). With a prefix
7918 arg, the class property is cleared out."
7920 (interactive "P")
7921 (idlwave-routines)
7922 (if (string-match "->" (buffer-substring
7923 (max (point-min) (1- (point)))
7924 (min (+ 2 (point)) (point-max))))
7925 ;; Cursor is on an arrow
7926 (if (get-text-property (point) 'idlwave-class)
7927 ;; arrow has class property
7928 (if arg
7929 ;; Remove property
7930 (save-excursion
7931 (backward-char 1)
7933 (remove-text-properties (match-beginning 1) (match-end 1)
7934 '(idlwave-class nil face nil))
7935 (message "Class property removed from arrow")))
7936 ;; Echo class property
7937 (message "Arrow has text property identifying object to be class %s"
7938 (get-text-property (point) 'idlwave-class)))
7939 ;; No property found
7940 (message "Arrow has no class text property"))
7942 ;; Not on an arrow...
7943 (let* ((idlwave-query-class nil)
7944 (idlwave-force-class-query (equal arg '(4)))
7945 (module (idlwave-what-module)))
7946 (if (car module)
7947 (apply 'idlwave-display-calling-sequence
7948 (idlwave-fix-module-if-obj_new module))
7949 (error "Don't know which calling sequence to show")))))
7951 (defun idlwave-resolve (&optional arg)
7952 "Call RESOLVE_ROUTINE on the module name at point.
7953 Like `idlwave-routine-info', this looks for a routine call at point.
7954 After confirmation in the minibuffer, it will use the shell to issue
7955 a RESOLVE call for this routine, to attempt to make it defined and its
7956 routine info available for IDLWAVE. If the routine is a method call,
7957 both `class__method' and `class__define' will be tried.
7958 With ARG, enforce query for the class of object methods."
7959 (interactive "P")
7960 (let* ((idlwave-query-class nil)
7961 (idlwave-force-class-query (equal arg '(4)))
7962 (module (idlwave-what-module))
7963 (name (idlwave-make-full-name (nth 2 module) (car module)))
7964 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7965 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7966 (kwd "")
7967 class)
7969 resolve)
7970 (setq type (match-string 1 resolve)
7971 class (if (match-beginning 2)
7972 (match-string 3 resolve)
7973 nil)
7974 name (match-string 4 resolve)))
7975 (if (string= (downcase type) "function")
7976 (setq kwd ",/is_function"))
7978 (cond
7979 ((null class)
7980 (idlwave-shell-send-command
7981 (format "resolve_routine,'%s'%s" (downcase name) kwd)
7982 'idlwave-update-routine-info
7983 nil t))
7984 (t
7985 (idlwave-shell-send-command
7986 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
7987 (list 'idlwave-shell-send-command
7988 (format "resolve_routine,'%s__%s'%s"
7989 (downcase class) (downcase name) kwd)
7990 '(idlwave-update-routine-info)
7991 nil t))))))
7993 (defun idlwave-find-module-this-file ()
7994 (interactive)
7995 (idlwave-find-module '(4)))
7997 (defun idlwave-find-module (&optional arg)
7998 "Find the source code of an IDL module.
7999 Works for modules for which IDLWAVE has routine info available.
8000 The function offers as default the module name `idlwave-routine-info'
8001 would use. With ARG limit to this buffer. With two prefix ARG's
8002 force class query for object methods."
8003 (interactive "P")
8004 (let* ((idlwave-query-class nil)
8005 (idlwave-force-class-query (equal arg '(16)))
8006 (this-buffer (equal arg '(4)))
8007 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
8008 (default (if module
8009 (concat (idlwave-make-full-name
8010 (nth 2 module) (car module))
8011 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
8012 "none"))
8013 (list
8014 (idlwave-uniquify
8015 (delq nil
8016 (mapcar (lambda (x)
8017 (if (eq 'system (car-safe (nth 3 x)))
8018 ;; Take out system routines with no source.
8019 nil
8020 (list
8021 (concat (idlwave-make-full-name
8022 (nth 2 x) (car x))
8023 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
8024 (if this-buffer
8025 (idlwave-save-buffer-update)
8026 (idlwave-routines))))))
8027 (name (idlwave-completing-read
8028 (if (or (not this-buffer)
8029 (assoc default list))
8030 (format "Module (Default %s): " default)
8031 (format "Module in this file: "))
8032 list))
8033 type class)
8035 ;; Nothing, use the default.
8036 (setq name default))
8037 (if (string-match "<[fp]>" name)
8038 (setq type (substring name -2 -1)
8039 name (substring name 0 -3)))
8041 (setq class (match-string 1 name)
8042 name (match-string 2 name)))
8043 (setq name (idlwave-sintern-routine-or-method name class)
8044 class (idlwave-sintern-class class)
8045 type (cond ((equal type "f") 'fun)
8046 ((equal type "p") 'pro)
8047 (t t)))
8048 (idlwave-do-find-module name type class nil this-buffer)))
8050 (defun idlwave-do-find-module (name type class
8051 &optional force-source this-buffer)
8052 (let ((name1 (idlwave-make-full-name class name))
8053 source buf1 entry
8054 (buf (current-buffer))
8055 (pos (point))
8056 file name2)
8057 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
8058 'WITH-FILE)
8059 source (or force-source (nth 3 entry))
8060 name2 (if (nth 2 entry)
8061 (idlwave-make-full-name (nth 2 entry) name)
8062 name1))
8063 (if source
8064 (setq file (idlwave-routine-source-file source)))
8065 (unless file ; Try to find it on the path.
8066 (setq file
8067 (idlwave-expand-lib-file-name
8068 (if class
8069 (format "%s__define.pro" (downcase class))
8070 (format "%s.pro" (downcase name))))))
8071 (cond
8072 ((or (null name) (equal name ""))
8073 (error "Abort"))
8074 ((eq (car source) 'system)
8075 (error "Source code for system routine %s is not available"
8076 name2))
8077 ((or (not file) (not (file-regular-p file)))
8078 (error "Source code for routine %s is not available"
8079 name2))
8080 (t
8081 (when (not this-buffer)
8082 (setq buf1
8083 (idlwave-find-file-noselect file 'find))
8084 (pop-to-buffer buf1 t))
8085 (goto-char (point-max))
8086 (let ((case-fold-search t))
8087 (if (re-search-backward
8089 (cond ((eq type 'fun) "function")
8090 ((eq type 'pro) "pro")
8093 (regexp-quote (downcase name2))
8094 "[^a-zA-Z0-9_$]")
8095 nil t)
8096 (goto-char (match-beginning 0))
8097 (pop-to-buffer buf)
8098 (goto-char pos)
8099 (error "Could not find routine %s" name2)))))))
8101 (defun idlwave-what-module ()
8102 "Return a default module for stuff near point.
8103 Used by `idlwave-routine-info' and `idlwave-find-module'."
8104 (idlwave-routines)
8105 (if (let ((case-fold-search t))
8106 (save-excursion
8107 (idlwave-beginning-of-statement)
8108 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
8109 ;; This is a function or procedure definition statement
8110 ;; We return the defined routine as module.
8111 (list
8112 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
8113 (match-string-no-properties 2))
8114 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
8115 (idlwave-sintern-class (match-string 3)))
8117 ;; Not a definition statement - analyze precise position.
8118 (let* ((where (idlwave-where))
8119 (cw (nth 2 where))
8120 (pro (car (nth 0 where)))
8121 (func (car (nth 1 where)))
8122 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
8123 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
8124 (following-char)))
8125 )
8126 (cond
8127 ((and (eq cw 'procedure)
8128 (not (equal this-word "")))
8129 (setq this-word (idlwave-sintern-routine-or-method
8130 this-word (nth 2 (nth 3 where))))
8131 (list this-word 'pro
8132 (idlwave-determine-class
8133 (cons this-word (cdr (nth 3 where)))
8134 'pro)))
8135 ((and (eq cw 'function)
8136 (not (equal this-word ""))
8137 (or (eq next-char ?\() ; exclude arrays, vars.
8139 (setq this-word (idlwave-sintern-routine-or-method
8140 this-word (nth 2 (nth 3 where))))
8141 (list this-word 'fun
8142 (idlwave-determine-class
8143 (cons this-word (cdr (nth 3 where)))
8144 'fun)))
8145 ((and (memq cw '(function-keyword procedure-keyword))
8146 (not (equal this-word ""))
8147 (eq next-char ?\()) ; A function!
8148 (setq this-word (idlwave-sintern-routine this-word))
8149 (list this-word 'fun nil))
8150 (func
8151 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
8152 (pro
8153 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
8154 (t nil)))))
8156 (defun idlwave-what-module-find-class ()
8157 "Call `idlwave-what-module' and find the inherited class if necessary."
8158 (let* ((module (idlwave-what-module))
8159 (class (nth 2 module)))
8160 (if (and (= (length module) 3)
8161 (stringp class))
8162 (list (car module)
8163 (nth 1 module)
8164 (apply 'idlwave-find-inherited-class module))
8165 module)))
8167 (defun idlwave-find-inherited-class (name type class)
8168 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
8169 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
8170 (if entry
8171 (nth 2 entry)
8172 class)))
8174 (defun idlwave-fix-module-if-obj_new (module)
8175 "Check if MODULE points to obj_new.
8176 If yes, and if the cursor is in the keyword region, change to the
8177 appropriate Init method."
8178 (let* ((name (car module))
8179 (pos (point))
8180 (case-fold-search t)
8181 string)
8182 (if (and (stringp name)
8183 (equal (downcase name) "obj_new")
8184 (save-excursion
8185 (idlwave-beginning-of-statement)
8186 (setq string (buffer-substring (point) pos))
8188 string)))
8189 (let ((name "Init")
8190 (class (match-string 1 string)))
8191 (setq module (list (idlwave-sintern-method "Init")
8192 'fun
8193 (idlwave-sintern-class class)))))
8194 module))
8196 (defun idlwave-fix-keywords (name type class keywords
8197 &optional super-classes system)
8198 "Update a list of keywords.
8199 Translate OBJ_NEW, adding all super-class keywords, or all keywords
8200 from all classes if CLASS equals t. If SYSTEM is non-nil, don't
8201 demand _EXTRA in the keyword list."
8202 (let ((case-fold-search t))
8204 ;; If this is the OBJ_NEW function, try to figure out the class and use
8205 ;; the keywords from the corresponding INIT method.
8206 (if (and (equal (upcase name) "OBJ_NEW")
8207 (or (eq major-mode 'idlwave-mode)
8208 (eq major-mode 'idlwave-shell-mode)))
8209 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
8210 (string (buffer-substring bos (point)))
8211 (case-fold-search t)
8212 class)
8214 string)
8215 (setq class (idlwave-sintern-class (match-string 1 string)))
8216 (setq idlwave-current-obj_new-class class)
8217 (setq keywords
8218 (append keywords
8219 (idlwave-entry-keywords
8220 (idlwave-rinfo-assq
8221 (idlwave-sintern-method "INIT")
8222 'fun
8223 class
8224 (idlwave-routines)) 'do-link))))))
8226 ;; If the class is `t', combine all keywords of all methods NAME
8227 (when (eq class t)
8228 (mapc (lambda (entry)
8229 (and
8230 (nth 2 entry) ; non-nil class
8231 (eq (nth 1 entry) type) ; correct type
8232 (setq keywords
8233 (append keywords
8234 (idlwave-entry-keywords entry 'do-link)))))
8235 (idlwave-all-assq name (idlwave-routines)))
8236 (setq keywords (idlwave-uniquify keywords)))
8238 ;; If we have inheritance, add all keywords from superclasses, if
8239 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
8240 (when (and
8241 super-classes
8242 idlwave-keyword-class-inheritance
8243 (stringp class)
8244 (or
8245 system
8246 (assq (idlwave-sintern-keyword "_extra") keywords)
8247 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
8248 ;; Check if one of the keyword-class regexps matches the name
8249 (let ((regexps idlwave-keyword-class-inheritance) re)
8250 (catch 'exit
8251 (while (setq re (pop regexps))
8252 (if (string-match re name) (throw 'exit t))))))
8254 (loop for entry in (idlwave-routines) do
8255 (and (nth 2 entry) ; non-nil class
8256 (memq (nth 2 entry) super-classes) ; an inherited class
8257 (eq (nth 1 entry) type) ; correct type
8258 (eq (car entry) name) ; correct name
8259 (mapc (lambda (k) (add-to-list 'keywords k))
8260 (idlwave-entry-keywords entry 'do-link))))
8261 (setq keywords (idlwave-uniquify keywords)))
8263 ;; Return the final list
8264 keywords))
8266 (defun idlwave-expand-keyword (keyword module)
8267 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
8268 KEYWORD may be an exact match or an abbreviation of a keyword.
8269 If the match is exact, KEYWORD itself is returned, even if there may be other
8270 keywords of which KEYWORD is an abbreviation. This is necessary because some
8271 system routines have keywords which are prefixes of other keywords.
8272 If KEYWORD is an abbreviation of several keywords, a list of all possible
8273 completions is returned.
8274 If the abbreviation was unique, the correct keyword is returned.
8275 If it cannot be a keyword, the function return nil.
8276 If we do not know about MODULE, just return KEYWORD literally."
8277 (let* ((name (car module))
8278 (type (nth 1 module))
8279 (class (nth 2 module))
8280 (kwd (idlwave-sintern-keyword keyword))
8281 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
8282 (kwd-alist (idlwave-entry-keywords entry))
8283 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
8284 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
8285 (completion-ignore-case t)
8286 candidates)
8287 (cond ((assq kwd kwd-alist)
8288 kwd)
8289 ((setq candidates (all-completions kwd kwd-alist))
8290 (if (= (length candidates) 1)
8291 (car candidates)
8292 candidates))
8293 ((and entry extra)
8294 ;; Inheritance may cause this keyword to be correct
8295 keyword)
8296 (entry
8297 ;; We do know the function, which does not have the keyword.
8298 nil)
8299 (t
8300 ;; We do not know the function, so this just might be a correct
8301 ;; keyword - return it as it is.
8302 keyword))))
8304 (defvar idlwave-rinfo-mouse-map (make-sparse-keymap))
8305 (defvar idlwave-rinfo-map (make-sparse-keymap))
8306 (define-key idlwave-rinfo-mouse-map
8307 (if (featurep 'xemacs) [button2] [mouse-2])
8308 'idlwave-mouse-active-rinfo)
8309 (define-key idlwave-rinfo-mouse-map
8310 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
8311 'idlwave-mouse-active-rinfo-shift)
8312 (define-key idlwave-rinfo-mouse-map
8313 (if (featurep 'xemacs) [button3] [mouse-3])
8314 'idlwave-mouse-active-rinfo-right)
8315 (define-key idlwave-rinfo-mouse-map " " 'idlwave-active-rinfo-space)
8316 (define-key idlwave-rinfo-map "q" 'idlwave-quit-help)
8317 (define-key idlwave-rinfo-mouse-map "q" 'idlwave-quit-help)
8318 (defvar idlwave-popup-source nil)
8319 (defvar idlwave-rinfo-marker (make-marker))
8321 (defun idlwave-quit-help ()
8322 (interactive)
8323 (let ((ri-window (get-buffer-window "*Help*"))
8324 (olh-window (get-buffer-window "*IDLWAVE Help*")))
8325 (when (and olh-window
8326 (fboundp 'idlwave-help-quit))
8327 (select-window olh-window)
8328 (idlwave-help-quit))
8329 (when (window-live-p ri-window)
8330 (delete-window ri-window))))
8332 (defun idlwave-display-calling-sequence (name type class
8333 &optional initial-class)
8334 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
8335 (let* ((initial-class (or initial-class class))
8336 (entry (or (idlwave-best-rinfo-assq name type class
8337 (idlwave-routines))
8338 (idlwave-rinfo-assq name type class
8339 idlwave-unresolved-routines)))
8340 (name (or (car entry) name))
8341 (class (or (nth 2 entry) class))
8342 (superclasses (idlwave-all-class-inherits initial-class))
8343 (twins (idlwave-routine-twins entry))
8344 (dtwins (idlwave-study-twins twins))
8345 (all dtwins)
8346 (system (eq (car (nth 3 entry)) 'system))
8347 (calling-seq (nth 4 entry))
8348 (keywords (idlwave-entry-keywords entry 'do-link))
8349 (html-file (car (nth 5 entry)))
8350 (help-echo-kwd
8351 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
8352 (help-echo-use
8353 "Button2/3: Online Help")
8354 (help-echo-src
8355 "Button2: Jump to source and back | Button3: Source in Help window.")
8356 (help-echo-class
8357 "Button2: Display info about same method in superclass")
8358 (col 0)
8359 (data (list name type class (current-buffer) nil initial-class))
8360 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8361 (face 'idlwave-help-link)
8362 beg props win cnt total)
8363 ;; Fix keywords, but don't add chained super-classes, since these
8364 ;; are shown separately for that super-class
8365 (setq keywords (idlwave-fix-keywords name type class keywords))
8366 (cond
8367 ((null entry)
8368 (error "No %s %s known %s" type name
8369 (if initial-class (concat "in class " initial-class) "")))
8370 ((or (null name) (equal name ""))
8371 (error "No function or procedure call at point"))
8372 ((null calling-seq)
8373 (error "Calling sequence of %s %s not available" type name))
8374 (t
8375 (move-marker idlwave-rinfo-marker (point))
8376 (with-current-buffer (get-buffer-create "*Help*")
8377 (use-local-map idlwave-rinfo-map)
8378 (setq buffer-read-only nil)
8379 (erase-buffer)
8380 (set (make-local-variable 'idlwave-popup-source) nil)
8381 (set (make-local-variable 'idlwave-current-obj_new-class)
8382 idlwave-current-obj_new-class)
8383 (when superclasses
8384 (setq props (list 'mouse-face 'highlight
8385 km-prop idlwave-rinfo-mouse-map
8386 'help-echo help-echo-class
8387 'data (cons 'class data)))
8388 (let ((classes (cons initial-class superclasses)) c)
8389 (insert "Classes: ")
8390 (while (setq c (pop classes))
8391 (insert " ")
8392 (setq beg (point))
8393 (insert c)
8394 (if (equal (downcase c) (downcase class))
8395 (add-text-properties beg (point) (list 'face 'bold))
8396 ;; If Method exists in a different class link it
8397 (if (idlwave-rinfo-assq name type c (idlwave-routines))
8398 (add-text-properties beg (point) props))))
8400 (setq props (list 'mouse-face 'highlight
8401 km-prop idlwave-rinfo-mouse-map
8402 'help-echo help-echo-use
8403 'data (cons 'usage data)))
8404 (if html-file (setq props (append (list 'face face 'link html-file)
8405 props)))
8406 (insert "Usage: ")
8407 (setq beg (point))
8408 (insert (if class
8409 (format calling-seq class name class name class name)
8410 (format calling-seq name name name name))
8412 (add-text-properties beg (point) props)
8414 (insert "Keywords:")
8415 (if (null keywords)
8416 (insert " No keywords accepted.")
8417 (setq col 9)
8418 (mapc
8419 (lambda (x)
8420 (if (>= (+ col 1 (length (car x)))
8421 (window-width))
8422 (progn
8424 (setq col 9)))
8425 (insert " ")
8426 (setq beg (point)
8427 ;; Relevant keywords already have link property attached
8428 props (list 'mouse-face 'highlight
8429 km-prop idlwave-rinfo-mouse-map
8430 'data (cons 'keyword data)
8431 'help-echo help-echo-kwd
8432 'keyword (car x)))
8433 (if system (setq props (append (list 'face face) props)))
8434 (insert (car x))
8435 (add-text-properties beg (point) props)
8436 (setq col (+ col 1 (length (car x)))))
8437 keywords))
8439 (setq cnt 1 total (length all))
8440 ;; Here entry is (key file (list of type-conses))
8441 (while (setq entry (pop all))
8442 (setq props (list 'mouse-face 'highlight
8443 km-prop idlwave-rinfo-mouse-map
8444 'help-echo help-echo-src
8445 'source (list (car (car (nth 2 entry))) ;type
8446 (nth 1 entry)
8447 nil
8448 (cdr (car (nth 2 entry))))
8449 'data (cons 'source data)))
8450 (idlwave-insert-source-location
8452 (if (equal cnt 1)
8453 (if (> total 1) "Sources:" "Source:")
8454 "")
8455 (if (> total 1) "- " ""))
8456 entry props)
8457 (incf cnt)
8458 (when (and all (> cnt idlwave-rinfo-max-source-lines))
8459 ;; No more source lines, please
8460 (insert (format
8462 idlwave-rinfo-max-source-lines))
8463 (setq all nil)))
8464 (goto-char (point-min))
8465 (setq buffer-read-only t))
8466 (display-buffer "*Help*")
8467 (if (and (setq win (get-buffer-window "*Help*"))
8468 idlwave-resize-routine-help-window)
8469 (progn
8470 (let ((ww (selected-window)))
8471 (unwind-protect
8472 (progn
8473 (select-window win)
8474 (enlarge-window (- (/ (frame-height) 2)
8475 (window-height)))
8476 (shrink-window-if-larger-than-buffer))
8477 (select-window ww)))))))))
8479 (defun idlwave-insert-source-location (prefix entry &optional file-props)
8480 "Insert a source location into the routine info buffer.
8481 Start line with PREFIX. If a file name is inserted, add FILE-PROPS
8482 to it."
8483 (let* ((key (car entry))
8484 (file (nth 1 entry))
8485 (types (nth 2 entry))
8486 (shell-flag (assq 'compiled types))
8487 (buffer-flag (assq 'buffer types))
8488 (user-flag (assq 'user types))
8489 (lib-flag (assq 'lib types))
8490 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
8491 (and user-flag (idlwave-count-memq 'user types))
8492 (and lib-flag (idlwave-count-memq 'lib types))
8493 1))
8494 (doflags t)
8495 beg special)
8497 (insert prefix)
8499 (cond
8500 ((eq key 'system)
8501 (setq doflags nil)
8502 (insert "System "))
8504 ((eq key 'builtin)
8505 (setq doflags nil)
8506 (insert "Builtin "))
8508 ((and (not file) shell-flag)
8509 (insert "Unresolved"))
8511 ((null file)
8512 (insert "ERROR"))
8514 ((idlwave-syslib-p file)
8515 (if (string-match "obsolete" (file-name-directory file))
8516 (insert "Obsolete ")
8517 (insert "SystemLib ")))
8519 ;; New special syntax: taken directly from routine-info for
8520 ;; library catalog routines
8521 ((setq special (or (cdr lib-flag) (cdr user-flag)))
8522 (insert (format "%-10s" special)))
8524 ;; Old special syntax: a matching regexp
8525 ((setq special (idlwave-special-lib-test file))
8526 (insert (format "%-10s" special)))
8528 ;; Catch-all with file
8529 ((idlwave-lib-p file) (insert "Library "))
8531 ;; Sanity catch all
8532 (t (insert "Other ")))
8534 (when doflags
8535 (insert (concat
8536 " ["
8537 (if lib-flag "L" "-")
8538 (if user-flag "C" "-")
8539 (if shell-flag "S" "-")
8540 (if buffer-flag "B" "-")
8541 "] ")))
8542 (when (> ndupl 1)
8543 (setq beg (point))
8544 (insert (format "(%dx) " ndupl))
8545 (add-text-properties beg (point) (list 'face 'bold)))
8546 (when (and file (not (equal file "")))
8547 (setq beg (point))
8548 (insert (apply 'abbreviate-file-name
8549 (if (featurep 'xemacs) (list file t) (list file))))
8550 (if file-props
8551 (add-text-properties beg (point) file-props)))))
8553 (defun idlwave-special-lib-test (file)
8554 "Check the path of FILE against the regexps which define special libs.
8555 Return the name of the special lib if there is a match."
8556 (let ((alist idlwave-special-lib-alist)
8557 entry rtn)
8558 (cond
8559 ((stringp file)
8560 (while (setq entry (pop alist))
8561 (if (string-match (car entry) file)
8562 (setq rtn (cdr entry)
8563 alist nil)))
8564 rtn)
8565 (t nil))))
8567 (defun idlwave-mouse-active-rinfo-right (ev)
8568 (interactive "e")
8569 (idlwave-mouse-active-rinfo ev 'right))
8571 (defun idlwave-mouse-active-rinfo-shift (ev)
8572 (interactive "e")
8573 (idlwave-mouse-active-rinfo ev nil 'shift))
8575 (defun idlwave-active-rinfo-space ()
8576 (interactive)
8577 (idlwave-mouse-active-rinfo nil 'right))
8579 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8580 "Do the mouse actions in the routine info buffer.
8581 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8582 was pressed."
8583 (interactive "e")
8584 (if ev (mouse-set-point ev))
8585 (let (data id name type class buf bufwin source link keyword
8586 word initial-class)
8587 (setq data (get-text-property (point) 'data)
8588 source (get-text-property (point) 'source)
8589 keyword (get-text-property (point) 'keyword)
8590 link (get-text-property (point) 'link)
8591 id (car data)
8592 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8593 buf (nth 4 data)
8594 initial-class (nth 6 data)
8595 word (idlwave-this-word)
8596 bufwin (get-buffer-window buf t))
8598 (cond ((eq id 'class) ; Switch class being displayed
8599 (if (window-live-p bufwin) (select-window bufwin))
8600 (idlwave-display-calling-sequence
8601 (idlwave-sintern-method name)
8602 type (idlwave-sintern-class word)
8603 initial-class))
8604 ((eq id 'usage) ; Online help on this routine
8605 (idlwave-online-help link name type class))
8606 ((eq id 'source) ; Source in help or buffer
8607 (if right ; In help
8608 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8609 (idlwave-help-source-try-header nil)
8610 ;; Fake idlwave-routines so help will find the right entry
8611 (idlwave-routines
8612 (list (list name type class source ""))))
8613 (idlwave-help-get-special-help name type class nil))
8614 ;; Otherwise just pop to the source
8615 (setq idlwave-popup-source (not idlwave-popup-source))
8616 (if idlwave-popup-source
8617 (condition-case err
8618 (idlwave-do-find-module name type class source)
8619 (error
8620 (setq idlwave-popup-source nil)
8621 (if (window-live-p bufwin) (select-window bufwin))
8622 (error (nth 1 err))))
8623 (if bufwin
8624 (select-window bufwin)
8625 (pop-to-buffer buf))
8626 (goto-char (marker-position idlwave-rinfo-marker)))))
8627 ((eq id 'keyword)
8628 (if right
8629 (idlwave-online-help link name type class keyword)
8630 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8632 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8633 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8634 (let ((bwin (get-buffer-window buffer)))
8635 (if idlwave-complete-empty-string-as-lower-case
8636 (setq keyword (downcase keyword)))
8637 (if bwin
8638 (select-window bwin)
8639 (pop-to-buffer buffer)
8640 (setq bwin (get-buffer-window buffer)))
8641 (if (eq (preceding-char) ?/)
8642 (insert keyword)
8643 (unless (save-excursion
8644 (re-search-backward
8646 (min (- (point) 100) (point-min)) t))
8647 (insert ", "))
8648 (if shift (insert "/"))
8649 (insert keyword)
8650 (if (and (not shift)
8651 idlwave-keyword-completion-adds-equal)
8652 (insert "=")))))
8654 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8655 "List the load path shadows of all routines defined in current buffer."
8656 (interactive "P")
8657 (idlwave-routines)
8658 (if (eq major-mode 'idlwave-mode)
8659 (idlwave-list-load-path-shadows
8660 nil (idlwave-update-current-buffer-info 'save-buffer)
8661 "in current buffer")
8662 (error "Current buffer is not in idlwave-mode")))
8664 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8665 "List the load path shadows of all routines compiled under the shell.
8666 This is very useful for checking an IDL application. Just compile the
8667 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8668 routines and update IDLWAVE internal info. Then check for shadowing
8669 with this command."
8670 (interactive "P")
8671 (cond
8672 ((or (not (fboundp 'idlwave-shell-is-running))
8673 (not (idlwave-shell-is-running)))
8674 (error "Shell is not running"))
8675 ((null idlwave-compiled-routines)
8676 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8677 (t
8678 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8679 "in the shell"))))
8681 (defun idlwave-list-all-load-path-shadows (&optional arg)
8682 "List the load path shadows of all routines known to IDLWAVE."
8683 (interactive "P")
8684 (idlwave-list-load-path-shadows nil nil "globally"))
8686 (defvar idlwave-sort-prefer-buffer-info t
8687 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8689 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8690 "List the routines which are defined multiple times.
8691 Search the information IDLWAVE has about IDL routines for multiple
8692 definitions.
8693 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8695 When IDL hits a routine call which is not defined, it will search on
8696 the load path in order to find a definition. The output of this command
8697 can be used to detect possible name clashes during this process."
8698 (idlwave-routines) ; Make sure everything is loaded.
8699 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8700 (or (y-or-n-p
8701 "You don't have any user or library catalogs. Continue anyway? ")
8702 (error "Abort")))
8703 (let* ((routines (append idlwave-system-routines
8704 idlwave-compiled-routines
8705 idlwave-library-catalog-routines
8706 idlwave-user-catalog-routines
8707 idlwave-buffer-routines
8708 nil))
8709 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8710 (keymap (make-sparse-keymap))
8711 (props (list 'mouse-face 'highlight
8712 km-prop keymap
8713 'help-echo "Mouse2: Find source"))
8714 (nroutines (length (or special-routines routines)))
8715 (step (/ nroutines 100))
8716 (n 0)
8717 (cnt 0)
8718 (idlwave-sort-prefer-buffer-info nil)
8719 routine twins dtwins twin done props1 lroutines)
8721 (if special-routines
8722 ;; Just looking for shadows of a few special routines
8723 (setq lroutines routines
8724 routines special-routines))
8726 (message "Sorting routines...")
8727 (setq routines (sort routines
8728 (lambda (a b)
8729 (string< (downcase (idlwave-make-full-name
8730 (nth 2 a) (car a)))
8731 (downcase (idlwave-make-full-name
8732 (nth 2 b) (car b)))))))
8733 (message "Sorting routines...done")
8735 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8736 (lambda (ev)
8737 (interactive "e")
8738 (mouse-set-point ev)
8739 (apply 'idlwave-do-find-module
8740 (get-text-property (point) 'find-args))))
8741 (define-key keymap [(return)]
8742 (lambda ()
8743 (interactive)
8744 (apply 'idlwave-do-find-module
8745 (get-text-property (point) 'find-args))))
8746 (message "Compiling list...( 0%%)")
8747 (with-current-buffer (get-buffer-create "*Shadows*")
8748 (setq buffer-read-only nil)
8749 (erase-buffer)
8750 (while (setq routine (pop routines))
8751 (if (= (mod (setq n (1+ n)) step) 0)
8752 (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines)))
8754 ;; Get a list of all twins
8755 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8756 (if (memq routine done)
8757 (setq dtwins nil)
8758 (setq dtwins (idlwave-study-twins twins)))
8759 ;; Mark all twins as dealt with
8760 (setq done (append twins done))
8761 (when (or (> (length dtwins) 1)
8762 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8763 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8764 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8765 (incf cnt)
8767 (idlwave-make-full-name (nth 2 routine)
8768 (car routine))
8769 (if (eq (nth 1 routine) 'fun) "()" "")))
8770 (while (setq twin (pop dtwins))
8771 (setq props1 (append (list 'find-args
8772 (list (nth 0 routine)
8773 (nth 1 routine)
8774 (nth 2 routine)))
8775 props))
8777 (goto-char (point-min))
8778 (setq buffer-read-only t))
8779 (setq loc (or loc ""))
8780 (if (> cnt 0)
8781 (progn
8782 (display-buffer (get-buffer "*Shadows*"))
8783 (message "%d case%s of shadowing found %s"
8784 cnt (if (= cnt 1) "" "s") loc))
8785 (message "No shadowing conflicts found %s" loc))))
8787 (defun idlwave-print-source (routine)
8788 (let* ((source (nth 3 routine))
8789 (stype (car source))
8790 (sfile (idlwave-routine-source-file source)))
8791 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8792 (if (and (eq stype 'compiled)
8793 (or (not (stringp sfile))
8795 (setq stype 'unresolved))
8797 stype
8798 (if sfile sfile "No source code available")))))
8800 (defun idlwave-routine-twins (entry &optional list)
8801 "Return all twin entries of ENTRY in LIST.
8802 LIST defaults to `idlwave-routines'.
8803 Twin entries are those which have the same name, type, and class.
8804 ENTRY will also be returned, as the first item of this list."
8805 (let* ((name (car entry))
8806 (type (nth 1 entry))
8807 (class (nth 2 entry))
8808 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8809 twins candidate)
8810 (while (setq candidate (pop candidates))
8811 (if (and (not (eq candidate entry))
8812 (eq type (nth 1 candidate))
8813 (eq class (nth 2 candidate)))
8814 (push candidate twins)))
8815 (if (setq candidate (idlwave-rinfo-assq name type class
8816 idlwave-unresolved-routines))
8817 (push candidate twins))
8818 (cons entry (nreverse twins))))
8820 (defun idlwave-study-twins (entries)
8821 "Return dangerous twins of first entry in ENTRIES.
8822 Dangerous twins are routines with same name, but in different files on
8823 the load path. If a file is in the system library and has an entry in
8824 the `idlwave-system-routines' list, we omit the latter as
8825 non-dangerous because many IDL routines are implemented as library
8826 routines, and may have been scanned."
8827 (let* ((entry (car entries))
8828 (name (car entry)) ;
8829 (type (nth 1 entry)) ; Must be bound for
8830 (class (nth 2 entry)) ; idlwave-routine-twin-compare
8831 (cnt 0)
8832 source type type-cons file alist syslibp key)
8833 (while (setq entry (pop entries))
8834 (incf cnt)
8835 (setq source (nth 3 entry)
8836 type (car source)
8837 type-cons (cons type (nth 3 source))
8838 file (idlwave-routine-source-file source))
8840 ;; Make KEY to index entry properly
8841 (setq key (cond ((eq type 'system) type)
8842 (file (file-truename file))
8843 (t 'unresolved)))
8845 ;; Check for an entry in the system library
8846 (if (and file
8847 (not syslibp)
8848 (idlwave-syslib-p file))
8849 (setq syslibp t))
8851 ;; If there's more than one matching entry for the same file, just
8852 ;; append the type-cons to the type list.
8853 (if (setq entry (assoc key alist))
8854 (push type-cons (nth 2 entry))
8855 (push (list key file (list type-cons)) alist)))
8857 (setq alist (nreverse alist))
8859 (when syslibp
8860 ;; File is in system *library* - remove any 'system entry
8861 (setq alist (delq (assq 'system alist) alist)))
8863 ;; If 'system remains and we've scanned the syslib, it's a builtin
8864 ;; (rather than a !DIR/lib/.pro file bundled as source).
8865 (when (and (idlwave-syslib-scanned-p)
8866 (setq entry (assoc 'system alist)))
8867 (setcar entry 'builtin))
8868 (sort alist 'idlwave-routine-twin-compare)))
8870 ;; FIXME: Dynamically scoped vars need to use the `idlwave-' prefix.
8871 ;; (defvar type)
8872 ;; (defvar class)
8873 (defmacro idlwave-xor (a b)
8874 `(and (or ,a ,b)
8875 (not (and ,a ,b))))
8877 (defun idlwave-routine-entry-compare (a b)
8878 "Compare two routine info entries for sorting.
8879 This is the general case. It first compares class, names, and type.
8880 If it turns out that A and B are twins (same name, class, and type),
8881 calls another routine which compares twins on the basis of their file
8882 names and path locations."
8883 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8884 (cond
8885 ((not (equal (idlwave-downcase-safe class)
8886 (idlwave-downcase-safe (nth 2 b))))
8887 ;; Class decides
8888 (cond ((null (nth 2 b)) nil)
8889 ((null class) t)
8890 (t (string< (downcase class) (downcase (nth 2 b))))))
8891 ((not (equal (downcase name) (downcase (car b))))
8892 ;; Name decides
8893 (string< (downcase name) (downcase (car b))))
8894 ((not (eq type (nth 1 b)))
8895 ;; Type decides
8896 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8897 (t
8898 ;; A and B are twins - so the decision is more complicated.
8899 ;; Call twin-compare with the proper arguments.
8900 (idlwave-routine-entry-compare-twins a b)))))
8902 (defun idlwave-routine-entry-compare-twins (a b)
8903 "Compare two routine entries, under the assumption that they are twins.
8904 This basically calls `idlwave-routine-twin-compare' with the correct args."
8905 (let* ((name (car a)) (type (nth 1 a)) (class (nth 2 a)) ; needed outside
8906 (asrc (nth 3 a))
8907 (atype (car asrc))
8908 (bsrc (nth 3 b))
8909 (btype (car bsrc))
8910 (afile (idlwave-routine-source-file asrc))
8911 (bfile (idlwave-routine-source-file bsrc)))
8912 (idlwave-routine-twin-compare
8913 (if (stringp afile)
8914 (list (file-truename afile) afile (list atype))
8915 (list atype afile (list atype)))
8916 (if (stringp bfile)
8917 (list (file-truename bfile) bfile (list btype))
8918 (list btype bfile (list btype))))
8919 ))
8921 ;; Bound in idlwave-study-twins,idlwave-routine-entry-compare-twins.
8922 ;; FIXME: Dynamically scoped vars need to use the `idlwave-' prefix.
8923 (defvar class)
8925 (defun idlwave-routine-twin-compare (a b)
8926 "Compare two routine twin entries for sorting.
8927 In here, A and B are not normal routine info entries, but special
8928 lists (KEY FILENAME (TYPES...)).
8929 This expects NAME TYPE CLASS to be bound to the right values."
8930 (let* (;; Dis-assemble entries
8931 (akey (car a)) (bkey (car b))
8932 (afile (nth 1 a)) (bfile (nth 1 b))
8933 (atypes (nth 2 a)) (btypes (nth 2 b))
8934 ;; System routines?
8935 (asysp (memq akey '(builtin system)))
8936 (bsysp (memq bkey '(builtin system)))
8937 ;; Compiled routines?
8938 (acompp (memq 'compiled atypes))
8939 (bcompp (memq 'compiled btypes))
8940 ;; Unresolved?
8941 (aunresp (or (eq akey 'unresolved)
8942 (and acompp (not afile))))
8943 (bunresp (or (eq bkey 'unresolved)
8944 (and bcompp (not bfile))))
8945 ;; Buffer info available?
8946 (abufp (memq 'buffer atypes))
8947 (bbufp (memq 'buffer btypes))
8948 ;; On search path?
8949 (tpath-alist (idlwave-true-path-alist))
8950 (apathp (and (stringp akey)
8951 (assoc (file-name-directory akey) tpath-alist)))
8952 (bpathp (and (stringp bkey)
8953 (assoc (file-name-directory bkey) tpath-alist)))
8954 ;; How early on search path? High number means early since we
8955 ;; measure the tail of the path list
8956 (anpath (length (memq apathp tpath-alist)))
8957 (bnpath (length (memq bpathp tpath-alist)))
8958 ;; Look at file names
8959 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8960 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8962 (regexp-quote (downcase class))
8963 (regexp-quote (downcase name)))
8965 ;; Is file name derived from the routine name?
8966 ;; Method file or class definition file?
8967 (anamep (string-match fname-re aname))
8968 (adefp (and class anamep (string= "define" (match-string 1 aname))))
8969 (bnamep (string-match fname-re bname))
8970 (bdefp (and class bnamep (string= "define" (match-string 1 bname)))))
8972 ;; Now: follow JD's ideas about sorting. Looks really simple now,
8973 ;; doesn't it? The difficult stuff is hidden above...
8974 (cond
8975 ((idlwave-xor asysp bsysp) asysp) ; System entries first
8976 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
8977 ((and idlwave-sort-prefer-buffer-info
8978 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
8979 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
8980 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
8981 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
8982 ((and class anamep bnamep ; both file names match ->
8983 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
8984 ((> anpath bnpath) t) ; Who is first on path?
8985 (t nil)))) ; Default
8987 (defun idlwave-routine-source-file (source)
8988 (if (nth 2 source)
8989 (expand-file-name (nth 1 source) (nth 2 source))
8990 (nth 1 source)))
8992 (defun idlwave-downcase-safe (string)
8993 "Donwcase if string, else return unchanged."
8994 (if (stringp string)
8995 (downcase string)
8996 string))
8998 (defun idlwave-count-eq (elt list)
8999 "How often is ELT in LIST?"
9000 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
9002 (defun idlwave-count-memq (elt alist)
9003 "How often is ELT a key in ALIST?"
9004 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
9006 (defun idlwave-syslib-p (file)
9007 "Non-nil if FILE is in the system library."
9008 (let* ((true-syslib (file-name-as-directory
9009 (file-truename
9010 (expand-file-name "lib" (idlwave-sys-dir)))))
9011 (true-file (file-truename file)))
9012 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
9014 (defun idlwave-lib-p (file)
9015 "Non-nil if FILE is in the library."
9016 (let ((true-dir (file-name-directory (file-truename file))))
9017 (assoc true-dir (idlwave-true-path-alist))))
9019 (defun idlwave-path-alist-add-flag (list-entry flag)
9020 "Add a flag to the path list entry, if not set."
9021 (let ((flags (cdr list-entry)))
9022 (add-to-list 'flags flag)
9023 (setcdr list-entry flags)))
9025 (defun idlwave-path-alist-remove-flag (list-entry flag)
9026 "Remove a flag to the path list entry, if set."
9027 (let ((flags (delq flag (cdr list-entry))))
9028 (setcdr list-entry flags)))
9030 (defun idlwave-true-path-alist ()
9031 "Return `idlwave-path-alist' alist with true-names.
9032 Info is cached, but relies on the functions setting `idlwave-path-alist'
9033 to reset the variable `idlwave-true-path-alist' to nil."
9034 (or idlwave-true-path-alist
9035 (setq idlwave-true-path-alist
9036 (mapcar (lambda(x) (cons
9037 (file-name-as-directory
9038 (file-truename
9039 (directory-file-name
9040 (car x))))
9041 (cdr x)))
9042 idlwave-path-alist))))
9044 (defun idlwave-syslib-scanned-p ()
9045 "Non-nil if the system lib file !DIR/lib has been scanned."
9046 (let* ((true-syslib (file-name-as-directory
9047 (file-truename
9048 (expand-file-name "lib" (idlwave-sys-dir))))))
9049 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
9051 ;; ----------------------------------------------------------------------------
9052 ;;
9053 ;; Online Help display
9056 ;; ----------------------------------------------------------------------------
9057 ;;
9058 ;; Additions for use with imenu.el and func-menu.el
9059 ;; (pop-up a list of IDL units in the current file).
9060 ;;
9062 (defun idlwave-prev-index-position ()
9063 "Search for the previous procedure or function.
9064 Return nil if not found. For use with imenu.el."
9065 (save-match-data
9066 (cond
9068 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
9069 (t nil))))
9071 (defun idlwave-unit-name ()
9072 "Return the unit name.
9073 Assumes that point is at the beginning of the unit as found by
9074 `idlwave-prev-index-position'."
9075 (forward-sexp 2)
9076 (forward-sexp -1)
9077 (let ((begin (point)))
9078 (re-search-forward
9080 (if (fboundp 'buffer-substring-no-properties)
9081 (buffer-substring-no-properties begin (point))
9082 (buffer-substring begin (point)))))
9084 (defalias 'idlwave-function-menu
9085 (condition-case nil
9086 (progn
9087 (require 'func-menu)
9088 'function-menu)
9089 (error (condition-case nil
9090 (progn
9091 (require 'imenu)
9092 'imenu)
9093 (error nil)))))
9095 ;; Here we hack func-menu.el in order to support this new mode.
9096 ;; The latest versions of func-menu.el already have this stuff in, so
9097 ;; we hack only if it is not already there.
9098 (when (fboundp 'eval-after-load)
9099 (eval-after-load "func-menu"
9100 '(progn
9101 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
9102 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
9103 (setq fume-function-name-regexp-alist
9104 (cons '(idlwave-mode . fume-function-name-regexp-idl)
9105 fume-function-name-regexp-alist)))
9106 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
9107 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
9108 (setq fume-find-function-name-method-alist
9109 (cons '(idlwave-mode . fume-find-next-idl-function-name)
9110 fume-find-function-name-method-alist))))))
9112 (defun idlwave-edit-in-idlde ()
9113 "Edit the current file in IDL Development environment."
9114 (interactive)
9115 (start-process "idldeclient" nil
9116 idlwave-shell-explicit-file-name "-c" "-e"
9117 (buffer-file-name)))
9119 (defvar idlwave-help-use-assistant)
9120 (defun idlwave-launch-idlhelp ()
9121 "Start the IDLhelp application."
9122 (interactive)
9123 (if idlwave-help-use-assistant
9124 (idlwave-help-assistant-raise)
9125 (start-process "idlhelp" nil idlwave-help-application)))
9127 ;; Menus - using easymenu.el
9128 (defvar idlwave-mode-menu-def
9129 `("IDLWAVE"
9130 ["PRO/FUNC menu" idlwave-function-menu t]
9131 ("Motion"
9132 ["Subprogram Start" idlwave-beginning-of-subprogram t]
9133 ["Subprogram End" idlwave-end-of-subprogram t]
9134 ["Block Start" idlwave-beginning-of-block t]
9135 ["Block End" idlwave-end-of-block t]
9136 ["Up Block" idlwave-backward-up-block t]
9137 ["Down Block" idlwave-down-block t]
9138 ["Skip Block Backward" idlwave-backward-block t]
9139 ["Skip Block Forward" idlwave-forward-block t])
9140 ("Mark"
9141 ["Subprogram" idlwave-mark-subprogram t]
9142 ["Block" idlwave-mark-block t]
9143 ["Header" idlwave-mark-doclib t])
9144 ("Format"
9145 ["Indent Entire Statement" idlwave-indent-statement
9147 ["Indent Subprogram" idlwave-indent-subprogram t]
9148 ["(Un)Comment Region" idlwave-toggle-comment-region t]
9149 ["Continue/Split line" idlwave-split-line t]
9150 "--"
9151 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
9152 :selected (symbol-value idlwave-fill-function)])
9153 ("Templates"
9154 ["Procedure" idlwave-procedure t]
9155 ["Function" idlwave-function t]
9156 ["Doc Header" idlwave-doc-header t]
9157 ["Log" idlwave-doc-modification t]
9158 "--"
9159 ["Case" idlwave-case t]
9160 ["For" idlwave-for t]
9161 ["Repeat" idlwave-repeat t]
9162 ["While" idlwave-while t]
9163 "--"
9164 ["Close Block" idlwave-close-block t])
9165 ("Completion"
9166 ["Complete" idlwave-complete t]
9167 ("Complete Specific"
9168 ["1 Procedure Name" (idlwave-complete 'procedure) t]
9169 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
9170 "--"
9171 ["3 Function Name" (idlwave-complete 'function) t]
9172 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
9173 "--"
9174 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
9175 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
9176 "--"
9177 ["7 Function Method Name" (idlwave-complete 'function-method) t]
9178 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
9179 "--"
9180 ["9 Class Name" idlwave-complete-class t]))
9181 ("Routine Info"
9182 ["Show Routine Info" idlwave-routine-info t]
9183 ["Online Context Help" idlwave-context-help t]
9184 "--"
9185 ["Find Routine Source" idlwave-find-module t]
9186 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
9187 "--"
9188 ["Update Routine Info" idlwave-update-routine-info t]
9189 ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t]
9190 "--"
9191 "IDL User Catalog"
9192 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
9193 ["Scan Directories" (idlwave-update-routine-info '(16))
9194 (and idlwave-path-alist (not idlwave-catalog-process))]
9195 ["Scan Directories &" (idlwave-update-routine-info '(64))
9196 (and idlwave-path-alist (not idlwave-catalog-process))]
9197 "--"
9198 "Routine Shadows"
9199 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
9200 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
9201 ["Check Everything" idlwave-list-all-load-path-shadows t])
9202 ("Misc"
9203 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
9204 "--"
9205 ["Insert TAB character" idlwave-hard-tab t])
9206 "--"
9207 ("External"
9208 ["Start IDL shell" idlwave-shell t]
9209 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
9210 ["Launch IDL Help" idlwave-launch-idlhelp t])
9211 "--"
9212 ("Customize"
9213 ["Browse IDLWAVE Group" idlwave-customize t]
9214 "--"
9215 ["Build Full Customize Menu" idlwave-create-customize-menu
9216 (fboundp 'customize-menu-create)])
9217 ("Documentation"
9218 ["Describe Mode" describe-mode t]
9219 ["Abbreviation List" idlwave-list-abbrevs t]
9220 "--"
9221 ["Commentary in idlwave.el" idlwave-show-commentary t]
9222 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
9223 "--"
9224 ["Info" idlwave-info t]
9225 "--"
9226 ["Help with Topic" idlwave-help-assistant-help-with-topic
9227 idlwave-help-use-assistant]
9228 ["Launch IDL Help" idlwave-launch-idlhelp t])))
9230 (defvar idlwave-mode-debug-menu-def
9231 '("Debug"
9232 ["Start IDL shell" idlwave-shell t]
9233 ["Save and .RUN buffer" idlwave-shell-save-and-run
9234 (and (boundp 'idlwave-shell-automatic-start)
9235 idlwave-shell-automatic-start)]))
9237 (if (or (featurep 'easymenu) (load "easymenu" t))
9238 (progn
9239 (easy-menu-define idlwave-mode-menu idlwave-mode-map
9240 "IDL and WAVE CL editing menu"
9241 idlwave-mode-menu-def)
9242 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
9243 "IDL and WAVE CL editing menu"
9244 idlwave-mode-debug-menu-def)))
9246 (defun idlwave-customize ()
9247 "Call the customize function with `idlwave' as argument."
9248 (interactive)
9249 ;; Try to load the code for the shell, so that we can customize it
9250 ;; as well.
9251 (or (featurep 'idlw-shell)
9252 (load "idlw-shell" t))
9253 (customize-browse 'idlwave))
9255 (defun idlwave-create-customize-menu ()
9256 "Create a full customization menu for IDLWAVE, insert it into the menu."
9257 (interactive)
9258 (if (fboundp 'customize-menu-create)
9259 (progn
9260 ;; Try to load the code for the shell, so that we can customize it
9261 ;; as well.
9262 (or (featurep 'idlw-shell)
9263 (load "idlw-shell" t))
9264 (easy-menu-change
9265 '("IDLWAVE") "Customize"
9266 `(["Browse IDLWAVE group" idlwave-customize t]
9267 "--"
9268 ,(customize-menu-create 'idlwave)
9269 ["Set" Custom-set t]
9270 ["Save" Custom-save t]
9271 ["Reset to Current" Custom-reset-current t]
9272 ["Reset to Saved" Custom-reset-saved t]
9273 ["Reset to Standard Settings" Custom-reset-standard t]))
9275 (error "Cannot expand menu (outdated version of cus-edit.el)")))
9277 (defun idlwave-show-commentary ()
9278 "Use the finder to view the file documentation from `idlwave.el'."
9279 (interactive)
9280 (finder-commentary "idlwave.el"))
9282 (defun idlwave-shell-show-commentary ()
9283 "Use the finder to view the file documentation from `idlw-shell.el'."
9284 (interactive)
9285 (finder-commentary "idlw-shell.el"))
9287 (defun idlwave-info ()
9288 "Read documentation for IDLWAVE in the info system."
9289 (interactive)
9290 (info "idlwave"))
9292 (defun idlwave-list-abbrevs (arg)
9293 "Show the code abbreviations define in IDLWAVE mode.
9294 This lists all abbrevs where the replacement text differs from the input text.
9295 These are the ones the users want to learn to speed up their writing.
9297 The function does *not* list abbrevs which replace a word with itself
9298 to call a hook. These hooks are used to change the case of words or
9299 to blink the matching `begin', and the user does not need to know them.
9301 With arg, list all abbrevs with the corresponding hook.
9303 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
9305 (interactive "P")
9306 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
9307 abbrevs
9308 str rpl func fmt (len-str 0) (len-rpl 0))
9309 (mapatoms
9310 (lambda (sym)
9311 (if (symbol-value sym)
9312 (progn
9313 (setq str (symbol-name sym)
9314 rpl (symbol-value sym)
9315 func (symbol-function sym))
9316 (if arg
9317 (setq func (prin1-to-string func))
9318 (if (and (listp func) (stringp (nth 2 func)))
9319 (setq rpl (concat "EVAL: " (nth 2 func))
9320 func "")
9321 (setq func "")))
9322 (if (or arg (not (string= rpl str)))
9323 (progn
9324 (setq len-str (max len-str (length str)))
9325 (setq len-rpl (max len-rpl (length rpl)))
9326 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
9327 table)
9328 ;; sort the list
9329 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
9330 ;; Make the format
9332 (with-output-to-temp-buffer "*Help*"
9333 (if arg
9334 (progn
9337 (princ (format fmt "KEY" "REPLACE" "HOOK"))
9338 (princ (format fmt "---" "-------" "----")))
9341 (princ (format fmt "KEY" "ACTION" ""))
9342 (princ (format fmt "---" "------" "")))
9343 (mapcar
9344 (lambda (list)
9345 (setq str (car list)
9346 rpl (nth 1 list)
9347 func (nth 2 list))
9348 (princ (format fmt str rpl func)))
9349 abbrevs)))
9350 ;; Make sure each abbreviation uses only one display line
9351 (with-current-buffer "*Help*"
9352 (setq truncate-lines t)))
9354 ;; Add .pro files to speedbar for support, if it's loaded
9355 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
9357 ;; Set an idle timer to load the routine info.
9358 ;; Will only work on systems which support this.
9359 (or idlwave-routines (idlwave-start-load-rinfo-timer))
9361 ;; Run the hook
9362 (run-hooks 'idlwave-load-hook)
9364 (provide 'idlwave)
9366 ;; arch-tag: f77f3b0c-c37c-424f-a328-0886fd42b6fb
9367 ;;; idlwave.el ends here