| blob | 4788cb307833ff01f323a186e182646103acd947 |
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.22
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
1373 ;; FIXME: This var seems to only ever be set, but never actually used!
1380 ;; Note that this is documented in the v18 manuals as being a string
1381 ;; of length one rather than a single character.
1382 ;; The code in this file accepts either format for compatibility.
1384 "Character to be inserted for IDL comment indentation.
1388 "Character which is inserted as a last character on previous line by
1394 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1398 ;; If I take the time I can replace idlwave-keyword-abbrev with
1399 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1400 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1401 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1402 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1405 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1406 Specifically, if the abbrev is in a comment or string it is unexpanded.
1407 Otherwise ARGS forms a list that is evaluated."
1408 ;; FIXME: it would probably be better to rely on the new :enable-function
1409 ;; to enforce the "don't expand in comments or strings".
1434 ;;(define-key map "\C-c\C- " 'idlwave-hard-tab)
1453 ;; (define-key map "\r" 'idlwave-newline)
1454 ;; (define-key map "\t" 'idlwave-indent-line)
1465 ;; Bind the debug commands also with the special modifiers.
1482 ;; (define-key map "\C-c\C-f" 'idlwave-function)
1483 ;; (define-key map "\C-c\C-p" 'idlwave-procedure)
1496 ;; Pickup both forms of Esc/Meta binding
1505 map)
1531 st)
1540 st)
1544 "Execute BODY with a different syntax table."
1552 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1553 ; "Execute BODY with a different syntax table."
1554 ; `(let ((saved-syntax (syntax-table)))
1555 ; (unwind-protect
1556 ; (progn
1557 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1558 ; ,@body)
1559 ; (set-syntax-table saved-syntax))))
1562 "KEY and CMD are made into a key binding and an indent action.
1563 KEY is a string - same as for the `define-key' function. CMD is a
1564 function of no arguments or a list to be evaluated. CMD is bound to
1565 KEY in `idlwave-mode-map' by defining an anonymous function calling
1566 `self-insert-command' followed by CMD. If KEY contains more than one
1567 character a binding will only be set if SELECT is 'both.
1569 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1570 replacing any previous value for KEY. If a binding is not set then it
1571 will instead be placed in `idlwave-indent-action-table'.
1573 If the optional argument SELECT is nil then an action and binding are
1574 created. If SELECT is 'noaction, then a binding is always set and no
1575 action is created. If SELECT is 'both then an action and binding
1576 will both be created even if KEY contains more than one character.
1577 Otherwise, if SELECT is non-nil then only an action is created.
1579 Some examples:
1580 No spaces before and 1 after a comma
1582 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1584 Capitalize system variables - action only
1585 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1587 ;; Add action
1593 ;; Replace action command
1595 ;; New action
1597 ;; Make key binding for action
1607 ;; Set action and key bindings.
1608 ;; See description of the function `idlwave-action-and-binding'.
1609 ;; Automatically add spaces for the following characters
1611 ;; Actions for & are complicated by &&
1614 ;; Automatically add spaces to equal sign if not keyword. This needs
1615 ;; to go ahead of > and <, so >= and <= will be treated correctly
1618 ;; Actions for > and < are complicated by >=, <=, and ->...
1625 ;;;
1626 ;;; Abbrev Section
1627 ;;;
1628 ;;; When expanding abbrevs and the abbrev hook moves backward, an extra
1629 ;;; space is inserted (this is the space typed by the user to expanded
1630 ;;; the abbrev).
1631 ;;;
1637 "Define-abbrev with backward compatibility.
1639 If NOPREFIX is non-nil, don't prepend prefix character. Installs into
1640 `idlwave-mode-abbrev-table' unless TABLE is non-nil."
1644 expansion
1645 hook)))
1655 ;;
1656 ;; Templates
1657 ;;
1667 ;;
1668 ;; Keywords, system functions, conversion routines
1669 ;;
1727 ;; This section is reserved words only. (From IDL user manual)
1728 ;;
1774 ;; defined later - so just make the compiler hush
1778 ;;;###autoload
1780 "Major mode for editing IDL source files (version 6.1_em22).
1782 The main features of this mode are
1784 1. Indentation and Formatting
1785 --------------------------
1786 Like other Emacs programming modes, C-j inserts a newline and indents.
1787 TAB is used for explicit indentation of the current line.
1790 function can also be used in the middle of a line to split the line
1791 at that point. When used inside a long constant string, the string
1792 is split at that point with the `+' concatenation operator.
1794 Comments are indented as follows:
1796 `;;;' Indentation remains unchanged.
1797 `;;' Indent like the surrounding code
1798 `;' Indent to a minimum column.
1800 The indentation of comments starting in column 0 is never changed.
1803 comment. The indentation of the second line of the paragraph
1804 relative to the first will be retained. Use
1806 comments. When the variable `idlwave-fill-comment-line-only' is
1807 nil, code can also be auto-filled and auto-indented.
1809 To convert pre-existing IDL code to your formatting style, mark the
1814 2. Routine Info
1815 ------------
1816 IDLWAVE displays information about the calling sequence and the
1817 accepted keyword parameters of a procedure or function with
1819 source file of a module. These commands know about system
1820 routines, all routines in idlwave-mode buffers and (when the
1821 idlwave-shell is active) about all modules currently compiled under
1822 this shell. It also makes use of pre-compiled or custom-scanned
1823 user and library catalogs many popular libraries ship with by
1825 information, which is also used for completion (see item 4).
1827 3. Online IDL Help
1828 ---------------
1831 for the system variable, keyword, or routines at point. A single
1832 key stroke gets you directly to the right place in the docs. See
1833 the manual to configure where and how the HTML help is displayed.
1835 4. Completion
1836 ----------
1838 class names, keyword parameters, system variables and tags, class
1839 tags, structure tags, filenames and much more. It is context
1840 sensitive and figures out what is expected at point. Lower case
1841 strings are completed in lower case, other strings in mixed or
1842 upper case.
1844 5. Code Templates and Abbreviations
1845 --------------------------------
1846 Many Abbreviations are predefined to expand to code fragments and templates.
1861 have direct keybindings - see the list of keybindings below.
1864 beginning of the current program unit (pro, function or main).
1865 Change log entries can be added to the current program unit with
1868 6. Automatic Case Conversion
1869 -------------------------
1870 The case of reserved words and some abbrevs is controlled by
1871 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1873 7. Automatic END completion
1874 ------------------------
1875 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1876 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1878 8. Hooks
1879 -----
1880 Loading idlwave.el runs `idlwave-load-hook'.
1881 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1883 9. Documentation and Customization
1884 -------------------------------
1885 Info documentation for this package is available. Use
1887 not work). For Postscript, PDF, and HTML versions of the
1888 documentation, check IDLWAVE's homepage at URL `http://idlwave.org'.
1889 IDLWAVE has customize support - see the group `idlwave'.
1891 10.Keybindings
1892 -----------
1893 Here is a list of all keybindings of this mode.
1895 followed by the key sequence to see what the key sequence does.
1898 :abbrev-table idlwave-mode-abbrev-table
1931 ;; ChangeLog
1935 ;; Set tag table list to use IDLTAGS as file name.
1939 ;; Font-lock additions
1940 ;; Following line is for Emacs - XEmacs uses the corresponding property
1941 ;; on the `idlwave-mode' symbol.
1948 ;; Imenu setup
1956 ;; HideShow setup
1959 idlwave-begin-block-reg
1960 idlwave-end-block-reg
1961 ";"
1964 ;; Make a local post-command-hook and add our hook to it
1965 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1966 ;; (make-local-hook 'post-command-hook)
1969 ;; Make local hooks for buffer updates
1970 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1971 ;; (make-local-hook 'kill-buffer-hook)
1973 ;; (make-local-hook 'after-save-hook)
1977 ;; Setup directories and file, if necessary
1980 ;; Update the routine info with info about current buffer?
1983 ;; Check help location
1993 idlwave-user-catalog-file
1994 idlwave-config-directory)
1995 idlwave-xml-system-rinfo-converted-file
1997 idlwave-xml-system-rinfo-converted-file
1998 idlwave-config-directory)
2000 idlwave-path-file
2001 idlwave-config-directory))
2006 "Fontify continuation lines correctly."
2017 ;;
2018 ;; Code Formatting ----------------------------------------------------
2019 ;;
2022 "Insert TAB in buffer in current position."
2026 ;;; This stuff is experimental
2029 "If non-nil, a list that can be evaluated using `eval'.
2030 It is evaluated in the lisp function `idlwave-command-hook' which is
2034 "Command run after every command.
2035 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
2036 sets the variable to zero afterwards."
2044 ;;; End experiment
2046 ;; It would be better to use expand.el for better abbrev handling and
2047 ;; versatility.
2050 "Reverse abbrev expansion if in comment or string.
2051 Argument ARG is the number of characters to move point
2052 backward if `idlwave-abbrev-move' is non-nil.
2053 If optional argument RESERVED is non-nil then the expansion
2054 consists of reserved words, which will be capitalized if
2055 `idlwave-reserved-word-upcase' is non-nil.
2056 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2057 is non-nil, unless its value is \`down in which case the abbrev will be
2058 made into all lowercase.
2059 Returns non-nil if abbrev is left expanded."
2062 nil)
2074 t))
2077 "Return t if point is inside a comment, nil otherwise."
2083 "Move to start of comment delimiter on current line.
2084 Moves to end of line if there is no comment delimiter.
2085 Ignores comment delimiters in strings.
2086 Returns point if comment found and nil otherwise."
2089 found)
2090 ;; Look for first comment delimiter not in a string
2102 "Should we operate on an active region?"
2108 "Insert quote and show matching quote if this is end of a string."
2119 ;; Not the end of a string
2123 "Ensure that the previous word was a token before `idlwave-show-begin'.
2124 An END token must be preceded by whitespace."
2134 "Find the start of current block and blinks to it for a second.
2135 Also checks if the correct END statement has been used."
2136 ;; All end statements are reserved words
2137 ;; Re-indent end line
2138 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2139 ;;(backward-char 1)
2143 begin-pos end-pos end end1 )
2147 idlwave-show-block)
2149 ;; Move inside current block
2162 end-pos))
2170 ;; A generic end
2181 end1 end)
2183 ;;(delete-char 1))
2197 ;; seems to be a case thing
2201 idlwave-block-matches))
2203 ;; Just a normal block
2208 "Terminate the current block with the correct END statement."
2210 ;; Start new line if we are not in a new line
2221 "Surround &, leaving room for && (which surround as well)."
2231 "Surround > and < by blanks, leaving room for >= and <=, and considering ->."
2237 ;; Key binding: pad only on left, to save for possible >=/<=
2241 "Surround the LENGTH characters before point with blanks.
2242 LENGTH defaults to 1.
2243 Optional arguments BEFORE and AFTER affect the behavior before and
2244 after the characters (see also description of `idlwave-make-space'):
2246 nil do nothing
2247 0 force no spaces
2248 integer > 0 force exactly n spaces
2249 integer < 0 at least |n| spaces
2251 The function does nothing if any of the following conditions is true:
2252 - `idlwave-surround-by-blank' is nil
2253 - the character before point is inside a string or comment"
2261 ;; avoid clobbering indent
2271 ;; Check to see if the line should auto wrap
2277 "Make space at point.
2278 The space affected is all the spaces and tabs around point.
2279 If n is non-nil then point is left abs(n) spaces from the beginning of
2280 the contiguous space.
2281 The amount of space at point is determined by N.
2282 If the value of N is:
2283 nil - do nothing.
2284 > 0 - exactly N spaces.
2285 < 0 - a minimum of -N spaces, i.e., do not change if there are
2286 already -N spaces.
2287 0 - no spaces (i.e. remove any existing space)."
2301 ;; n = 0, done
2302 ))))
2305 "Insert a newline and indent the current and previous line."
2307 ;;
2308 ;; Handle unterminated single and double quotes
2309 ;; If not in a comment and in a string then insertion of a newline
2310 ;; will mean unbalanced quotes.
2311 ;;
2316 ;;
2317 ;; The current line is being split, the cursor should be at the
2318 ;; beginning of the new line skipping the leading indentation.
2319 ;;
2320 ;; The reason we insert the new line before indenting is that the
2321 ;; indenting could be confused by keywords (e.g. END) on the line
2322 ;; after the split point. This prevents us from just using
2323 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2324 ;;
2330 ;;
2331 ;; Use global variable 'comment-column' to set parallel comment
2332 ;;
2333 ;; Modeled on lisp.el
2334 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2336 "Compute indent for the beginning of the IDL comment delimiter."
2342 ;; On line by itself, indent as code
2345 ;; after code - do not change
2349 comment-column))))
2352 "Continue line by breaking line at point and indent the lines.
2353 For a code line insert continuation marker. If the line is a line comment
2354 then the new line will contain a comment with the same indentation.
2355 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2356 non-nil."
2358 ;; Expand abbreviation, just like normal RET would.
2362 ;; For code line add continuation.
2363 ;; Check if splitting a string.
2367 ;; Split the string.
2369 idlwave-continuation-char beg)
2373 ;; Do not split the string.
2377 ;; Not splitting a string.
2383 ;; Indent previous line
2388 ;; Reindent new line
2392 "Move point to the beginning of the current program unit.
2393 If NOMARK is non-nil, do not push mark."
2398 "Move point to the start of the next program unit.
2399 If NOMARK is non-nil, do not push mark."
2405 "Mark current IDL statement."
2413 "Mark containing block."
2425 "Put mark at beginning of program, point at end.
2426 The marks are pushed."
2436 "Move to beginning of enclosing block if prefix ARG >= 0.
2437 If prefix ARG < 0 then move forward to enclosing block end."
2442 "Go to the beginning of the current block."
2448 "Go to the beginning of the current block."
2454 "Move across next nested block."
2461 "Move backward across previous nested block."
2467 "Go down a block.
2468 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2469 Returns non-nil if successfull."
2473 ;; Backward
2481 ;; Forward
2489 status))
2492 "Put point at beginning of doc library header, mark at end.
2493 The marks are pushed."
2514 "Return (NAME TYPE CLASS) of current routine."
2518 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2527 "Move to beginning of the current statement.
2528 Skips back past statement continuations.
2529 Point is placed at the beginning of the line whether or not this is an
2530 actual statement."
2542 "Move point to beginning of the previous statement.
2543 Returns t if the current line before moving is the beginning of
2544 the first non-comment statement in the file, and nil otherwise."
2548 ;; first line in file
2549 t
2550 ;; skip blank lines, label lines, include lines and line comments
2552 ;; The current statement is the first statement until we
2553 ;; reach another statement.
2561 ;; skip continuation lines
2567 first-statement)))
2570 "Move point to the end of the current IDL statement.
2571 If not in a statement just moves to end of line. Returns position."
2581 "Move point to the end of the current IDL statement.
2582 If not in a statement just moves to end of line. Returns position."
2590 "Move point to beginning of the next IDL statement.
2591 Returns t if that statement is the last non-comment IDL statement
2592 in the file, and nil otherwise."
2596 ;; skip blank lines, label lines, include lines and line comments
2598 ;; The current statement is the last statement until
2599 ;; we reach a new statement.
2606 last-statement))
2609 "Skip past multiple commands on a line (with `&')."
2619 "Skip label or case statement element.
2620 Returns position after label.
2621 If there is no label point is not moved and nil is returned."
2622 ;; Case expressions and labels are terminated by a colon.
2623 ;; So we find the first colon in the line and make sure
2624 ;; - no `?' is before it (might be a ? b : c)
2625 ;; - it is not in a comment
2626 ;; - not in a string constant
2627 ;; - not in parenthesis (like a[0:3])
2628 ;; - not followed by another ":" in explicit class, ala a->b::c
2629 ;; As many in this mode, this function is heuristic and not an exact
2630 ;; parser.
2642 nil)))
2645 "Move to start of next IDL substatement after point.
2646 Uses the type of the current IDL statement to determine if the next
2647 statement is on a new line or is a subpart of the current statement.
2648 Returns point at start of substatement modulo whitespace.
2649 If optional argument is non-nil move to beginning of current
2650 substatement."
2654 st nst last)
2660 ;; Continue looking for substatements until we are past orig
2674 ;; If a continuation line starts here, move to next line
2680 "Return the type of the current IDL statement.
2681 Uses `idlwave-statement-match' to return a cons of (type . point) with
2682 point the ending position where the type was determined. Type is the
2683 association from `idlwave-statement-match', i.e. the cons cell from the
2684 list not just the type symbol. Returns nil if not an identifiable
2685 statement."
2687 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2688 ;; and possibly comments
2700 "Pad '=' with spaces.
2701 Two cases: Assignment statement, and keyword assignment.
2702 Which case is determined using `idlwave-start-of-substatement' and
2703 `idlwave-statement-type'. The equal sign will be surrounded by BEFORE
2704 and AFTER blanks. If `idlwave-pad-keyword' is t then keyword assignment
2705 is treated just like assignment statements. When nil, spaces are
2706 removed for keyword assignment. Any other value keeps the current space
2707 around the `='. Limits in for loops are treated as keyword assignment.
2709 Starting with IDL 6.0, a number of op= assignments are available.
2710 Since ambiguities of the form:
2712 r and= b
2713 rand= b
2715 can occur, alphanumeric operator assignment will never be pre-padded,
2716 only post-padded. You must use a space before these to disambiguate
2717 \(not just for padding, but for proper parsing by IDL too!). Other
2718 operators, such as ##=, ^=, etc., will be pre-padded.
2720 IS-ACTION is ignored.
2722 See `idlwave-surround'."
2735 ;; Why doesn't ##? work for both?
2739 ;(setq begin nil) ; won't modify begin
2743 ;; Everything gets padded equally
2745 ;; Treating keywords/for variables specially...
2763 "Call `idlwave-indent-line' and do expand actions.
2764 With prefix ARG non-nil, indent the entire sub-statement."
2772 ;;Expand the END abbreviation, just as RET or Space would have.
2783 "Indent current IDL line as code or as a comment.
2784 The actions in `idlwave-indent-action-table' are performed.
2785 If the optional argument EXPAND is non-nil then the actions in
2786 `idlwave-indent-expand-table' are performed."
2788 ;; Move point out of left margin.
2797 ;; Indentation for a line comment
2801 ;;
2802 ;; Code Line
2803 ;;
2804 ;; Before indenting, run action routines.
2805 ;;
2808 ;;
2811 ;;
2812 ;; No longer expand abbrevs on the line. The user can do this
2813 ;; manually using expand-region-abbrevs.
2814 ;;
2815 ;; Indent for code line
2816 ;;
2819 ;; a label line
2821 ;; a batch command
2823 ;; leave flush left
2824 nil
2825 ;; indent the line
2827 ;; Adjust parallel comment
2830 ;; Emacs 21 is too smart with fill-column on comment indent
2833 fill-column)))
2836 ;; Get rid of marker
2840 "Perform an action repeatedly on a line.
2841 ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is
2842 either a function name to be called with `funcall' or a list to be
2843 evaluated with `eval'. The action performed by FUNC should leave
2844 point after the match for REG - otherwise an infinite loop may be
2845 entered. FUNC is always passed a final argument of 'is-action, so it
2846 can discriminate between being run as an action, or a key binding."
2856 "Indent from point with spaces until column COL.
2857 Inserts space before markers at point."
2863 "Indent the current line to column COL.
2864 Indents such that first non-whitespace character is at column COL
2865 Inserts spaces before markers at point."
2872 "Indent program unit which contains point."
2884 "Indent current statement, including all continuation lines."
2893 "Return appropriate indentation for current line as IDL code."
2897 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2898 ;; function
2901 ;; Check for continuation line
2906 ;; calculate indent based on previous and current statements
2909 ;; calculate indent based on previous statement
2912 ;; Beginning of file
2917 ;; Main block
2920 idlwave-main-block-indent))
2921 ;; Begin block
2924 idlwave-block-indent))
2925 ;; End Block
2928 ;; Match to the *beginning* of the block opener
2932 ;; idlwave-end-offset
2933 ;; idlwave-block-indent))
2935 ;; Default to current indent
2937 ;; adjust the indentation based on the current statement
2939 ;; End block
2944 ;;
2945 ;; Parentheses indent
2946 ;;
2949 "Calculate the continuation indent inside a paren group.
2950 Returns a cons-cell with (open . indent), where open is the
2951 location of the open paren."
2953 ;; Found an innermost open paren.
2956 ;; Line up with next word unless this is a closing paren.
2959 ;; Plain Kernighan-style nested indent
2963 ;; This is a closed paren - line up under open paren.
2967 ;; Empty (or just comment) follows -- revert to basic indent
2969 ;; Skip paren
2972 nil)
2974 ;; Line up with first word after any blank space
2980 "Calculates the IDL continuation indent column from the previous statement.
2981 Note that here previous statement usually means the beginning of the
2982 current statement if this statement is a continuation of the previous
2983 line. Various special types of continuations, including assignments,
2984 routine definitions, and parenthetical groupings, are treated separately."
2995 idlwave-continuation-indent))
2996 fancy-nonparen-indent fancy-paren-indent)
2998 ;; Align then with its matching if, etc.
3005 match cont-re)
3020 ;; Indent in from the previous line for continuing statements
3025 match)
3037 ;; Parenthetical indent, either traditional or Kernighan style
3044 indent-cons)
3047 beg-reg end-reg close-exp))
3048 ;; First permitted containing paren
3050 idlwave-indent-to-open-paren
3051 idlwave-indent-parens-nested
3054 idlwave-max-extra-continuation-indent))
3057 fancy-paren-indent)
3059 ;; A continued assignment, or procedure call/definition
3067 ;; A continued Procedure call or definition
3070 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3072 ;; Comment only, or blank line with "$"? Basic indent.
3074 nil
3077 ;; Continued assignment (with =):
3091 idlwave-max-extra-continuation-indent))
3094 fancy-nonparen-indent))
3096 ;; Basic indent, by default
3102 "Move to next match of the regular expression KEY-RE.
3103 Matches inside comments or string constants will be ignored.
3104 If DIR is negative, the search will be backwards.
3105 At a successful match, the mark is pushed unless NOMARK is non-nil.
3106 Searches are limited to LIMIT.
3107 Searches are case-insensitive and use a special syntax table which
3108 treats `$' and `_' as word characters.
3109 Return value is the beginning of the match or (in case of failure) nil."
3113 found)
3127 found)
3128 nil)))
3131 "When optional argument DIR is non-negative, move forward to end of
3132 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3133 regular expressions. When DIR is negative, move backwards to block beginning.
3134 Recursively calls itself to skip over nested blocks. DIR defaults to
3135 forward. Calls `push-mark' unless the optional argument NOMARK is
3136 non-nil. Movement is limited by the start of program units because of
3137 possibility of unbalanced blocks."
3144 idlwave-begin-block-reg
3145 idlwave-end-block-reg))
3146 found
3148 idlwave-end-block-reg))
3152 idlwave-begin-unit-reg dir t limit)
3155 idlwave-end-unit-reg dir t limit)))
3156 limit)))
3168 "The minimum indent in the current statement."
3179 min
3183 "Return indentation of the current statement.
3184 If in a statement, moves to beginning of statement before finding indent."
3191 "Return the column of the indentation of the current line.
3192 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3196 ;; if we are at the end of blank line return 0
3201 "Test if current line is continuation line.
3202 Blank or comment-only lines following regular continuation lines (with
3203 `$') count as continuations too."
3214 "Test if the current line is a comment line."
3220 "Test if the current line is a comment line."
3226 "Search current line from current point for REGEXP.
3227 If optional argument CONT is non-nil, searches to the end of
3228 the current statement.
3229 If optional arg BEG is non-nil, search starts from the beginning of the
3230 current statement.
3231 Ignores matches that end in a comment or inside a string expression.
3232 Returns point if successful, nil otherwise.
3233 This function produces unexpected results if REGEXP contains quotes or
3234 a comment delimiter. The search is case insensitive.
3235 If successful leaves point after the match, otherwise, does not move point."
3241 found)
3247 found))
3250 "Fill paragraphs in comments.
3251 A paragraph is made up of all contiguous lines having the same comment
3252 leader (the leading whitespace before the comment delimiter and the
3253 comment delimiter). In addition, paragraphs are separated by blank
3254 line comments. The indentation is given by the hanging indent of the
3255 first line, otherwise by the minimum indentation of the lines after
3256 the first line. The indentation of the first line does not change.
3257 Does not effect code lines. Does not fill comments on the same line
3258 with code. The hanging indent is given by the end of the first match
3259 matching `idlwave-hang-indent-regexp' on the paragraph's first line.
3260 If the optional argument NOHANG is non-nil then the hanging indent is
3261 ignored."
3263 ;; check if this is a line comment
3270 pre here diff fill-prefix-reg bcl first-indent
3271 hang start end)
3272 ;; Change tabs to spaces in the surrounding paragraph.
3273 ;; The surrounding paragraph will be the largest containing block of
3274 ;; contiguous line comments. Thus, we may be changing tabs in
3275 ;; a much larger area than is needed, but this is the easiest
3276 ;; brute force way to do it.
3277 ;;
3278 ;; This has the undesirable side effect of replacing the tabs
3279 ;; permanently without the user's request or knowledge.
3287 ;;
3293 ;; Get the comment leader on the line and its length
3295 ;; the comment leader is the indentation plus exactly the
3296 ;; number of consecutive ";".
3303 ;; Mark the beginning and end of the paragraph
3309 ;; Move to first line of paragraph
3323 ;; if at end of buffer add a newline (need this because
3324 ;; fill-region needs END to be at the beginning of line after
3325 ;; the paragraph or it will add a line).
3328 ;; Set END to the beginning of line after the paragraph
3329 ;; END is calculated as distance from end of buffer
3331 ;;
3332 ;; Calculate the indentation for the paragraph.
3333 ;;
3334 ;; In the following while statements, after one iteration
3335 ;; point will be at the beginning of a line in which case
3336 ;; the while will not be executed for the
3337 ;; the first paragraph line and thus will not affect the
3338 ;; indentation.
3339 ;;
3340 ;; First check to see if indentation is based on hanging indent.
3346 ;; Adjust lines of paragraph by inserting spaces so that
3347 ;; each line's indent is at least as great as the hanging
3348 ;; indent. This is needed for fill-paragraph to work with
3349 ;; a fill-prefix.
3358 ;; adjust the original location for the
3359 ;; inserted text.
3363 )
3365 ;; No hang. Instead find minimum indentation of paragraph
3366 ;; after first line.
3367 ;; For the following while statement, since START is at the
3368 ;; beginning of line and END is at the end of line
3369 ;; point is greater than START at least once (which would
3370 ;; be the case for a single line paragraph).
3381 ?\ )))
3382 ;; first-line indent
3388 indent))
3390 ;; try to keep point at its original place
3393 ;; In place of the more modern fill-region-as-paragraph, a hack
3394 ;; to keep whitespace untouched on the first line within the
3395 ;; indent length and to preserve any indent on the first line
3396 ;; (first indent).
3402 start
3405 nil)
3409 ;; When we want the point at the beginning of the comment
3410 ;; body fill-region will put it at the beginning of the line.
3415 "Calculate the position of the hanging indent for the comment paragraph.
3416 The hanging indent position is given by the first match with the
3417 `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3418 non-nil then use last occurrence matching `idlwave-hang-indent-regexp'
3419 on the line.
3420 If not found returns nil."
3432 "Called to break lines in auto fill mode.
3433 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3434 non-nil. Places a continuation character at the end of the line if
3435 not in a comment. Splits strings with IDL concatenation operator `+'
3436 if `idlwave-auto-fill-split-string' is non-nil."
3438 nil ; do not to fill
3441 ;; Check for comment line
3446 ;; Prevent actions do-auto-fill which calls indent-line-function.
3451 idlwave-auto-fill-split-string)
3454 ))))
3458 ;; Indent the split line
3463 ;; A continued line comment
3464 ;; We treat continued line comments as part of a comment
3465 ;; paragraph. So we check for a hanging indent.
3473 ;; Remove whitespace between comment delimiter and
3474 ;; text, insert spaces for appropriate indentation.
3480 ;; Split code or comment?
3484 ;; Splitting a non-full-line comment.
3485 ;; Insert the comment delimiter from split line
3490 ;; Insert blank to keep off beginning of line
3499 ;; Split code line - add continuation character
3502 ;; Check to see if we split a string
3504 idlwave-auto-fill-split-string)
3505 ;; Split the string and concatenate.
3506 ;; The first extra space is for the space
3507 ;; the line was split. That space was removed.
3512 ;; Make the second part of continued string
3517 ;; Warning
3520 ;; Although do-auto-fill (via indent-new-comment-line) calls
3521 ;; idlwave-indent-line for the new line, re-indent again
3522 ;; because of the addition of the continuation character.
3524 )))))
3527 "Toggle auto-fill mode for IDL mode.
3528 With arg, turn auto-fill mode on if arg is positive.
3529 In auto-fill mode, inserting a space at a column beyond `fill-column'
3530 automatically breaks the line at a previous space."
3536 'idlwave-auto-fill
3537 nil))
3538 ;; update mode-line
3541 ;(defun idlwave-fill-routine-call ()
3542 ; "Fill a routine definition or statement, indenting appropriately."
3543 ; (let ((where (idlwave-where)))))
3547 "Insert a documentation header at the beginning of the unit.
3548 Inserts the value of the variable `idlwave-file-header'. Sets mark
3549 before moving to do insertion unless the optional prefix argument
3550 NOMARK is non-nil."
3553 ;; make sure we catch the current line if it begins the unit
3559 ;; skip function or procedure line
3573 "Default timestamp insertion function."
3579 ;; Remove extra spaces from line
3581 ;; Insert a blank line comment to separate from the date entry -
3582 ;; will keep the entry from flowing onto date line if re-filled.
3586 "Insert a brief modification log at the beginning of the current program.
3587 Looks for an occurrence of the value of user variable
3588 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user
3589 name and places the point for the user to add a log. Before moving, saves
3590 location on mark ring so that the user can return to previous point."
3605 end t)
3616 ;; CJC 3/16/93
3617 ;; Interface to expand-region-abbrevs which did not work when the
3618 ;; abbrev hook associated with an abbrev moves point backwards
3619 ;; after abbrev expansion, e.g., as with the abbrev '.n'.
3620 ;; The original would enter an infinite loop in attempting to expand
3621 ;; .n (it would continually expand and unexpand the abbrev without expanding
3622 ;; because the point would keep going back to the beginning of the
3623 ;; abbrev instead of to the end of the abbrev). We now keep the
3624 ;; abbrev hook from moving backwards.
3625 ;;;
3627 "Expand each abbrev occurrence in the region.
3628 Calling from a program, arguments are START END."
3637 "Return t if point is in a comment or quoted string.
3638 Returns nil otherwise."
3642 "Return location of the opening quote
3643 if point is in a IDL string constant, nil otherwise.
3644 Ignores comment delimiters on the current line.
3645 Properly handles nested quotation marks and octal
3646 constants - a double quote followed by an octal digit."
3647 ;; Treat an octal inside an apostrophe to be a normal string. Treat a
3648 ;; double quote followed by an octal digit to be an octal constant
3649 ;; rather than a string. Therefore, there is no terminating double
3650 ;; quote.
3652 ;; Because single and double quotes can quote each other we must
3653 ;; search for the string start from the beginning of line.
3659 delim
3660 found)
3662 ;; Find string start
3663 ;; Don't find an octal constant beginning with a double quote
3665 ;; Find the string end.
3666 ;; In IDL, two consecutive delimiters after the start of a
3667 ;; string act as an
3668 ;; escape for the delimiter in the string.
3669 ;; Two consecutive delimiters alone (i.e., not after the
3670 ;; start of a string) is the null string.
3672 ;; Move to position after quote
3675 ;; Get the string delimiter
3677 ;; Check for null string
3680 ;; Look for next unpaired delimiter
3686 ))
3689 ;; return string beginning position or nil
3693 "Determine if the character after point is a pointer dereference *."
3703 ;; Statement templates
3705 ;; Replace these with a general template function, something like
3706 ;; expand.el (I think there was also something with a name similar to
3707 ;; dmacro.el)
3710 "Build a template with optional prompt expression.
3712 Opens a line if point is not followed by a newline modulo intervening
3713 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3714 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3715 adjusted according to `idlwave-abbrev-change-case'. If optional
3716 argument PROMPT is a string then it is displayed as a message in the
3717 minibuffer. The PROMPT serves as a reminder to the user of an
3718 expression to enter.
3720 The lines containing S1 and S2 are reindented using `indent-region'
3721 unless the optional second argument NOINDENT is non-nil."
3723 ;; This is a gross hack to avoit template abbrev expansion
3724 ;; in the shell. FIXME: This is a dirty hack.
3734 end)
3747 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3750 string))
3753 "Build skeleton IDL if-else block."
3761 "Build skeleton IDL case statement."
3769 "Build skeleton IDL switch statement."
3777 "Build skeleton IDL loop statement."
3785 "Build skeleton IDL if statement."
3821 "Return a list of substrings of STRING which are separated by PATTERN.
3835 end)
3843 ;; Return the buffer currently visiting FILE
3853 "List of buffers pulled up by IDLWAVE for special reasons.
3857 ;; Return a buffer visiting file.
3861 buf)))
3864 "Kill buffers created automatically by IDLWAVE.
3865 Function prompts for a letter to identify the buffers to kill.
3866 Possible letters are:
3869 clicks in the routine info window.
3870 s Buffers created by the IDLWAVE Shell to display where execution
3871 stopped or an error was found.
3872 a Both of the above.
3874 Buffers containing unsaved changes require confirmation before they are killed."
3878 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3892 "How many outlawed buffers have tag TAG?"
3896 idlwave-outlawed-buffers))))
3899 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3902 entry)
3916 "Remove BUFFER from the buffers which may be killed.
3917 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3918 Intended for `after-save-hook'."
3921 ;; Revoke license
3925 ;; Remove this function from the hook.
3930 ;; Find FILE on the scanned lib path and return a buffer visiting it
3932 dir efile)
3940 ;; Find FILE on the scanned lib path and return a buffer visiting it
3941 ;; This is for, e.g., finding source with no user catalog
3948 "Create the IDL tags file IDLTAGS in the current directory from
3949 the list of directories specified in the minibuffer. Directories may be
3950 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
3951 specified top directories are searched if the directory name is prefixed
3952 by @. Specify @ directories with care, it may take a long, long time if
3953 you specify /."
3956 buffer save_buffer files numfiles item errbuf)
3958 ;;
3959 ;; Read list of directories
3962 ;;
3963 ;; Set etags command, vars
3969 ;;
3970 ;; For each directory
3974 ;;
3975 ;; Find the subdirectories
3997 ;;
3998 ;; For each subdirectory
4002 ;;
4003 ;; Call etags
4012 0
4014 ;;
4015 ;; Append additional tags
4022 )))
4034 ))
4037 "Comment the lines in the region if the first non-blank line is
4038 commented, and conversely, uncomment region. If optional prefix arg
4039 N is non-nil, then for N positive, add N comment delimiters or for N
4040 negative, remove N comment delimiters.
4041 Uses `comment-region' which does not place comment delimiters on
4042 blank lines."
4049 ;; skip blank lines
4061 ;; ----------------------------------------------------------------------------
4062 ;; ----------------------------------------------------------------------------
4063 ;; ----------------------------------------------------------------------------
4064 ;; ----------------------------------------------------------------------------
4065 ;;
4066 ;; Completion and Routine Info
4067 ;;
4069 ;; String "intern" functions
4071 ;; For the completion and routine info function, we want to normalize
4072 ;; the case of procedure names etc. We do this by "interning" these
4073 ;; string is a hand-crafted way. Hashes are used to map the downcase
4074 ;; version of the strings to the cased versions. Most *-sint-*
4075 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4076 ;; system hash. The former is re-scanned, and the latter takes case
4077 ;; precedence.
4078 ;;
4079 ;; Since these cased versions are really lisp objects, we can use `eq'
4080 ;; to search, which is a large performance boost. All new strings
4081 ;; need to be "sinterned". We do this as early as possible after
4082 ;; getting these strings from completion or buffer substrings. So
4083 ;; most of the code can simply assume to deal with "sinterned"
4084 ;; strings. The only exception is that the functions which scan whole
4085 ;; buffers for routine information do not intern the grabbed strings.
4086 ;; This is only done afterwards. Therefore in these functions it is
4087 ;; *not* safe to assume the strings can be compared with `eq' and be
4088 ;; fed into the routine assq functions.
4090 ;; Here we define the hashing functions.
4092 ;; The variables which hold the hashes.
4101 "Reset all sintern hashes."
4102 ;; Make sure the hash functions are accessible.
4113 ;; Make sure these are lists
4118 ;; Reset the system & library hash
4126 idlwave-sint-libnames nil))
4128 ;; Reset the buffer & shell hash
4144 ;;(defmacro idlwave-sintern (type var)
4145 ;; `(cond ((not (stringp name)) name)
4146 ;; ((gethash (downcase name) (cdr ,var)))
4147 ;; ((gethash (downcase name) (car ,var)))
4148 ;; (set (idlwave-sintern-set name ,type ,var set))
4149 ;; (name)))
4189 iname))
4192 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4196 kwd-list)
4199 "Sintern all strings in the rinfo LIST.
4200 With optional parameter SET: also set new patterns. Probably this
4201 will always have to be t. If DEFAULT-DIR is passed, it is used as
4202 the base of the directory."
4214 ;; The class and name
4222 ;; The source
4235 ;; The keywords
4238 kwds))
4240 ;; Build a canonicalized list
4245 ;; Creating new sintern tables
4248 "Define a variable and a function to sintern the new type TAG.
4249 This defines the function `idlwave-sintern-TAG' and the variable
4250 `idlwave-sint-TAGs'."
4262 name)
4266 "Reset the sintern variable associated with TAG."
4269 ;;---------------------------------------------------------------------------
4272 ;; The variables which hold the information
4288 "Alist with !PATH directories and zero or more flags if the dir has
4289 been scanned in a user catalog ('user) or discovered in a library
4305 ;;
4306 ;; The code to get routine info from different sources.
4313 "Provide a list of IDL routines.
4314 This routine loads the builtin routines on the first call.
4315 Later it only returns the value of the variable."
4325 ;; Keep it running...
4326 )
4328 ;; Something is wrong, get rid of the process
4337 ;; return the current value
4338 idlwave-routines)))
4341 "List of functions which should run after a global rinfo update.
4345 "Rescan the previously selected directories. For batch processing."
4349 "Dispatch another Emacs instance to update the idlwave catalog.
4350 After the process finishes normally, the first access to routine info
4351 will re-read the catalog."
4375 nil emacs args)))
4378 process
4382 idlwave-system-routines nil
4383 idlwave-catalog-process nil)
4389 ;; Format for all routine info user catalog, library catalogs, etc.:
4390 ;;
4391 ;; ("ROUTINE" type class
4392 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4393 ;; (buffer pro_file dir) | (compiled pro_file dir)
4394 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4395 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4396 ;;
4397 ;; DIR will be supplied dynamically while loading library catalogs,
4398 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4399 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4400 ;; be nil, as can LINK1, etc., if no HTML help is available.
4407 "Update the internal routine-info lists.
4410 about individual routines.
4412 The information can come from 4 sources:
4413 1. IDL programs in the current editing session
4414 2. Compiled modules in an IDL shell running as Emacs subprocess
4415 3. A list which covers the IDL system routines.
4416 4. A list which covers the prescanned library files.
4418 Scans all IDLWAVE-mode buffers of the current editing session (see
4419 `idlwave-scan-all-buffers-for-routine-info').
4420 When an IDL shell is running, this command also queries the IDL program
4421 for currently compiled routines.
4423 With prefix ARG, also reload the system and library lists.
4424 With two prefix ARG's, also rescans the chosen user catalog tree.
4425 With three prefix args, dispatch asynchronous process to do the update.
4427 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4428 lists, but instead wait for the shell query to complete and
4429 asynchronously finish updating routine info. This is set
4430 automatically when called interactively. When you need routine
4431 information updated immediately, leave NO-CONCATENATE nil."
4433 ;; Stop any idle processing
4441 ;; Start a background process which updates the catalog.
4444 ;; Update the user catalog now, and wait for them.
4448 idlwave-buffer-case-takes-precedence
4450 ;; The override-idle means, even if the idle timer has done some
4451 ;; preparing work, load and renormalize everything anyway.
4455 idlwave-compiled-routines nil
4456 idlwave-unresolved-routines nil)
4457 ;; Reset the appropriate hashes
4459 ;; reset was already done in idle time, so skip this step now once
4466 ;; We can safely scan the buffer stuff first
4470 ;; We first do the system info, and then the buffers
4474 ;; Let's see if there is a shell
4478 idlwave-query-shell-for-routine-info)))
4480 ;; Load the library catalogs again, first re-scanning the path
4492 ;; 1. If we are not going to ask the shell, we need to do the
4493 ;; concatenation now.
4494 ;; 2. When this function is called non-interactively, it
4495 ;; means that someone needs routine info *now*. The
4496 ;; shell update causes the concatenation to be
4497 ;; *delayed*, so not in time for the current command.
4498 ;; Therefore, we do a concatenation now, even though
4499 ;; the shell might do it again.
4503 ;; Ask the shell about the routines it knows of.
4526 idlwave-init-rinfo-when-idle-after
4532 ;;------ XML Help routine info system
4534 ;; Load the system routine info from the cached routine info file,
4535 ;; which, if necessary, will be re-created from the XML file on
4536 ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo
4537 ;; file distributed with older IDLWAVE versions (<6.0)
4541 ;; See if we can create it from XML source
4561 idlwave-xml-system-rinfo-converted-file
4562 catalog-file)))
4566 "Alist of system variables and the associated structure tags.
4574 ;; From a list of syntax statements, shorten with %s and group with "or"
4583 x)
4588 ;; Create a class list entry from the xml parsed list., returning a
4589 ;; cons of form (class-entry method-entries).
4595 class-entry
4596 method methods-entry extra-kwds
4597 props get-props set-props init-props inherits
4598 pelem ptype)
4628 init-props)
4631 get-props)
4634 set-props)
4638 methods-entry)))
4641 ;;(unless (get 'init-props 'matched)
4642 ;; (message "Failed to match Init in class %s" class))
4643 ;;(unless (get 'get-props 'matched)
4644 ;; (message "Failed to match GetProperty in class %s" class))
4645 ;;(unless (get 'set-props 'matched)
4646 ;; (message "Failed to match SetProperty in class %s" class))
4654 ;; Create correctly structured list elements from ROUTINE or METHOD
4655 ;; XML list structures. Return a list of list elements, with more
4656 ;; than one sub-list possible if a routine can serve as both
4657 ;; procedure and function (e.g. call_method).
4664 syntax kwd klink pref-list kwds pelem ptype props result type)
4699 ;; Debug
4700 ;; (if (and (null (aref syntax-vec 0))
4701 ;; (null (aref syntax-vec 1))
4702 ;; (null (aref syntax-vec 2)))
4703 ;; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints")
4704 ;; (if class
4705 ;; (insert (format "Missing SYNTAX entry for %s::%s\n" class name))
4706 ;; (insert (message "Missing SYNTAX entry for %s\n" name)))))
4708 ;; Executive commands are treated specially
4720 result)))
4724 ;; Group keywords by link file, as a list with elements
4725 ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2))
4737 ;; Ensure the master link is there
4740 linkfiles
4745 ;; Clean up the syntax of routines which are actually aliases by
4746 ;; removing the "OR" from the statements
4755 ;; Duplicate and trim original routine aliases from rinfo list
4756 ;; This if for, e.g. OPENR/OPENW/OPENU
4766 ;; Add any missing aliases (separate by slashes)
4781 ;; Duplicate and trim original routine aliases from rinfo list
4782 ;; This if for, e.g. !X, !Y, !Z.
4795 ;; Create a sysvar list entry from the xml parsed list.
4803 pelem ptype props tags)
4814 tags))))
4828 ;; Automatically generated from source file:
4833 idlwave-xml-routine-info-file))
4851 "Convert XML supplied IDL routine info into internal form.
4852 Cache to disk for quick recovery."
4858 props rinfo msg-cnt elem type nelem class-result alias
4859 routines routine-aliases statement-aliases sysvar-aliases)
4869 ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff.
4879 idlwave-system-variables-alist nil
4880 idlwave-system-class-info nil
4881 idlwave-executive-commands-alist nil
4882 idlwave-help-special-topic-words nil)
4898 routine-aliases)
4903 ;; a cons cell is an executive commands
4915 idlwave-help-special-topic-words)
4916 ;; Save the links to those which are statement aliases (not routines)
4925 sysvar-aliases)
4927 idlwave-system-variables-alist)))
4938 ;; ("ROUTINE" type class
4939 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4940 ;; (buffer pro_file dir) | (compiled pro_file dir)
4941 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4942 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4952 ;;(load "idlw-rinfo" 'noerror 'nomessage)
4974 ;; Check for the old style catalog and warn
4977 idlwave-library-routines)
4982 idlwave-user-catalog-file))
5009 ;; restart the timer
5014 idlwave-init-rinfo-when-idle-after
5020 ;; Load and case-treat the system, user catalog, and library routine
5021 ;; info files.
5023 ;; System
5025 ;;(load "idlw-rinfo" 'noerror 'nomessage))
5037 ;; User catalog
5046 idlwave-library-routines)
5049 idlwave-user-catalog-file))
5058 ;; Library catalog
5069 ;; Scan all buffers, current buffer last
5074 ;; Don't scan any buffers
5077 ;; Just scan this buffer
5083 ;; Put the result into the correct variable
5088 "Put the different sources for routine information together."
5089 ;; The sequence here is important because earlier definitions shadow
5090 ;; later ones. We assume that if things in the buffers are newer
5091 ;; then in the shell of the system, they are meant to be different.
5094 idlwave-compiled-routines
5095 idlwave-library-catalog-routines
5096 idlwave-user-catalog-routines))
5099 ;; Give a message with information about the number of routines we have.
5102 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
5112 "Return the class alist - make it if necessary."
5119 idlwave-class-alist)))
5121 ;; Three functions for the hooks
5130 "Update `idlwave-routines' for current buffer.
5131 Can run from `after-save-hook'."
5135 idlwave-scan-all-buffers-for-routine-info
5136 idlwave-routines)
5142 nil
5148 routines)
5152 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
5154 found)
5156 ;; The following test uses eq to make sure it works correctly
5157 ;; when two buffers visit the same file. Then the file names
5158 ;; will be equal, but not eq.
5164 ;; End of that section reached. Jump.
5170 ;;----- Scanning buffers -------------------
5173 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
5179 buffer-file-name)
5180 ;; yes, this buffer has the right mode.
5185 ;; Concatenate the individual lists and return the result
5189 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
5191 routine-list string entry)
5205 routine-list))
5210 "Parse a module definition."
5212 start name args type keywords class)
5213 ;; Remove comments
5216 ;; Remove the continuation line stuff
5221 ;; Match the name and type.
5229 ;; Match normal args and keyword args
5232 string start)
5237 ;; Normalize and sort.
5241 ;; Make and return the entry
5242 ;; We don't know which argument are optional, so this information
5243 ;; will not be contained in the calling sequence.
5246 class
5249 ; ((string= (downcase
5250 ; (file-name-sans-extension
5251 ; (file-name-nondirectory (buffer-file-name))))
5252 ; (downcase name))
5253 ; (list 'lib))
5254 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
5260 "%s"
5268 nil))))
5271 ;;----- Scanning the user catalog -------------------
5274 "Return the syslib directory, or a dummy that never matches."
5278 idlwave-system-directory)
5284 "Scan all files on selected dirs of IDL search path for routine information.
5286 A widget checklist will allow you to choose the directories. Write
5287 the result as a file `idlwave-user-catalog-file'. When this file
5288 exists, it will be automatically loaded to give routine information
5289 about library routines. With ARG, just rescan the same directories
5290 as last time - so no widget will pop up."
5292 ;; Make sure the file is loaded if it exists.
5298 ;; Make sure the file name makes sense
5304 idlwave-user-catalog-file))))
5308 ;; Rescan the known directories
5313 ;; Expand the directories from library-path and run the widget
5317 ;; Propagate any flags on the existing path-alist
5320 idlwave-true-path-alist)))
5327 ;; Ask the shell for the path and then run the widget
5336 ;; Parse shell path information and select among it.
5338 ;; Command hook used by `idlwave-create-user-catalog-file'.
5340 ;; Scan immediately
5342 ;; Set the path and display the widget
5348 "This is the front-end to the creation of the IDLWAVE user catalog.
5349 Please select the directories on IDL's search path from which you
5350 would like to extract routine information, to be stored in the file:
5352 %s
5354 If this is not the correct file, first set variable
5355 `idlwave-user-catalog-file', and call this command again.
5357 N.B. Many libraries include pre-scanned catalog files
5359 not be scanned. You can scan your own libraries off-line using the
5360 perl script `idlwave_catalog'.
5362 After selecting the directories, choose [Scan & Save] to scan the library
5363 directories and save the routine info.
5369 "Create the widget to select IDL search path directories for scanning."
5381 idlwave-user-catalog-file))
5392 :notify
5402 :notify
5420 'checklist
5424 dirs-list))
5425 :greedy t
5447 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
5452 dir-entry)
5458 selected-dirs)
5465 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5469 dirs-alist dir files file)
5471 idlwave-path-alist path-alist ; for library-path instead
5472 idlwave-true-path-alist nil)
5493 idlwave-user-catalog-routines)))))))))
5501 font-lock-mode)
5507 ;; Define the routine info list
5514 idlwave-user-catalog-routines))
5518 ;; Save the buffer
5524 idlwave-user-catalog-file)
5542 font-lock-mode)
5547 ;; Define the variable which knows the value of "!DIR"
5549 idlwave-system-directory))
5551 ;; Define the variable which contains a list of all scanned directories
5558 idlwave-path-alist))
5565 ;; Expand parts of path starting with '+' recursively into directory list.
5566 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5576 ;; Expand recursively
5578 ;; Keep unchanged
5584 ;; Return a list of all directories below DIR, including DIR itself
5593 path1))
5596 ;;----- Scanning the library catalogs ------------------
5602 "Scan for library catalog files (.idlwave_catalog) and ingest.
5604 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5605 instead, if present) are searched. Print MESSAGE-BASE along with the
5606 libraries being loaded, if passed, and skip loading/normalizing if
5607 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5608 be set to nil to disable library catalog scanning."
5615 dir-entry dir catalog all-routines)
5623 ;; Load the catalog file
5628 message-base
5630 old-libname)))
5632 idlwave-library-catalog-libname))
5639 all-routines))))
5641 ;; Add a 'lib flag if on path-alist
5648 ;;----- Communicating with the Shell -------------------
5650 ;; First, here is the idl program which can be used to query IDL for
5651 ;; defined routines.
5653 "
5654 ;; START OF IDLWAVE SUPPORT ROUTINES
5655 pro idlwave_print_safe,item,limit
5656 catch,err
5657 if err ne 0 then begin
5658 print,'Could not print item.'
5659 return
5660 endif
5661 if n_elements(item) gt limit then $
5662 print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $
5663 else print,item
5664 end
5666 pro idlwave_print_info_entry,name,func=func,separator=sep
5667 ;; See if it's an object method
5668 if name eq '' then return
5669 func = keyword_set(func)
5670 methsep = strpos(name,'::')
5671 meth = methsep ne -1
5673 ;; Get routine info
5674 pars = routine_info(name,/parameters,functions=func)
5675 source = routine_info(name,/source,functions=func)
5676 nargs = pars.num_args
5677 nkw = pars.num_kw_args
5678 if nargs gt 0 then args = pars.args
5679 if nkw gt 0 then kwargs = pars.kw_args
5681 ;; Trim the class, and make the name
5682 if meth then begin
5683 class = strmid(name,0,methsep)
5684 name = strmid(name,methsep+2,strlen(name)-1)
5685 if nargs gt 0 then begin
5686 ;; remove the self argument
5687 wh = where(args ne 'SELF',nargs)
5688 if nargs gt 0 then args = args[wh]
5689 endif
5690 endif else begin
5691 ;; No class, just a normal routine.
5693 endelse
5695 ;; Calling sequence
5697 if func then cs = 'Result = '
5698 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5699 cs = cs + '%s'
5700 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5701 if nargs gt 0 then begin
5702 for j=0,nargs-1 do begin
5703 cs = cs + args[j]
5704 if j lt nargs-1 then cs = cs + ', '
5705 endfor
5706 end
5707 if func then cs = cs + ')'
5708 ;; Keyword arguments
5709 kwstring = ''
5710 if nkw gt 0 then begin
5711 for j=0,nkw-1 do begin
5712 kwstring = kwstring + ' ' + kwargs[j]
5713 endfor
5714 endif
5716 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5718 print,ret + ': ' + name + sep + class + sep + source[0].path $
5719 + sep + cs + sep + kwstring
5720 end
5722 pro idlwave_routine_info,file
5723 on_error,1
5724 sep = '<@>'
5726 all = routine_info()
5727 fileQ=n_elements(file) ne 0
5728 if fileQ then file=strtrim(file,2)
5729 for i=0L,n_elements(all)-1L do begin
5730 if fileQ then begin
5731 if (routine_info(all[i],/SOURCE)).path eq file then $
5732 idlwave_print_info_entry,all[i],separator=sep
5733 endif else idlwave_print_info_entry,all[i],separator=sep
5734 endfor
5735 all = routine_info(/functions)
5736 for i=0L,n_elements(all)-1L do begin
5737 if fileQ then begin
5738 if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $
5739 idlwave_print_info_entry,all[i],separator=sep,/FUNC
5740 endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC
5741 endfor
5742 print,'>>>END OF IDLWAVE ROUTINE INFO'
5743 end
5745 pro idlwave_get_sysvars
5746 on_error,1
5747 catch,error_status
5748 if error_status ne 0 then begin
5749 print, 'Cannot get info about system variables'
5750 endif else begin
5751 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5752 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5753 v = strsplit(s,' +',/regex,/extract) ; get variables
5754 for i=0L,n_elements(v)-1 do begin
5755 t = [''] ; get tag list
5756 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5757 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5758 endfor
5759 endelse
5760 end
5762 pro idlwave_get_class_tags, class
5763 res = execute('tags=tag_names({'+class+'})')
5764 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5765 end
5766 ;; END OF IDLWAVE SUPPORT ROUTINES
5767 "
5788 (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5793 ;; Restore if necessary. Must use execute to hide lame routine_info
5794 ;; errors on undefinded routine
5796 (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'"
5797 idlwave-shell-temp-rinfo-save-file
5798 idlwave-shell-temp-rinfo-save-file)
5803 "Query the shell for routine_info of compiled modules and update the lists."
5804 ;; Save and compile the procedure. The compiled procedure is then
5805 ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may
5806 ;; need to test for and possibly RESTORE the procedure each time we
5807 ;; use it, since the user may have killed or redefined it. In
5808 ;; particular, .RESET_SESSION will kill all user procedures. If
5809 ;; FILE is set, only update routine info for routines in that file.
5812 ; execute the routine_info procedure, and analyze the output
5820 ;; ---------------------------------------------------------------------------
5821 ;;
5822 ;; Completion and displaying routine calling sequences
5834 "Complete a function, procedure or keyword name at point.
5835 This function is smart and figures out what can be completed
5836 at this point.
5837 - At the beginning of a statement it completes procedure names.
5838 - In the middle of a statement it completes function names.
5839 - After a `(' or `,' in the argument list of a function or procedure,
5840 it completes a keyword of the relevant function or procedure.
5841 - In the first arg of `OBJ_NEW', it completes a class name.
5843 When several completions are possible, a list will be displayed in
5844 the *Completions* buffer. If this list is too long to fit into the
5845 window, scrolling can be achieved by repeatedly pressing
5848 The function also knows about object methods. When it needs a class
5849 name, the action depends upon `idlwave-query-class', which see. You
5850 can force IDLWAVE to ask you for a class name with a
5853 See also the variables `idlwave-keyword-completion-adds-equal' and
5854 `idlwave-function-completion-adds-paren'.
5856 The optional ARG can be used to specify the completion type in order
5857 to override IDLWAVE's idea of what should be completed at point.
5858 Possible values are:
5860 0 <=> query for the completion type
5861 1 <=> 'procedure
5862 2 <=> 'procedure-keyword
5863 3 <=> 'function
5864 4 <=> 'function-keyword
5865 5 <=> 'procedure-method
5866 6 <=> 'procedure-method-keyword
5867 7 <=> 'function-method
5868 8 <=> 'function-method-keyword
5869 9 <=> 'class
5871 As a special case, the universal argument C-u forces completion of
5872 function names in places where the default would be a keyword.
5874 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5875 completion.
5877 For Lisp programmers only:
5878 When we force a keyword, optional argument MODULE can contain the module name.
5879 When we force a method or a method keyword, CLASS can specify the class."
5906 ;; Complete a filename in quotes
5911 ;; Check for any special completion functions
5918 ;; Complete a class
5924 ;; Complete a procedure name
5937 isa
5943 isa
5947 ;; Complete a function name
5960 isa
5966 isa
5974 ;; Complete a procedure keyword
5991 super-classes system))
6003 isa
6007 ;; Complete a function keyword
6020 msg-name)
6025 super-classes system))
6026 ;; OBJ_NEW: Messages mention the proper Init method
6033 msg-name))
6042 isa
6048 "List of special completion functions.
6049 These functions are called for each completion. Each function must
6050 check if its own special completion context is present. If yes, it
6051 should use `idlwave-complete-in-buffer' to do some completion and
6052 return t. If such a function returns t, *no further* attempts to
6053 complete other contexts will be done. If the function returns nil,
6058 fun ret)
6063 nil)))
6066 ;; Return an artificial WHERE specification to force the completion
6067 ;; routine to complete a specific item independent of context.
6068 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
6069 ;; MODULE and CLASS can be used to specify the routine name and class.
6070 ;; The class name will also be found in MODULE if that is like "class::mod".
6088 what)
6161 ;; Completing read, case insensitive
6171 "Use the comint stuff to complete a file name."
6179 idlwave-shell-default-directory
6180 default-directory)))
6184 ;; Make a fully qualified module name including the class name
6188 "Like `idlwave-rinfo-assq', but sintern strings first."
6194 ;; Works like assq, but also checks type and class
6205 ;; Return the first matching method on the inheritance list
6207 class rtn)
6211 rtn))
6214 keep-system)
6215 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
6216 If WITH-FILE is passed, find the best rinfo entry with a file
6217 included. If KEEP-SYSTEM is set, don't prune system for compiled
6218 syslib files."
6221 list))
6222 syslibp)
6229 ;; Its a compiled syslib, so we need to remove the system entry
6235 twins)))))
6239 keep-system)
6240 "Like `idlwave-best-rinfo-assq', but sintern strings first."
6246 "Does the entry list ENTRIES contain a syslib entry?
6247 If yes, return the index (>=1)."
6256 nil)))
6259 "Return a list of all associations of Key in LIST."
6267 "Return all classes which have a method METHOD.
6268 TYPE is 'fun or 'pro.
6269 When TYPE is not specified, both procedures and functions will be considered."
6282 "Return all classes which have a method METHOD with keyword KEYWORD.
6283 TYPE is 'fun or 'pro.
6284 When TYPE is not specified, both procedures and functions will be considered."
6287 nil
6299 "Return list of all elements in LIST which are also in CLUB."
6308 "Return list of all elements in LIST which are not in CLUB."
6312 nil
6318 "Return whether or not the class is listed explicitly, ala a->b::c.
6319 INFO is as returned by `idlwave-what-function' or `-procedure'."
6326 "List of special functions for determining class.
6330 ;; Determine the class of a routine call.
6331 ;; INFO is the `cw-list' structure as returned by idlwave-where.
6332 ;; The second element in this structure is the class. When nil, we
6333 ;; return nil. When t, try to get the class from text properties at
6334 ;; the arrow. When the object is "self", we use the class of the
6335 ;; current routine. otherwise prompt the user for a class name.
6336 ;; Also stores the selected class as a text property at the arrow.
6337 ;; TYPE is 'fun or 'pro.
6343 idlwave-query-class))
6345 idlwave-query-class))
6357 store special-class class-alist)
6361 ;; There is an object which would like to know its class
6363 idlwave-store-inquired-class
6370 ;; Before prompting, try any special class determination routines
6372 idlwave-determine-class-special
6378 store idlwave-store-inquired-class)))
6380 ;; Prompt for a class, if we need to
6401 ;; Store it, if requested
6403 ;; We have a real class here
6409 rear-nonsticky t))
6412 ;; Return the class
6413 class)
6414 ;; Default as fallback
6424 ;; Record a file link, if any, for the tested names during selection.
6428 sel))
6432 "Find out where we are.
6433 The return value is a list with the following stuff:
6434 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
6436 PRO-LIST (PRO POINT CLASS ARROW)
6437 FUNC-LIST (FUNC POINT CLASS ARROW)
6438 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
6439 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
6440 be completed here.
6441 LAST-CHAR last relevant character before point (non-white non-comment,
6442 not part of current identifier or leading slash).
6444 In the lists, we have these meanings:
6445 PRO: Procedure name
6446 FUNC: Function name
6447 POINT: Where is this
6448 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
6449 ARROW: Location of the arrow"
6467 cw cw-mod cw-arrow cw-class cw-point)
6471 match-string)
6477 match-string))
6479 cw-arrow pro-arrow))
6481 match-string)
6482 nil)
6484 match-string)
6487 match-string)
6494 cw-class func-class cw-arrow func-arrow))
6497 cw-class pro-class cw-arrow pro-arrow))
6498 ; ((member last-char '(?\' ?\) ?\] ?!))
6499 ; ;; after these chars, a function makes no sense
6500 ; ;; FIXME: I am sure there can be more in this list
6501 ; ;; FIXME: Do we want to do this at all?
6502 ; nil)
6503 ;; Everywhere else we try a function.
6507 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t)
6511 t))))))
6514 cw
6516 last-char)))
6519 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6527 ;; Find out if point is within the argument list of a function.
6528 ;; The return value is ("function-name" class arrow-start (point) level).
6529 ;; Level is 1 on the top level parentheses, higher further down.
6531 ;; If the optional BOUND is an integer, bound backwards directed
6532 ;; searches to this point.
6536 func-point
6538 func arrow-start class)
6543 ;; move back out of the current parenthesis
6552 bound t))
6555 pos func-point)
6561 'exit
6565 arrow-start func-point cnt)))
6570 ;; Find out if point is within the argument list of a procedure.
6571 ;; The return value is ("procedure-name" class arrow-pos (point)).
6573 ;; If the optional BOUND is an integer, bound backwards directed
6574 ;; searches to this point.
6576 pro class arrow-start string)
6578 ;;(idlwave-beginning-of-statement)
6588 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6589 string))
6594 pos)
6599 arrow-start
6600 pro-point)))
6603 ;; If there is an object at point, move over it and return t.
6613 nil)
6631 nil)))
6634 "Return the last character before point which is not white or a comment
6635 and also not part of the current identifier. Since we do this in
6636 order to identify places where keywords are, we consider the initial
6637 `/' of a keyword as part of the identifier.
6638 This function is not general, can only be used for completion stuff."
6641 ;; skip the current identifier
6643 ;; also skip a leading slash which might be belong to the keyword
6646 ;; FIXME: does not check if this is a valid identifier
6654 ;; continuation line
6668 &optional prepare-display-function
6669 special-selector)
6670 "Perform TYPE completion of word before point against LIST.
6671 SELECTOR is the PREDICATE argument for the completion function. Show
6672 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6673 'procedure, 'class-tag, 'keyword, 'sysvar, etc. SPECIAL-SELECTOR is
6674 used only once, for `all-completions', and can be used to, e.g.,
6675 accumulate information on matching completions."
6678 dpart dcompletion)
6683 ;; What is already in the buffer?
6688 idlwave-complete-after-success-form
6691 idlwave-complete-after-success-form-force
6695 ;; Try a completion
6701 idlwave-completion-help-links nil)
6704 ;; nothing available.
6708 ;; We can add something
6712 idlwave-complete-empty-string-as-lower-case)
6714 dcompletion
6715 completion))
6717 ;; Now this is a unique match
6719 t)
6725 selector))))))
6727 ;; This is already complete
6730 nil)
6732 ;; We cannot add something - offer a list.
6740 idlwave-completion-help-links))))
6741 list))
6743 ;; "complete" means, this is already a valid completion
6746 ;; (completion-fixup-function ; Emacs
6747 ;; (lambda () (and (eq (preceding-char) ?>)
6748 ;; (re-search-backward " <" beg t)))))
6756 idlwave-complete-empty-string-as-lower-case)
6762 x)
6763 list)))
6765 t))))
6768 "Complete a class at point."
6770 ;; Call `idlwave-routines' to make sure the class list will be available
6772 ;; Check for the special case of completing empty string after pro/function
6781 ;; Yank the full class specification
6783 ;; Do the completion, using list gathered from `idlwave-routines'
6792 idlwave-completion-help-links))
6793 x))
6794 list)))))
6797 ;; Attach the proper class list to a LIST of completion items.
6798 ;; TYPE, when 'kwd, shows classes for method keywords, when
6799 ;; 'class-tag, for class tags, and otherwise for methods.
6800 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6806 ;; In these cases, we do not have to do anything
6807 list
6811 ;; (do-dots (featurep 'xemacs))
6817 classes nclasses class-info space)
6820 ;; get the classes
6822 ;; Just one class for tags
6826 ;; Multiple classes for method or method-keyword
6830 method-selector x type-selector)
6836 classes)))))
6838 ;; Make the separator between item and class-info
6843 ;; We do want info in the buffer
6846 space
6851 ;; We do want properties
6855 x))
6858 x))
6859 list))))
6862 ;; Call idlwave-attach-classes with method parameters
6865 ;; Call idlwave-attach-classes with keyword parameters
6868 ;; Call idlwave-attach-classes with class structure tags
6872 ;;----------------------------------------------------------------------
6873 ;;----------------------------------------------------------------------
6874 ;;----------------------------------------------------------------------
6875 ;;----------------------------------------------------------------------
6876 ;;----------------------------------------------------------------------
6883 "Select an item in LIST with a popup menu.
6884 TITLE is the title to put atop the popup. If SORT is non-nil,
6885 sort the list before displaying."
6887 rtn menu)
6897 x)))
6898 list)))
6911 rtn))
6914 "Split the MENU into submenus of maximum length N."
6916 ;; No splitting needed
6917 menu
6932 nextmenu))
6934 nextmenu nil
6939 "Split the MENU into submenus of maximum length N."
6941 ;; No splitting needed
6942 menu
6958 nextmenu))
6960 nextmenu nil
6964 menu)))
6969 "Scroll the completion window on this frame."
6987 "Display the completions in LIST in the completions buffer and echo MESSAGE."
6995 list)
6998 ;; Store a special value in `this-command'. When `idlwave-complete'
6999 ;; finds this in `last-command', it will scroll the *Completions* buffer.
7002 ;; Mark the completions buffer as created by cib
7005 ;; Fontify the classes
7010 ;; Run the hook
7013 ;; Display the message
7017 "Call FUNCTION as a completion chooser and pass ARGS to it."
7023 ;; For the shell, remove the fontification of the word before point
7038 "Restore the old (before completion) window configuration."
7040 idlwave-before-completion-wconf
7044 "Make the user select an element from the alist in the variable SYM.
7045 The keys of the alist are expected to be strings. The function returns the
7046 car of the selected association.
7047 To do this, PROMPT is displayed and the user must hit a letter key to
7048 select an entry. If the user does not reply within DELAY seconds, a help
7049 window with the options is displayed automatically.
7050 The key which is associated with each option is generated automatically.
7052 If these don't exist, a letter in the string is automatically selected."
7056 keys-alist char)
7057 ;; First check the cache
7060 ;; Need to make new list
7064 ;; Display prompt and wait for quick reply
7069 ;; No quick reply: Show help
7075 keys-alist))
7079 ;; Return the selected result
7082 ;; Used for, e.g., electric debug super-examine.
7084 "Make an alist for single key selection."
7092 ;; First check if the configuration predetermined a key
7099 ;; Then check for capital letters
7109 t t name))
7112 ;; Now check for lowercase letters
7122 t t name))
7125 ;; Bummer, nothing found! Use a stupid number
7132 "Set the buffer-local value of VAR in BUFFER to VALUE."
7137 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
7142 ;; In XEmacs, we can use :activate-callback directly to advice the
7143 ;; choose functions. We use the private keymap only for the online
7144 ;; help feature.
7153 cl-args))
7162 "Execute `default-choose-completion' and then restore the win-conf."
7166 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7169 (define-key new-map [button3] (lambda ()
7170 (interactive)
7171 (setq this-command last-command)))
7172 new-map))
7174 ;; In Emacs we also replace keybindings in the completion
7175 ;; map in order to install our wrappers.
7177 (defun idlwave-display-completion-list-emacs (list)
7178 "Display completion list and install the choose wrappers."
7179 (with-output-to-temp-buffer "*Completions*"
7180 (display-completion-list list))
7181 (with-current-buffer "*Completions*"
7182 (use-local-map
7183 (or idlwave-completion-map
7184 (setq idlwave-completion-map
7185 (idlwave-make-modified-completion-map-emacs
7186 (current-local-map)))))))
7188 (defun idlwave-make-modified-completion-map-emacs (old-map)
7189 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7190 (let ((new-map (copy-keymap old-map)))
7191 (substitute-key-definition
7192 'choose-completion 'idlwave-choose-completion new-map)
7193 (substitute-key-definition
7194 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
7195 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
7196 new-map))
7198 (defun idlwave-choose-completion (&rest args)
7199 "Choose the completion that point is in or next to."
7200 (interactive)
7201 (apply 'idlwave-choose 'choose-completion args))
7203 (defun idlwave-mouse-choose-completion (&rest args)
7204 "Click on an alternative in the `*Completions*' buffer to choose it."
7205 (interactive "e")
7206 (apply 'idlwave-choose 'mouse-choose-completion args))
7208 ;;----------------------------------------------------------------------
7209 ;;----------------------------------------------------------------------
7211 ;;; ------------------------------------------------------------------------
7212 ;;; Stucture parsing code, and code to manage class info
7214 ;;
7215 ;; - Go again over the documentation how to write a completion
7216 ;; plugin. It is in self.el, but currently still very bad.
7217 ;; This could be in a separate file in the distribution, or
7218 ;; in an appendix for the manual.
7220 (defvar idlwave-struct-skip
7222 "Regexp for skipping continued blank or comment-only lines in structures.")
7224 (defvar idlwave-struct-tag-regexp
7225 (concat "[{,]" ;leading comma/brace
7226 idlwave-struct-skip ; 4 groups
7229 "Regexp for structure tags.")
7231 (defun idlwave-struct-tags ()
7232 "Return a list of all tags in the structure defined at point.
7233 Point is expected just before the opening `{' of the struct definition."
7234 (save-excursion
7235 (let* ((borders (idlwave-struct-borders))
7236 (beg (car borders))
7237 (end (cdr borders))
7238 tags)
7239 (goto-char beg)
7240 (save-restriction
7241 (narrow-to-region beg end)
7242 (while (re-search-forward idlwave-struct-tag-regexp end t)
7243 ;; Check if we are still on the top level of the structure.
7244 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7245 (= (point) beg))
7246 (push (match-string-no-properties 5) tags))
7247 (goto-char (match-end 0))))
7248 (nreverse tags))))
7250 (defun idlwave-find-struct-tag (tag)
7251 "Find a given TAG in the structure defined at point."
7252 (let* ((borders (idlwave-struct-borders))
7253 (end (cdr borders))
7254 (case-fold-search t))
7256 end t)))
7258 (defun idlwave-struct-inherits ()
7259 "Return a list of all `inherits' names in the struct at point.
7260 Point is expected just before the opening `{' of the struct definition."
7261 (save-excursion
7262 (let* ((borders (idlwave-struct-borders))
7263 (beg (car borders))
7264 (end (cdr borders))
7265 (case-fold-search t)
7266 names)
7267 (goto-char beg)
7268 (save-restriction
7269 (narrow-to-region beg end)
7270 (while (re-search-forward
7271 (concat "[{,]" ;leading comma/brace
7272 idlwave-struct-skip ; 4 groups
7273 "inherits" ; The INHERITS tag
7274 idlwave-struct-skip ; 4 more
7276 end t)
7277 ;; Check if we are still on the top level of the structure.
7278 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7279 (= (point) beg))
7280 (push (match-string-no-properties 9) names))
7281 (goto-char (match-end 0))))
7282 (nreverse names))))
7284 (defun idlwave-in-structure ()
7285 "Return t if point is inside an IDL structure definition."
7286 (let ((beg (point)))
7287 (save-excursion
7288 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
7289 (if (idlwave-find-structure-definition nil nil 'back)
7290 (let ((borders (idlwave-struct-borders)))
7291 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
7292 (and (> beg (car borders)) (< beg (cdr borders))))))))))
7294 (defun idlwave-struct-borders ()
7295 "Return the borders of the {...} after point as a cons cell."
7296 (let (beg)
7297 (save-excursion
7298 (skip-chars-forward "^{")
7299 (setq beg (point))
7300 (condition-case nil (forward-list 1)
7301 (error (goto-char beg)))
7302 (cons beg (point)))))
7304 (defun idlwave-find-structure-definition (&optional var name bound)
7305 "Search forward for a structure definition.
7306 If VAR is non-nil, search for a structure assigned to variable VAR.
7307 If NAME is non-nil, search for a named structure NAME, if a string,
7308 or a generic named structure otherwise. If BOUND is an integer, limit
7309 the search. If BOUND is the symbol `all', we search first back and
7310 then forward through the entire file. If BOUND is the symbol `back'
7311 we search only backward."
7313 (case-fold-search t)
7314 (lim (if (integerp bound) bound nil))
7315 (re (concat
7316 (if var
7320 (if name
7321 (if (stringp name)
7323 ;; Just a generic name
7325 ""))))
7326 (if (or (and (or (eq bound 'all) (eq bound 'back))
7327 (re-search-backward re nil t))
7328 (and (not (eq bound 'back)) (re-search-forward re lim t)))
7329 (progn
7330 (goto-char (match-beginning 3))
7331 (match-string-no-properties 5)))))
7333 (defvar idlwave-class-info nil)
7334 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
7336 (add-hook 'idlwave-update-rinfo-hook
7337 (lambda () (setq idlwave-class-reset t)))
7338 (add-hook 'idlwave-after-load-rinfo-hook
7339 (lambda () (setq idlwave-class-info nil)))
7341 (defun idlwave-class-info (class)
7342 (let (list entry)
7343 (if idlwave-class-info
7344 (if idlwave-class-reset
7345 (setq
7346 idlwave-class-reset nil
7347 idlwave-class-info ; Remove any visited in a buffer
7348 (delq nil (mapcar
7349 (lambda (x)
7350 (let ((filebuf
7351 (idlwave-class-file-or-buffer
7352 (or (cdr (assq 'found-in x)) (car x)))))
7353 (if (cdr filebuf)
7354 nil
7355 x)))
7356 idlwave-class-info))))
7357 ;; Info is nil, put in the system stuff to start.
7358 (setq idlwave-class-info idlwave-system-class-info)
7359 (setq list idlwave-class-info)
7360 (while (setq entry (pop list))
7361 (idlwave-sintern-class-info entry)))
7362 (setq class (idlwave-sintern-class class))
7363 (or (assq class idlwave-class-info)
7364 (progn (idlwave-scan-class-info class)
7365 (assq class idlwave-class-info)))))
7367 (defun idlwave-sintern-class-info (entry)
7368 "Sintern the class names in a class-info entry."
7369 (let ((inherits (assq 'inherits entry)))
7370 (setcar entry (idlwave-sintern-class (car entry) 'set))
7371 (if inherits
7372 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
7373 (cdr inherits))))))
7375 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
7376 "Find class structure definition(s).
7377 If ALL-HOOK is set, find all named structure definitions in a given
7378 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
7379 set, look for the name__define pro, and inside of it, for the ALT-CLASS
7380 class/struct definition."
7381 (let ((case-fold-search t) end-lim name)
7382 (when (re-search-forward
7384 (if all-hook
7385 (progn
7386 ;; For everything there
7387 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
7388 (while (setq name
7389 (idlwave-find-structure-definition nil t end-lim))
7390 (funcall all-hook name)))
7391 (idlwave-find-structure-definition nil (or alt-class class))))))
7394 (defun idlwave-class-file-or-buffer (class)
7395 "Find buffer visiting CLASS definition."
7396 (let* ((pro (concat (downcase class) "__define"))
7397 (file (idlwave-routine-source-file
7398 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
7399 (idlwave-routines))))))
7400 (cons file (if file (idlwave-get-buffer-visiting file)))))
7403 (defun idlwave-scan-class-info (class)
7404 "Scan all class and named structure info in the class__define pro."
7405 (let* ((idlwave-auto-routine-info-updates nil)
7406 (filebuf (idlwave-class-file-or-buffer class))
7407 (file (car filebuf))
7408 (buf (cdr filebuf))
7409 (class (idlwave-sintern-class class)))
7410 (if (or
7411 (not file)
7412 (and ;; neither a regular file nor a visited buffer
7413 (not buf)
7414 (not (file-regular-p file))))
7415 nil ; Cannot find the file/buffer to get any info
7416 (save-excursion
7417 (if buf (set-buffer buf)
7418 ;; Read the file in temporarily
7419 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
7420 (erase-buffer)
7421 (unless (derived-mode-p 'idlwave-mode)
7422 (idlwave-mode))
7423 (insert-file-contents file))
7424 (save-excursion
7425 (goto-char 1)
7426 (idlwave-find-class-definition class
7427 ;; Scan all of the structures found there
7428 (lambda (name)
7429 (let* ((this-class (idlwave-sintern-class name))
7430 (entry
7431 (list this-class
7432 (cons 'tags (idlwave-struct-tags))
7433 (cons 'inherits (idlwave-struct-inherits)))))
7434 (if (not (eq this-class class))
7435 (setq entry (nconc entry (list (cons 'found-in class)))))
7436 (idlwave-sintern-class-info entry)
7437 (push entry idlwave-class-info)))))))))
7439 (defun idlwave-class-found-in (class)
7440 "Return the FOUND-IN property of the CLASS."
7441 (cdr (assq 'found-in (idlwave-class-info class))))
7442 (defun idlwave-class-tags (class)
7443 "Return the native tags in CLASS."
7444 (cdr (assq 'tags (idlwave-class-info class))))
7445 (defun idlwave-class-inherits (class)
7446 "Return the direct superclasses of CLASS."
7447 (cdr (assq 'inherits (idlwave-class-info class))))
7450 (defun idlwave-all-class-tags (class)
7451 "Return a list of native and inherited tags in CLASS."
7452 (condition-case err
7453 (apply 'append (mapcar 'idlwave-class-tags
7454 (cons class (idlwave-all-class-inherits class))))
7455 (error
7456 (idlwave-class-tag-reset)
7457 (error "%s" (error-message-string err)))))
7460 (defun idlwave-all-class-inherits (class)
7461 "Return a list of all superclasses of CLASS (recursively expanded).
7462 The list is cached in `idlwave-class-info' for faster access."
7463 (cond
7464 ((not idlwave-support-inheritance) nil)
7465 ((eq class nil) nil)
7466 ((eq class t) nil)
7467 (t
7468 (let ((info (idlwave-class-info class))
7469 entry)
7470 (if (setq entry (assq 'all-inherits info))
7471 (cdr entry)
7472 ;; Save the depth of inheritance scan to check for circular references
7473 (let ((inherits (mapcar (lambda (x) (cons x 0))
7474 (idlwave-class-inherits class)))
7475 rtn all-inherits cl)
7476 (while inherits
7477 (setq cl (pop inherits)
7478 rtn (cons (car cl) rtn)
7479 inherits (append (mapcar (lambda (x)
7480 (cons x (1+ (cdr cl))))
7481 (idlwave-class-inherits (car cl)))
7482 inherits))
7483 (if (> (cdr cl) 999)
7484 (error
7485 "Class scan: inheritance depth exceeded. Circular inheritance?")
7486 ))
7487 (setq all-inherits (nreverse rtn))
7488 (nconc info (list (cons 'all-inherits all-inherits)))
7489 all-inherits))))))
7491 (defun idlwave-entry-keywords (entry &optional record-link)
7492 "Return the flat entry keywords alist from routine-info entry.
7493 If RECORD-LINK is non-nil, the keyword text is copied and a text
7494 property indicating the link is added."
7495 (let (kwds)
7496 (mapc
7497 (lambda (key-list)
7498 (let ((file (car key-list)))
7499 (mapcar (lambda (key-cons)
7500 (let ((key (car key-cons))
7501 (link (cdr key-cons)))
7502 (when (and record-link file)
7503 (setq key (copy-sequence key))
7504 (put-text-property
7505 0 (length key)
7506 'link
7507 (concat
7508 file
7509 (if link
7510 (concat idlwave-html-link-sep
7511 (number-to-string link))))
7512 key))
7513 (push (list key) kwds)))
7514 (cdr key-list))))
7515 (nthcdr 5 entry))
7516 (nreverse kwds)))
7518 (defun idlwave-entry-find-keyword (entry keyword)
7519 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set."
7520 (catch 'exit
7521 (mapc
7522 (lambda (key-list)
7523 (let ((file (car key-list))
7524 (kwd (assoc keyword (cdr key-list))))
7525 (when kwd
7526 (setq kwd (cons (car kwd)
7527 (if (and file (cdr kwd))
7528 (concat file
7529 idlwave-html-link-sep
7530 (number-to-string (cdr kwd)))
7531 (cdr kwd))))
7532 (throw 'exit kwd))))
7533 (nthcdr 5 entry))))
7535 ;;==========================================================================
7536 ;;
7537 ;; Completing class structure tags. This is a completion plugin.
7538 ;; The necessary taglist is constructed dynamically
7540 (defvar idlwave-current-tags-class nil)
7541 (defvar idlwave-current-class-tags nil)
7542 (defvar idlwave-current-native-class-tags nil)
7543 (defvar idlwave-sint-class-tags nil)
7544 (declare-function idlwave-sintern-class-tag "idlwave" t t)
7545 (idlwave-new-sintern-type 'class-tag)
7546 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7547 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7549 (defun idlwave-complete-class-structure-tag ()
7550 "Complete a structure tag on a `self' argument in an object method."
7551 (interactive)
7552 (let ((pos (point))
7553 (case-fold-search t))
7554 (if (save-excursion
7555 ;; Check if the context is right
7556 (skip-chars-backward "a-zA-Z0-9._$")
7557 (and (< (point) (- pos 4))
7559 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7560 (super-classes (idlwave-all-class-inherits class-selector)))
7561 ;; Check if we are in a class routine
7562 (unless class-selector
7563 (error "Not in a method procedure or function"))
7564 ;; Check if we need to update the "current" class
7565 (if (not (equal class-selector idlwave-current-tags-class))
7566 (idlwave-prepare-class-tag-completion class-selector))
7567 (setq idlwave-completion-help-info
7568 (list 'idlwave-complete-class-structure-tag-help
7569 (idlwave-sintern-routine
7570 (concat class-selector "__define"))
7571 nil))
7572 ;; FIXME: idlwave-cpl-bold doesn't seem used anywhere.
7573 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7574 (idlwave-complete-in-buffer
7575 'class-tag 'class-tag
7576 idlwave-current-class-tags nil
7577 (format "Select a tag of class %s" class-selector)
7578 "class tag"
7579 'idlwave-attach-class-tag-classes))
7580 t) ; return t to skip other completions
7581 nil)))
7583 (defun idlwave-class-tag-reset ()
7584 (setq idlwave-current-tags-class nil))
7586 (defun idlwave-prepare-class-tag-completion (class)
7587 "Find and parse the necessary class definitions for class structure tags."
7588 (setq idlwave-sint-class-tags nil)
7589 (setq idlwave-current-tags-class class)
7590 (setq idlwave-current-class-tags
7591 (mapcar (lambda (x)
7592 (list (idlwave-sintern-class-tag x 'set)))
7593 (idlwave-all-class-tags class)))
7594 (setq idlwave-current-native-class-tags
7595 (mapcar 'downcase (idlwave-class-tags class))))
7597 ;===========================================================================
7598 ;;
7599 ;; Completing system variables and their structure fields
7600 ;; This is also a plugin.
7602 (defvar idlwave-sint-sysvars nil)
7603 (defvar idlwave-sint-sysvartags nil)
7604 (declare-function idlwave-sintern-sysvar "idlwave" t t)
7605 (declare-function idlwave-sintern-sysvartag "idlwave" t t)
7606 (idlwave-new-sintern-type 'sysvar)
7607 (idlwave-new-sintern-type 'sysvartag)
7608 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7609 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7610 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7613 (defun idlwave-complete-sysvar-or-tag ()
7614 "Complete a system variable."
7615 (interactive)
7616 (let ((pos (point))
7617 (case-fold-search t))
7618 (cond ((save-excursion
7619 ;; Check if the context is right for system variable
7620 (skip-chars-backward "[a-zA-Z0-9_$]")
7621 (equal (char-before) ?!))
7622 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7623 (idlwave-complete-in-buffer 'sysvar 'sysvar
7624 idlwave-system-variables-alist nil
7625 "Select a system variable"
7626 "system variable")
7627 t) ; return t to skip other completions
7628 ((save-excursion
7629 ;; Check if the context is right for sysvar tag
7630 (skip-chars-backward "a-zA-Z0-9_$.")
7631 (and (equal (char-before) ?!)
7633 (<= (match-end 0) pos)))
7634 ;; Complete a system variable tag
7635 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7636 (entry (assq var idlwave-system-variables-alist))
7637 (tags (cdr (assq 'tags entry))))
7638 (or entry (error "!%s is not a known system variable" var))
7639 (or tags (error "System variable !%s is not a structure" var))
7640 (setq idlwave-completion-help-info
7641 (list 'idlwave-complete-sysvar-tag-help var))
7642 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7643 tags nil
7644 "Select a system variable tag"
7645 "system variable tag")
7646 t)) ; return t to skip other completions
7647 (t nil))))
7649 (defvar idlw-help-link) ;dynamic variables set by help callback
7650 (defun idlwave-complete-sysvar-help (mode word)
7651 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7652 (entry (assoc word idlwave-system-variables-alist)))
7653 (cond
7654 ((eq mode 'test)
7655 (and (stringp word) entry (nth 1 (assq 'link entry))))
7656 ((eq mode 'set)
7657 ;; Setting dynamic!!!
7658 (if entry (setq idlw-help-link (nth 1 (assq 'link entry)))))
7659 (t (error "This should not happen")))))
7661 (defun idlwave-complete-sysvar-tag-help (mode word)
7662 (let* ((var (nth 1 idlwave-completion-help-info))
7663 (entry (assoc var idlwave-system-variables-alist))
7664 (tags (cdr (assq 'tags entry)))
7665 (main (nth 1 (assq 'link entry)))
7666 target)
7667 (cond
7668 ((eq mode 'test) ; we can at least link the main
7669 (and (stringp word) entry main))
7670 ((eq mode 'set)
7671 (if entry
7672 (setq idlw-help-link
7673 (if (setq target (cdr (assoc-string word tags t)))
7674 (idlwave-substitute-link-target main target)
7675 main)))) ;; setting dynamic!!!
7676 (t (error "This should not happen")))))
7678 (defun idlwave-split-link-target (link)
7679 "Split a given LINK into link file and anchor."
7680 (if (string-match idlwave-html-link-sep link)
7681 (cons (substring link 0 (match-beginning 0))
7682 (string-to-number (substring link (match-end 0))))))
7684 (defun idlwave-substitute-link-target (link target)
7685 "Substitute the TARGET anchor for the given LINK."
7686 (let (main-base)
7687 (setq main-base (if (string-match "#" link)
7688 (substring link 0 (match-beginning 0))
7689 link))
7690 (if target
7691 (concat main-base idlwave-html-link-sep (number-to-string target))
7692 link)))
7694 ;; Fake help in the source buffer for class structure tags.
7695 ;; IDLW-HELP-LINK AND IDLW-HELP-NAME ARE GLOBAL-VARIABLES HERE.
7696 ;; (from idlwave-do-mouse-completion-help)
7697 (defvar idlw-help-name)
7698 (defvar idlw-help-link)
7699 (defvar idlwave-help-do-class-struct-tag nil)
7700 (defun idlwave-complete-class-structure-tag-help (mode word)
7701 (cond
7702 ((eq mode 'test) ; nothing gets fontified for class tags
7703 nil)
7704 ((eq mode 'set)
7705 (let (class-with found-in)
7706 (when (setq class-with
7707 (idlwave-class-or-superclass-with-tag
7708 idlwave-current-tags-class
7709 word))
7710 (if (assq (idlwave-sintern-class class-with)
7711 idlwave-system-class-info)
7712 (error "No help available for system class tags"))
7713 (if (setq found-in (idlwave-class-found-in class-with))
7714 (setq idlw-help-name (cons (concat found-in "__define") class-with))
7715 (setq idlw-help-name (concat class-with "__define")))))
7716 (setq idlw-help-link word
7717 idlwave-help-do-class-struct-tag t))
7718 (t (error "This should not happen"))))
7720 (defun idlwave-class-or-superclass-with-tag (class tag)
7721 "Find and return the CLASS or one of its superclass with the
7722 associated TAG, if any."
7723 (let ((sclasses (cons class (idlwave-all-class-inherits class)))
7724 cl)
7725 (catch 'exit
7726 (while sclasses
7727 (setq cl (pop sclasses))
7728 (let ((tags (idlwave-class-tags cl)))
7729 (while tags
7730 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7731 (throw 'exit cl))
7732 (setq tags (cdr tags))))))))
7735 (defun idlwave-sysvars-reset ()
7736 (if (and (fboundp 'idlwave-shell-is-running)
7737 (idlwave-shell-is-running)
7738 idlwave-idlwave_routine_info-compiled)
7739 (idlwave-shell-send-command "idlwave_get_sysvars"
7740 'idlwave-process-sysvars 'hide)))
7742 (defun idlwave-process-sysvars ()
7743 (idlwave-shell-filter-sysvars)
7744 (setq idlwave-sint-sysvars nil
7745 idlwave-sint-sysvartags nil)
7746 (idlwave-sintern-sysvar-alist))
7748 (defun idlwave-sintern-sysvar-alist ()
7749 (let ((list idlwave-system-variables-alist) entry tags)
7750 (while (setq entry (pop list))
7751 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7752 (setq tags (assq 'tags entry))
7753 (if tags
7754 (setcdr tags
7755 (mapcar (lambda (x)
7756 (cons (idlwave-sintern-sysvartag (car x) 'set)
7757 (cdr x)))
7758 (cdr tags)))))))
7760 (defvar idlwave-shell-command-output)
7761 (defun idlwave-shell-filter-sysvars ()
7762 "Get any new system variables and tags."
7763 (let ((text idlwave-shell-command-output)
7764 (start 0)
7765 (old idlwave-system-variables-alist)
7766 var tags type name class link old-entry)
7767 (setq idlwave-system-variables-alist nil)
7769 text start)
7770 (setq start (match-end 0)
7771 var (match-string 1 text)
7772 tags (if (match-end 3)
7773 (idlwave-split-string (match-string 3 text))))
7774 ;; Maintain old links, if present
7775 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7776 (setq link (assq 'link old-entry))
7777 (setq idlwave-system-variables-alist
7778 (cons (list var
7779 (cons
7780 'tags
7781 (mapcar (lambda (x)
7782 (cons x
7783 (cdr (assq
7784 (idlwave-sintern-sysvartag x)
7785 (cdr (assq 'tags old-entry))))))
7786 tags)) link)
7787 idlwave-system-variables-alist)))
7788 ;; Keep the old value if query was not successful
7789 (setq idlwave-system-variables-alist
7790 (or idlwave-system-variables-alist old))))
7792 (defun idlwave-completion-fontify-classes ()
7793 "Goto the *Completions* buffer and fontify the class info."
7794 (when (featurep 'font-lock)
7795 (with-current-buffer "*Completions*"
7796 (save-excursion
7797 (goto-char (point-min))
7798 (let ((buffer-read-only nil))
7800 (put-text-property (match-beginning 0) (match-end 0)
7801 'face 'font-lock-string-face)))))))
7803 (defun idlwave-uniquify (list)
7804 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7805 (delq nil
7806 (mapcar (lambda (x)
7807 (unless (gethash x ht)
7808 (puthash x t ht)
7809 x))
7810 list))))
7812 (defun idlwave-after-successful-completion (type slash &optional verify)
7813 "Add `=' or `(' after successful completion of keyword and function.
7814 Restore the pre-completion window configuration if possible."
7815 (cond
7816 ((eq type 'procedure)
7817 nil)
7818 ((eq type 'function)
7819 (cond
7820 ((equal idlwave-function-completion-adds-paren nil) nil)
7821 ((or (equal idlwave-function-completion-adds-paren t)
7822 (equal idlwave-function-completion-adds-paren 1))
7823 (insert "("))
7824 ((equal idlwave-function-completion-adds-paren 2)
7825 (insert "()")
7826 (backward-char 1))
7827 (t nil)))
7828 ((eq type 'keyword)
7829 (if (and idlwave-keyword-completion-adds-equal
7830 (not slash))
7831 (progn (insert "=") t)
7832 nil)))
7834 ;; Restore the pre-completion window configuration if this is safe.
7836 (if (or (eq verify 'force) ; force
7837 (and
7838 (get-buffer-window "*Completions*") ; visible
7839 (idlwave-local-value 'idlwave-completion-p
7840 "*Completions*") ; cib-buffer
7841 (eq (marker-buffer idlwave-completion-mark)
7842 (current-buffer)) ; buffer OK
7843 (equal (marker-position idlwave-completion-mark)
7844 verify))) ; pos OK
7845 (idlwave-restore-wconf-after-completion))
7846 (move-marker idlwave-completion-mark nil)
7847 (setq idlwave-before-completion-wconf nil))
7849 (defun idlwave-mouse-context-help (ev &optional arg)
7850 "Call `idlwave-context-help' on the clicked location."
7851 (interactive "eP")
7852 (mouse-set-point ev)
7853 (idlwave-context-help arg))
7855 (defvar idlwave-last-context-help-pos nil)
7856 (defun idlwave-context-help (&optional arg)
7857 "Display IDL Online Help on context.
7858 If point is on a keyword, help for that keyword will be shown. If
7859 point is on a routine name or in the argument list of a routine, help
7860 for that routine will be displayed. Works for system routines and
7861 keywords, it pulls up text help. For other routies and keywords,
7862 visits the source file, finding help in the header (if
7863 `idlwave-help-source-try-header' is non-nil) or the routine definition
7864 itself."
7865 (interactive "P")
7866 (idlwave-do-context-help arg))
7868 (defun idlwave-mouse-completion-help (ev)
7869 "Display online help about the completion at point."
7870 (interactive "eP")
7871 ;; Restore last-command for next command, to make
7872 ;; scrolling/cancelling of completions work.
7873 (setq this-command last-command)
7874 (idlwave-do-mouse-completion-help ev))
7876 (defun idlwave-routine-info (&optional arg external)
7877 "Display a routines calling sequence and list of keywords.
7878 When point is on the name a function or procedure, or in the argument
7879 list of a function or procedure, this command displays a help buffer with
7880 the information. When called with prefix arg, enforce class query.
7882 When point is on an object operator `->', display the class stored in
7883 this arrow, if any (see `idlwave-store-inquired-class'). With a prefix
7884 arg, the class property is cleared out."
7886 (interactive "P")
7887 (idlwave-routines)
7888 (if (string-match "->" (buffer-substring
7889 (max (point-min) (1- (point)))
7890 (min (+ 2 (point)) (point-max))))
7891 ;; Cursor is on an arrow
7892 (if (get-text-property (point) 'idlwave-class)
7893 ;; arrow has class property
7894 (if arg
7895 ;; Remove property
7896 (save-excursion
7897 (backward-char 1)
7899 (remove-text-properties (match-beginning 1) (match-end 1)
7900 '(idlwave-class nil face nil))
7901 (message "Class property removed from arrow")))
7902 ;; Echo class property
7903 (message "Arrow has text property identifying object to be class %s"
7904 (get-text-property (point) 'idlwave-class)))
7905 ;; No property found
7906 (message "Arrow has no class text property"))
7908 ;; Not on an arrow...
7909 (let* ((idlwave-query-class nil)
7910 (idlwave-force-class-query (equal arg '(4)))
7911 (module (idlwave-what-module)))
7912 (if (car module)
7913 (apply 'idlwave-display-calling-sequence
7914 (idlwave-fix-module-if-obj_new module))
7915 (error "Don't know which calling sequence to show")))))
7917 (defun idlwave-resolve (&optional arg)
7918 "Call RESOLVE_ROUTINE on the module name at point.
7919 Like `idlwave-routine-info', this looks for a routine call at point.
7920 After confirmation in the minibuffer, it will use the shell to issue
7921 a RESOLVE call for this routine, to attempt to make it defined and its
7922 routine info available for IDLWAVE. If the routine is a method call,
7923 both `class__method' and `class__define' will be tried.
7924 With ARG, enforce query for the class of object methods."
7925 (interactive "P")
7926 (let* ((idlwave-query-class nil)
7927 (idlwave-force-class-query (equal arg '(4)))
7928 (module (idlwave-what-module))
7929 (name (idlwave-make-full-name (nth 2 module) (car module)))
7930 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7931 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7932 (kwd "")
7933 class)
7935 resolve)
7936 (setq type (match-string 1 resolve)
7937 class (if (match-beginning 2)
7938 (match-string 3 resolve)
7939 nil)
7940 name (match-string 4 resolve)))
7941 (if (string= (downcase type) "function")
7942 (setq kwd ",/is_function"))
7944 (cond
7945 ((null class)
7946 (idlwave-shell-send-command
7947 (format "resolve_routine,'%s'%s" (downcase name) kwd)
7948 'idlwave-update-routine-info
7949 nil t))
7950 (t
7951 (idlwave-shell-send-command
7952 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
7953 (list 'idlwave-shell-send-command
7954 (format "resolve_routine,'%s__%s'%s"
7955 (downcase class) (downcase name) kwd)
7956 '(idlwave-update-routine-info)
7957 nil t))))))
7959 (defun idlwave-find-module-this-file ()
7960 (interactive)
7961 (idlwave-find-module '(4)))
7963 (defun idlwave-find-module (&optional arg)
7964 "Find the source code of an IDL module.
7965 Works for modules for which IDLWAVE has routine info available.
7966 The function offers as default the module name `idlwave-routine-info'
7967 would use. With ARG limit to this buffer. With two prefix ARG's
7968 force class query for object methods."
7969 (interactive "P")
7970 (let* ((idlwave-query-class nil)
7971 (idlwave-force-class-query (equal arg '(16)))
7972 (this-buffer (equal arg '(4)))
7973 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
7974 (default (if module
7975 (concat (idlwave-make-full-name
7976 (nth 2 module) (car module))
7977 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
7978 "none"))
7979 (list
7980 (idlwave-uniquify
7981 (delq nil
7982 (mapcar (lambda (x)
7983 (if (eq 'system (car-safe (nth 3 x)))
7984 ;; Take out system routines with no source.
7985 nil
7986 (list
7987 (concat (idlwave-make-full-name
7988 (nth 2 x) (car x))
7989 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
7990 (if this-buffer
7991 (idlwave-save-buffer-update)
7992 (idlwave-routines))))))
7993 (name (idlwave-completing-read
7994 (if (or (not this-buffer)
7995 (assoc default list))
7996 (format "Module (Default %s): " default)
7997 (format "Module in this file: "))
7998 list))
7999 type class)
8001 ;; Nothing, use the default.
8002 (setq name default))
8003 (if (string-match "<[fp]>" name)
8004 (setq type (substring name -2 -1)
8005 name (substring name 0 -3)))
8007 (setq class (match-string 1 name)
8008 name (match-string 2 name)))
8009 (setq name (idlwave-sintern-routine-or-method name class)
8010 class (idlwave-sintern-class class)
8011 type (cond ((equal type "f") 'fun)
8012 ((equal type "p") 'pro)
8013 (t t)))
8014 (idlwave-do-find-module name type class nil this-buffer)))
8016 (defun idlwave-do-find-module (name type class
8017 &optional force-source this-buffer)
8018 (let ((name1 (idlwave-make-full-name class name))
8019 source buf1 entry
8020 (buf (current-buffer))
8021 (pos (point))
8022 file name2)
8023 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
8024 'WITH-FILE)
8025 source (or force-source (nth 3 entry))
8026 name2 (if (nth 2 entry)
8027 (idlwave-make-full-name (nth 2 entry) name)
8028 name1))
8029 (if source
8030 (setq file (idlwave-routine-source-file source)))
8031 (unless file ; Try to find it on the path.
8032 (setq file
8033 (idlwave-expand-lib-file-name
8034 (if class
8035 (format "%s__define.pro" (downcase class))
8036 (format "%s.pro" (downcase name))))))
8037 (cond
8038 ((or (null name) (equal name ""))
8039 (error "Abort"))
8040 ((eq (car source) 'system)
8041 (error "Source code for system routine %s is not available"
8042 name2))
8043 ((or (not file) (not (file-regular-p file)))
8044 (error "Source code for routine %s is not available"
8045 name2))
8046 (t
8047 (when (not this-buffer)
8048 (setq buf1
8049 (idlwave-find-file-noselect file 'find))
8050 (pop-to-buffer buf1 t))
8051 (goto-char (point-max))
8052 (let ((case-fold-search t))
8053 (if (re-search-backward
8055 (cond ((eq type 'fun) "function")
8056 ((eq type 'pro) "pro")
8059 (regexp-quote (downcase name2))
8060 "[^a-zA-Z0-9_$]")
8061 nil t)
8062 (goto-char (match-beginning 0))
8063 (pop-to-buffer buf)
8064 (goto-char pos)
8065 (error "Could not find routine %s" name2)))))))
8067 (defun idlwave-what-module ()
8068 "Return a default module for stuff near point.
8069 Used by `idlwave-routine-info' and `idlwave-find-module'."
8070 (idlwave-routines)
8071 (if (let ((case-fold-search t))
8072 (save-excursion
8073 (idlwave-beginning-of-statement)
8074 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
8075 ;; This is a function or procedure definition statement
8076 ;; We return the defined routine as module.
8077 (list
8078 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
8079 (match-string-no-properties 2))
8080 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
8081 (idlwave-sintern-class (match-string 3)))
8083 ;; Not a definition statement - analyze precise position.
8084 (let* ((where (idlwave-where))
8085 (cw (nth 2 where))
8086 (pro (car (nth 0 where)))
8087 (func (car (nth 1 where)))
8088 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
8089 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
8090 (following-char)))
8091 )
8092 (cond
8093 ((and (eq cw 'procedure)
8094 (not (equal this-word "")))
8095 (setq this-word (idlwave-sintern-routine-or-method
8096 this-word (nth 2 (nth 3 where))))
8097 (list this-word 'pro
8098 (idlwave-determine-class
8099 (cons this-word (cdr (nth 3 where)))
8100 'pro)))
8101 ((and (eq cw 'function)
8102 (not (equal this-word ""))
8103 (or (eq next-char ?\() ; exclude arrays, vars.
8105 (setq this-word (idlwave-sintern-routine-or-method
8106 this-word (nth 2 (nth 3 where))))
8107 (list this-word 'fun
8108 (idlwave-determine-class
8109 (cons this-word (cdr (nth 3 where)))
8110 'fun)))
8111 ((and (memq cw '(function-keyword procedure-keyword))
8112 (not (equal this-word ""))
8113 (eq next-char ?\()) ; A function!
8114 (setq this-word (idlwave-sintern-routine this-word))
8115 (list this-word 'fun nil))
8116 (func
8117 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
8118 (pro
8119 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
8120 (t nil)))))
8122 (defun idlwave-what-module-find-class ()
8123 "Call `idlwave-what-module' and find the inherited class if necessary."
8124 (let* ((module (idlwave-what-module))
8125 (class (nth 2 module)))
8126 (if (and (= (length module) 3)
8127 (stringp class))
8128 (list (car module)
8129 (nth 1 module)
8130 (apply 'idlwave-find-inherited-class module))
8131 module)))
8133 (defun idlwave-find-inherited-class (name type class)
8134 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
8135 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
8136 (if entry
8137 (nth 2 entry)
8138 class)))
8140 (defun idlwave-fix-module-if-obj_new (module)
8141 "Check if MODULE points to obj_new.
8142 If yes, and if the cursor is in the keyword region, change to the
8143 appropriate Init method."
8144 (let* ((name (car module))
8145 (pos (point))
8146 (case-fold-search t)
8147 string)
8148 (if (and (stringp name)
8149 (equal (downcase name) "obj_new")
8150 (save-excursion
8151 (idlwave-beginning-of-statement)
8152 (setq string (buffer-substring (point) pos))
8154 string)))
8155 (let ((name "Init")
8156 (class (match-string 1 string)))
8157 (setq module (list (idlwave-sintern-method "Init")
8158 'fun
8159 (idlwave-sintern-class class)))))
8160 module))
8162 (defun idlwave-fix-keywords (name type class keywords
8163 &optional super-classes system)
8164 "Update a list of keywords.
8165 Translate OBJ_NEW, adding all super-class keywords, or all keywords
8166 from all classes if CLASS equals t. If SYSTEM is non-nil, don't
8167 demand _EXTRA in the keyword list."
8168 (let ((case-fold-search t))
8170 ;; If this is the OBJ_NEW function, try to figure out the class and use
8171 ;; the keywords from the corresponding INIT method.
8172 (if (and (equal (upcase name) "OBJ_NEW")
8173 (derived-mode-p 'idlwave-mode 'idlwave-shell-mode))
8174 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
8175 (string (buffer-substring bos (point)))
8176 (case-fold-search t)
8177 class)
8179 string)
8180 (setq class (idlwave-sintern-class (match-string 1 string)))
8181 (setq idlwave-current-obj_new-class class)
8182 (setq keywords
8183 (append keywords
8184 (idlwave-entry-keywords
8185 (idlwave-rinfo-assq
8186 (idlwave-sintern-method "INIT")
8187 'fun
8188 class
8189 (idlwave-routines)) 'do-link))))))
8191 ;; If the class is `t', combine all keywords of all methods NAME
8192 (when (eq class t)
8193 (mapc (lambda (entry)
8194 (and
8195 (nth 2 entry) ; non-nil class
8196 (eq (nth 1 entry) type) ; correct type
8197 (setq keywords
8198 (append keywords
8199 (idlwave-entry-keywords entry 'do-link)))))
8200 (idlwave-all-assq name (idlwave-routines)))
8201 (setq keywords (idlwave-uniquify keywords)))
8203 ;; If we have inheritance, add all keywords from superclasses, if
8204 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
8205 (when (and
8206 super-classes
8207 idlwave-keyword-class-inheritance
8208 (stringp class)
8209 (or
8210 system
8211 (assq (idlwave-sintern-keyword "_extra") keywords)
8212 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
8213 ;; Check if one of the keyword-class regexps matches the name
8214 (let ((regexps idlwave-keyword-class-inheritance) re)
8215 (catch 'exit
8216 (while (setq re (pop regexps))
8217 (if (string-match re name) (throw 'exit t))))))
8219 (loop for entry in (idlwave-routines) do
8220 (and (nth 2 entry) ; non-nil class
8221 (memq (nth 2 entry) super-classes) ; an inherited class
8222 (eq (nth 1 entry) type) ; correct type
8223 (eq (car entry) name) ; correct name
8224 (mapc (lambda (k) (add-to-list 'keywords k))
8225 (idlwave-entry-keywords entry 'do-link))))
8226 (setq keywords (idlwave-uniquify keywords)))
8228 ;; Return the final list
8229 keywords))
8231 (defun idlwave-expand-keyword (keyword module)
8232 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
8233 KEYWORD may be an exact match or an abbreviation of a keyword.
8234 If the match is exact, KEYWORD itself is returned, even if there may be other
8235 keywords of which KEYWORD is an abbreviation. This is necessary because some
8236 system routines have keywords which are prefixes of other keywords.
8237 If KEYWORD is an abbreviation of several keywords, a list of all possible
8238 completions is returned.
8239 If the abbreviation was unique, the correct keyword is returned.
8240 If it cannot be a keyword, the function return nil.
8241 If we do not know about MODULE, just return KEYWORD literally."
8242 (let* ((name (car module))
8243 (type (nth 1 module))
8244 (class (nth 2 module))
8245 (kwd (idlwave-sintern-keyword keyword))
8246 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
8247 (kwd-alist (idlwave-entry-keywords entry))
8248 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
8249 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
8250 (completion-ignore-case t)
8251 candidates)
8252 (cond ((assq kwd kwd-alist)
8253 kwd)
8254 ((setq candidates (all-completions kwd kwd-alist))
8255 (if (= (length candidates) 1)
8256 (car candidates)
8257 candidates))
8258 ((and entry extra)
8259 ;; Inheritance may cause this keyword to be correct
8260 keyword)
8261 (entry
8262 ;; We do know the function, which does not have the keyword.
8263 nil)
8264 (t
8265 ;; We do not know the function, so this just might be a correct
8266 ;; keyword - return it as it is.
8267 keyword))))
8269 (defvar idlwave-rinfo-mouse-map (make-sparse-keymap))
8270 (defvar idlwave-rinfo-map (make-sparse-keymap))
8271 (define-key idlwave-rinfo-mouse-map
8272 (if (featurep 'xemacs) [button2] [mouse-2])
8273 'idlwave-mouse-active-rinfo)
8274 (define-key idlwave-rinfo-mouse-map
8275 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
8276 'idlwave-mouse-active-rinfo-shift)
8277 (define-key idlwave-rinfo-mouse-map
8278 (if (featurep 'xemacs) [button3] [mouse-3])
8279 'idlwave-mouse-active-rinfo-right)
8280 (define-key idlwave-rinfo-mouse-map " " 'idlwave-active-rinfo-space)
8281 (define-key idlwave-rinfo-map "q" 'idlwave-quit-help)
8282 (define-key idlwave-rinfo-mouse-map "q" 'idlwave-quit-help)
8283 (defvar idlwave-popup-source nil)
8284 (defvar idlwave-rinfo-marker (make-marker))
8286 (defun idlwave-quit-help ()
8287 (interactive)
8288 (let ((ri-window (get-buffer-window "*Help*"))
8289 (olh-window (get-buffer-window "*IDLWAVE Help*")))
8290 (when (and olh-window
8291 (fboundp 'idlwave-help-quit))
8292 (select-window olh-window)
8293 (idlwave-help-quit))
8294 (when (window-live-p ri-window)
8295 (delete-window ri-window))))
8297 (defun idlwave-display-calling-sequence (name type class
8298 &optional initial-class)
8299 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
8300 (let* ((initial-class (or initial-class class))
8301 (entry (or (idlwave-best-rinfo-assq name type class
8302 (idlwave-routines))
8303 (idlwave-rinfo-assq name type class
8304 idlwave-unresolved-routines)))
8305 (name (or (car entry) name))
8306 (class (or (nth 2 entry) class))
8307 (superclasses (idlwave-all-class-inherits initial-class))
8308 (twins (idlwave-routine-twins entry))
8309 (dtwins (idlwave-study-twins twins))
8310 (all dtwins)
8311 (system (eq (car (nth 3 entry)) 'system))
8312 (calling-seq (nth 4 entry))
8313 (keywords (idlwave-entry-keywords entry 'do-link))
8314 (html-file (car (nth 5 entry)))
8315 (help-echo-kwd
8316 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
8317 (help-echo-use
8318 "Button2/3: Online Help")
8319 (help-echo-src
8320 "Button2: Jump to source and back | Button3: Source in Help window.")
8321 (help-echo-class
8322 "Button2: Display info about same method in superclass")
8323 (col 0)
8324 (data (list name type class (current-buffer) nil initial-class))
8325 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8326 (face 'idlwave-help-link)
8327 beg props win cnt total)
8328 ;; Fix keywords, but don't add chained super-classes, since these
8329 ;; are shown separately for that super-class
8330 (setq keywords (idlwave-fix-keywords name type class keywords))
8331 (cond
8332 ((null entry)
8333 (error "No %s %s known %s" type name
8334 (if initial-class (concat "in class " initial-class) "")))
8335 ((or (null name) (equal name ""))
8336 (error "No function or procedure call at point"))
8337 ((null calling-seq)
8338 (error "Calling sequence of %s %s not available" type name))
8339 (t
8340 (move-marker idlwave-rinfo-marker (point))
8341 (with-current-buffer (get-buffer-create "*Help*")
8342 (use-local-map idlwave-rinfo-map)
8343 (setq buffer-read-only nil)
8344 (erase-buffer)
8345 (set (make-local-variable 'idlwave-popup-source) nil)
8346 (set (make-local-variable 'idlwave-current-obj_new-class)
8347 idlwave-current-obj_new-class)
8348 (when superclasses
8349 (setq props (list 'mouse-face 'highlight
8350 km-prop idlwave-rinfo-mouse-map
8351 'help-echo help-echo-class
8352 'data (cons 'class data)))
8353 (let ((classes (cons initial-class superclasses)) c)
8354 (insert "Classes: ")
8355 (while (setq c (pop classes))
8356 (insert " ")
8357 (setq beg (point))
8358 (insert c)
8359 (if (equal (downcase c) (downcase class))
8360 (add-text-properties beg (point) (list 'face 'bold))
8361 ;; If Method exists in a different class link it
8362 (if (idlwave-rinfo-assq name type c (idlwave-routines))
8363 (add-text-properties beg (point) props))))
8365 (setq props (list 'mouse-face 'highlight
8366 km-prop idlwave-rinfo-mouse-map
8367 'help-echo help-echo-use
8368 'data (cons 'usage data)))
8369 (if html-file (setq props (append (list 'face face 'link html-file)
8370 props)))
8371 (insert "Usage: ")
8372 (setq beg (point))
8373 (insert (if class
8374 (format calling-seq class name class name class name)
8375 (format calling-seq name name name name))
8377 (add-text-properties beg (point) props)
8379 (insert "Keywords:")
8380 (if (null keywords)
8381 (insert " No keywords accepted.")
8382 (setq col 9)
8383 (mapc
8384 (lambda (x)
8385 (if (>= (+ col 1 (length (car x)))
8386 (window-width))
8387 (progn
8389 (setq col 9)))
8390 (insert " ")
8391 (setq beg (point)
8392 ;; Relevant keywords already have link property attached
8393 props (list 'mouse-face 'highlight
8394 km-prop idlwave-rinfo-mouse-map
8395 'data (cons 'keyword data)
8396 'help-echo help-echo-kwd
8397 'keyword (car x)))
8398 (if system (setq props (append (list 'face face) props)))
8399 (insert (car x))
8400 (add-text-properties beg (point) props)
8401 (setq col (+ col 1 (length (car x)))))
8402 keywords))
8404 (setq cnt 1 total (length all))
8405 ;; Here entry is (key file (list of type-conses))
8406 (while (setq entry (pop all))
8407 (setq props (list 'mouse-face 'highlight
8408 km-prop idlwave-rinfo-mouse-map
8409 'help-echo help-echo-src
8410 'source (list (car (car (nth 2 entry))) ;type
8411 (nth 1 entry)
8412 nil
8413 (cdr (car (nth 2 entry))))
8414 'data (cons 'source data)))
8415 (idlwave-insert-source-location
8417 (if (equal cnt 1)
8418 (if (> total 1) "Sources:" "Source:")
8419 "")
8420 (if (> total 1) "- " ""))
8421 entry props)
8422 (incf cnt)
8423 (when (and all (> cnt idlwave-rinfo-max-source-lines))
8424 ;; No more source lines, please
8425 (insert (format
8427 idlwave-rinfo-max-source-lines))
8428 (setq all nil)))
8429 (goto-char (point-min))
8430 (setq buffer-read-only t))
8431 (display-buffer "*Help*")
8432 (if (and (setq win (get-buffer-window "*Help*"))
8433 idlwave-resize-routine-help-window)
8434 (progn
8435 (let ((ww (selected-window)))
8436 (unwind-protect
8437 (progn
8438 (select-window win)
8439 (enlarge-window (- (/ (frame-height) 2)
8440 (window-height)))
8441 (shrink-window-if-larger-than-buffer))
8442 (select-window ww)))))))))
8444 (defun idlwave-insert-source-location (prefix entry &optional file-props)
8445 "Insert a source location into the routine info buffer.
8446 Start line with PREFIX. If a file name is inserted, add FILE-PROPS
8447 to it."
8448 (let* ((key (car entry))
8449 (file (nth 1 entry))
8450 (types (nth 2 entry))
8451 (shell-flag (assq 'compiled types))
8452 (buffer-flag (assq 'buffer types))
8453 (user-flag (assq 'user types))
8454 (lib-flag (assq 'lib types))
8455 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
8456 (and user-flag (idlwave-count-memq 'user types))
8457 (and lib-flag (idlwave-count-memq 'lib types))
8458 1))
8459 (doflags t)
8460 beg special)
8462 (insert prefix)
8464 (cond
8465 ((eq key 'system)
8466 (setq doflags nil)
8467 (insert "System "))
8469 ((eq key 'builtin)
8470 (setq doflags nil)
8471 (insert "Builtin "))
8473 ((and (not file) shell-flag)
8474 (insert "Unresolved"))
8476 ((null file)
8477 (insert "ERROR"))
8479 ((idlwave-syslib-p file)
8480 (if (string-match "obsolete" (file-name-directory file))
8481 (insert "Obsolete ")
8482 (insert "SystemLib ")))
8484 ;; New special syntax: taken directly from routine-info for
8485 ;; library catalog routines
8486 ((setq special (or (cdr lib-flag) (cdr user-flag)))
8487 (insert (format "%-10s" special)))
8489 ;; Old special syntax: a matching regexp
8490 ((setq special (idlwave-special-lib-test file))
8491 (insert (format "%-10s" special)))
8493 ;; Catch-all with file
8494 ((idlwave-lib-p file) (insert "Library "))
8496 ;; Sanity catch all
8497 (t (insert "Other ")))
8499 (when doflags
8500 (insert (concat
8501 " ["
8502 (if lib-flag "L" "-")
8503 (if user-flag "C" "-")
8504 (if shell-flag "S" "-")
8505 (if buffer-flag "B" "-")
8506 "] ")))
8507 (when (> ndupl 1)
8508 (setq beg (point))
8509 (insert (format "(%dx) " ndupl))
8510 (add-text-properties beg (point) (list 'face 'bold)))
8511 (when (and file (not (equal file "")))
8512 (setq beg (point))
8513 (insert (apply 'abbreviate-file-name
8514 (if (featurep 'xemacs) (list file t) (list file))))
8515 (if file-props
8516 (add-text-properties beg (point) file-props)))))
8518 (defun idlwave-special-lib-test (file)
8519 "Check the path of FILE against the regexps which define special libs.
8520 Return the name of the special lib if there is a match."
8521 (let ((alist idlwave-special-lib-alist)
8522 entry rtn)
8523 (cond
8524 ((stringp file)
8525 (while (setq entry (pop alist))
8526 (if (string-match (car entry) file)
8527 (setq rtn (cdr entry)
8528 alist nil)))
8529 rtn)
8530 (t nil))))
8532 (defun idlwave-mouse-active-rinfo-right (ev)
8533 (interactive "e")
8534 (idlwave-mouse-active-rinfo ev 'right))
8536 (defun idlwave-mouse-active-rinfo-shift (ev)
8537 (interactive "e")
8538 (idlwave-mouse-active-rinfo ev nil 'shift))
8540 (defun idlwave-active-rinfo-space ()
8541 (interactive)
8542 (idlwave-mouse-active-rinfo nil 'right))
8544 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8545 "Do the mouse actions in the routine info buffer.
8546 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8547 was pressed."
8548 (interactive "e")
8549 (if ev (mouse-set-point ev))
8550 (let (data id name type class buf bufwin source link keyword
8551 word initial-class)
8552 (setq data (get-text-property (point) 'data)
8553 source (get-text-property (point) 'source)
8554 keyword (get-text-property (point) 'keyword)
8555 link (get-text-property (point) 'link)
8556 id (car data)
8557 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8558 buf (nth 4 data)
8559 initial-class (nth 6 data)
8560 word (idlwave-this-word)
8561 bufwin (get-buffer-window buf t))
8563 (cond ((eq id 'class) ; Switch class being displayed
8564 (if (window-live-p bufwin) (select-window bufwin))
8565 (idlwave-display-calling-sequence
8566 (idlwave-sintern-method name)
8567 type (idlwave-sintern-class word)
8568 initial-class))
8569 ((eq id 'usage) ; Online help on this routine
8570 (idlwave-online-help link name type class))
8571 ((eq id 'source) ; Source in help or buffer
8572 (if right ; In help
8573 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8574 (idlwave-help-source-try-header nil)
8575 ;; Fake idlwave-routines so help will find the right entry
8576 (idlwave-routines
8577 (list (list name type class source ""))))
8578 (idlwave-help-get-special-help name type class nil))
8579 ;; Otherwise just pop to the source
8580 (setq idlwave-popup-source (not idlwave-popup-source))
8581 (if idlwave-popup-source
8582 (condition-case err
8583 (idlwave-do-find-module name type class source)
8584 (error
8585 (setq idlwave-popup-source nil)
8586 (if (window-live-p bufwin) (select-window bufwin))
8587 (error (nth 1 err))))
8588 (if bufwin
8589 (select-window bufwin)
8590 (pop-to-buffer buf))
8591 (goto-char (marker-position idlwave-rinfo-marker)))))
8592 ((eq id 'keyword)
8593 (if right
8594 (idlwave-online-help link name type class keyword)
8595 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8597 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8598 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8599 (let ((bwin (get-buffer-window buffer)))
8600 (if idlwave-complete-empty-string-as-lower-case
8601 (setq keyword (downcase keyword)))
8602 (if bwin
8603 (select-window bwin)
8604 (pop-to-buffer buffer)
8605 (setq bwin (get-buffer-window buffer)))
8606 (if (eq (preceding-char) ?/)
8607 (insert keyword)
8608 (unless (save-excursion
8609 (re-search-backward
8611 (min (- (point) 100) (point-min)) t))
8612 (insert ", "))
8613 (if shift (insert "/"))
8614 (insert keyword)
8615 (if (and (not shift)
8616 idlwave-keyword-completion-adds-equal)
8617 (insert "=")))))
8619 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8620 "List the load path shadows of all routines defined in current buffer."
8621 (interactive "P")
8622 (idlwave-routines)
8623 (if (derived-mode-p 'idlwave-mode)
8624 (idlwave-list-load-path-shadows
8625 nil (idlwave-update-current-buffer-info 'save-buffer)
8626 "in current buffer")
8627 (error "Current buffer is not in idlwave-mode")))
8629 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8630 "List the load path shadows of all routines compiled under the shell.
8631 This is very useful for checking an IDL application. Just compile the
8632 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8633 routines and update IDLWAVE internal info. Then check for shadowing
8634 with this command."
8635 (interactive "P")
8636 (cond
8637 ((or (not (fboundp 'idlwave-shell-is-running))
8638 (not (idlwave-shell-is-running)))
8639 (error "Shell is not running"))
8640 ((null idlwave-compiled-routines)
8641 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8642 (t
8643 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8644 "in the shell"))))
8646 (defun idlwave-list-all-load-path-shadows (&optional arg)
8647 "List the load path shadows of all routines known to IDLWAVE."
8648 (interactive "P")
8649 (idlwave-list-load-path-shadows nil nil "globally"))
8651 (defvar idlwave-sort-prefer-buffer-info t
8652 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8654 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8655 "List the routines which are defined multiple times.
8656 Search the information IDLWAVE has about IDL routines for multiple
8657 definitions.
8658 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8660 When IDL hits a routine call which is not defined, it will search on
8661 the load path in order to find a definition. The output of this command
8662 can be used to detect possible name clashes during this process."
8663 (idlwave-routines) ; Make sure everything is loaded.
8664 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8665 (or (y-or-n-p
8666 "You don't have any user or library catalogs. Continue anyway? ")
8667 (error "Abort")))
8668 (let* ((routines (append idlwave-system-routines
8669 idlwave-compiled-routines
8670 idlwave-library-catalog-routines
8671 idlwave-user-catalog-routines
8672 idlwave-buffer-routines
8673 nil))
8674 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8675 (keymap (make-sparse-keymap))
8676 (props (list 'mouse-face 'highlight
8677 km-prop keymap
8678 'help-echo "Mouse2: Find source"))
8679 (nroutines (length (or special-routines routines)))
8680 (step (/ nroutines 100))
8681 (n 0)
8682 (cnt 0)
8683 (idlwave-sort-prefer-buffer-info nil)
8684 routine twins dtwins twin done props1 lroutines)
8686 (if special-routines
8687 ;; Just looking for shadows of a few special routines
8688 (setq lroutines routines
8689 routines special-routines))
8691 (message "Sorting routines...")
8692 (setq routines (sort routines
8693 (lambda (a b)
8694 (string< (downcase (idlwave-make-full-name
8695 (nth 2 a) (car a)))
8696 (downcase (idlwave-make-full-name
8697 (nth 2 b) (car b)))))))
8698 (message "Sorting routines...done")
8700 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8701 (lambda (ev)
8702 (interactive "e")
8703 (mouse-set-point ev)
8704 (apply 'idlwave-do-find-module
8705 (get-text-property (point) 'find-args))))
8706 (define-key keymap [(return)]
8707 (lambda ()
8708 (interactive)
8709 (apply 'idlwave-do-find-module
8710 (get-text-property (point) 'find-args))))
8711 (message "Compiling list...( 0%%)")
8712 (with-current-buffer (get-buffer-create "*Shadows*")
8713 (setq buffer-read-only nil)
8714 (erase-buffer)
8715 (while (setq routine (pop routines))
8716 (if (= (mod (setq n (1+ n)) step) 0)
8717 (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines)))
8719 ;; Get a list of all twins
8720 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8721 (if (memq routine done)
8722 (setq dtwins nil)
8723 (setq dtwins (idlwave-study-twins twins)))
8724 ;; Mark all twins as dealt with
8725 (setq done (append twins done))
8726 (when (or (> (length dtwins) 1)
8727 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8728 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8729 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8730 (incf cnt)
8732 (idlwave-make-full-name (nth 2 routine)
8733 (car routine))
8734 (if (eq (nth 1 routine) 'fun) "()" "")))
8735 (while (setq twin (pop dtwins))
8736 (setq props1 (append (list 'find-args
8737 (list (nth 0 routine)
8738 (nth 1 routine)
8739 (nth 2 routine)))
8740 props))
8742 (goto-char (point-min))
8743 (setq buffer-read-only t))
8744 (setq loc (or loc ""))
8745 (if (> cnt 0)
8746 (progn
8747 (display-buffer (get-buffer "*Shadows*"))
8748 (message "%d case%s of shadowing found %s"
8749 cnt (if (= cnt 1) "" "s") loc))
8750 (message "No shadowing conflicts found %s" loc))))
8752 (defun idlwave-print-source (routine)
8753 (let* ((source (nth 3 routine))
8754 (stype (car source))
8755 (sfile (idlwave-routine-source-file source)))
8756 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8757 (if (and (eq stype 'compiled)
8758 (or (not (stringp sfile))
8760 (setq stype 'unresolved))
8762 stype
8763 (if sfile sfile "No source code available")))))
8765 (defun idlwave-routine-twins (entry &optional list)
8766 "Return all twin entries of ENTRY in LIST.
8767 LIST defaults to `idlwave-routines'.
8768 Twin entries are those which have the same name, type, and class.
8769 ENTRY will also be returned, as the first item of this list."
8770 (let* ((name (car entry))
8771 (type (nth 1 entry))
8772 (class (nth 2 entry))
8773 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8774 twins candidate)
8775 (while (setq candidate (pop candidates))
8776 (if (and (not (eq candidate entry))
8777 (eq type (nth 1 candidate))
8778 (eq class (nth 2 candidate)))
8779 (push candidate twins)))
8780 (if (setq candidate (idlwave-rinfo-assq name type class
8781 idlwave-unresolved-routines))
8782 (push candidate twins))
8783 (cons entry (nreverse twins))))
8785 (defun idlwave-study-twins (entries)
8786 "Return dangerous twins of first entry in ENTRIES.
8787 Dangerous twins are routines with same name, but in different files on
8788 the load path. If a file is in the system library and has an entry in
8789 the `idlwave-system-routines' list, we omit the latter as
8790 non-dangerous because many IDL routines are implemented as library
8791 routines, and may have been scanned."
8792 (let* ((entry (car entries))
8793 (idlwave-twin-name (car entry)) ;
8794 (type (nth 1 entry)) ; Must be bound for
8795 (idlwave-twin-class (nth 2 entry)) ; idlwave-routine-twin-compare
8796 (cnt 0)
8797 source type type-cons file alist syslibp key)
8798 (while (setq entry (pop entries))
8799 (incf cnt)
8800 (setq source (nth 3 entry)
8801 type (car source)
8802 type-cons (cons type (nth 3 source))
8803 file (idlwave-routine-source-file source))
8805 ;; Make KEY to index entry properly
8806 (setq key (cond ((eq type 'system) type)
8807 (file (file-truename file))
8808 (t 'unresolved)))
8810 ;; Check for an entry in the system library
8811 (if (and file
8812 (not syslibp)
8813 (idlwave-syslib-p file))
8814 (setq syslibp t))
8816 ;; If there's more than one matching entry for the same file, just
8817 ;; append the type-cons to the type list.
8818 (if (setq entry (assoc key alist))
8819 (push type-cons (nth 2 entry))
8820 (push (list key file (list type-cons)) alist)))
8822 (setq alist (nreverse alist))
8824 (when syslibp
8825 ;; File is in system *library* - remove any 'system entry
8826 (setq alist (delq (assq 'system alist) alist)))
8828 ;; If 'system remains and we've scanned the syslib, it's a builtin
8829 ;; (rather than a !DIR/lib/.pro file bundled as source).
8830 (when (and (idlwave-syslib-scanned-p)
8831 (setq entry (assoc 'system alist)))
8832 (setcar entry 'builtin))
8833 (sort alist 'idlwave-routine-twin-compare)))
8835 ;; FIXME: Dynamically scoped vars need to use the `idlwave-' prefix.
8836 ;; (defvar type)
8837 (defmacro idlwave-xor (a b)
8838 `(and (or ,a ,b)
8839 (not (and ,a ,b))))
8841 (defun idlwave-routine-entry-compare (a b)
8842 "Compare two routine info entries for sorting.
8843 This is the general case. It first compares class, names, and type.
8844 If it turns out that A and B are twins (same name, class, and type),
8845 calls another routine which compares twins on the basis of their file
8846 names and path locations."
8847 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8848 (cond
8849 ((not (equal (idlwave-downcase-safe class)
8850 (idlwave-downcase-safe (nth 2 b))))
8851 ;; Class decides
8852 (cond ((null (nth 2 b)) nil)
8853 ((null class) t)
8854 (t (string< (downcase class) (downcase (nth 2 b))))))
8855 ((not (equal (downcase name) (downcase (car b))))
8856 ;; Name decides
8857 (string< (downcase name) (downcase (car b))))
8858 ((not (eq type (nth 1 b)))
8859 ;; Type decides
8860 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8861 (t
8862 ;; A and B are twins - so the decision is more complicated.
8863 ;; Call twin-compare with the proper arguments.
8864 (idlwave-routine-entry-compare-twins a b)))))
8866 (defun idlwave-routine-entry-compare-twins (a b)
8867 "Compare two routine entries, under the assumption that they are twins.
8868 This basically calls `idlwave-routine-twin-compare' with the correct args."
8869 (let* ((idlwave-twin-name (car a))
8870 (type (nth 1 a))
8871 (idlwave-twin-class (nth 2 a)) ; used in idlwave-routine-twin-compare
8872 (asrc (nth 3 a))
8873 (atype (car asrc))
8874 (bsrc (nth 3 b))
8875 (btype (car bsrc))
8876 (afile (idlwave-routine-source-file asrc))
8877 (bfile (idlwave-routine-source-file bsrc)))
8878 (idlwave-routine-twin-compare
8879 (if (stringp afile)
8880 (list (file-truename afile) afile (list atype))
8881 (list atype afile (list atype)))
8882 (if (stringp bfile)
8883 (list (file-truename bfile) bfile (list btype))
8884 (list btype bfile (list btype))))))
8886 ;; Bound in idlwave-study-twins,idlwave-routine-entry-compare-twins.
8887 (defvar idlwave-twin-class)
8888 (defvar idlwave-twin-name)
8890 (defun idlwave-routine-twin-compare (a b)
8891 "Compare two routine twin entries for sorting.
8892 In here, A and B are not normal routine info entries, but special
8893 lists (KEY FILENAME (TYPES...)).
8894 This expects NAME TYPE IDLWAVE-TWIN-CLASS to be bound to the right values."
8895 (let* (;; Dis-assemble entries
8896 (akey (car a)) (bkey (car b))
8897 (afile (nth 1 a)) (bfile (nth 1 b))
8898 (atypes (nth 2 a)) (btypes (nth 2 b))
8899 ;; System routines?
8900 (asysp (memq akey '(builtin system)))
8901 (bsysp (memq bkey '(builtin system)))
8902 ;; Compiled routines?
8903 (acompp (memq 'compiled atypes))
8904 (bcompp (memq 'compiled btypes))
8905 ;; Unresolved?
8906 (aunresp (or (eq akey 'unresolved)
8907 (and acompp (not afile))))
8908 (bunresp (or (eq bkey 'unresolved)
8909 (and bcompp (not bfile))))
8910 ;; Buffer info available?
8911 (abufp (memq 'buffer atypes))
8912 (bbufp (memq 'buffer btypes))
8913 ;; On search path?
8914 (tpath-alist (idlwave-true-path-alist))
8915 (apathp (and (stringp akey)
8916 (assoc (file-name-directory akey) tpath-alist)))
8917 (bpathp (and (stringp bkey)
8918 (assoc (file-name-directory bkey) tpath-alist)))
8919 ;; How early on search path? High number means early since we
8920 ;; measure the tail of the path list
8921 (anpath (length (memq apathp tpath-alist)))
8922 (bnpath (length (memq bpathp tpath-alist)))
8923 ;; Look at file names
8924 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8925 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8926 (fname-re (if idlwave-twin-class
8928 (regexp-quote (downcase idlwave-twin-class))
8929 (regexp-quote (downcase idlwave-twin-name)))
8931 ;; Is file name derived from the routine name?
8932 ;; Method file or class definition file?
8933 (anamep (string-match fname-re aname))
8934 (adefp (and idlwave-twin-class anamep
8935 (string= "define" (match-string 1 aname))))
8936 (bnamep (string-match fname-re bname))
8937 (bdefp (and idlwave-twin-class bnamep
8938 (string= "define" (match-string 1 bname)))))
8940 ;; Now: follow JD's ideas about sorting. Looks really simple now,
8941 ;; doesn't it? The difficult stuff is hidden above...
8942 (cond
8943 ((idlwave-xor asysp bsysp) asysp) ; System entries first
8944 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
8945 ((and idlwave-sort-prefer-buffer-info
8946 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
8947 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
8948 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
8949 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
8950 ((and idlwave-twin-class anamep bnamep ; both file names match ->
8951 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
8952 ((> anpath bnpath) t) ; Who is first on path?
8953 (t nil)))) ; Default
8955 (defun idlwave-routine-source-file (source)
8956 (if (nth 2 source)
8957 (expand-file-name (nth 1 source) (nth 2 source))
8958 (nth 1 source)))
8960 (defun idlwave-downcase-safe (string)
8961 "Donwcase if string, else return unchanged."
8962 (if (stringp string)
8963 (downcase string)
8964 string))
8966 (defun idlwave-count-eq (elt list)
8967 "How often is ELT in LIST?"
8968 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
8970 (defun idlwave-count-memq (elt alist)
8971 "How often is ELT a key in ALIST?"
8972 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
8974 (defun idlwave-syslib-p (file)
8975 "Non-nil if FILE is in the system library."
8976 (let* ((true-syslib (file-name-as-directory
8977 (file-truename
8978 (expand-file-name "lib" (idlwave-sys-dir)))))
8979 (true-file (file-truename file)))
8980 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
8982 (defun idlwave-lib-p (file)
8983 "Non-nil if FILE is in the library."
8984 (let ((true-dir (file-name-directory (file-truename file))))
8985 (assoc true-dir (idlwave-true-path-alist))))
8987 (defun idlwave-path-alist-add-flag (list-entry flag)
8988 "Add a flag to the path list entry, if not set."
8989 (let ((flags (cdr list-entry)))
8990 (add-to-list 'flags flag)
8991 (setcdr list-entry flags)))
8993 (defun idlwave-path-alist-remove-flag (list-entry flag)
8994 "Remove a flag to the path list entry, if set."
8995 (let ((flags (delq flag (cdr list-entry))))
8996 (setcdr list-entry flags)))
8998 (defun idlwave-true-path-alist ()
8999 "Return `idlwave-path-alist' alist with true-names.
9000 Info is cached, but relies on the functions setting `idlwave-path-alist'
9001 to reset the variable `idlwave-true-path-alist' to nil."
9002 (or idlwave-true-path-alist
9003 (setq idlwave-true-path-alist
9004 (mapcar (lambda(x) (cons
9005 (file-name-as-directory
9006 (file-truename
9007 (directory-file-name
9008 (car x))))
9009 (cdr x)))
9010 idlwave-path-alist))))
9012 (defun idlwave-syslib-scanned-p ()
9013 "Non-nil if the system lib file !DIR/lib has been scanned."
9014 (let* ((true-syslib (file-name-as-directory
9015 (file-truename
9016 (expand-file-name "lib" (idlwave-sys-dir))))))
9017 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
9019 ;; ----------------------------------------------------------------------------
9020 ;;
9021 ;; Online Help display
9024 ;; ----------------------------------------------------------------------------
9025 ;;
9026 ;; Additions for use with imenu.el and func-menu.el
9027 ;; (pop-up a list of IDL units in the current file).
9028 ;;
9030 (defun idlwave-prev-index-position ()
9031 "Search for the previous procedure or function.
9032 Return nil if not found. For use with imenu.el."
9033 (save-match-data
9034 (cond
9036 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
9037 (t nil))))
9039 (defun idlwave-unit-name ()
9040 "Return the unit name.
9041 Assumes that point is at the beginning of the unit as found by
9042 `idlwave-prev-index-position'."
9043 (forward-sexp 2)
9044 (forward-sexp -1)
9045 (let ((begin (point)))
9046 (re-search-forward
9048 (if (fboundp 'buffer-substring-no-properties)
9049 (buffer-substring-no-properties begin (point))
9050 (buffer-substring begin (point)))))
9052 (defalias 'idlwave-function-menu
9053 (condition-case nil
9054 (progn
9055 (require 'func-menu)
9056 'function-menu)
9057 (error (condition-case nil
9058 (progn
9059 (require 'imenu)
9060 'imenu)
9061 (error nil)))))
9063 ;; Here we hack func-menu.el in order to support this new mode.
9064 ;; The latest versions of func-menu.el already have this stuff in, so
9065 ;; we hack only if it is not already there.
9066 (when (fboundp 'eval-after-load)
9067 (eval-after-load "func-menu"
9068 '(progn
9069 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
9070 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
9071 (setq fume-function-name-regexp-alist
9072 (cons '(idlwave-mode . fume-function-name-regexp-idl)
9073 fume-function-name-regexp-alist)))
9074 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
9075 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
9076 (setq fume-find-function-name-method-alist
9077 (cons '(idlwave-mode . fume-find-next-idl-function-name)
9078 fume-find-function-name-method-alist))))))
9080 (defun idlwave-edit-in-idlde ()
9081 "Edit the current file in IDL Development environment."
9082 (interactive)
9083 (start-process "idldeclient" nil
9084 idlwave-shell-explicit-file-name "-c" "-e"
9085 (buffer-file-name)))
9087 (defvar idlwave-help-use-assistant)
9088 (defun idlwave-launch-idlhelp ()
9089 "Start the IDLhelp application."
9090 (interactive)
9091 (if idlwave-help-use-assistant
9092 (idlwave-help-assistant-raise)
9093 (start-process "idlhelp" nil idlwave-help-application)))
9095 ;; Menus - using easymenu.el
9096 (defvar idlwave-mode-menu-def
9097 `("IDLWAVE"
9098 ["PRO/FUNC menu" idlwave-function-menu t]
9099 ("Motion"
9100 ["Subprogram Start" idlwave-beginning-of-subprogram t]
9101 ["Subprogram End" idlwave-end-of-subprogram t]
9102 ["Block Start" idlwave-beginning-of-block t]
9103 ["Block End" idlwave-end-of-block t]
9104 ["Up Block" idlwave-backward-up-block t]
9105 ["Down Block" idlwave-down-block t]
9106 ["Skip Block Backward" idlwave-backward-block t]
9107 ["Skip Block Forward" idlwave-forward-block t])
9108 ("Mark"
9109 ["Subprogram" idlwave-mark-subprogram t]
9110 ["Block" idlwave-mark-block t]
9111 ["Header" idlwave-mark-doclib t])
9112 ("Format"
9113 ["Indent Entire Statement" idlwave-indent-statement
9115 ["Indent Subprogram" idlwave-indent-subprogram t]
9116 ["(Un)Comment Region" idlwave-toggle-comment-region t]
9117 ["Continue/Split line" idlwave-split-line t]
9118 "--"
9119 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
9120 :selected (symbol-value idlwave-fill-function)])
9121 ("Templates"
9122 ["Procedure" idlwave-procedure t]
9123 ["Function" idlwave-function t]
9124 ["Doc Header" idlwave-doc-header t]
9125 ["Log" idlwave-doc-modification t]
9126 "--"
9127 ["Case" idlwave-case t]
9128 ["For" idlwave-for t]
9129 ["Repeat" idlwave-repeat t]
9130 ["While" idlwave-while t]
9131 "--"
9132 ["Close Block" idlwave-close-block t])
9133 ("Completion"
9134 ["Complete" idlwave-complete t]
9135 ("Complete Specific"
9136 ["1 Procedure Name" (idlwave-complete 'procedure) t]
9137 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
9138 "--"
9139 ["3 Function Name" (idlwave-complete 'function) t]
9140 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
9141 "--"
9142 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
9143 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
9144 "--"
9145 ["7 Function Method Name" (idlwave-complete 'function-method) t]
9146 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
9147 "--"
9148 ["9 Class Name" idlwave-complete-class t]))
9149 ("Routine Info"
9150 ["Show Routine Info" idlwave-routine-info t]
9151 ["Online Context Help" idlwave-context-help t]
9152 "--"
9153 ["Find Routine Source" idlwave-find-module t]
9154 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
9155 "--"
9156 ["Update Routine Info" idlwave-update-routine-info t]
9157 ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t]
9158 "--"
9159 "IDL User Catalog"
9160 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
9161 ["Scan Directories" (idlwave-update-routine-info '(16))
9162 (and idlwave-path-alist (not idlwave-catalog-process))]
9163 ["Scan Directories &" (idlwave-update-routine-info '(64))
9164 (and idlwave-path-alist (not idlwave-catalog-process))]
9165 "--"
9166 "Routine Shadows"
9167 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
9168 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
9169 ["Check Everything" idlwave-list-all-load-path-shadows t])
9170 ("Misc"
9171 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
9172 "--"
9173 ["Insert TAB character" idlwave-hard-tab t])
9174 "--"
9175 ("External"
9176 ["Start IDL shell" idlwave-shell t]
9177 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
9178 ["Launch IDL Help" idlwave-launch-idlhelp t])
9179 "--"
9180 ("Customize"
9181 ["Browse IDLWAVE Group" idlwave-customize t]
9182 "--"
9183 ["Build Full Customize Menu" idlwave-create-customize-menu
9184 (fboundp 'customize-menu-create)])
9185 ("Documentation"
9186 ["Describe Mode" describe-mode t]
9187 ["Abbreviation List" idlwave-list-abbrevs t]
9188 "--"
9189 ["Commentary in idlwave.el" idlwave-show-commentary t]
9190 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
9191 "--"
9192 ["Info" idlwave-info t]
9193 "--"
9194 ["Help with Topic" idlwave-help-assistant-help-with-topic
9195 idlwave-help-use-assistant]
9196 ["Launch IDL Help" idlwave-launch-idlhelp t])))
9198 (defvar idlwave-mode-debug-menu-def
9199 '("Debug"
9200 ["Start IDL shell" idlwave-shell t]
9201 ["Save and .RUN buffer" idlwave-shell-save-and-run
9202 (and (boundp 'idlwave-shell-automatic-start)
9203 idlwave-shell-automatic-start)]))
9205 (if (or (featurep 'easymenu) (load "easymenu" t))
9206 (progn
9207 (easy-menu-define idlwave-mode-menu idlwave-mode-map
9208 "IDL and WAVE CL editing menu"
9209 idlwave-mode-menu-def)
9210 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
9211 "IDL and WAVE CL editing menu"
9212 idlwave-mode-debug-menu-def)))
9214 (defun idlwave-customize ()
9215 "Call the customize function with `idlwave' as argument."
9216 (interactive)
9217 ;; Try to load the code for the shell, so that we can customize it
9218 ;; as well.
9219 (or (featurep 'idlw-shell)
9220 (load "idlw-shell" t))
9221 (customize-browse 'idlwave))
9223 (defun idlwave-create-customize-menu ()
9224 "Create a full customization menu for IDLWAVE, insert it into the menu."
9225 (interactive)
9226 (if (fboundp 'customize-menu-create)
9227 (progn
9228 ;; Try to load the code for the shell, so that we can customize it
9229 ;; as well.
9230 (or (featurep 'idlw-shell)
9231 (load "idlw-shell" t))
9232 (easy-menu-change
9233 '("IDLWAVE") "Customize"
9234 `(["Browse IDLWAVE group" idlwave-customize t]
9235 "--"
9236 ,(customize-menu-create 'idlwave)
9237 ["Set" Custom-set t]
9238 ["Save" Custom-save t]
9239 ["Reset to Current" Custom-reset-current t]
9240 ["Reset to Saved" Custom-reset-saved t]
9241 ["Reset to Standard Settings" Custom-reset-standard t]))
9243 (error "Cannot expand menu (outdated version of cus-edit.el)")))
9245 (defun idlwave-show-commentary ()
9246 "Use the finder to view the file documentation from `idlwave.el'."
9247 (interactive)
9248 (finder-commentary "idlwave.el"))
9250 (defun idlwave-shell-show-commentary ()
9251 "Use the finder to view the file documentation from `idlw-shell.el'."
9252 (interactive)
9253 (finder-commentary "idlw-shell.el"))
9255 (defun idlwave-info ()
9256 "Read documentation for IDLWAVE in the info system."
9257 (interactive)
9258 (info "idlwave"))
9260 (defun idlwave-list-abbrevs (arg)
9261 "Show the code abbreviations define in IDLWAVE mode.
9262 This lists all abbrevs where the replacement text differs from the input text.
9263 These are the ones the users want to learn to speed up their writing.
9265 The function does *not* list abbrevs which replace a word with itself
9266 to call a hook. These hooks are used to change the case of words or
9267 to blink the matching `begin', and the user does not need to know them.
9269 With arg, list all abbrevs with the corresponding hook.
9271 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
9273 (interactive "P")
9274 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
9275 abbrevs
9276 str rpl func fmt (len-str 0) (len-rpl 0))
9277 (mapatoms
9278 (lambda (sym)
9279 (if (symbol-value sym)
9280 (progn
9281 (setq str (symbol-name sym)
9282 rpl (symbol-value sym)
9283 func (symbol-function sym))
9284 (if arg
9285 (setq func (prin1-to-string func))
9286 (if (and (listp func) (stringp (nth 2 func)))
9287 (setq rpl (concat "EVAL: " (nth 2 func))
9288 func "")
9289 (setq func "")))
9290 (if (or arg (not (string= rpl str)))
9291 (progn
9292 (setq len-str (max len-str (length str)))
9293 (setq len-rpl (max len-rpl (length rpl)))
9294 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
9295 table)
9296 ;; sort the list
9297 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
9298 ;; Make the format
9300 (with-output-to-temp-buffer "*Help*"
9301 (if arg
9302 (progn
9305 (princ (format fmt "KEY" "REPLACE" "HOOK"))
9306 (princ (format fmt "---" "-------" "----")))
9309 (princ (format fmt "KEY" "ACTION" ""))
9310 (princ (format fmt "---" "------" "")))
9311 (mapcar
9312 (lambda (list)
9313 (setq str (car list)
9314 rpl (nth 1 list)
9315 func (nth 2 list))
9316 (princ (format fmt str rpl func)))
9317 abbrevs)))
9318 ;; Make sure each abbreviation uses only one display line
9319 (with-current-buffer "*Help*"
9320 (setq truncate-lines t)))
9322 ;; Add .pro files to speedbar for support, if it's loaded
9323 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
9325 ;; Set an idle timer to load the routine info.
9326 ;; Will only work on systems which support this.
9327 (or idlwave-routines (idlwave-start-load-rinfo-timer))
9329 ;; Run the hook
9330 (run-hooks 'idlwave-load-hook)
9332 (provide 'idlwave)
9334 ;;; idlwave.el ends here