| blob | bdd291243519f828c94cf3a0654d8dae2b86c353 |
1 ;;; idlwave.el --- IDL editing mode for GNU Emacs
2 ;; Copyright (c) 1999, 2000, 2001,2002 Free Software Foundation
4 ;; Author: Carsten Dominik <dominik@astro.uva.nl>
5 ;; Chris Chase <chase@att.com>
6 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
7 ;; Version: 4.15
8 ;; Date: $Date: 2002/10/18 08:12:35 $
9 ;; Keywords: languages
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software; you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation; either version 2, or (at your option)
16 ;; any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs; see the file COPYING. If not, write to the
25 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
26 ;; Boston, MA 02111-1307, USA.
28 ;;; Commentary:
30 ;; In distant past, based on pascal.el. Though bears little
31 ;; resemblance to that now.
32 ;;
33 ;; Incorporates many ideas, such as abbrevs, action routines, and
34 ;; continuation line indenting, from wave.el.
35 ;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder.
36 ;;
37 ;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode")
38 ;; for features, key bindings, and info.
39 ;; Also, Info format documentation is available with `M-x idlwave-info'
40 ;;
41 ;; New versions of IDLWAVE, documentation, and more information
42 ;; available from:
43 ;; http://idlwave.org
44 ;;
45 ;; INSTALLATION
46 ;; ============
47 ;;
48 ;; Follow the instructions in the INSTALL file of the distribution.
49 ;; In short, put this file on your load path and add the following
50 ;; lines to your .emacs file:
51 ;;
52 ;; (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
53 ;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
54 ;; (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
55 ;;
56 ;;
57 ;; SOURCE
58 ;; ======
59 ;;
60 ;; The newest version of this file is available from the maintainer's
61 ;; Webpage.
62 ;;
63 ;; http://idlwave.org
64 ;;
65 ;; DOCUMENTATION
66 ;; =============
67 ;;
68 ;; IDLWAVE is documented online in info format.
69 ;; A printable version of the documentation is available from the
70 ;; maintainers webpage (see under SOURCE)
71 ;;
72 ;;
73 ;; ACKNOWLEDGMENTS
74 ;; ===============
75 ;;
76 ;; Thanks to the following people for their contributions and comments:
77 ;;
78 ;; Ulrik Dickow <dickow@nbi.dk>
79 ;; Eric E. Dors <edors@lanl.gov>
80 ;; Stein Vidar H. Haugan <s.v.h.haugan@astro.uio.no>
81 ;; David Huenemoerder <dph@space.mit.edu>
82 ;; Kevin Ivory <Kevin.Ivory@linmpi.mpg.de>
83 ;; Xuyong Liu <liu@stsci.edu>
84 ;; Simon Marshall <Simon.Marshall@esrin.esa.it>
85 ;; Laurent Mugnier <mugnier@onera.fr>
86 ;; Lubos Pochman <lubos@rsinc.com>
87 ;; Bob Portmann <portmann@al.noaa.gov>
88 ;; Patrick M. Ryan <pat@jaameri.gsfc.nasa.gov>
89 ;; Marty Ryba <ryba@ll.mit.edu>
90 ;; Phil Williams <williams@irc.chmcc.org>
91 ;; Phil Sterne <sterne@dublin.llnl.gov>
92 ;;
93 ;; CUSTOMIZATION:
94 ;; =============
95 ;;
96 ;; IDLWAVE has extensive customize support - so if you want to learn
97 ;; about the variables which control the behavior of the mode, use
98 ;; `M-x idlwave-customize'.
99 ;;
100 ;; You can set your own preferred values with Customize, or with Lisp
101 ;; code in .emacs. For an example of what to put into .emacs, check
102 ;; the TexInfo documentation or see a complete .emacs at
103 ;; http://idlwave.org.
104 ;;
105 ;; KNOWN PROBLEMS:
106 ;; ==============
107 ;;
108 ;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual
109 ;; Numerics, Inc. is growing less and less complete as the two
110 ;; languages grow increasingly apart. The mode probably shouldn't
111 ;; even have "WAVE" in it's title, but it's catchy, and required to
112 ;; avoid conflict with the CORBA idl.el mode. Caveat WAVEor.
113 ;;
114 ;; Moving the point backwards in conjunction with abbrev expansion
115 ;; does not work as I would like it, but this is a problem with
116 ;; emacs abbrev expansion done by the self-insert-command. It ends
117 ;; up inserting the character that expanded the abbrev after moving
118 ;; point backward, e.g., "\cl" expanded with a space becomes
119 ;; "LONG( )" with point before the close paren. This is solved by
120 ;; using a temporary function in `post-command-hook' - not pretty,
121 ;; but it works.
122 ;;
123 ;; Tabs and spaces are treated equally as whitespace when filling a
124 ;; comment paragraph. To accomplish this, tabs are permanently
125 ;; replaced by spaces in the text surrounding the paragraph, which
126 ;; may be an undesirable side-effect. Replacing tabs with spaces is
127 ;; limited to comments only and occurs only when a comment
128 ;; paragraph is filled via `idlwave-fill-paragraph'.
129 ;;
130 ;; Avoid muti-statement lines (using "&") on block begin and end
131 ;; lines. Multi-statement lines can mess up the formatting, for
132 ;; example, multiple end statements on a line: endif & endif.
133 ;; Using "&" outside of block begin/end lines should be okay.
134 ;;
135 ;; Determining the expression at point for printing and other
136 ;; examination commands is somewhat rough: currently only fairly
137 ;; simple entities are found. You can always drag-select or examine
138 ;; a region.
139 ;;
140 ;; When forcing completion of method keywords, the initial
141 ;; query for a method has multiple entries for some methods. Would
142 ;; be too difficult to fix this hardly used case.
143 ;;
144 \f
145 ;;; Code:
150 ;; Kludge to allow `defcustom' for Emacs 19.
153 nil ;; We've got what we needed
154 ;; We have the old or no custom-library, hack around it!
160 "Major mode for editing IDL .pro files"
171 ;;; Variables for indentation behavior ---------------------------------------
174 "Indentation and formatting options for IDLWAVE mode."
178 "*Extra indentation for the main block of code.
179 That is the block between the FUNCTION/PRO statement and the END
180 statement for that program unit."
185 "*Extra indentation applied to block lines.
186 If you change this, you probably also want to change `idlwave-end-offset'."
191 "*Extra indentation applied to block END lines.
192 A value equal to negative `idlwave-block-indent' will make END lines
193 line up with the block BEGIN lines."
198 "*Extra indentation applied to continuation lines.
199 This extra offset applies to the first of a set of continuation lines.
200 The following lines receive the same indentation as the first."
205 "*Maximum additional indentation for special continuation indent.
206 Several special indentations are tried to help line up continuation
207 lines in routine calls or definitions, other statements with
208 parentheses, or assignment statements. This variable specifies a
209 maximum amount by which this special indentation can exceed the
210 standard continuation indentation, otherwise defaulting to a fixed
211 offset. Set to 0 to effectively disable all special continuation
212 indentation, or to a large number (like 100) to enable it in all
213 cases. See also `idlwave-indent-top-open-paren', which can override
214 this variable."
219 "*Non-nil means, indent continuation lines to innermost open
220 parenthesis. This indentation occurs even if otherwise disallowed by
221 `idlwave-max-extra-continuation-indent'. Matching parens and the
222 interleaving args are lined up. Example:
224 x = function_a(function_b(function_c( a, b, [1,2,3, $
225 4,5,6 $
226 ], $
227 c, d $
228 )))
230 When this variable is nil, paren alignment may still occur, based on
231 the value of `max-extra-continuation-indent', which, if zero, would
232 yield:
234 x = function_a(function_b(function_c( a, b, [1,2,3, $
235 4,5,6 $
236 ], $
237 c, d $
238 )))"
243 "*If set non-nil then comment paragraphs are indented under the
244 hanging indent given by `idlwave-hang-indent-regexp' match in the first line
245 of the paragraph."
250 "*Regular expression matching the position of the hanging indent
251 in the first line of a comment paragraph. The size of the indent
252 extends to the end of the match for the regular expression."
257 "*If non-nil then use last match on line for `idlwave-indent-regexp'."
262 "*If non-nil then auto fill will only operate on comment lines."
267 "*If non-nil then auto fill will split strings with the IDL `+' operator.
268 When the line end falls within a string, string concatenation with the
269 '+' operator will be used to distribute a long string over lines.
270 If nil and a string is split then a terminal beep and warning are issued.
272 This variable is ignored when `idlwave-fill-comment-line-only' is
273 non-nil, since in this case code is not auto-filled."
278 "*If non-nil then `idlwave-split-line' will split strings with `+'.
279 When the splitting point of a line falls inside a string, split the string
280 using the `+' string concatenation operator. If nil and a string is
281 split then a terminal beep and warning are issued."
286 "*The indentation of a comment that starts with this regular
287 expression will not be changed. Note that the indentation of a comment
288 at the beginning of a line is never changed."
293 "*A comment anchored at the beginning of line.
294 A comment matching this regular expression will not have its
303 "*A comment that starts with this regular expression on a line by
304 itself is indented as if it is a part of IDL code. As a result if
305 the comment is not preceded by whitespace it is unchanged."
309 ;; Comments not matching any of the above will be indented as a
310 ;; right-margin comment, i.e., to a minimum of `comment-column'.
313 ;;; Routine Info and Completion ---------------------------------------
316 "Routine Info options for IDLWAVE mode."
321 "*Seconds of idle time before routine info is automatically initialized.
322 Initializing the routine info can take long, in particular if a large
323 library catalog is involved. When Emacs is idle for more than the number
324 of seconds specified by this variable, it starts the initialization.
325 The process is split into five steps, in order to keep possible work
326 interruption as short as possible. If one of the steps finishes, and no
327 user input has arrived in the mean time, initialization proceeds immediately
328 to the next step.
329 A good value for this variable is about 1/3 of the time initialization
330 take in you setup. So if you have a fast machine and no problems with a slow network connection, don't hesitate to set this to 2 seconds.
331 A Value of 0 means, don't initialize automatically."
336 "*Non-nil means, scan buffers for IDL programs when updating info.
337 The scanning is done by the command `idlwave-update-routine-info'.
338 The following values are allowed:
340 nil Don't scan any buffers.
341 t Scan all idlwave-mode buffers in the current editing session.
342 current Scan only the current buffer, but no other buffers."
350 "*Non-nil means query the shell for info about compiled routines.
351 Querying the shell is useful to get information about compiled modules,
352 and it is turned on by default. However, when you have a complete library
353 scan, this is not necessary."
359 "*Controls under what circumstances routine info is updated automatically.
360 Possible values:
361 nil Never
362 t All available
363 \(...) A list of circumstances. Allowed members are:
364 find-file Add info for new IDLWAVE buffers.
365 save-buffer Update buffer info when buffer is saved
366 kill-buffer Remove buffer info when buffer gets killed
367 compile-buffer Update shell info after `idlwave-shell-save-and...'"
379 "*Maximum number of source files displayed in the Routine Info window.
380 When an integer, it is the maximum number of source files displayed.
381 t means to show all source files."
386 "Library path for Windows and MacOS. Not needed under Unix.
387 When selecting the directories to scan for IDL library routine info,
388 IDLWAVE can under UNIX query the shell for the exact search path.
389 However, under Windows and MacOS, the IDLWAVE shell does not work. In this
390 case, this variable specifies the path where IDLWAVE can find library files.
391 The shell will only be asked when this variable is nil.
392 The value is a list of directories. A directory preceeded by a `+' will
393 be searched recursively. If you set this variable on a UNIX system, the shell
394 will not be asked.
395 See also `idlwave-system-directory'."
400 "The IDL system directory for Windows and MacOS. Not needed under UNIX.
401 Set this to the value of the `!DIR' system variable in IDL. IDLWAVE uses
402 this to find out which of the library routines belong to the official system
403 library. All files inside the `lib' subdirectory are considered system
404 library files - so don't install private stuff in this directory.
405 On UNIX systems, IDLWAVE queries the shell for the value of `!DIR'.
406 See also `idlwave-library-path'."
411 "*File for routine information of the IDL library.
412 When this points to a file, the file will be loaded when IDLWAVE first
413 accesses routine info (or does completion).
414 When you scan the library with `idlwave-create-libinfo-file', this file
415 will be used to store the result."
420 "Alist of regular expressions matching special library directories.
421 When listing routine source locations, IDLWAVE gives a short hint where
422 the file defining the routine is located. By default it lists `SystemLib'
423 for routines in the system library `!DIR/lib' and `Library' for anything
424 else. This variable can define additional types. The car of each entry
425 is a regular expression matching the file name (they normally will match
426 on the path). The cdr is the string to be used as identifier. Max 10
427 chars are allowed."
433 "Online Help options for IDLWAVE mode."
437 "The directory where idlw-help.txt and idlw-help.el are stored."
442 "*Non-nil means, use a separate frame for Online Help if possible."
448 "The frame parameters for the special Online Help frame.
449 See also `idlwave-help-use-dedicated-frame'.
450 If you do not set the frame width here, the value specified in
451 `idlw-help.el' will be used."
457 "Maximum number of items per pane in popup menus.
458 Currently only used for class selection during completion help."
463 "The function to call for online help if the normal help fails.
464 Online help works only for system routines which are described in the
465 IDL manuals. A function may be specified to access help from other sources.
467 The function must accept four arguments: NAME, TYPE, CLASS, KEYWORD.
468 The Help buffer is current when this function is called, and the help
469 text should be loaded into this buffer. If help is found, the function
470 should return the buffer position which should be used as `window-start'
471 in the help window. Also, the variable `idlwave-help-mode-line-indicator'
472 should be set to a useful string, which will be displayed in the mode line
473 of the help window. If should also set the variable `idlwave-min-frame-width'
474 to a positive integer. IDLWAVE will ensure that the help frame is at
475 least that many columns wide.
476 Failure to find help should be indicated by throwing an error.
478 When this variable is non-nil, IDLWAVE will allow the mouse-3 help click
479 for every routine and keyword, even though the item may not be highlighted
480 in blue (indicating the availability of system documentation).
482 The default value for this function is `idlwave-help-with-source' which
483 loads the routine source file into the help buffer. If you try to write
484 a different function which accesses a special help file or so, it is
485 probably a good idea to still call this function as a fallback."
490 "*Non-nil means, fontify source code displayed as help like normal code."
495 "*Non-nil means, try to find help in routine header when displaying source.
496 Routines which are not documented in the system manual use their source as
497 help text. When this variable is non-nil, we try to find a description of
498 the help item in the first routine doclib header above the routine definition.
499 If the variable is nil, or if we cannot find/parse the header, the routine
500 definition is displayed instead."
507 "Face for highlighting links into IDLWAVE online help."
511 "*Non-nil means, make all possible links in help active.
512 This just activates all words which are also a help topic - some links may
513 be misleading."
519 "Completion options for IDLWAVE mode."
536 "Association list setting the case of completed words.
538 This variable determines the case (UPPER/lower/Capitalized...) of
539 words inserted into the buffer by completion. The preferred case can
540 be specified separately for routine names, keywords, classes and
541 methods.
542 This alist should therefore have entries for `routine' (normal
543 functions and procedures, i.e. non-methods), `keyword', `class', and
544 `method'. Plausible values are
546 upcase upcase whole word, like `BOX_CURSOR'
547 downcase downcase whole word, like `read_ppm'
548 capitalize capitalize each part, like `Widget_Control'
549 preserve preserve case as is, like `IDLgrView'
551 The value can also be any Emacs Lisp function which transforms the
552 case of characters in a string.
554 A value of `preserve' means that the case of the completed word is
555 identical to the way it was written in the definition statement of the
556 routine. This was implemented to allow for mixed-case completion, in
557 particular of object classes and methods.
558 If a completable word is defined in multiple locations, the meaning of
559 `preserve' is not unique since the different definitions might be
560 cased differently. Therefore IDLWAVE always takes the case of the
561 *first* definition it encounters during routine info collection and
562 uses the case derived from it consistently.
564 Note that a lowercase-only string in the buffer will always be completed in
565 lower case (but see the variable `idlwave-completion-force-default-case').
567 After changing this variable, you need to either restart Emacs or press
568 `C-u C-c C-i' to update the internal lists."
575 "*Non-nil means, completion will always honor `idlwave-completion-case'.
576 When nil, only the completion of a mixed case or upper case string
577 will honor the default settings in `idlwave-completion-case', while
578 the completion of lower case strings will be completed entirely in
579 lower case."
584 "*Non-nil means, the empty string is considered downcase for completion.
585 The case of what is already in the buffer determines the case of completions.
586 When this variable is non-nil, the empty string is considered to be downcase.
587 Completing on the empty string then offers downcase versions of the possible
588 completions."
593 "Obsolete variable. See `idlwave-complete-empty-string-as-lower-case' and
597 "*Non-nil means, the case of tokens in buffers dominates over system stuff.
598 To make this possible, we need to re-case everything each time we update
599 the routine info from the buffers. This is slow.
600 The default is to consider the case given in the system and library files
601 first which makes updating much faster."
606 "*Non-nil means, highlight completions for which system help is available.
607 Help can then be accessed with mouse-3.
608 This option is only effective when the online help system is installed."
613 "Non-nil means, treat inheritance with completion, online help etc.
614 When nil, IDLWAVE only knows about the native methods and tags of a class,
615 not about inherited ones."
620 "List of regular expressions for class-driven keyword inheritance.
622 up the class tree. While it cannot be assumed that the presence of an
623 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
624 certain methods this assumption is almost always true. The methods
625 for which to assume this can be set here."
631 "*Number of classes to show when completing object methods and keywords.
632 When completing methods or keywords for an object with unknown class,
633 the *Completions* buffer will show the legal classes for each completion
634 like this:
636 MyMethod <Class1,Class2,Class3>
638 The value of this variable may be nil to inhibit display, or an integer to
639 indicate the maximum number of classes to display.
641 On XEmacs, a full list of classes will also be placed into a `help-echo'
642 property on the competion items, so that the list of classes for the current
643 item is displayed in the echo area. If the value of this variable is a
644 negative integer, the `help-echo' property will be suppressed."
650 "*Non-nil means, fontify the classes in completions buffer.
651 This makes it easier to distinguish the completion items from the extra
652 class info listed. See `idlwave-completion-show-classes'."
658 "Association list governing specification of object classes for completion.
660 When IDLWAVE tries to complete object-oriented methods, it usually
661 cannot determine the class of a given object from context. In order
662 to provide the user with a correct list of methods or keywords, it
663 needs to determine the appropriate class. IDLWAVE has two ways of
664 doing this (well, three ways if you count the shell... see
665 `idlwave-shell-query-for-class'):
667 1. Combine the items of all available classes which contain this
668 method for the purpose of completion. So when completing a method,
669 all methods of all known classes are available, and when completing
670 a keyword, all keywords allowed for this method in any class are
671 shown. This behavior is very much like normal completion and is
672 therefore the default. It works much better than one might think -
673 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
674 become uncomfortably long. See also
675 `idlwave-completion-show-classes'.
677 2. The second possibility is to ask the user on each occasion. To
678 make this less interruptive, IDLWAVE can store the class as a text
679 property on the object operator `->'. For a given object in the
680 source code, class selection will then be needed only once
681 - for example to complete the method. Keywords to the method can
682 then be completed directly, because the class is already known.
683 You will have to turn on the storage of the selected class
684 explicitly with the variable `idlwave-store-inquired-class'.
686 This variable allows you to configure IDLWAVE's method and
687 method-keyword completion behavior. Its value is an alist, which
688 should contain at least two elements: (method-default . VALUE) and
689 \(keyword-default . VALUE), where VALUE is either t or nil. These
690 specify if the class should be found during method and keyword
691 completion, respectively.
693 The alist may have additional entries specifying exceptions from the
694 keyword completion rule for specific methods, like INIT or
695 GETPROPERTY. In order to turn on class specification for the INIT
705 :inline t
710 "*Non-nil means, store class of a method call as text property on `->'.
711 IDLWAVE sometimes has to ask the user for the class associated with a
712 particular object method call. This happens during the commands
713 `idlwave-routine-info' and `idlwave-complete', depending upon the
714 value of the variable `idlwave-query-class'.
716 When you specify a class, this information can be stored as a text
717 property on the `->' arrow in the source code, so that during the same
718 editing session, IDLWAVE will not have to ask again. When this
719 variable is non-nil, IDLWAVE will store and reuse the class information.
721 on the arrow.
723 The default of this variable is nil, since the result of commands then
724 is more predictable. However, if you know what you are doing, it can
725 be nice to turn this on.
727 An arrow which knows the class will be highlighted with
729 displays (with prefix arg: deletes) the class stored on the arrow
730 at point."
735 "*Face to highlight object operator arrows `->' which carry a class property.
736 When IDLWAVE stores a class name as text property on an object arrow
737 \(see variable `idlwave-store-inquired-class', it highlights the arrow
738 with this font in order to remind the user that this arrow is special."
743 "*Non-nil means, resize the Routine-info *Help* window to fit the content."
748 "*Non-nil means, completion automatically adds `=' after completed keywords."
753 "*Non-nil means, completion automatically adds `(' after completed function.
754 nil means, don't add anything.
755 A value of `2' means, also add the closing parenthesis and position cursor
756 between the two."
763 "*Non-nil means, try to restore the window configuration after completion.
764 When completion is not unique, Emacs displays a list of completions.
765 This messes up your window configuration. With this variable set, IDLWAVE
766 restores the old configuration after successful completion."
770 ;;; Variables for abbrev and action behavior -----------------------------
773 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
774 The variables in this group govern this."
778 "*Non-nil means performs actions when indenting.
779 The actions that can be performed are listed in `idlwave-indent-action-table'."
784 "*A single character string used to start abbreviations in abbrev mode.
785 Possible characters to chose from: ~`\%
786 or even '?'. '.' is not a good choice because it can make structure
787 field names act like abbrevs in certain circumstances.
789 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
790 must set it directly using `setq' in the .emacs file before idlwave.el
791 is loaded."
796 "*Non-nil means, enable `idlwave-surround'.
797 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
798 `idlwave-surround'.
799 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
801 Also see the default key bindings for keys using `idlwave-surround'.
802 Keys are bound and made into actions calling `idlwave-surround' with
803 `idlwave-action-and-binding'.
804 See help for `idlwave-action-and-binding' for examples.
806 Also see help for `idlwave-surround'."
811 "*Non-nil means pad '=' for keywords like assignments.
812 Whenever `idlwave-surround' is non-nil then this affects how '=' is padded
813 for keywords. If t, it is padded the same as for assignments.
814 If nil then spaces are removed. With any other value, spaces are left
815 unchanged."
823 "*Non-nil means point blinks to block beginning for `idlwave-show-begin'."
828 "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
833 "*Non-nil means re-indent line after END was typed."
838 "*Non-nil means the abbrev hook can move point.
839 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
840 definitions, use the command `list-abbrevs', for abbrevs that move
841 point. Moving point is useful, for example, to place point between
842 parentheses of expanded functions.
844 See `idlwave-check-abbrev'."
849 "*Non-nil means all abbrevs will be forced to either upper or lower case.
850 If the value t, all expanded abbrevs will be upper case.
851 If the value is 'down then abbrevs will be forced to lower case.
852 If nil, the case will not change.
853 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
854 upper case, regardless of this variable."
859 "*Non-nil means, reserved words will be made upper case via abbrev expansion.
860 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
861 Has effect only if in abbrev-mode."
865 ;;; Action/Expand Tables.
866 ;;
867 ;; The average user may have difficulty modifying this directly. It
868 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
869 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
870 ;; examples of how to add an action.
871 ;;
872 ;; The action table is used by `idlwave-indent-line' whereas both the
873 ;; action and expand tables are used by `idlwave-indent-and-action'. In
874 ;; general, the expand table is only used when a line is explicitly
875 ;; indented. Whereas, in addition to being used when the expand table
876 ;; is used, the action table is used when a line is indirectly
877 ;; indented via line splitting, auto-filling or a new line creation.
878 ;;
879 ;; Example actions:
880 ;;
881 ;; Capitalize system vars
882 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
883 ;;
884 ;; Capitalize procedure name
885 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
886 ;; '(capitalize-word 1) t)
887 ;;
888 ;; Capitalize common block name
889 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
890 ;; '(capitalize-word 1) t)
891 ;; Capitalize label
892 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
893 ;; '(capitalize-word -1) t)
896 "*Associated array containing action lists of search string (car),
897 and function as a cdr. This table is used by `idlwave-indent-line'.
898 See documentation for `idlwave-do-action' for a complete description of
899 the action lists.
901 Additions to the table are made with `idlwave-action-and-binding' when a
902 binding is not requested.
906 "*Associated array containing action lists of search string (car),
907 and function as a cdr. The table is used by the
908 `idlwave-indent-and-action' function. See documentation for
909 `idlwave-do-action' for a complete description of the action lists.
911 Additions to the table are made with `idlwave-action-and-binding' when a
912 binding is requested.
915 ;;; Documentation header and history keyword ---------------------------------
918 "Options for documenting IDLWAVE files."
921 ;; FIXME: make defcustom?
924 ";+
925 ; NAME:
926 ;
927 ;
928 ;
929 ; PURPOSE:
930 ;
931 ;
932 ;
933 ; CATEGORY:
934 ;
935 ;
936 ;
937 ; CALLING SEQUENCE:
938 ;
939 ;
940 ;
941 ; INPUTS:
942 ;
943 ;
944 ;
945 ; OPTIONAL INPUTS:
946 ;
947 ;
948 ;
949 ; KEYWORD PARAMETERS:
950 ;
951 ;
952 ;
953 ; OUTPUTS:
954 ;
955 ;
956 ;
957 ; OPTIONAL OUTPUTS:
958 ;
959 ;
960 ;
961 ; COMMON BLOCKS:
962 ;
963 ;
964 ;
965 ; SIDE EFFECTS:
966 ;
967 ;
968 ;
969 ; RESTRICTIONS:
970 ;
971 ;
972 ;
973 ; PROCEDURE:
974 ;
975 ;
976 ;
977 ; EXAMPLE:
978 ;
979 ;
980 ;
981 ; MODIFICATION HISTORY:
982 ;
983 ;-
985 "*A list (PATHNAME STRING) specifying the doc-header template to use for
986 summarizing a file. If PATHNAME is non-nil then this file will be included.
987 Otherwise STRING is used. If nil, the file summary will be omitted.
988 For example you might set PATHNAME to the path for the
992 "*Non-nil means, the documentation header will always be at start of file.
993 When nil, the header is positioned between the PRO/FUNCTION line of
994 the current routine and the code, allowing several routine headers in
995 a file."
1000 "*The hook function used to update the timestamp of a function."
1005 "*The modifications keyword to use with the log documentation commands.
1006 A ':' is added to the keyword end.
1007 Inserted by doc-header and used to position logs by doc-modification.
1008 If nil it will not be inserted."
1013 "*Regexp matching the start of a document library header."
1018 "*Regexp matching the end of a document library header."
1022 ;;; External Programs -------------------------------------------------------
1025 "Path locations of external commands used by IDLWAVE."
1028 ;; WARNING: The following variable has recently been moved from
1029 ;; idlw-shell.el to this file. I hope this does not break
1030 ;; anything.
1033 "*If non-nil, this is the command to run IDL.
1034 Should be an absolute file path or path relative to the current environment
1035 execution search path. If you want to specify command line switches
1036 for the idl program, use `idlwave-shell-command-line-options'.
1038 I know the name of this variable is badly chosen, but I cannot change
1039 it without compromizing backwards-compatibility."
1044 "*A list of command line options for calling the IDL program.
1045 Since IDL is executed directly without going through a shell like /bin/sh,
1047 string for each argument. But you may also give a single string which
1048 contains the options whitespace-separated. Emacs will be kind enough to
1049 split it for you."
1051 string
1056 "*The external application providing reference help for programming."
1060 ;;; Some Shell variables which must be defined here.-----------------------
1063 "List of modifiers to be used for the debugging commands.
1064 Will be used to bind debugging commands in the shell buffer and in all
1065 source buffers. These are additional convenience bindings, the debugging
1066 commands are always available with the `C-c C-d' prefix.
1067 If you set this to '(control shift), this means setting a breakpoint will
1068 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1069 are `control', `meta', `super', `hyper', `alt', and `shift'."
1080 "*If non-nil attempt invoke idlwave-shell if not already running.
1081 This is checked when an attempt to send a command to an
1082 IDL process is made."
1086 ;;; Miscellaneous variables -------------------------------------------------
1089 "Miscellaneous options for IDLWAVE mode."
1093 "*Non-nil displays a startup message when `idlwave-mode' is first called."
1099 common-blocks class-arrows)
1100 "Items which should be fontified on the default fontification level 2.
1101 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1102 is everything and level 2 is specified by this list.
1103 This variable must be set before IDLWAVE gets loaded. It is
1104 a list of symbols, the following symbols are allowed.
1106 pros-and-functions Procedure and Function definitions
1107 batch-files Batch Files
1108 idlwave-idl-keywords IDL Keywords
1109 label Statement Labels
1110 goto Goto Statements
1111 common-blocks Common Blocks
1112 keyword-parameters Keyword Parameters in routine definitions and calls
1113 system-variables System Variables
1114 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1115 class-arrows Object Arrows with class property"
1133 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1138 "Normal hook. Executed when idlwave.el is loaded."
1143 "Non-nil means turn on a few experimental features.
1144 This variable is only for the maintainer, to test difficult stuff,
1145 while still distributing stable releases.
1148 ;;;
1149 ;;; End customization variables section
1150 ;;;
1152 ;;; Non customization variables
1154 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1155 ;;; Simon Marshall <simon@gnu.ai.mit.edu>
1156 ;;; and Carsten Dominik...
1158 ;; The following are the reserved words in IDL. Maybe we should
1159 ;; highlight some more stuff as well?
1160 ;; Procedure declarations. Fontify keyword plus procedure name.
1162 ;; To update this regexp, update the list of keywords and
1163 ;; evaluate the form.
1164 ;; (insert
1165 ;; (prin1-to-string
1166 ;; (concat
1167 ;; "\\<\\("
1168 ;; (regexp-opt
1169 ;; '("and" "or" "xor" "not"
1170 ;; "eq" "ge" "gt" "le" "lt" "ne"
1171 ;; "for" "do" "endfor"
1172 ;; "if" "then" "endif" "else" "endelse"
1173 ;; "case" "of" "endcase"
1174 ;; "switch" "break" "continue" "endswitch"
1175 ;; "begin" "end"
1176 ;; "repeat" "until" "endrep"
1177 ;; "while" "endwhile"
1178 ;; "goto" "return"
1179 ;; "inherits" "mod"
1180 ;; "compile_opt" "forward_function"
1181 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1182 ;; "\\)\\>")))
1183 "\\<\\(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\\)\\>")
1186 ;; Function declarations. Fontify keyword plus function name.
1192 ;; Common blocks
1198 ;; Start with point after block name and comma
1200 nil
1202 )))
1204 ;; Batch files
1208 ;; FIXME warning.
1212 ;; Labels
1216 ;; The goto statement and its label
1222 ;; Tags in structure definitions. Note that this definition actually
1223 ;; collides with labels, so we have to use the same face.
1227 ;; Structure names
1232 ;; Named parameters, like /xlog or ,xrange=[]
1233 ;; This is anchored to the comma preceeding the keyword.
1234 ;; Treats continuation lines, works only during whole buffer
1235 ;; fontification. Slow, use it only in fancy fontification.
1237 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\\(\n[ \t]*;.*\\)*\n[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1240 ;; System variables start with a bang.
1245 ;; Special and unusual operators (not used because too noisy)
1249 ;; All operators (not used because too noisy)
1253 ;; Arrows with text property `idlwave-class'
1267 batch-files
1268 idlwave-idl-keywords
1269 label goto
1270 structtag
1271 structname
1272 common-blocks
1273 keyword-parameters
1274 system-variables
1275 class-arrows)
1279 ;; Match an object arrow with class property
1289 idlwave-font-lock-keywords-1
1290 idlwave-font-lock-keywords-2
1291 idlwave-font-lock-keywords-3)
1292 nil t
1294 beginning-of-line))
1300 "Regexp to match the start of a full-line comment.
1301 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1306 "Regular expression to find the beginning of a block. The case does
1310 "Regular expression to find the beginning of a unit. The case does
1314 "Regular expression to find the line that indicates the end of unit.
1315 This line is the end of buffer or the start of another unit. The case does
1323 "Regular expression to find the end of a block. The case does
1336 "Matches between statements and the corresponding END variant.
1337 The cars are the reserved words starting a block. If the block really
1338 begins with BEGIN, the cars are the reserved words before the begin
1339 which can be used to identify the block type.
1340 This is used to check for the correct END type, to close blocks and
1345 "Regular expression matching reserved words which can stand before
1346 blocks starting with a BEGIN statement. The matches must have associations
1363 ;; "endif else" is the only possible "end" that can be
1364 ;; followed by a statement on the same line.
1366 ;; all other "end"s can not be followed by a statement.
1380 "Associated list of statement matching regular expressions.
1381 Each regular expression matches the start of an IDL statement. The
1382 first element of each association is a symbol giving the statement
1383 type. The associated value is a list. The first element of this list
1384 is a regular expression matching the start of an IDL statement for
1385 identifying the statement type. The second element of this list is a
1386 regular expression for finding a substatement for the type. The
1387 substatement starts after the end of the found match modulo
1388 whitespace. If it is nil then the statement has no substatement. The
1389 list order matters since matching an assignment statement exactly is
1390 not possible without parsing. Thus assignment statement become just
1399 ;; Note that this is documented in the v18 manuals as being a string
1400 ;; of length one rather than a single character.
1401 ;; The code in this file accepts either format for compatibility.
1403 "Character to be inserted for IDL comment indentation.
1407 "Character which is inserted as a last character on previous line by
1413 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1417 ;; If I take the time I can replace idlwave-keyword-abbrev with
1418 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1419 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1420 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1421 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1424 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1425 Specifically, if the abbrev is in a comment or string it is unexpanded.
1426 Otherwise ARGS forms a list that is evaluated."
1471 "Execute BODY with a different syntax table."
1479 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1480 ; "Execute BODY with a different syntax table."
1481 ; `(let ((saved-syntax (syntax-table)))
1482 ; (unwind-protect
1483 ; (progn
1484 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1485 ; ,@body)
1486 ; (set-syntax-table saved-syntax))))
1489 "KEY and CMD are made into a key binding and an indent action.
1490 KEY is a string - same as for the `define-key' function. CMD is a
1491 function of no arguments or a list to be evaluated. CMD is bound to
1492 KEY in `idlwave-mode-map' by defining an anonymous function calling
1493 `self-insert-command' followed by CMD. If KEY contains more than one
1494 character a binding will only be set if SELECT is 'both.
1496 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1497 replacing any previous value for KEY. If a binding is not set then it
1498 will instead be placed in `idlwave-indent-action-table'.
1500 If the optional argument SELECT is nil then an action and binding are
1501 created. If SELECT is 'noaction, then a binding is always set and no
1502 action is created. If SELECT is 'both then an action and binding
1503 will both be created even if KEY contains more than one character.
1504 Otherwise, if SELECT is non-nil then only an action is created.
1506 Some examples:
1507 No spaces before and 1 after a comma
1509 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1511 Capitalize system variables - action only
1512 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1514 ;; Add action
1519 ;; Replace action command
1521 ;; New action
1523 ;; Make key binding for action
1532 cmd
1539 ;(define-key idlwave-mode-map "\C-c\C- " 'idlwave-hard-tab)
1558 ;; (define-key idlwave-mode-map "\r" 'idlwave-newline)
1559 ;; (define-key idlwave-mode-map "\t" 'idlwave-indent-line)
1573 ;; Bind the debug commands also with the special modifiers.
1584 ;; (define-key idlwave-mode-map "\C-c\C-f" 'idlwave-function)
1585 ;; (define-key idlwave-mode-map "\C-c\C-p" 'idlwave-procedure)
1612 ;; Set action and key bindings.
1613 ;; See description of the function `idlwave-action-and-binding'.
1614 ;; Automatically add spaces for the following characters
1617 ;; Binding works for both > and ->, by changing the length of the token.
1622 ;; Automatically add spaces to equal sign if not keyword
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 ;;
1725 ;; This section is reserved words only. (From IDL user manual)
1726 ;;
1772 ;; defined later - so just make the compiler hush
1776 ;;;###autoload
1778 "Major mode for editing IDL and WAVE CL .pro files.
1780 The main features of this mode are
1782 1. Indentation and Formatting
1783 --------------------------
1784 Like other Emacs programming modes, C-j inserts a newline and indents.
1785 TAB is used for explicit indentation of the current line.
1788 function can also be used in the middle of a line to split the line
1789 at that point. When used inside a long constant string, the string
1790 is split at that point with the `+' concatenation operator.
1792 Comments are indented as follows:
1794 `;;;' Indentation remains unchanged.
1795 `;;' Indent like the surrounding code
1796 `;' Indent to a minimum column.
1798 The indentation of comments starting in column 0 is never changed.
1801 comment. The indentation of the second line of the paragraph
1802 relative to the first will be retained. Use
1804 comments. When the variable `idlwave-fill-comment-line-only' is
1805 nil, code can also be auto-filled and auto-indented (not
1806 recommended).
1808 To convert pre-existing IDL code to your formatting style, mark the
1813 2. Routine Info
1814 ------------
1815 IDLWAVE displays information about the calling sequence and the
1816 accepted keyword parameters of a procedure or function with
1818 source file of a module. These commands know about system
1819 routines, all routines in idlwave-mode buffers and (when the
1820 idlwave-shell is active) about all modules currently compiled under
1822 information, which is also used for completion (see item 4).
1824 3. Online IDL Help
1825 ---------------
1827 for the system variable, keyword, or routine at point. A single key
1828 stroke gets you directly to the right place in the docs. Two additional
1829 files (an ASCII version of the IDL documentation and a topics file) must
1830 be installed for this - check the IDLWAVE webpage for these files.
1832 4. Completion
1833 ----------
1835 class names and keyword parameters. It is context sensitive and
1836 figures out what is expected at point (procedure/function/keyword).
1837 Lower case strings are completed in lower case, other strings in
1838 mixed or upper case.
1840 5. Code Templates and Abbreviations
1841 --------------------------------
1842 Many Abbreviations are predefined to expand to code fragments and templates.
1857 direct keybindings - see the list of keybindings below.
1860 current program unit (pro, function or main). Change log entries
1863 6. Automatic Case Conversion
1864 -------------------------
1865 The case of reserved words and some abbrevs is controlled by
1866 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1868 7. Automatic END completion
1869 ------------------------
1870 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1871 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1873 8. Hooks
1874 -----
1875 Loading idlwave.el runs `idlwave-load-hook'.
1876 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1878 9. Documentation and Customization
1879 -------------------------------
1880 Info documentation for this package is available. Use
1882 not work). For Postscript, PDF, and HTML versions of the
1883 documentation, check IDLWAVE's homepage at `http://idlwave.org'.
1884 IDLWAVE has customize support - see the group `idlwave'.
1886 10.Keybindings
1887 -----------
1888 Here is a list of all keybindings of this mode.
1890 followed by the key sequence to see what the key sequence does.
1935 ;; Set tag table list to use IDLTAGS as file name.
1939 ;; Font-lock additions - originally Phil Williams, then Ulrik Dickow
1940 ;; Following line is for Emacs - XEmacs uses the corresponding porperty
1941 ;; on the `idlwave-mode' symbol.
1944 ;; Imenu setup
1952 ;; Make a local post-command-hook and add our hook to it
1953 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1957 ;; Make local hooks for buffer updates
1958 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1965 ;; Update the routine info with info about current buffer?
1968 ;; Run the mode hook
1971 ;;
1972 ;; Done with start up and initialization code.
1973 ;; The remaining routines are the code formatting functions.
1974 ;;
1977 "Push mark for compatibility with Emacs 18/19."
1983 "Inserts TAB in buffer in current position."
1987 ;;; This stuff is experimental
1990 "If non-nil, a list that can be evaluated using `eval'.
1991 It is evaluated in the lisp function `idlwave-command-hook' which is
1995 "Command run after every command.
1996 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
1997 sets the variable to zero afterwards."
2005 ;;; End experiment
2007 ;; It would be better to use expand.el for better abbrev handling and
2008 ;; versatility.
2011 "Reverses abbrev expansion if in comment or string.
2012 Argument ARG is the number of characters to move point
2013 backward if `idlwave-abbrev-move' is non-nil.
2014 If optional argument RESERVED is non-nil then the expansion
2015 consists of reserved words, which will be capitalized if
2016 `idlwave-reserved-word-upcase' is non-nil.
2017 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2018 is non-nil, unless its value is \`down in which case the abbrev will be
2019 made into all lowercase.
2020 Returns non-nil if abbrev is left expanded."
2023 nil)
2035 t))
2038 "Returns t if point is inside a comment, nil otherwise."
2044 "Move to start of comment delimiter on current line.
2045 Moves to end of line if there is no comment delimiter.
2046 Ignores comment delimiters in strings.
2047 Returns point if comment found and nil otherwise."
2050 found)
2051 ;; Look for first comment delimiter not in a string
2066 "Is transien-mark-mode on and the region active?
2067 Works on both Emacs and XEmacs."
2073 "Insert quote and show matching quote if this is end of a string."
2084 ;; Not the end of a string
2088 "Ensure that the previous word was a token before `idlwave-show-begin'.
2089 An END token must be preceded by whitespace."
2099 "Finds the start of current block and blinks to it for a second.
2100 Also checks if the correct end statement has been used."
2101 ;; All end statements are reserved words
2102 ;; Re-indent end line
2108 begin-pos end-pos end end1 )
2112 idlwave-show-block)
2114 ;; Move inside current block
2127 end-pos))
2135 ;; A generic end
2146 end1 end)
2163 idlwave-block-matches))
2164 ;;((re-search-backward ":[ \t]*\\=" limit t)
2165 ;; ;; seems to be a case thing
2166 ;; '("begin" . "end"))
2168 ;; Just a nromal block
2173 "Terminate the current block with the correct END statement."
2176 ;; Start new line if we are not in a new line
2187 "Let the > symbol expand around -> if present. The new token length
2188 is returned."
2192 "Surround the LENGTH characters before point with blanks.
2193 LENGTH defaults to 1.
2194 Optional arguments BEFORE and AFTER affect the behavior before and
2195 after the characters (see also description of `idlwave-make-space'):
2197 nil do nothing
2198 0 force no spaces
2199 integer > 0 force exactly n spaces
2200 integer < 0 at least |n| spaces
2202 The function does nothing if any of the following conditions is true:
2203 - `idlwave-surround-by-blank' is nil
2204 - the character before point is inside a string or comment
2205 - the char preceeding the string to be surrounded is a member of ESCAPE-CHARS.
2206 This hack is used to avoid padding of `>' when it is part of
2207 the '->' operator. In this case, ESCAPE-CHARS would be '(?-).
2209 If a function is passed in EC-HOOK, and an ESCAPE-CHARS match occurs,
2210 the named function will be called with a single argument of the
2211 preceeding character. Then idlwave-surround will run as usual if
2212 EC-HOOK returns non-nil, and a new length will be taken from the
2213 return value."
2226 ;; avoid clobbering indent
2236 ;; Check to see if the line should auto wrap
2242 "Make space at point.
2243 The space affected is all the spaces and tabs around point.
2244 If n is non-nil then point is left abs(n) spaces from the beginning of
2245 the contiguous space.
2246 The amount of space at point is determined by N.
2247 If the value of N is:
2248 nil - do nothing.
2249 > 0 - exactly N spaces.
2250 < 0 - a minimum of -N spaces, i.e., do not change if there are
2251 already -N spaces.
2252 0 - no spaces (i.e. remove any existing space)."
2266 ;; n = 0, done
2267 ))))
2270 "Inserts a newline and indents the current and previous line."
2272 ;;
2273 ;; Handle unterminated single and double quotes
2274 ;; If not in a comment and in a string then insertion of a newline
2275 ;; will mean unbalanced quotes.
2276 ;;
2281 ;;
2282 ;; The current line is being split, the cursor should be at the
2283 ;; beginning of the new line skipping the leading indentation.
2284 ;;
2285 ;; The reason we insert the new line before indenting is that the
2286 ;; indenting could be confused by keywords (e.g. END) on the line
2287 ;; after the split point. This prevents us from just using
2288 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2289 ;;
2295 ;;
2296 ;; Use global variable 'comment-column' to set parallel comment
2297 ;;
2298 ;; Modeled on lisp.el
2299 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2301 "Compute indent for the beginning of the IDL comment delimiter."
2309 ;; On line by itself, indent as code
2312 ;; after code - do not change
2316 comment-column))))
2319 "Continue line by breaking line at point and indent the lines.
2320 For a code line insert continuation marker. If the line is a line comment
2321 then the new line will contain a comment with the same indentation.
2322 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2323 non-nil."
2325 ;; Expand abbreviation, just like normal RET would.
2329 ;; For code line add continuation.
2330 ;; Check if splitting a string.
2334 ;; Split the string.
2336 idlwave-continuation-char beg)
2340 ;; Do not split the string.
2344 ;; Not splitting a string.
2350 ;; Indent previous line
2355 ;; Reindent new line
2359 "Moves point to the beginning of the current program unit."
2364 "Moves point to the start of the next program unit."
2370 "Mark current IDL statement."
2378 "Mark containing block."
2390 "Put mark at beginning of program, point at end.
2391 The marks are pushed."
2401 "Move to beginning of enclosing block if prefix ARG >= 0.
2402 If prefix ARG < 0 then move forward to enclosing block end."
2407 "Go to the beginning of the current block."
2413 "Go to the beginning of the current block."
2419 "Move across next nested block."
2425 "Move backward across previous nested block."
2431 "Go down a block.
2432 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2433 Returns non-nil if successfull."
2437 ;; Backward
2445 ;; Forward
2453 status))
2456 "Put point at beginning of doc library header, mark at end.
2457 The marks are pushed."
2475 "Return (NAME TYPE CLASS) of current routine."
2479 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2488 "Move to beginning of the current statement.
2489 Skips back past statement continuations.
2490 Point is placed at the beginning of the line whether or not this is an
2491 actual statement."
2503 "Moves point to beginning of the previous statement.
2504 Returns t if the current line before moving is the beginning of
2505 the first non-comment statement in the file, and nil otherwise."
2509 ;; first line in file
2510 t
2511 ;; skip blank lines, label lines, include lines and line comments
2513 ;; The current statement is the first statement until we
2514 ;; reach another statement.
2522 ;; skip continuation lines
2528 first-statement)))
2531 "Moves point to the end of the current IDL statement.
2532 If not in a statement just moves to end of line. Returns position."
2542 "Moves point to the end of the current IDL statement.
2543 If not in a statement just moves to end of line. Returns position."
2551 "Moves point to beginning of the next IDL statement.
2552 Returns t if that statement is the last
2553 non-comment IDL statement in the file, and nil otherwise."
2557 ;; skip blank lines, label lines, include lines and line comments
2559 ;; The current statement is the last statement until
2560 ;; we reach a new statement.
2567 last-statement))
2570 "Skip past multiple commands on a line (with `&')."
2578 "Skip label or case statement element.
2579 Returns position after label.
2580 If there is no label point is not moved and nil is returned."
2581 ;; Case expressions and labels are terminated by a colon.
2582 ;; So we find the first colon in the line and make sure
2583 ;; - no `?' is before it (might be a ? b : c)
2584 ;; - it is not in a comment
2585 ;; - not in a string constant
2586 ;; - not in parenthesis (like a[0:3])
2587 ;; - not followed by another ":" in explicit class, ala a->b::c
2588 ;; As many in this mode, this function is heuristic and not an exact
2589 ;; parser.
2601 nil)))
2604 "Move to start of next IDL substatement after point.
2605 Uses the type of the current IDL statement to determine if the next
2606 statement is on a new line or is a subpart of the current statement.
2607 Returns point at start of substatement modulo whitespace.
2608 If optional argument is non-nil move to beginning of current
2609 substatement."
2613 st nst last)
2618 ;; Continue looking for substatements until we are past orig
2632 ;; If a continuation line starts here, move to next line
2638 "Return the type of the current IDL statement.
2639 Uses `idlwave-statement-match' to return a cons of (type . point) with
2640 point the ending position where the type was determined. Type is the
2641 association from `idlwave-statement-match', i.e. the cons cell from the
2642 list not just the type symbol. Returns nil if not an identifiable
2643 statement."
2645 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2646 ;; and possibly comments
2658 "Pad '=' with spaces.
2659 Two cases: Assignment statement, and keyword assignment.
2660 The case is determined using `idlwave-start-of-substatement' and
2661 `idlwave-statement-type'.
2662 The equal sign will be surrounded by BEFORE and AFTER blanks.
2663 If `idlwave-pad-keyword' is t then keyword assignment is treated just
2664 like assignment statements. When nil, spaces are removed for keyword
2665 assignment. Any other value keeps the current space around the `='.
2666 Limits in for loops are treated as keyword assignment.
2667 See `idlwave-surround'. "
2668 ;; Even though idlwave-surround checks `idlwave-surround-by-blank' this
2669 ;; check saves the time of finding the statement type.
2678 ;; An assignment statement or keywor and we need padding
2681 ;; Spaces should be removed at a keyword
2686 "Call `idlwave-indent-line' and do expand actions.
2687 With prefix ARG non-nil, indent the entire sub-statement."
2695 ;;Expand the END abbreviation, just as RET or Space would have.
2703 "Indents current IDL line as code or as a comment.
2704 The actions in `idlwave-indent-action-table' are performed.
2705 If the optional argument EXPAND is non-nil then the actions in
2706 `idlwave-indent-expand-table' are performed."
2708 ;; Move point out of left margin.
2717 ;; Indentation for a line comment
2721 ;;
2722 ;; Code Line
2723 ;;
2724 ;; Before indenting, run action routines.
2725 ;;
2728 ;;
2731 ;;
2732 ;; No longer expand abbrevs on the line. The user can do this
2733 ;; manually using expand-region-abbrevs.
2734 ;;
2735 ;; Indent for code line
2736 ;;
2739 ;; a label line
2741 ;; a batch command
2743 ;; leave flush left
2744 nil
2745 ;; indent the line
2747 ;; Adjust parallel comment
2750 ;; Emacs 21 is too smart with fill-column on comment indent
2753 fill-column)))
2756 ;; Get rid of marker
2760 "Perform an action repeatedly on a line.
2761 ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is
2762 either a function name to be called with `funcall' or a list to be
2763 evaluated with `eval'. The action performed by FUNC should leave point
2764 after the match for REG - otherwise an infinite loop may be entered."
2774 "Indent from point with spaces until column COL.
2775 Inserts space before markers at point."
2781 "Indent the current line to column COL.
2782 Indents such that first non-whitespace character is at column COL
2783 Inserts spaces before markers at point."
2790 "Indents program unit which contains point."
2802 "Indent current statement, including all continuation lines."
2811 "Return appropriate indentation for current line as IDL code."
2815 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2816 ;; function
2819 ;; Check for continuation line
2824 ;; calculate indent based on previous and current statements
2826 ;; calculate indent based on previous statement
2831 ;; Main block
2834 idlwave-main-block-indent))
2835 ;; Begin block
2838 idlwave-block-indent))
2841 idlwave-end-offset
2842 idlwave-block-indent))
2844 ;; adjust the indentation based on the current statement
2846 ;; End block
2851 ;;
2852 ;; Parentheses balacing/indent
2853 ;;
2856 "Calculate the continuation indent inside a paren group.
2857 Returns a cons-cell with (open . indent), where open is the
2858 location of the open paren"
2860 ;; Found an innermost open paren.
2863 ;; Line up with next word unless this is a closing paren.
2866 ;; This is a closed paren - line up under open paren.
2869 ;; Empty (or just comment) - just line up next to paren
2871 ;; Skip paren
2875 ;; Line up with first word after blank space
2881 "Calculates the IDL continuation indent column from the previous statement.
2882 Note that here previous statement means the beginning of the current
2883 statement if this statement is a continuation of the previous line."
2889 ; (beg-reg (progn (idlwave-previous-statement) (point)))
2900 ;; Try without parens first:
2905 ;; A continued Procedure call or definition
2908 (looking-at "[ \t]*\\([a-zA-Z0-9$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
2910 ;; Comment only, or blank line with "$"? Align with ,
2915 ;; Continued assignment (with =),
2918 ;; Comment only? Align with =
2929 idlwave-max-extra-continuation-indent)))
2931 ;; Look for any enclosing parens
2939 idlwave-max-extra-continuation-indent))))
2940 fancy-enclosing-paren-indent)
2942 ;; else continuations are always standard
2944 cur-indent)
2946 ;; an allowed parenthesis-indent
2948 fancy-paren-indent)
2950 ;; a disallowed paren indent nested inside one or more other
2951 ;; parens: indent relative to the first allowed enclosing paren
2952 ;; set, if any... if it's actually a greater indent, just use
2953 ;; the fancy-paren-indent anyway.
2958 enclose-indent-cons
2959 enclose-indent)
2964 nil)
2968 idlwave-max-extra-continuation-indent)
2973 ;; a disallowed paren indent inside another type: indent relative
2976 fancy-nonparen-indent-allowed )
2979 ;; an allowed nonparen-only indent
2981 fancy-nonparen-indent)
2983 ;; everything else
2985 basic-indent)))))
2988 "Move to next match of the regular expression KEY-RE.
2989 Matches inside comments or string constants will be ignored.
2990 If DIR is negative, the search will be backwards.
2991 At a successful match, the mark is pushed unless NOMARK is non-nil.
2992 Searches are limited to LIMIT.
2993 Searches are case-insensitive and use a special syntax table which
2994 treats `$' and `_' as word characters.
2995 Return value is the beginning of the match or (in case of failure) nil."
2999 found)
3010 found)
3011 nil)))
3014 "When optional argument DIR is non-negative, move forward to end of
3015 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3016 regular expressions. When DIR is negative, move backwards to block beginning.
3017 Recursively calls itself to skip over nested blocks. DIR defaults to
3018 forward. Calls `push-mark' unless the optional argument NOMARK is
3019 non-nil. Movement is limited by the start of program units because of
3020 possibility of unbalanced blocks."
3027 idlwave-begin-block-reg
3028 idlwave-end-block-reg))
3029 found
3031 idlwave-end-block-reg))
3035 idlwave-begin-unit-reg dir t limit)
3038 idlwave-end-unit-reg dir t limit)))
3039 limit)))
3051 "Return indentation of the current statement.
3052 If in a statement, moves to beginning of statement before finding indent."
3057 "Return the column of the indentation of the current line.
3058 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3062 ;; if we are at the end of blank line return 0
3067 "Tests if current line is continuation line.
3068 Blank or comment-only lines following regular continuation lines (with
3069 `$') count as continuations too."
3079 "Tests if the current line is a comment line."
3085 "Tests if the current line is a comment line."
3091 "Searches current line from current point for REGEXP.
3092 If optional argument CONT is non-nil, searches to the end of
3093 the current statement.
3094 If optional arg BEG is non-nil, search starts from the beginning of the
3095 current statement.
3096 Ignores matches that end in a comment or inside a string expression.
3097 Returns point if successful, nil otherwise.
3098 This function produces unexpected results if REGEXP contains quotes or
3099 a comment delimiter. The search is case insensitive.
3100 If successful leaves point after the match, otherwise, does not move point."
3106 found)
3112 found))
3115 "Fills paragraphs in comments.
3116 A paragraph is made up of all contiguous lines having the same comment
3117 leader (the leading whitespace before the comment delimiter and the
3118 comment delimiter). In addition, paragraphs are separated by blank
3119 line comments. The indentation is given by the hanging indent of the
3120 first line, otherwise by the minimum indentation of the lines after
3121 the first line. The indentation of the first line does not change.
3122 Does not effect code lines. Does not fill comments on the same line
3123 with code. The hanging indent is given by the end of the first match
3124 matching `idlwave-hang-indent-regexp' on the paragraph's first line . If the
3125 optional argument NOHANG is non-nil then the hanging indent is
3126 ignored."
3128 ;; check if this is a line comment
3135 pre here diff fill-prefix-reg bcl first-indent
3136 hang start end)
3137 ;; Change tabs to spaces in the surrounding paragraph.
3138 ;; The surrounding paragraph will be the largest containing block of
3139 ;; contiguous line comments. Thus, we may be changing tabs in
3140 ;; a much larger area than is needed, but this is the easiest
3141 ;; brute force way to do it.
3142 ;;
3143 ;; This has the undesirable side effect of replacing the tabs
3144 ;; permanently without the user's request or knowledge.
3152 ;;
3159 t)
3160 ;; Get the comment leader on the line and its length
3162 ;; the comment leader is the indentation plus exactly the
3163 ;; number of consecutive ";".
3173 ;; Mark the beginning and end of the paragraph
3179 ;; Move to first line of paragraph
3193 ;; if at end of buffer add a newline (need this because
3194 ;; fill-region needs END to be at the beginning of line after
3195 ;; the paragraph or it will add a line).
3198 ;; Set END to the beginning of line after the paragraph
3199 ;; END is calculated as distance from end of buffer
3201 ;;
3202 ;; Calculate the indentation for the paragraph.
3203 ;;
3204 ;; In the following while statements, after one iteration
3205 ;; point will be at the beginning of a line in which case
3206 ;; the while will not be executed for the
3207 ;; the first paragraph line and thus will not affect the
3208 ;; indentation.
3209 ;;
3210 ;; First check to see if indentation is based on hanging indent.
3216 ;; Adjust lines of paragraph by inserting spaces so that
3217 ;; each line's indent is at least as great as the hanging
3218 ;; indent. This is needed for fill-paragraph to work with
3219 ;; a fill-prefix.
3226 t)
3230 ;; adjust the original location for the
3231 ;; inserted text.
3235 )
3237 ;; No hang. Instead find minimum indentation of paragraph
3238 ;; after first line.
3239 ;; For the following while statement, since START is at the
3240 ;; beginning of line and END is at the end of line
3241 ;; point is greater than START at least once (which would
3242 ;; be the case for a single line paragraph).
3249 comment-start-skip
3251 t)
3254 )
3257 ?\ )))
3258 ;; first-line indent
3263 comment-start-skip
3265 t)
3267 indent))
3269 ;; try to keep point at its original place
3272 ;; In place of the more modern fill-region-as-paragraph, a hack
3273 ;; to keep whitespace untouched on the first line within the
3274 ;; indent length and to preserve any indent on the first line
3275 ;; (first indent).
3281 start
3284 nil)
3288 ;; When we want the point at the beginning of the comment
3289 ;; body fill-region will put it at the beginning of the line.
3294 "Calculate the position of the hanging indent for the comment
3295 paragraph. The hanging indent position is given by the first match
3296 with the `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3297 non-nil then use last occurrence matching `idlwave-hang-indent-regexp' on
3298 the line.
3299 If not found returns nil."
3304 idlwave-hang-indent-regexp
3306 t)
3311 idlwave-hang-indent-regexp
3313 t)
3317 "Called to break lines in auto fill mode.
3318 Only fills comment lines if `idlwave-fill-comment-line-only' is non-nil.
3319 Places a continuation character at the end of the line
3320 if not in a comment. Splits strings with IDL concatenation operator
3321 `+' if `idlwave-auto-fill-split-string is non-nil."
3323 nil ; do not to fill
3326 ;; Check for comment line
3331 ;; Prevent actions do-auto-fill which calls indent-line-function.
3338 ;; Indent the split line
3340 )
3344 ;; A continued line comment
3345 ;; We treat continued line comments as part of a comment
3346 ;; paragraph. So we check for a hanging indent.
3355 ;; Remove whitespace between comment delimiter and
3356 ;; text, insert spaces for appropriate indentation.
3359 comment-start-skip
3364 )))
3365 ;; Split code or comment?
3369 ;; Splitting a non-line comment.
3370 ;; Insert the comment delimiter from split line
3375 ;; Insert blank to keep off beginning of line
3384 ;; Split code line - add continuation character
3387 ;; Check to see if we split a string
3389 idlwave-auto-fill-split-string)
3390 ;; Split the string and concatenate.
3391 ;; The first extra space is for the space
3392 ;; the line was split. That space was removed.
3397 ;; Make the second part of continued string
3402 ;; Warning
3405 ;; Although do-auto-fill (via indent-new-comment-line) calls
3406 ;; idlwave-indent-line for the new line, re-indent again
3407 ;; because of the addition of the continuation character.
3409 )))))
3412 "Toggle auto-fill mode for IDL mode.
3413 With arg, turn auto-fill mode on if arg is positive.
3414 In auto-fill mode, inserting a space at a column beyond `fill-column'
3415 automatically breaks the line at a previous space."
3421 'idlwave-auto-fill
3422 nil))
3423 ;; update mode-line
3427 "Insert a documentation header at the beginning of the unit.
3428 Inserts the value of the variable idlwave-file-header. Sets mark before
3429 moving to do insertion unless the optional prefix argument NOMARK
3430 is non-nil."
3433 ;; make sure we catch the current line if it begins the unit
3439 ;; skip function or procedure line
3453 "Default timestamp insertion function"
3459 ;; Remove extra spaces from line
3461 ;; Insert a blank line comment to separate from the date entry -
3462 ;; will keep the entry from flowing onto date line if re-filled.
3466 "Insert a brief modification log at the beginning of the current program.
3467 Looks for an occurrence of the value of user variable
3468 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user name
3469 and places the point for the user to add a log. Before moving, saves
3470 location on mark ring so that the user can return to previous point."
3485 end t)
3495 ;;; CJC 3/16/93
3496 ;;; Interface to expand-region-abbrevs which did not work when the
3497 ;;; abbrev hook associated with an abbrev moves point backwards
3498 ;;; after abbrev expansion, e.g., as with the abbrev '.n'.
3499 ;;; The original would enter an infinite loop in attempting to expand
3500 ;;; .n (it would continually expand and unexpand the abbrev without expanding
3501 ;;; because the point would keep going back to the beginning of the
3502 ;;; abbrev instead of to the end of the abbrev). We now keep the
3503 ;;; abbrev hook from moving backwards.
3504 ;;;
3506 "Expand each abbrev occurrence in the region.
3507 Calling from a program, arguments are START END."
3516 "Returns t if point is in a comment or quoted string.
3517 nil otherwise."
3521 "Returns location of the opening quote
3522 if point is in a IDL string constant, nil otherwise.
3523 Ignores comment delimiters on the current line.
3524 Properly handles nested quotation marks and octal
3525 constants - a double quote followed by an octal digit."
3526 ;;; Treat an octal inside an apostrophe to be a normal string. Treat a
3527 ;;; double quote followed by an octal digit to be an octal constant
3528 ;;; rather than a string. Therefore, there is no terminating double
3529 ;;; quote.
3531 ;; Because single and double quotes can quote each other we must
3532 ;; search for the string start from the beginning of line.
3538 delim
3539 found)
3541 ;; Find string start
3542 ;; Don't find an octal constant beginning with a double quote
3544 ;; Find the string end.
3545 ;; In IDL, two consecutive delimiters after the start of a
3546 ;; string act as an
3547 ;; escape for the delimiter in the string.
3548 ;; Two consecutive delimiters alone (i.e., not after the
3549 ;; start of a string) is the null string.
3551 ;; Move to position after quote
3554 ;; Get the string delimiter
3556 ;; Check for null string
3559 ;; Look for next unpaired delimiter
3567 ))
3570 ;; return string beginning position or nil
3574 "Determines if the character after point is a pointer dereference *."
3585 ;; Statement templates
3587 ;; Replace these with a general template function, something like
3588 ;; expand.el (I think there was also something with a name similar to
3589 ;; dmacro.el)
3592 "Build a template with optional prompt expression.
3594 Opens a line if point is not followed by a newline modulo intervening
3595 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3596 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3597 adjusted according to `idlwave-abbrev-change-case'. If optional argument
3598 PROMPT is a string then it is displayed as a message in the
3599 minibuffer. The PROMPT serves as a reminder to the user of an
3600 expression to enter.
3602 The lines containing S1 and S2 are reindented using `indent-region'
3603 unless the optional second argument NOINDENT is non-nil."
3605 ;; This is a gross hack to avoit template abbrev expansion
3606 ;; in the shell. FIXME: This is a dirty hack.
3616 end)
3629 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3632 string))
3635 "Build skeleton IDL if-else block."
3643 "Build skeleton IDL case statement."
3651 "Build skeleton IDL switch statement."
3659 "Build skeleton for loop statment."
3667 "Build skeleton for loop statment."
3703 "Return a list of substrings of STRING which are separated by PATTERN.
3717 end)
3725 ;; Return the buffer currently visiting FILE
3735 "List of buffer pulled up by idlwave for special reasons.
3739 ;; Return a buffer visiting file.
3743 buf)))
3746 "Cleanup by killing buffers created automatically by IDLWAVE.
3747 Function prompts for a letter to identify the buffers to kill.
3748 Possible letters are:
3751 clicks in the routine info window.
3752 s Buffers created by the IDLWAVE Shell to display where execution
3753 stopped or an error was found.
3754 a Both of the above.
3756 Buffer containing unsaved changes require confirmation before they are killed."
3760 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3774 "How many outlawed buffers have tag TAG?"
3778 idlwave-outlawed-buffers))))
3781 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3784 entry)
3798 "Remove BUFFER from the buffers which may be killed.
3799 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3800 Intended for `after-save-hook'."
3803 ;; Revoke license
3807 ;; Remove this function from the hook.
3812 ;; Find FILE on the scanned lib path and return a buffer visiting it
3814 dir efile)
3821 ;; Find FILE on the scanned lib path and return a buffer visiting it
3827 idlwave-path-alist))))
3832 "Creates the IDL tags file IDLTAGS in the current directory from
3833 the list of directories specified in the minibuffer. Directories may be
3834 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
3835 specified top directories are searched if the directory name is prefixed
3836 by @. Specify @ directories with care, it may take a long, long time if
3837 you specify /."
3840 buffer save_buffer files numfiles item errbuf)
3842 ;;
3843 ;; Read list of directories
3846 ;;
3847 ;; Set etags command, vars
3853 ;;
3854 ;; For each directory
3858 ;;
3859 ;; Find the subdirectories
3881 ;;
3882 ;; For each subdirectory
3886 ;;
3887 ;; Call etags
3895 ;;
3896 ;; Append additional tags
3903 )))
3915 ))
3918 "Comment the lines in the region if the first non-blank line is
3919 commented, and conversely, uncomment region. If optional prefix arg
3920 N is non-nil, then for N positive, add N comment delimiters or for N
3921 negative, remove N comment delimiters.
3922 Uses `comment-region' which does not place comment delimiters on
3923 blank lines."
3930 ;; skip blank lines
3940 ;; ----------------------------------------------------------------------------
3941 ;; ----------------------------------------------------------------------------
3942 ;; ----------------------------------------------------------------------------
3943 ;; ----------------------------------------------------------------------------
3944 ;;
3945 ;; Completion and Routine Info
3946 ;;
3948 ;; String "intern" functions
3950 ;; For the completion and routine info function, we want to normalize
3951 ;; the case of procedure names etc. We do this by "interning" these
3952 ;; string is a hand-crafted way. Hashes are used to map the downcase
3953 ;; version of the strings to the cased versions. Since these cased
3954 ;; versions are really lisp objects, we can use `eq' to search, which
3955 ;; is a large performance boost.
3956 ;; All new strings need to be "sinterned". We do this as early as
3957 ;; possible after getting these strings from completion or buffer
3958 ;; substrings. So most of the code can simply assume to deal with
3959 ;; "sinterned" strings. The only exception is that the functions
3960 ;; which scan whole buffers for routine information do not intern the
3961 ;; grabbed strings. This is only done afterwards. Therefore in these
3962 ;; functions it is *not* safe to assume the strings can be compared
3963 ;; with `eq' and be fed into the routine assq functions.
3965 ;; Here we define the hashing functions.
3967 ;; The variables which hold the hashes.
3975 "Reset all sintern hashes."
3976 ;; Make sure the hash functions are accessible.
3988 ;; Make sure these are lists
3995 ;; Reset the system & library hash
4004 ;; Reset the buffer & shell hash
4018 ;;(defmacro idlwave-sintern (type var)
4019 ;; `(cond ((not (stringp name)) name)
4020 ;; ((gethash (downcase name) (cdr ,var)))
4021 ;; ((gethash (downcase name) (car ,var)))
4022 ;; (set (idlwave-sintern-set name ,type ,var set))
4023 ;; (name)))
4060 iname))
4063 "Sintern all strings in the rinfo LIST. With optional parameter SET:
4064 also set new patterns. Probably this will always have to be t."
4078 kwds))
4093 ;; Creating new sintern tables
4096 "Define a variable and a function to sintern the new type TAG.
4097 This defines the function `idlwave-sintern-TAG' and the variable
4098 `idlwave-sint-TAGs'."
4110 name)
4114 "Reset the sintern variable associated with TAG."
4117 ;;---------------------------------------------------------------------------
4120 ;; The variables which hold the information
4147 ;;
4148 ;; The code to get routine info from different sources.
4155 "Provide a list of IDL routines.
4156 This routine loads the builtin routines on the first call. Later it
4157 only returns the value of the variable."
4167 ;; Keep it running...
4168 )
4170 ;; Something is wrong, get rid of the process
4179 ;; return the current value
4180 idlwave-routines)))
4183 "List of functions which should run after a global rinfo update.
4187 "Rescan the previously selected directories. For batch processing."
4191 "Dispatch another emacs instance to update the idlwave catalog.
4192 After the process finishes normally, the first access to routine info
4193 will re-read the catalog."
4217 nil emacs args)))
4220 process
4224 idlwave-system-routines nil
4225 idlwave-catalog-process nil)
4233 "Update the internal routine-info lists.
4236 about individual routines.
4238 The information can come from 4 sources:
4239 1. IDL programs in the current editing session
4240 2. Compiled modules in an IDL shell running as Emacs subprocess
4241 3. A list which covers the IDL system routines.
4242 4. A list which covers the prescanned library files.
4244 Scans all IDLWAVE-mode buffers of the current editing session (see
4245 `idlwave-scan-all-buffers-for-routine-info').
4246 When an IDL shell is running, this command also queries the IDL program
4247 for currently compiled routines.
4249 With prefix ARG, also reload the system and library lists.
4250 With two prefix ARG's, also rescans the library tree.
4251 With three prefix args, dispatch asynchronous process to do the update."
4253 ;; Stop any idle processing
4261 ;; Start a background process which updates the catalog.
4264 ;; Update the catalog now, and wait for it.
4268 idlwave-buffer-case-takes-precedence
4270 ;; The override-idle means, even if the idle timer has done some
4271 ;; preparing work, load and renormalize everything anyway.
4275 idlwave-compiled-routines nil
4276 idlwave-unresolved-routines nil)
4277 ;; Reset the appropriate hashes
4279 ;; reset was already done in idle time, so skip this step now once
4286 ;; We can safely scan the buffer stuff first
4290 ;; We first do the system info, and then the buffers
4294 ;; Let's see if there is a shell
4298 idlwave-query-shell-for-routine-info)))
4302 ;; 1. If we are not going to ask the shell, we need to do the
4303 ;; concatenation now.
4304 ;; 2. When this function is called non-interactively, it means
4305 ;; that someone needs routine info *now*. The shell update
4306 ;; causes the concatenation *delayed*, so not in time for
4307 ;; the current command. Therefore, we do a concatenation
4308 ;; now, even though the shell might do it again.
4312 ;; Ask the shell about the routines it knows.
4334 idlwave-init-rinfo-when-idle-after
4384 ;; restart the timer
4389 idlwave-init-rinfo-when-idle-after
4391 ))))
4394 ;; Load and case-treat the system and lib info files.
4426 ;; Scan all buffers, current buffer last
4431 ;; Don't scan any buffers
4434 ;; Just scan this buffer
4440 ;; Put the result into the correct variable
4445 "Put the different sources for routine information together."
4446 ;; The sequence here is important because earlier definitions shadow
4447 ;; later ones. We assume that if things in the buffers are newer
4448 ;; then in the shell of the system, it is meant to be different.
4452 idlwave-compiled-routines
4453 idlwave-library-routines))
4456 ;; Give a message with information about the number of routines we have.
4459 "Routine info updated: buffer(%d) compiled(%d) catalog(%d) system(%d)"
4468 "Return the class alist - make it if necessary."
4475 idlwave-class-alist)))
4477 ;; Three functions for the hooks
4486 "Undate idlwave-routines for current buffer. Can run from after-save-hook."
4490 idlwave-scan-all-buffers-for-routine-info
4491 idlwave-routines)
4497 nil
4503 routines)
4507 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
4509 found)
4511 ;; The following test uses eq to make sure it works correctly
4512 ;; when two buffers visit the same file. Then the file names
4513 ;; will be equal, but not eq.
4519 ;; End of that section reached. Jump.
4525 ;;----- Scanning buffers -------------------
4528 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
4534 buffer-file-name)
4535 ;; yes, this buffer has the right mode.
4540 ;; Concatenate the individual lists and return the result
4544 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
4546 routine-list string entry)
4560 routine-list))
4564 "Parse a module definition."
4566 start name args type keywords class)
4567 ;; Remove comments
4570 ;; Remove the continuation line stuff
4575 ;; Match the name and type.
4583 ;; Match normal args and keyword args
4586 string start)
4591 ;; Normalize and sort.
4595 ;; Make and return the entry
4596 ;; We don't know which argument are optional, so this information
4597 ;; will not be contained in the calling sequence.
4600 class
4603 ; ((string= (downcase
4604 ; (file-name-sans-extension
4605 ; (file-name-nondirectory (buffer-file-name))))
4606 ; (downcase name))
4607 ; (list 'lib))
4608 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
4614 "%s"
4622 nil))))
4624 ;;----- Scanning the library -------------------
4630 "Return the syslib directory, or a dummy that never matches."
4636 "Scan all files on selected dirs of IDL search path for routine information.
4637 A widget checklist will allow you to choose the directories.
4638 Write the result as a file `idlwave-libinfo-file'. When this file exists,
4639 will be automatically loaded to give routine information about library
4640 routines.
4641 With ARG, just rescan the same directories as last time - so no widget
4642 will pop up."
4644 ;; Make sure the file is loaded if it exists.
4650 ;; Make sure the file name makes sense
4656 idlwave-libinfo-file))))
4662 idlwave-sys-dir)
4663 ;; Rescan the known directories
4665 idlwave-sys-dir
4666 idlwave-path-alist))
4668 ;; Get the directories from that variable
4670 idlwave-system-directory
4673 idlwave-path-alist))))
4675 ;; Ask the shell for the path and run the widget
4683 ;; Command hook used by `idlwave-create-libinfo-file'.
4685 ;; Scan immediately
4687 idlwave-sys-dir
4688 idlwave-path-alist)
4689 ;; Display the widget
4694 sysdir dirs
4696 idlwave-path-alist))))))
4699 "This is the front-end to the creation of IDLWAVE library catalog.
4700 Please select below the directories on IDL's search path from which you
4701 would like to extract routine information, which will be stored in the file
4703 %s
4705 If this is not the correct file, first set variable `idlwave-libinfo-file'.
4706 Then call this command again.
4708 For writing code, you need to include the directories which contain the
4709 routines you use. If IDLWAVE should be able to analyse routine shadowing
4710 it is best to scan all directories.
4712 After selecting the directories, choose [Scan & Save] to scan the library
4713 directories and save the routine info.
4719 "Create the widget to select IDL search path directories for scanning."
4726 ;; Allow only those directories to be selected which are in the path.
4729 selected-dirs)))
4735 idlwave-libinfo-file))
4763 nil))
4771 'checklist
4772 :value selected-dirs
4773 :greedy t
4792 ;; Call `idlwave-scan-lib-files' with data taken from the widget.
4799 path-dirs)))
4804 ;; Scan the files in PATH-ALIST and store the info in a file
4809 dirs-alist dir files file)
4821 ;; Has the flag of scanned directories
4836 idlwave-library-routines)))
4837 ))))))
4838 ;; Sorting is not necessary since we sort each time before a routine
4839 ;; is used. So we don't do it here - the catalog file looks nicer
4840 ;; when it is unsorted.
4841 ;;(message "Sorting...")
4842 ;;(setq idlwave-library-routines
4843 ;;(sort idlwave-library-routines 'idlwave-routine-entry-compare))
4844 ;;(message "Sorting...done")
4852 font-lock-mode)
4858 ;; Define the variable which knows the value of "!DIR"
4860 idlwave-sys-dir))
4862 ;; Define the variable which contains a list of all scanned directories
4866 path-alist)
4869 ;; Define the routine info list
4876 ; (insert (with-output-to-string (prin1 x))))
4877 idlwave-library-routines))
4881 ;; Save the buffer
4887 idlwave-libinfo-file)
4892 ;; Expand parts of path starting with '+' recursively into directory list.
4893 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
4903 ;; Expand recursively
4905 ;; Keep unchanged
4911 ;; Return a list of all directories below DIR, including DIR itself
4920 path1))
4922 ;;----- Asking the shell -------------------
4924 ;; First, here is the idl program which can be used to query IDL for
4925 ;; defined routines.
4927 "
4928 ;; START OF IDLWAVE SUPPORT ROUTINES
4929 pro idlwave_print_info_entry,name,func=func,separator=sep
4930 ;; See if it's an object method
4931 if name eq '' then return
4932 func = keyword_set(func)
4933 methsep = strpos(name,'::')
4934 meth = methsep ne -1
4936 ;; Get routine info
4937 pars = routine_info(name,/parameters,functions=func)
4938 source = routine_info(name,/source,functions=func)
4939 nargs = pars.num_args
4940 nkw = pars.num_kw_args
4941 if nargs gt 0 then args = pars.args
4942 if nkw gt 0 then kwargs = pars.kw_args
4944 ;; Trim the class, and make the name
4945 if meth then begin
4946 class = strmid(name,0,methsep)
4947 name = strmid(name,methsep+2,strlen(name)-1)
4948 if nargs gt 0 then begin
4949 ;; remove the self argument
4950 wh = where(args ne 'SELF',nargs)
4951 if nargs gt 0 then args = args(wh)
4952 endif
4953 endif else begin
4954 ;; No class, just a normal routine.
4956 endelse
4958 ;; Calling sequence
4960 if func then cs = 'Result = '
4961 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
4962 cs = cs + '%s'
4963 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
4964 if nargs gt 0 then begin
4965 for j=0,nargs-1 do begin
4966 cs = cs + args(j)
4967 if j lt nargs-1 then cs = cs + ', '
4968 endfor
4969 end
4970 if func then cs = cs + ')'
4971 ;; Keyword arguments
4972 kwstring = ''
4973 if nkw gt 0 then begin
4974 for j=0,nkw-1 do begin
4975 kwstring = kwstring + ' ' + kwargs(j)
4976 endfor
4977 endif
4979 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])(func)
4981 print,ret + ': ' + name + sep + class + sep + source(0).path $
4982 + sep + cs + sep + kwstring
4983 end
4985 pro idlwave_routine_info
4986 sep = '<@>'
4988 all = routine_info()
4989 for i=0,n_elements(all)-1 do $
4990 idlwave_print_info_entry,all(i),separator=sep
4991 all = routine_info(/functions)
4992 for i=0,n_elements(all)-1 do $
4993 idlwave_print_info_entry,all(i),/func,separator=sep
4994 print,'>>>END OF IDLWAVE ROUTINE INFO'
4995 end
4997 pro idlwave_get_sysvars
4998 forward_function strjoin,strtrim,strsplit
4999 catch,error_status
5000 if error_status ne 0 then begin
5001 print, 'Cannot get info about system variables'
5002 endif else begin
5003 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5004 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5005 v = strsplit(s,' +',/regex,/extract) ; get variables
5006 for i=0,n_elements(v)-1 do begin
5007 t = [''] ; get tag list
5008 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5009 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5010 endfor
5011 endelse
5012 end
5014 pro idlwave_get_class_tags, class
5015 res = execute('tags=tag_names({'+class+'})')
5016 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5017 end
5018 ;; END OF IDLWAVE SUPPORT ROUTINES
5019 "
5028 "Query the shell for routine_info of compiled modules and update the lists."
5029 ;; Save and compile the procedure. The compiled procedure is then
5030 ;; saved into an IDL SAVE file, to allow for fast RESTORE.
5031 ;; We need to RESTORE the procedure each time we use it, since
5032 ;; the user may have killed or redefined it. In particular,
5033 ;; .RESET_SESSION will kill all user procedures.
5045 ; (message "SENDING SAVE") ; ????????????????????????
5051 ;; Restore and execute the procedure, analyze the output
5052 ; (message "SENDING RESTORE & EXECUTE") ; ????????????????????????
5055 idlwave-shell-temp-rinfo-save-file)
5061 ;; ---------------------------------------------------------------------------
5062 ;;
5063 ;; Completion and displaying routine calling sequences
5070 "Complete a function, procedure or keyword name at point.
5071 This function is smart and figures out what can be legally completed
5072 at this point.
5073 - At the beginning of a statement it completes procedure names.
5074 - In the middle of a statement it completes function names.
5075 - after a `(' or `,' in the argument list of a function or procedure,
5076 it completes a keyword of the relevant function or procedure.
5077 - In the first arg of `OBJ_NEW', it completes a class name.
5079 When several completions are possible, a list will be displayed in the
5080 *Completions* buffer. If this list is too long to fit into the
5081 window, scrolling can be achieved by repeatedly pressing
5084 The function also knows about object methods. When it needs a class
5085 name, the action depends upon `idlwave-query-class', which see. You
5086 can force IDLWAVE to ask you for a class name with a
5089 See also the variables `idlwave-keyword-completion-adds-equal' and
5090 `idlwave-function-completion-adds-paren'.
5092 The optional ARG can be used to specify the completion type in order
5093 to override IDLWAVE's idea of what should be completed at point.
5094 Possible values are:
5096 0 <=> query for the completion type
5097 1 <=> 'procedure
5098 2 <=> 'procedure-keyword
5099 3 <=> 'function
5100 4 <=> 'function-keyword
5101 5 <=> 'procedure-method
5102 6 <=> 'procedure-method-keyword
5103 7 <=> 'function-method
5104 8 <=> 'function-method-keyword
5105 9 <=> 'class
5107 As a special case, the universal argument C-u forces completion of
5108 function names in places where the default would be a keyword.
5110 For Lisp programmers only:
5111 When we force a keyword, optional argument MODULE can contain the module name.
5112 When we force a method or a method keyword, CLASS can specify the class."
5136 ;; Check for any special completion functions
5152 ;; Complete a procedure name
5165 isa
5171 isa
5175 ;; Complete a function name
5188 isa
5194 isa
5202 ;; Complete a procedure keyword
5229 isa
5233 ;; Complete a function keyword
5245 msg-name)
5250 ;; OBJ_NEW: Messages mention the proper Init method
5257 msg-name)))
5266 isa
5272 "List of special completion functions.
5273 These functions are called for each completion. Each function must check
5274 if its own special completion context is present. If yes, it should
5275 use `idlwave-complete-in-buffer' to do some completion and return `t'.
5276 If such a function returns `t', *no further* attempts to complete
5277 other contexts will be done. If the function returns `nil', other completions
5282 fun ret)
5287 nil)))
5290 ;; Return an artificial WHERE specification to force the completion
5291 ;; routine to complete a specific item independent of context.
5292 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
5293 ;; MODULE and CLASS can be used to specify the routine name and class.
5294 ;; The class name will also be found in MODULE if that is like "class::mod".
5312 what)
5385 ;; Completing read, case insensitive
5395 "Use the comint stuff to complete a file name."
5403 idlwave-shell-default-directory
5404 default-directory)))
5408 ;; Make a fully qualified module name including the class name
5412 "Like `idlwave-rinfo-assq', but sintern strings first."
5418 ;; Works like assq, but also checks type and class
5430 class rtn)
5434 rtn))
5437 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first."
5440 list))
5441 syslibp)
5447 ;; Its a syslib, so we need to remove the system entry
5452 "Like `idlwave-best-rinfo-assq', but sintern strings first."
5458 "Does the entry list ENTRIES contain a syslib entry?
5459 If yes, return the index (>=1)."
5470 nil)))
5473 "Return a list of all associations of Key in LIST."
5481 "Return all classes which have a method METHOD. TYPE is 'fun or 'pro.
5482 When TYPE is not specified, both procedures and functions will be considered."
5495 "Return all classes which have a method METHOD with keyword KEYWORD.
5496 TYPE is 'fun or 'pro.
5497 When TYPE is not specified, both procedures and functions will be considered."
5500 nil
5512 "Return list of all elements in LIST which are also in CLUB."
5521 "Return list of all elements in LIST which are not in CLUB."
5525 nil
5531 "Return whether or not the class is listed explicitly, ala a->b::c.
5532 INFO is as returned by idlwave-what-function or -procedure."
5539 "List of special functions for determining class.
5543 ;; Determine the class of a routine call.
5544 ;; INFO is the `cw-list' structure as returned by idlwave-where.
5545 ;; The second element in this structure is the class. When nil, we
5546 ;; return nil. When t, try to get the class from text properties at
5547 ;; the arrow. When the object is "self", we use the class of the
5548 ;; current routine. otherwise prompt the user for a class name.
5549 ;; Also stores the selected class as a text property at the arrow.
5550 ;; TYPE is 'fun or 'pro.
5556 idlwave-query-class))
5558 idlwave-query-class))
5570 store special-class class-alist)
5574 ;; There is an object which would like to know its class
5576 idlwave-store-inquired-class
5583 ;; Before prompting, try any special class determination routines
5585 idlwave-determine-class-special
5591 store idlwave-store-inquired-class)))
5593 ;; Prompt for a class, if we need to
5614 ;; Store it, if requested
5616 ;; We have a real class here
5622 rear-nonsticky t))
5625 ;; Return the class
5626 class)
5627 ;; Default as fallback
5639 )))
5642 "Find out where we are.
5643 The return value is a list with the following stuff:
5644 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
5646 PRO-LIST (PRO POINT CLASS ARROW)
5647 FUNC-LIST (FUNC POINT CLASS ARROW)
5648 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
5649 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
5650 be completed here.
5651 LAST-CHAR last relevant character before point (non-white non-comment,
5652 not part of current identifier or leading slash).
5654 In the lists, we have these meanings:
5655 PRO: Procedure name
5656 FUNC: Function name
5657 POINT: Where is this
5658 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
5659 ARROW: Location of the arrow"
5676 cw cw-mod cw-arrow cw-class cw-point)
5686 cw-arrow pro-arrow))
5689 nil)
5701 cw-class func-class cw-arrow func-arrow))
5704 cw-class pro-class cw-arrow pro-arrow))
5705 ; ((member last-char '(?\' ?\) ?\] ?!))
5706 ; ;; after these chars, a function makes no sense
5707 ; ;; FIXME: I am sure there can be more in this list
5708 ; ;; FIXME: Do we want to do this at all?
5709 ; nil)
5710 ;; Everywhere else we try a function.
5718 t))))))
5721 cw
5723 last-char)))
5726 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
5734 ;; Find out if point is within the argument list of a function.
5735 ;; The return value is ("function-name" class arrow-start (point) level).
5736 ;; Level is 1 on the top level parentheses, higher further down.
5738 ;; If the optional BOUND is an integer, bound backwards directed
5739 ;; searches to this point.
5743 func-point
5745 func arrow-start class)
5750 ;; move back out of the current parenthesis
5759 bound t))
5762 pos func-point)
5768 'exit
5772 arrow-start func-point cnt)))
5777 ;; Find out if point is within the argument list of a procedure.
5778 ;; The return value is ("procedure-name" class arrow-pos (point)).
5780 ;; If the optional BOUND is an integer, bound backwards directed
5781 ;; searches to this point.
5783 pro class arrow-start string)
5785 ;;(idlwave-beginning-of-statement)
5795 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\'\\)" string))
5800 pos)
5805 arrow-start
5806 pro-point)))
5809 ;; If there is an object at point, move over it and return t.
5819 nil)
5837 nil)))
5840 "Return the last character before point which is not white or a comment
5841 and also not part of the current identifier. Since we do this in
5842 order to identify places where keywords are, we consider the initial
5843 `/' of a keyword as part of the identifier.
5844 This function is not general, can only be used for completion stuff."
5847 ;; skip the current identifier
5849 ;; also skip a leading slash which might be belong to the keyword
5852 ;; FIXME: does not check if this is a valid identifier
5860 ;; continuation line
5874 "Perform TYPE completion of word before point against LIST.
5875 SELECTOR is the PREDICATE argument for the completion function. Show
5876 PROMPT in echo area. TYPE is one of 'function, 'procedure,
5877 'class-tag, or 'keyword."
5880 dpart dcompletion)
5885 ;; What is already in the buffer?
5890 idlwave-complete-after-success-form
5893 idlwave-complete-after-success-form-force
5897 ;; Try a completion
5905 ;; nothing available.
5909 ;; We can add something
5913 idlwave-complete-empty-string-as-lower-case)
5918 ;; Now this is a unique match
5920 t)
5926 ;; This is already complete
5929 nil)
5931 ;; We cannot add something - offer a list.
5934 ;; "complete" means, this is already a valid completion
5946 idlwave-complete-empty-string-as-lower-case)
5952 x)
5953 list)))
5955 t))))
5958 "Complete a class at point."
5960 ;; Call `idlwave-routines' to make sure the class list will be available
5962 ;; Check for the special case of completing empty string after pro/function
5971 ;; Yank the full class specification
5973 ;; Do the completion
5978 ;; Attach the proper class list to a LIST of completion items.
5979 ;; TYPE, when 'kwd, shows classes for method keywords, when
5980 ;; 'class-tag, for class tags, and otherwise for methods.
5981 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
5987 ;; In these cases, we do not have to do anything
5988 list
5992 ;; (do-dots (featurep 'xemacs))
5998 classes nclasses class-info space)
6001 ;; get the classes
6003 ;; Just one class for tags
6007 ;; Multiple classes for method of method-keyword
6011 method-selector x type-selector)
6017 classes)))))
6019 ;; Make the separator between item and class-info
6024 ;; We do want info in the buffer
6027 space
6032 ;; We do want properties
6036 x))
6039 x))
6040 list))))
6043 ;; Call idlwave-attach-classes with method parameters
6046 ;; Call idlwave-attach-classes with keyword parameters
6049 ;; Call idlwave-attach-classes with class structure tags
6053 ;;----------------------------------------------------------------------
6054 ;;----------------------------------------------------------------------
6055 ;;----------------------------------------------------------------------
6056 ;;----------------------------------------------------------------------
6057 ;;----------------------------------------------------------------------
6063 "Select an item in LIST with a popup menu.
6064 TITLE is the title to put atop the popup. If SORT is non-nil,
6065 sort the list before displaying"
6067 rtn menu resp)
6077 x)))
6078 list)))
6091 rtn))
6094 "Split the MENU into submenus of maximum length N."
6096 ;; No splitting needed
6097 menu
6112 nextmenu))
6114 nextmenu nil
6119 "Split the MENU into submenus of maximum length N."
6121 ;; No splitting needed
6122 menu
6138 nextmenu))
6140 nextmenu nil
6144 menu)))
6149 "Scroll the completion window on this frame."
6167 "Display the completions in LIST in the completions buffer and echo MESSAGE."
6175 list)
6178 ;; Store a special value in `this-command'. When `idlwave-complete'
6179 ;; finds this in `last-command', it will scroll the *Completions* buffer.
6182 ;; Mark the completions buffer as created by cib
6185 ;; Fontify the classes
6190 ;; Run the hook
6193 ;; Display the message
6197 "Call FUNCTION as a completion chooser and pass ARGS to it."
6203 ;; Remove the fontification of the word before point
6218 "Restore the old (before completion) window configuration."
6220 idlwave-before-completion-wconf
6224 "Set the buffer-local value of VAR in BUFFER to VALUE."
6230 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
6236 ;; In XEmacs, we can use :activate-callback directly to advice the
6237 ;; choose functions. We use the private keymap only for the online
6238 ;; help feature.
6247 cl-args))
6257 "Execute `default-choose-completion' and then restore the win-conf."
6261 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
6264 (define-key new-map [button3] (lambda ()
6265 (interactive)
6266 (setq this-command last-command)))
6267 new-map))
6269 ;; In Emacs we also replace keybindings in the completion
6270 ;; map in order to install our wrappers.
6272 (defun idlwave-display-completion-list-emacs (list)
6273 "Display completion list and install the choose wrappers."
6274 (with-output-to-temp-buffer "*Completions*"
6275 (display-completion-list list))
6276 (save-excursion
6277 (set-buffer "*Completions*")
6278 (use-local-map
6279 (or idlwave-completion-map
6280 (setq idlwave-completion-map
6281 (idlwave-make-modified-completion-map-emacs
6282 (current-local-map)))))))
6284 (defun idlwave-make-modified-completion-map-emacs (old-map)
6285 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
6286 (let ((new-map (copy-keymap old-map)))
6287 (substitute-key-definition
6288 'choose-completion 'idlwave-choose-completion new-map)
6289 (substitute-key-definition
6290 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
6291 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
6292 new-map))
6294 (defun idlwave-choose-completion (&rest args)
6295 "Choose the completion that point is in or next to."
6296 (interactive)
6297 (apply 'idlwave-choose 'choose-completion args))
6299 (defun idlwave-mouse-choose-completion (&rest args)
6300 "Click on an alternative in the `*Completions*' buffer to choose it."
6301 (interactive "e")
6302 (apply 'idlwave-choose 'mouse-choose-completion args))
6304 ;;----------------------------------------------------------------------
6305 ;;----------------------------------------------------------------------
6307 ;;; ------------------------------------------------------------------------
6308 ;;; Sturucture parsing code, and code to manage class info
6310 ;;
6311 ;; - Go again over the documentation how to write a completion
6312 ;; plugin. It is in self.el, but currently still very bad.
6313 ;; This could be in a separate file in the distribution, or
6314 ;; in an appendix for the manual.
6316 (defun idlwave-struct-tags ()
6317 "Return a list of all tags in the structure defined at point.
6318 Point is expected just before the opening `{' of the struct definition."
6319 (save-excursion
6320 (let* ((borders (idlwave-struct-borders))
6321 (beg (car borders))
6322 (end (cdr borders))
6323 tags)
6324 (goto-char beg)
6325 (while (re-search-forward "[{,][ \t]*\\(\\$.*\n\\(^[ \t]*\\(\\$[ \t]*\\)?\\(;.*\\)?\n\\)*[ \t]*\\)?\\([a-zA-Z][a-zA-Z0-9_]*\\)[ \t]*:" end t)
6326 ;; Check if we are still on the top level of the structure.
6327 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
6328 (= (point) beg))
6329 (push (match-string 5) tags))
6330 (goto-char (match-end 0)))
6331 (nreverse tags))))
6333 (defun idlwave-find-struct-tag (tag)
6334 "Find a given TAG in the structure defined at point."
6335 (let* ((borders (idlwave-struct-borders))
6336 (beg (car borders))
6337 (end (cdr borders))
6338 (case-fold-search t))
6340 end t)))
6342 (defun idlwave-struct-inherits ()
6343 "Return a list of all `inherits' names in the struct at point.
6344 Point is expected just before the opening `{' of the struct definition."
6345 (save-excursion
6346 (let* ((borders (idlwave-struct-borders))
6347 (beg (car borders))
6348 (end (cdr borders))
6349 (case-fold-search t)
6350 names)
6351 (goto-char beg)
6352 (while (re-search-forward "[{,][ \t]*\\(\\$.*\n[ \t]*\\)?inherits[ \t]*\\(\\$.*\n[ \t]*\\)?\\([a-zA-Z][a-zA-Z0-9_]*\\)" end t)
6353 ;; Check if we are still on the top level of the structure.
6354 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
6355 (= (point) beg))
6356 (push (match-string 3) names))
6357 (goto-char (match-end 0)))
6358 (nreverse names))))
6360 (defun idlwave-in-structure ()
6361 "Return t if point is inside an IDL structure."
6362 (let ((beg (point)))
6363 (save-excursion
6364 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
6365 (if (idlwave-find-structure-definition nil nil 'back)
6366 (let ((borders (idlwave-struct-borders)))
6367 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
6368 (and (> beg (car borders)) (< beg (cdr borders))))))))))
6370 (defun idlwave-struct-borders ()
6371 "Return the borders of the {...} after point as a cons cell."
6372 (let (beg)
6373 (save-excursion
6374 (skip-chars-forward "^{")
6375 (setq beg (point))
6376 (condition-case nil (forward-list 1)
6377 (error (goto-char beg)))
6378 (cons beg (point)))))
6380 (defun idlwave-find-structure-definition (&optional var name bound)
6381 "Search forward for a structure definition.
6382 If VAR is non-nil, search for a structure assigned to variable VAR.
6383 If NAME is non-nil, search for a named structure NAME. If BOUND is an
6384 integer, limit the search. If BOUND is the symbol `all', we search
6385 first back and then forward through the entire file. If BOUND is the
6386 symbol `back' we search only backward."
6388 (case-fold-search t)
6389 (lim (if (integerp bound) bound nil))
6390 (re (concat
6391 (if var
6396 (if (or (and (or (eq bound 'all) (eq bound 'back))
6397 (re-search-backward re nil t))
6398 (and (not (eq bound 'back)) (re-search-forward re lim t)))
6399 (goto-char (match-beginning 3)))))
6401 (defvar idlwave-class-info nil)
6402 (defvar idlwave-system-class-info nil)
6403 (add-hook 'idlwave-update-rinfo-hook
6404 (lambda () (setq idlwave-class-info nil)))
6405 (add-hook 'idlwave-after-load-rinfo-hook
6406 (lambda () (setq idlwave-class-info nil)))
6408 (defun idlwave-class-info (class)
6409 (let (list entry)
6410 (unless idlwave-class-info
6411 ;; Info is nil, put in the system stuff.
6412 (setq idlwave-class-info idlwave-system-class-info)
6413 (setq list idlwave-class-info)
6414 (while (setq entry (pop list))
6415 (idlwave-sintern-class-info entry)))
6416 (setq class (idlwave-sintern-class class))
6417 (setq entry (assq class idlwave-class-info))
6418 (unless entry
6419 (setq entry (idlwave-find-class-info class))
6420 (when entry
6421 ;; Sintern and cache the info
6422 (idlwave-sintern-class-info entry)
6423 (push entry idlwave-class-info)))
6424 entry))
6426 (defun idlwave-sintern-class-info (entry)
6427 "Sintern the class names in a class-info entry."
6428 (let ((taglist (assq 'tags entry))
6429 (inherits (assq 'inherits entry)))
6430 (setcar entry (idlwave-sintern-class (car entry) 'set))
6431 (if inherits
6432 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
6433 (cdr inherits))))))
6435 (defun idlwave-find-class-definition (class)
6436 (let ((case-fold-search t))
6437 (if (re-search-forward
6439 ;; FIXME: should we limit to end of pro here?
6440 (idlwave-find-structure-definition nil class))))
6442 (defun idlwave-find-class-info (class)
6443 "Find the __define procedure for a class structure and return info entry."
6444 (let* ((pro (concat (downcase class) "__define"))
6445 (class (idlwave-sintern-class class))
6446 (idlwave-auto-routine-info-updates nil)
6447 (file (cdr (nth 3 (idlwave-rinfo-assoc pro 'pro nil
6448 (idlwave-routines)))))
6449 buf)
6450 (if (or (not file)
6451 (not (file-regular-p
6452 (setq file (idlwave-expand-lib-file-name file)))))
6453 nil ; Cannot get info
6454 (save-excursion
6455 (if (setq buf (idlwave-get-buffer-visiting file))
6456 (set-buffer buf)
6457 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
6458 (erase-buffer)
6459 (unless (eq major-mode 'idlwave-mode)
6460 (idlwave-mode))
6461 (insert-file-contents file))
6462 (save-excursion
6463 (goto-char 1)
6464 (if (idlwave-find-class-definition class)
6465 (list class
6466 (cons 'tags (idlwave-struct-tags))
6467 (cons 'inherits (idlwave-struct-inherits)))))))))
6469 (defun idlwave-class-tags (class)
6470 "Return the native tags in CLASS."
6471 (cdr (assq 'tags (idlwave-class-info class))))
6472 (defun idlwave-class-inherits (class)
6473 "Return the direct superclasses of CLASS."
6474 (cdr (assq 'inherits (idlwave-class-info class))))
6476 (defun idlwave-all-class-tags (class)
6477 "Return a list of native and inherited tags in CLASS."
6478 (condition-case err
6479 (apply 'append (mapcar 'idlwave-class-tags
6480 (cons class (idlwave-all-class-inherits class))))
6481 (error
6482 (idlwave-class-tag-reset)
6483 (error "%s" (error-message-string err)))))
6486 (defun idlwave-all-class-inherits (class)
6487 "Return a list of all superclasses of CLASS (recursively expanded).
6488 The list is cached in `idlwave-class-info' for faster access."
6489 (cond
6490 ((not idlwave-support-inheritance) nil)
6491 ((eq class nil) nil)
6492 ((eq class t) nil)
6493 (t
6494 (let ((info (idlwave-class-info class))
6495 entry)
6496 (if (setq entry (assq 'all-inherits info))
6497 (cdr entry)
6498 ;; Save the depth of inheritance scan to check for circular references
6499 (let ((inherits (mapcar (lambda (x) (cons x 0))
6500 (idlwave-class-inherits class)))
6501 rtn all-inherits cl)
6502 (while inherits
6503 (setq cl (pop inherits)
6504 rtn (cons (car cl) rtn)
6505 inherits (append (mapcar (lambda (x)
6506 (cons x (1+ (cdr cl))))
6507 (idlwave-class-inherits (car cl)))
6508 inherits))
6509 (if (> (cdr cl) 999)
6510 (error
6511 "Class scan: inheritance depth exceeded. Circular inheritance?")
6512 ))
6513 (setq all-inherits (nreverse rtn))
6514 (nconc info (list (cons 'all-inherits all-inherits)))
6515 all-inherits))))))
6518 ;;==========================================================================
6519 ;;
6520 ;; Completing class structure tags. This is a completion plugin.
6521 ;; The necessary taglist is constructed dynamically
6523 (defvar idlwave-current-tags-class nil)
6524 (defvar idlwave-current-class-tags nil)
6525 (defvar idlwave-current-native-class-tags nil)
6526 (defvar idlwave-sint-class-tags nil)
6527 (idlwave-new-sintern-type 'class-tag)
6528 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
6529 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
6531 (defun idlwave-complete-class-structure-tag ()
6532 "Complete a structure tag on a `self' argument in an object method."
6533 (interactive)
6534 (let ((pos (point))
6535 (case-fold-search t))
6536 (if (save-excursion
6537 ;; Check if the context is right
6538 (skip-chars-backward "[a-zA-Z0-9._$]")
6539 (and (< (point) (- pos 4))
6541 (let* ((class-selector (nth 2 (idlwave-current-routine)))
6542 (super-classes (idlwave-all-class-inherits class-selector)))
6543 ;; Check if we are in a class routine
6544 (unless class-selector
6545 (error "Not in a method procedure or function"))
6546 ;; Check if we need to update the "current" class
6547 (if (not (equal class-selector idlwave-current-tags-class))
6548 (idlwave-prepare-class-tag-completion class-selector))
6549 (setq idlwave-completion-help-info
6550 (list 'idlwave-complete-class-structure-tag-help
6551 (idlwave-sintern-routine
6552 (concat class-selector "__define"))
6553 nil))
6554 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
6555 (idlwave-complete-in-buffer
6556 'class-tag 'class-tag
6557 idlwave-current-class-tags nil
6558 (format "Select a tag of class %s" class-selector)
6559 "class tag"
6560 'idlwave-attach-class-tag-classes))
6561 t) ; return t to skip other completions
6562 nil)))
6564 (defun idlwave-class-tag-reset ()
6565 (setq idlwave-current-tags-class nil))
6567 (defun idlwave-prepare-class-tag-completion (class)
6568 "Find and parse the necessary class definitions for class structure tags."
6569 (setq idlwave-sint-class-tags nil)
6570 (setq idlwave-current-tags-class class)
6571 (setq idlwave-current-class-tags
6572 (mapcar (lambda (x)
6573 (list (idlwave-sintern-class-tag x 'set)))
6574 (idlwave-all-class-tags class)))
6575 (setq idlwave-current-native-class-tags
6576 (mapcar 'downcase (idlwave-class-tags class))))
6578 ;===========================================================================
6579 ;;
6580 ;; Completing system variables and their structure fields
6581 ;; This is also a plugin. It is a bit bigger since we support loading
6582 ;; current system variables from the shell and highlighting in the
6583 ;; completions buffer.
6585 (defvar idlwave-sint-sysvars nil)
6586 (defvar idlwave-sint-sysvartags nil)
6587 (idlwave-new-sintern-type 'sysvar)
6588 (idlwave-new-sintern-type 'sysvartag)
6589 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
6590 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
6591 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-remember-builtin-sysvars)
6592 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
6594 (defvar idlwave-system-variables-alist nil
6595 "Alist of system variables and the associated structure tags.
6596 Gets set in `idlw-rinfo.el'.")
6597 (defvar idlwave-builtin-system-variables nil)
6599 (defun idlwave-complete-sysvar-or-tag ()
6600 "Complete a system variable."
6601 (interactive)
6602 (let ((pos (point))
6603 (case-fold-search t))
6604 (cond ((save-excursion
6605 ;; Check if the context is right for system variable
6606 (skip-chars-backward "[a-zA-Z0-9_$]")
6607 (equal (char-before) ?!))
6608 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
6609 (idlwave-complete-in-buffer 'sysvar 'sysvar
6610 idlwave-system-variables-alist nil
6611 "Select a system variable"
6612 "system variable")
6613 t) ; return t to skip other completions
6614 ((save-excursion
6615 ;; Check if the context is right for sysvar tag
6616 (skip-chars-backward "[a-zA-Z0-9_$.]")
6617 (and (equal (char-before) ?!)
6619 (<= (match-end 0) pos)))
6620 ;; Complete a system variable tag
6621 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
6622 (entry (assq var idlwave-system-variables-alist))
6623 (tags (cdr entry)))
6624 (or entry (error "!%s is not know to be a system variable" var))
6625 (or tags (error "System variable !%s is not a structure" var))
6626 (setq idlwave-completion-help-info
6627 (list 'idlwave-complete-sysvar-help var))
6628 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
6629 tags nil
6630 "Select a system variable tag"
6631 "system variable tag")
6632 t)) ; return t to skip other completions
6633 (t nil))))
6635 ;; Here we fake help using the routine "system variables" with keyword
6636 ;; set to the sysvar. Name and kwd are global variables here.
6637 (defvar name)
6638 (defvar kwd)
6639 (defun idlwave-complete-sysvar-help (mode word)
6640 (cond
6641 ((eq mode 'test)
6642 (or (and (eq nil (nth 1 idlwave-completion-help-info))
6643 (member (downcase word) idlwave-builtin-system-variables))
6644 (and (stringp (nth 1 idlwave-completion-help-info))
6645 (member (downcase (nth 1 idlwave-completion-help-info))
6646 idlwave-builtin-system-variables))))
6647 ((eq mode 'set)
6648 (setq name "system variables"
6649 kwd (concat "!"
6650 (if (stringp (nth 1 idlwave-completion-help-info))
6651 (nth 1 idlwave-completion-help-info)
6652 word))))
6653 (t (error "This should not happen"))))
6655 ;; Fake help in the source buffer for class structure tags.
6656 ;; kwd and name are global-variables here.
6657 (defvar idlwave-help-do-class-struct-tag nil)
6658 (defun idlwave-complete-class-structure-tag-help (mode word)
6659 (cond
6660 ((eq mode 'test) ; nothing gets fontified for class tags
6661 nil)
6662 ((eq mode 'set)
6663 (let (class-with)
6664 (when (setq class-with
6665 (idlwave-class-or-superclass-with-tag
6666 idlwave-current-tags-class
6667 word))
6668 (if (assq (idlwave-sintern-class class-with)
6669 idlwave-system-class-info)
6670 (error "No help available for system class tags."))
6671 (setq name (concat class-with "__define"))))
6672 (setq kwd word
6673 idlwave-help-do-class-struct-tag t))
6674 (t (error "This should not happen"))))
6676 (defun idlwave-class-or-superclass-with-tag (class tag)
6677 "Find and return the CLASS or one of its superclass with the
6678 associated TAG, if any."
6679 (let ((sclasses (cons class (cdr (assq 'all-inherits
6680 (idlwave-class-info class)))))
6681 cl)
6682 (catch 'exit
6683 (while sclasses
6684 (setq cl (pop sclasses))
6685 (let ((tags (idlwave-class-tags cl)))
6686 (while tags
6687 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
6688 (throw 'exit cl))
6689 (setq tags (cdr tags))))))))
6692 (defun idlwave-sysvars-reset ()
6693 (if (and (fboundp 'idlwave-shell-is-running)
6694 (idlwave-shell-is-running))
6695 (idlwave-shell-send-command "idlwave_get_sysvars"
6696 'idlwave-process-sysvars 'hide)))
6698 (defun idlwave-process-sysvars ()
6699 (idlwave-shell-filter-sysvars)
6700 (setq idlwave-sint-sysvars nil
6701 idlwave-sint-sysvartags nil)
6702 (idlwave-sintern-sysvar-alist))
6704 (defun idlwave-remember-builtin-sysvars ()
6705 (setq idlwave-builtin-system-variables
6706 (mapcar 'downcase
6707 (mapcar 'car idlwave-system-variables-alist))))
6709 (defun idlwave-sintern-sysvar-alist ()
6710 (let ((list idlwave-system-variables-alist) entry)
6711 (while (setq entry (pop list))
6712 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
6713 (setcdr entry (mapcar (lambda (x)
6714 (list (idlwave-sintern-sysvartag (car x) 'set)))
6715 (cdr entry))))))
6717 (defvar idlwave-shell-command-output)
6718 (defun idlwave-shell-filter-sysvars ()
6719 "Get the system variables and structure tags."
6720 (let ((text idlwave-shell-command-output)
6721 (start 0)
6722 (old idlwave-system-variables-alist)
6723 var tags type name class)
6724 (setq idlwave-system-variables-alist nil)
6726 text start)
6727 (setq start (match-end 0)
6728 var (match-string 1 text)
6729 tags (if (match-end 3) (idlwave-split-string (match-string 3 text))))
6730 (setq idlwave-system-variables-alist
6731 (cons (cons var (mapcar 'list tags))
6732 idlwave-system-variables-alist)))
6733 ;; Keep the old value if query was not successful
6734 (setq idlwave-system-variables-alist
6735 (or idlwave-system-variables-alist old))))
6737 (defun idlwave-completion-fontify-classes ()
6738 "Goto the *Completions* buffer and fontify the class info."
6739 (when (featurep 'font-lock)
6740 (save-excursion
6741 (set-buffer "*Completions*")
6742 (save-excursion
6743 (goto-char (point-min))
6744 (let ((buffer-read-only nil))
6746 (put-text-property (match-beginning 0) (match-end 0)
6747 'face 'font-lock-string-face)))))))
6749 (defun idlwave-uniquify (list)
6750 (let (nlist)
6751 (loop for x in list do
6752 (add-to-list 'nlist x))
6753 nlist))
6755 (defun idlwave-after-successful-completion (type slash &optional verify)
6756 "Add `=' or `(' after successful completion of keyword and function.
6757 Restore the pre-completion window configuration if possible."
6758 (cond
6759 ((eq type 'procedure)
6760 nil)
6761 ((eq type 'function)
6762 (cond
6763 ((equal idlwave-function-completion-adds-paren nil) nil)
6764 ((or (equal idlwave-function-completion-adds-paren t)
6765 (equal idlwave-function-completion-adds-paren 1))
6766 (insert "("))
6767 ((equal idlwave-function-completion-adds-paren 2)
6768 (insert "()")
6769 (backward-char 1))
6770 (t nil)))
6771 ((eq type 'keyword)
6772 (if (and idlwave-keyword-completion-adds-equal
6773 (not slash))
6774 (progn (insert "=") t)
6775 nil)))
6777 ;; Restore the pre-completion window configuration if this is safe.
6779 (if (or (eq verify 'force) ; force
6780 (and
6781 (get-buffer-window "*Completions*") ; visible
6782 (idlwave-local-value 'idlwave-completion-p
6783 "*Completions*") ; cib-buffer
6784 (eq (marker-buffer idlwave-completion-mark)
6785 (current-buffer)) ; buffer OK
6786 (equal (marker-position idlwave-completion-mark)
6787 verify))) ; pos OK
6788 (idlwave-restore-wconf-after-completion))
6789 (move-marker idlwave-completion-mark nil)
6790 (setq idlwave-before-completion-wconf nil))
6792 (defun idlwave-mouse-context-help (ev &optional arg)
6793 "Call `idlwave-context-help' on the clicked location."
6794 (interactive "eP")
6795 (mouse-set-point ev)
6796 (idlwave-context-help arg))
6798 (defvar idlwave-last-context-help-pos nil)
6799 (defun idlwave-context-help (&optional arg)
6800 "Display IDL Online Help on context.
6801 If point is on a keyword, help for that keyword will be shown. If
6802 point is on a routine name or in the argument list of a routine, help
6803 for that routine will be displayed. Works for system routines and
6804 keywords, it pulls up text help. For other routies and keywords,
6805 visits the source file, finding help in the header (if
6806 `idlwave-help-source-try-header' is non-nil) or the routine definition
6807 itself."
6808 (interactive "P")
6809 (idlwave-require-online-help)
6810 (idlwave-do-context-help arg))
6812 (defun idlwave-mouse-completion-help (ev)
6813 "Display online help about the completion at point."
6814 (interactive "eP")
6815 (idlwave-require-online-help)
6816 ;; Restore last-command for next command, to make scrolling of completions
6817 ;; work.
6818 (setq this-command last-command)
6819 (idlwave-do-mouse-completion-help ev))
6821 (defvar idlwave-help-is-loaded nil
6822 "Is online help avaiable?")
6823 ;; The following variables will be defined by `idlw-help.el'.
6824 (defvar idlwave-help-frame-width nil)
6825 (defvar idlwave-help-file nil)
6826 (defvar idlwave-help-topics nil)
6828 (defun idlwave-help-directory ()
6829 "Return the help directory, or nil if that is not known."
6830 (or (and (stringp idlwave-help-directory)
6831 (> (length idlwave-help-directory) 0)
6832 idlwave-help-directory)
6833 (getenv "IDLWAVE_HELP_DIRECTORY")))
6835 (defun idlwave-require-online-help ()
6836 (if idlwave-help-is-loaded
6837 t ;; everything is OK.
6838 (let* ((dir (or (idlwave-help-directory)
6839 (error "Online Help not installed (help directory unknown) - download at idlwave.org")))
6840 (lfile1 (expand-file-name "idlw-help.elc" dir))
6841 (lfile2 (expand-file-name "idlw-help.el" dir))
6842 (hfile (expand-file-name "idlw-help.txt" dir)))
6843 (if (or (and (file-regular-p lfile1) (load-file lfile1))
6844 (and (file-regular-p lfile2) (load-file lfile2)))
6845 (progn
6846 (if (and idlwave-help-frame-parameters
6847 (not (assoc 'width idlwave-help-frame-parameters)))
6848 (push (cons 'width idlwave-help-frame-width)
6849 idlwave-help-frame-parameters))
6850 (or idlwave-help-topics
6851 (error "File `%s' in help dir `%s' does not define `idlwave-help-topics'"
6852 "idlw-help.el" dir)))
6853 (error "No such file `%s' in help dir `%s'" "idlw-help.el" dir))
6854 (if (file-regular-p hfile)
6855 (setq idlwave-help-is-loaded t
6856 idlwave-help-file hfile)
6857 (error "No such file `%s' in dir `%s'" "idlw-help.txt" dir)))))
6859 (defun idlwave-routine-info (&optional arg external)
6860 "Display a routines calling sequence and list of keywords.
6861 When point is on the name a function or procedure, or in the argument
6862 list of a function or procedure, this command displays a help buffer
6863 with the information. When called with prefix arg, enforce class
6864 query.
6866 When point is on an object operator `->', display the class stored in
6867 this arrow, if any (see `idlwave-store-inquired-class'). With a
6868 prefix arg, the class property is cleared out."
6870 (interactive "P")
6871 (idlwave-routines)
6872 (if (string-match "->" (buffer-substring
6873 (max (point-min) (1- (point)))
6874 (min (+ 2 (point)) (point-max))))
6875 ;; Cursor is on an arrow
6876 (if (get-text-property (point) 'idlwave-class)
6877 ;; arrow has class property
6878 (if arg
6879 ;; Remove property
6880 (save-excursion
6881 (backward-char 1)
6883 (remove-text-properties (match-beginning 1) (match-end 1)
6884 '(idlwave-class nil face nil))
6885 (message "Class property removed from arrow")))
6886 ;; Echo class property
6887 (message "Arrow has text property identifying object to be class %s"
6888 (get-text-property (point) 'idlwave-class)))
6889 ;; No property found
6890 (message "Arrow has no class text property"))
6892 ;; Not on an arrow...
6893 (let* ((idlwave-query-class nil)
6894 (idlwave-force-class-query (equal arg '(4)))
6895 (module (idlwave-what-module)))
6896 (if (car module)
6897 (apply 'idlwave-display-calling-sequence
6898 (idlwave-fix-module-if-obj_new module))
6899 (error "Don't know which calling sequence to show")))))
6901 (defun idlwave-resolve (&optional arg)
6902 "Call RESOLVE on the module name at point.
6903 Like `idlwave-routine-info', this looks for a routine call at point.
6904 After confirmation in the minibuffer, it will use the shell to issue
6905 a RESOLVE call for this routine, to attempt to make it defined and its
6906 routine info available for IDLWAVE. If the routine is a method call,
6907 both `class__method' and `class__define' will be tried.
6908 With ARG, enforce query for the class of object methods."
6909 (interactive "P")
6910 (let* ((idlwave-query-class nil)
6911 (idlwave-force-class-query (equal arg '(4)))
6912 (module (idlwave-what-module))
6913 (name (idlwave-make-full-name (nth 2 module) (car module)))
6914 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
6915 (resolve (read-string "Resolve: " (format "%s %s" type name)))
6916 (kwd "")
6917 class)
6919 resolve)
6920 (setq type (match-string 1 resolve)
6921 class (if (match-beginning 2)
6922 (match-string 3 resolve)
6923 nil)
6924 name (match-string 4 resolve)))
6925 (if (string= (downcase type) "function")
6926 (setq kwd ",/is_function"))
6928 (cond
6929 ((null class)
6930 (idlwave-shell-send-command
6931 (format "resolve_routine,'%s'%s" (downcase name) kwd)
6932 'idlwave-update-routine-info
6933 nil t))
6934 (t
6935 (idlwave-shell-send-command
6936 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
6937 (list 'idlwave-shell-send-command
6938 (format "resolve_routine,'%s__%s'%s"
6939 (downcase class) (downcase name) kwd)
6940 '(idlwave-update-routine-info)
6941 nil t))))))
6943 (defun idlwave-find-module (&optional arg)
6944 "Find the source code of an IDL module.
6945 Works for modules for which IDLWAVE has routine info available.
6946 The function offers as default the module name `idlwave-routine-info' would
6947 use. With ARG force class query for object methods."
6948 (interactive "P")
6949 (let* ((idlwave-query-class nil)
6950 (idlwave-force-class-query (equal arg '(4)))
6951 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
6952 (default (concat (idlwave-make-full-name (nth 2 module) (car module))
6953 (if (eq (nth 1 module) 'pro) "<p>" "<f>")))
6954 (list
6955 (delq nil
6956 (mapcar (lambda (x)
6957 (if (eq 'system (car-safe (nth 3 x)))
6958 ;; Take out system routines with no source.
6959 nil
6960 (cons
6961 (concat (idlwave-make-full-name (nth 2 x) (car x))
6962 (if (eq (nth 1 x) 'pro) "<p>" "<f>"))
6963 (cdr x))))
6964 (idlwave-routines))))
6965 (name (idlwave-completing-read
6966 (format "Module (Default %s): "
6967 (if default default "none"))
6968 list))
6969 type class)
6971 ;; Nothing, use the default.
6972 (setq name default))
6973 (if (string-match "<[fp]>" name)
6974 (setq type (substring name -2 -1)
6975 name (substring name 0 -3)))
6977 (setq class (match-string 1 name)
6978 name (match-string 2 name)))
6979 (setq name (idlwave-sintern-routine-or-method name class)
6980 class (idlwave-sintern-class class)
6981 type (cond ((equal type "f") 'fun)
6982 ((equal type "p") 'pro)
6983 (t t)))
6984 (idlwave-do-find-module name type class)))
6986 (defun idlwave-do-find-module (name type class &optional force-source)
6987 (let ((name1 (idlwave-make-full-name class name))
6988 source buf1 entry
6989 (buf (current-buffer))
6990 (pos (point))
6991 name2)
6992 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines))
6993 source (or force-source (nth 3 entry))
6994 name2 (if (nth 2 entry)
6995 (idlwave-make-full-name (nth 2 entry) name)
6996 name1))
6997 (cond
6998 ((or (null name) (equal name ""))
6999 (error "Abort"))
7000 ((null entry)
7001 (error "Nothing known about a module %s" name2))
7002 ((eq (car source) 'system)
7003 (error "Source code for system routine %s is not available"
7004 name2))
7005 ((equal (cdr source) "")
7006 (error "Source code for routine %s is not available"
7007 name2))
7008 ((memq (car source) '(buffer lib compiled))
7009 (setq buf1
7010 (if (eq (car source) 'lib)
7011 (idlwave-find-file-noselect
7012 (idlwave-expand-lib-file-name
7013 (or (cdr source)
7014 (format "%s.pro" (downcase name)))) 'find)
7015 (idlwave-find-file-noselect (cdr source) 'find)))
7016 (pop-to-buffer buf1 t)
7017 (goto-char (point-max))
7018 (let ((case-fold-search t))
7019 (if (re-search-backward
7021 (cond ((equal type "f") "function")
7022 ((equal type "p") "pro")
7025 (regexp-quote (downcase name2))
7026 "[^a-zA-Z0-9_$]")
7027 nil t)
7028 (goto-char (match-beginning 0))
7029 (pop-to-buffer buf)
7030 (goto-char pos)
7031 (error "Could not find routine %s" name2)))))))
7033 (defun idlwave-what-module ()
7034 "Return a default module for stuff near point.
7035 Used by `idlwave-routine-info' and `idlwave-find-module'."
7036 (idlwave-routines)
7037 (if (let ((case-fold-search t))
7038 (save-excursion
7039 (idlwave-beginning-of-statement)
7040 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
7041 ;; This is a function or procedure definition statement
7042 ;; We return the defined routine as module.
7043 (list
7044 (idlwave-sintern-routine-or-method (match-string 4)
7045 (match-string 2))
7046 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
7047 (idlwave-sintern-class (match-string 3)))
7049 ;; Not a definition statement - analyze precise positon.
7050 (let* ((where (idlwave-where))
7051 (cw (nth 2 where))
7052 (pro (car (nth 0 where)))
7053 (func (car (nth 1 where)))
7054 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
7055 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
7056 (following-char)))
7057 )
7058 (cond
7059 ((and (eq cw 'procedure)
7060 (not (equal this-word "")))
7061 (setq this-word (idlwave-sintern-routine-or-method
7062 this-word (nth 2 (nth 3 where))))
7063 (list this-word 'pro
7064 (idlwave-determine-class
7065 (cons this-word (cdr (nth 3 where)))
7066 'pro)))
7067 ((and (eq cw 'function)
7068 (not (equal this-word ""))
7069 (or (eq next-char ?\() ; exclude arrays, vars.
7071 (setq this-word (idlwave-sintern-routine-or-method
7072 this-word (nth 2 (nth 3 where))))
7073 (list this-word 'fun
7074 (idlwave-determine-class
7075 (cons this-word (cdr (nth 3 where)))
7076 'fun)))
7077 ((and (memq cw '(function-keyword procedure-keyword))
7078 (not (equal this-word ""))
7079 (eq next-char ?\()) ; A function!
7080 (setq this-word (idlwave-sintern-routine this-word))
7081 (list this-word 'fun nil))
7082 (func
7083 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
7084 (pro
7085 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
7086 (t nil)))))
7088 (defun idlwave-what-module-find-class ()
7089 "Call idlwave-what-module and find the inherited class if necessary."
7090 (let* ((module (idlwave-what-module))
7091 (class (nth 2 module))
7092 classes)
7093 (if (and (= (length module) 3)
7094 (stringp class))
7095 (list (car module)
7096 (nth 1 module)
7097 (apply 'idlwave-find-inherited-class module))
7098 module)))
7100 (defun idlwave-find-inherited-class (name type class)
7101 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
7102 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
7103 (if entry
7104 (nth 2 entry)
7105 class)))
7107 (defun idlwave-fix-module-if-obj_new (module)
7108 "Check if MODULE points to obj_new. If yes, and if the cursor is in the
7109 keyword region, change to the appropriate Init method."
7110 (let* ((name (car module))
7111 (pos (point))
7112 (case-fold-search t)
7113 string)
7114 (if (and (stringp name)
7115 (equal (downcase name) "obj_new")
7116 (save-excursion
7117 (idlwave-beginning-of-statement)
7118 (setq string (buffer-substring (point) pos))
7120 string)))
7121 (let ((name "Init")
7122 (class (match-string 1 string)))
7123 (setq module (list (idlwave-sintern-method "Init")
7124 'fun
7125 (idlwave-sintern-class class)))))
7126 module))
7129 (defun idlwave-fix-keywords (name type class keywords)
7130 ;; This fixes the list of keywords.
7131 (let ((case-fold-search t))
7133 ;; If this is the OBJ_NEW function, try to figure out the class and use
7134 ;; the keywords from the corresponding INIT method.
7135 (if (and (equal (upcase name) "OBJ_NEW")
7136 (or (eq major-mode 'idlwave-mode)
7137 (eq major-mode 'idlwave-shell-mode)))
7138 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
7139 (string (buffer-substring bos (point)))
7140 (case-fold-search t)
7141 class)
7143 string)
7144 (setq class (idlwave-sintern-class (match-string 1 string)))
7145 (setq idlwave-current-obj_new-class class)
7146 (setq keywords
7147 (append keywords
7148 (nth 5 (idlwave-rinfo-assq
7149 (idlwave-sintern-method "INIT")
7150 'fun
7151 class
7152 (idlwave-routines))))))))
7154 ;; If the class is `t', combine all keywords of all methods NAME
7155 (when (eq class t)
7156 (loop for x in (idlwave-routines) do
7157 (and (nth 2 x) ; non-nil class
7158 (eq (nth 1 x) type) ; correct type
7159 (eq (car x) name) ; correct name
7160 (mapcar (lambda (k) (add-to-list 'keywords k))
7161 (nth 5 x))))
7162 (setq keywords (idlwave-uniquify keywords)))
7164 ;; If we have inheritance, add all keywords from superclasses, if
7165 ;; the user indicated that method in
7166 ;; `idlwave-keyword-class-inheritance'
7167 (when (and
7168 idlwave-keyword-class-inheritance
7169 (stringp class)
7170 (or (assq (idlwave-sintern-keyword "_extra") keywords)
7171 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
7172 (boundp 'super-classes)
7173 ;; Check if one of the keyword-class regexps matches the name
7174 (let ((regexps idlwave-keyword-class-inheritance) re)
7175 (catch 'exit
7176 (while (setq re (pop regexps))
7177 (if (string-match re name) (throw 'exit t))))))
7178 (loop for x in (idlwave-routines) do
7179 (and (nth 2 x) ; non-nil class
7180 (or (eq (nth 2 x) class) ; the right class
7181 (memq (nth 2 x) super-classes)) ; an inherited class
7182 (eq (nth 1 x) type) ; correct type
7183 (eq (car x) name) ; correct name
7184 (mapcar (lambda (k) (add-to-list 'keywords k))
7185 (nth 5 x))))
7186 (setq keywords (idlwave-uniquify keywords)))
7188 ;; Return the final list
7189 keywords))
7191 (defun idlwave-expand-keyword (keyword module)
7192 "Expand KEYWORD to one of the legal keyword parameters of MODULE.
7193 KEYWORD may be an exact match or an abbreviation of a keyword.
7194 If the match is exact, KEYWORD itself is returned, even if there may be other
7195 keywords of which KEYWORD is an abbreviation. This is necessary because some
7196 system routines have keywords which are prefixes of other keywords.
7197 If KEYWORD is an abbreviation of several keywords, a list of all possible
7198 completions is returned.
7199 If the abbreviation was unique, the correct keyword is returned.
7200 If it cannot be a keyword, the function return nil.
7201 If we do not know about MODULE, just return KEYWORD literally."
7202 (let* ((name (car module))
7203 (type (nth 1 module))
7204 (class (nth 2 module))
7205 (kwd (idlwave-sintern-keyword keyword))
7206 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
7207 (kwd-alist (nth 5 entry))
7208 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
7209 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
7210 (completion-ignore-case t)
7211 candidates)
7212 (cond ((assq kwd kwd-alist)
7213 kwd)
7214 ((setq candidates (all-completions kwd kwd-alist))
7215 (if (= (length candidates) 1)
7216 (car candidates)
7217 candidates))
7218 ((and entry extra)
7219 ;; Inheritance may cause this keyword to be correct
7220 keyword)
7221 (entry
7222 ;; We do know the function, which does not have the keyword.
7223 nil)
7224 (t
7225 ;; We do not know the function, so this just might be a correct
7226 ;; keyword - return it as it is.
7227 keyword))))
7229 (defvar idlwave-rinfo-mouse-map (make-sparse-keymap))
7230 (defvar idlwave-rinfo-map (make-sparse-keymap))
7231 (define-key idlwave-rinfo-mouse-map
7232 (if (featurep 'xemacs) [button2] [mouse-2])
7233 'idlwave-mouse-active-rinfo)
7234 (define-key idlwave-rinfo-mouse-map
7235 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
7236 'idlwave-mouse-active-rinfo-shift)
7237 (define-key idlwave-rinfo-mouse-map
7238 (if (featurep 'xemacs) [button3] [mouse-3])
7239 'idlwave-mouse-active-rinfo-right)
7240 (define-key idlwave-rinfo-mouse-map " " 'idlwave-active-rinfo-space)
7241 (define-key idlwave-rinfo-map "q" 'idlwave-quit-help)
7242 (define-key idlwave-rinfo-mouse-map "q" 'idlwave-quit-help)
7243 (defvar idlwave-popup-source nil)
7244 (defvar idlwave-rinfo-marker (make-marker))
7246 (defun idlwave-quit-help ()
7247 (interactive)
7248 (let ((ri-window (get-buffer-window "*Help*"))
7249 (olh-window (get-buffer-window "*IDLWAVE Help*")))
7250 (when (and olh-window
7251 (fboundp 'idlwave-help-quit))
7252 (select-window olh-window)
7253 (idlwave-help-quit))
7254 (when (window-live-p ri-window)
7255 (delete-window ri-window))))
7257 (defun idlwave-display-calling-sequence (name type class
7258 &optional initial-class)
7259 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
7260 (let* ((initial-class (or initial-class class))
7261 (entry (or (idlwave-best-rinfo-assq name type class
7262 (idlwave-routines))
7263 (idlwave-rinfo-assq name type class
7264 idlwave-unresolved-routines)))
7265 (name (or (car entry) name))
7266 (class (or (nth 2 entry) class))
7267 (superclasses (idlwave-all-class-inherits initial-class))
7268 (twins (idlwave-routine-twins entry))
7269 (dtwins (idlwave-study-twins twins))
7270 (all dtwins)
7271 (system (idlwave-rinfo-assq
7272 name type class idlwave-system-routines))
7273 (have-sysdoc (and system (idlwave-help-directory)))
7274 ;; (source (nth 3 entry))
7275 (have-olh (and (or system idlwave-extra-help-function)
7276 (idlwave-help-directory)))
7277 (calling-seq (nth 4 entry))
7278 (keywords (nth 5 entry))
7279 (olh (nth 6 entry))
7280 (help-echo-kwd
7281 (if have-olh
7282 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') Button3: Online Help "
7283 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD')."))
7284 (help-echo-use
7285 (if have-olh
7286 "Button2/3: Online Help"
7287 nil))
7288 (help-echo-src
7289 (if (idlwave-help-directory)
7290 "Button2: Pop to source and back. Button3: Source in Help window."
7291 "Button2: Pop to source and back."))
7292 (help-echo-class
7293 "Button2: Display info about same method in superclass")
7294 (col 0)
7295 (data (list name type class (current-buffer) olh initial-class))
7296 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
7297 (face 'idlwave-help-link-face)
7298 beg props win cnt total)
7299 (setq keywords (idlwave-fix-keywords name type class keywords))
7300 (cond
7301 ((null entry)
7302 (error "No %s %s known %s" type name
7303 (if initial-class (concat "in class " initial-class) "")))
7304 ((or (null name) (equal name ""))
7305 (error "No function or procedure call at point"))
7306 ((null calling-seq)
7307 (error "Calling sequence of %s %s is not available" type name))
7308 (t
7309 (save-excursion
7310 (move-marker idlwave-rinfo-marker (point))
7311 (set-buffer (get-buffer-create "*Help*"))
7312 (use-local-map idlwave-rinfo-map)
7313 (setq buffer-read-only nil)
7314 (erase-buffer)
7315 (set (make-local-variable 'idlwave-popup-source) nil)
7316 (set (make-local-variable 'idlwave-current-obj_new-class)
7317 idlwave-current-obj_new-class)
7318 (when superclasses
7319 (setq props (list 'mouse-face 'highlight
7320 km-prop idlwave-rinfo-mouse-map
7321 'help-echo help-echo-class
7322 'data (cons 'class data)))
7323 (let ((classes (cons initial-class superclasses)) c)
7324 (insert "Classes: ")
7325 (while (setq c (pop classes))
7326 (insert " ")
7327 (setq beg (point))
7328 (insert c)
7329 (if (equal (downcase c) (downcase class))
7330 (add-text-properties beg (point) (list 'face 'bold))
7331 (if (idlwave-rinfo-assq name type c (idlwave-routines))
7332 (add-text-properties beg (point) props))))
7334 (setq props (if have-olh
7335 (list 'mouse-face 'highlight
7336 km-prop idlwave-rinfo-mouse-map
7337 'help-echo help-echo-use
7338 'data (cons 'usage data))))
7339 (if have-sysdoc (setq props (append (list 'face face) props)))
7340 (insert "Usage: ")
7341 (setq beg (point))
7342 (insert (if class
7343 (format calling-seq class name)
7344 (format calling-seq name))
7346 (add-text-properties beg (point) props)
7348 (insert "Keywords:")
7349 (if (null keywords)
7350 (insert " No keywords accepted.")
7351 (setq col 9)
7352 (mapcar
7353 (lambda (x)
7354 (if (>= (+ col 1 (length (car x)))
7355 (window-width))
7356 (progn
7358 (setq col 9)))
7359 (insert " ")
7360 (setq beg (point)
7361 props (list 'mouse-face 'highlight
7362 km-prop idlwave-rinfo-mouse-map
7363 'data (cons 'keyword data)
7364 'help-echo help-echo-kwd
7365 'keyword (car x)))
7366 (if have-sysdoc (setq props (append (list 'face face) props)))
7367 (insert (car x))
7368 (add-text-properties beg (point) props)
7369 (setq col (+ col 1 (length (car x)))))
7370 keywords))
7372 (setq cnt 1 total (length all))
7373 (while (setq entry (pop all))
7374 (setq props (list 'mouse-face 'highlight
7375 km-prop idlwave-rinfo-mouse-map
7376 'help-echo help-echo-src
7377 'source (cons (car (nth 2 entry)) (nth 1 entry))
7378 'data (cons 'source data)))
7379 (idlwave-insert-source-location
7381 (if (equal cnt 1)
7382 (if (> total 1) "Sources:" "Source:")
7383 "")
7384 (if (> total 1) "- " ""))
7385 entry props)
7386 (incf cnt)
7387 (when (and all (> cnt idlwave-rinfo-max-source-lines))
7388 ;; No more source lines, please
7389 (insert (format
7391 idlwave-rinfo-max-source-lines))
7392 (setq all nil)))
7394 (setq buffer-read-only t))
7395 (display-buffer "*Help*")
7396 (if (and (setq win (get-buffer-window "*Help*"))
7397 idlwave-resize-routine-help-window)
7398 (progn
7399 (let ((ww (selected-window)))
7400 (unwind-protect
7401 (progn
7402 (select-window win)
7403 (enlarge-window (- (/ (frame-height) 2)
7404 (window-height)))
7405 (shrink-window-if-larger-than-buffer))
7406 (select-window ww)))))))))
7408 (defun idlwave-insert-source-location (prefix entry &optional file-props)
7409 "Insert a source location into the routine info buffer.
7410 Start line with PREFIX.
7411 If a file name is inserted, add FILE-PROPS to it."
7413 (let* ((key (car entry))
7414 (file (nth 1 entry))
7415 (types (nth 2 entry))
7416 (shell-flag (member 'compiled types))
7417 (buffer-flag (member 'buffer types))
7418 (lib-flag (member 'lib types))
7419 (ndupl (or (and buffer-flag (idlwave-count-eq 'buffer types))
7420 (and lib-flag (idlwave-count-eq 'lib types))
7421 1))
7422 (doflags t)
7423 beg special)
7425 (insert prefix)
7427 (cond
7428 ((eq key 'system)
7429 (setq doflags nil)
7430 (insert "System "))
7431 ((eq key 'builtin)
7432 (setq doflags nil)
7433 (insert "Builtin "))
7434 ((and (not file) shell-flag)
7435 (insert "Unresolved"))
7436 ((null file) (insert "ERROR"))
7437 ((setq special (idlwave-special-lib-test file))
7438 (insert (format "%-10s" special)))
7439 ((idlwave-syslib-p file)
7440 (if (string-match "obsolete" (file-name-directory file))
7441 (insert "Obsolete ")
7442 (insert "SystemLib ")))
7443 ((idlwave-lib-p file) (insert "Library "))
7444 (t (insert "Other ")))
7446 (when doflags
7447 (insert (concat
7448 " ["
7449 (if lib-flag "C" "-")
7450 (if shell-flag "S" "-")
7451 (if buffer-flag "B" "-")
7452 "] ")))
7453 (when (> ndupl 1)
7454 (setq beg (point))
7455 (insert (format "(%dx) " ndupl))
7456 (add-text-properties beg (point) (list 'face 'bold)))
7457 (when (and file (not (equal file "")))
7458 (setq beg (point))
7459 (insert (apply 'abbreviate-file-name
7460 (if (featurep 'xemacs) (list file t) (list file))))
7461 (if file-props
7462 (add-text-properties beg (point) file-props)))))
7464 (defun idlwave-special-lib-test (file)
7465 "Check the path of FILE against the regexps which define special libs.
7466 Return the name of the special lib if there is a match."
7467 (let ((alist idlwave-special-lib-alist)
7468 entry rtn)
7469 (cond
7470 ((stringp file)
7471 (while (setq entry (pop alist))
7472 (if (string-match (car entry) file)
7473 (setq rtn (cdr entry)
7474 alist nil)))
7475 rtn)
7476 (t nil))))
7478 (defun idlwave-mouse-active-rinfo-right (ev)
7479 (interactive "e")
7480 (idlwave-mouse-active-rinfo ev 'right))
7482 (defun idlwave-mouse-active-rinfo-shift (ev)
7483 (interactive "e")
7484 (idlwave-mouse-active-rinfo ev nil 'shift))
7486 (defun idlwave-active-rinfo-space ()
7487 (interactive)
7488 (idlwave-mouse-active-rinfo nil 'right))
7490 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
7491 "Does the mouse actions in the routine info buffer.
7492 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
7493 was pressed."
7494 (interactive "e")
7495 (if ev (mouse-set-point ev))
7496 (let (data id name type class buf keyword bufwin source word initial-class)
7497 (setq data (get-text-property (point) 'data)
7498 source (get-text-property (point) 'source)
7499 keyword (get-text-property (point) 'keyword)
7500 id (car data)
7501 name (nth 1 data) type (nth 2 data) class (nth 3 data)
7502 buf (nth 4 data)
7503 initial-class (nth 6 data)
7504 word (idlwave-this-word)
7505 bufwin (get-buffer-window buf t))
7506 (cond ((eq id 'class)
7507 (if (window-live-p bufwin) (select-window bufwin))
7508 (idlwave-display-calling-sequence
7509 (idlwave-sintern-method name)
7510 type (idlwave-sintern-class word)
7511 initial-class))
7512 ((eq id 'usage)
7513 (idlwave-require-online-help)
7514 (idlwave-online-help nil name type class))
7515 ((eq id 'source)
7516 (if (and right (idlwave-help-directory))
7517 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
7518 (idlwave-help-source-try-header nil)
7519 ;; Fake idlwave-routines, to make help find the right entry
7520 (idlwave-routines
7521 (list (list (nth 1 data) (nth 2 data) (nth 3 data) source ""))))
7522 (idlwave-require-online-help)
7523 (idlwave-help-get-special-help name type class nil))
7524 (setq idlwave-popup-source (not idlwave-popup-source))
7525 (if idlwave-popup-source
7526 (condition-case err
7527 (idlwave-do-find-module name type class source)
7528 (error
7529 (setq idlwave-popup-source nil)
7530 (if (window-live-p bufwin) (select-window bufwin))
7531 (error (nth 1 err))))
7532 (if bufwin
7533 (select-window bufwin)
7534 (pop-to-buffer buf))
7535 (goto-char (marker-position idlwave-rinfo-marker)))))
7536 ((eq id 'keyword)
7537 (if right
7538 (progn
7539 (idlwave-require-online-help)
7540 (idlwave-online-help nil name type class keyword))
7541 (idlwave-rinfo-insert-keyword keyword buf shift))))))
7543 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
7544 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
7545 (let ((bwin (get-buffer-window buffer)))
7546 (if idlwave-complete-empty-string-as-lower-case
7547 (setq keyword (downcase keyword)))
7548 (if bwin
7549 (select-window bwin)
7550 (pop-to-buffer buffer)
7551 (setq bwin (get-buffer-window buffer)))
7552 (if (eq (preceding-char) ?/)
7553 (insert keyword)
7554 (unless (save-excursion
7555 (re-search-backward
7557 (min (- (point) 100) (point-min)) t))
7558 (insert ", "))
7559 (if shift (insert "/"))
7560 (insert keyword)
7561 (if (and (not shift)
7562 idlwave-keyword-completion-adds-equal)
7563 (insert "=")))))
7565 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
7566 "List the load path shadows of all routines defined in current buffer."
7567 (interactive "P")
7568 (idlwave-routines)
7569 (if (eq major-mode 'idlwave-mode)
7570 (idlwave-list-load-path-shadows
7571 nil (idlwave-update-current-buffer-info 'save-buffer)
7572 "in current buffer")
7573 (error "Current buffer is not in idlwave-mode")))
7575 (defun idlwave-list-shell-load-path-shadows (&optional arg)
7576 "List the load path shadows of all routines compiled under the shell.
7577 This is very useful for checking an IDL application. Just compile the
7578 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
7579 routines and update IDLWAVE internal info. Then check for shadowing
7580 with this command."
7581 (interactive "P")
7582 (cond
7583 ((or (not (fboundp 'idlwave-shell-is-running))
7584 (not (idlwave-shell-is-running)))
7585 (error "Shell is not running"))
7586 ((null idlwave-compiled-routines)
7587 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
7588 (t
7589 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
7590 "in the shell"))))
7592 (defun idlwave-list-all-load-path-shadows (&optional arg)
7593 "List the load path shadows of all routines known to IDLWAVE."
7594 (interactive "P")
7595 (idlwave-list-load-path-shadows nil nil "globally"))
7597 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
7598 "List the routines which are defined multiple times.
7599 Search the information IDLWAVE has about IDL routines for multiple
7600 definitions.
7601 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
7603 When IDL hits a routine call which is not defined, it will search on
7604 the load path in order to find a definition. The output of this
7605 command can be used to detect possible name clashes during this process."
7606 (idlwave-routines) ; Make sure everything is loaded.
7607 (unless idlwave-library-routines
7608 (or (y-or-n-p
7609 "You don't have a library catalog. Continue anyway? ")
7610 (error "Abort")))
7611 (let* ((routines (append idlwave-system-routines
7612 idlwave-compiled-routines
7613 idlwave-library-routines
7614 idlwave-buffer-routines
7615 nil))
7616 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
7617 (keymap (make-sparse-keymap))
7618 (props (list 'mouse-face 'highlight
7619 km-prop keymap
7620 'help-echo "Mouse2: Find source"))
7621 (nroutines (length (or special-routines routines)))
7622 (step (/ nroutines 99))
7623 (n 0)
7624 (next-perc 1)
7625 (cnt 0)
7626 (idlwave-sort-prefer-buffer-info nil)
7627 routine twins dtwins twin done props1 lroutines)
7629 (if special-routines
7630 ;; Just looking for shadows of a few special routines
7631 (setq lroutines routines
7632 routines special-routines))
7634 (message "Sorting routines...")
7635 (setq routines (sort routines
7636 (lambda (a b)
7637 (string< (downcase (idlwave-make-full-name
7638 (nth 2 a) (car a)))
7639 (downcase (idlwave-make-full-name
7640 (nth 2 b) (car b)))))))
7641 (message "Sorting routines...done")
7643 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
7644 (lambda (ev)
7645 (interactive "e")
7646 (mouse-set-point ev)
7647 (apply 'idlwave-do-find-module
7648 (get-text-property (point) 'find-args))))
7649 (define-key keymap [(return)]
7650 (lambda ()
7651 (interactive)
7652 (apply 'idlwave-do-find-module
7653 (get-text-property (point) 'find-args))))
7654 (message "Compiling list...( 0%%)")
7655 (save-excursion
7656 (set-buffer (get-buffer-create "*Shadows*"))
7657 (setq buffer-read-only nil)
7658 (erase-buffer)
7659 (while (setq routine (pop routines))
7660 (setq n (1+ n))
7661 (if (= (* next-perc step) n)
7662 (progn
7663 (message "Compiling list...(%2d%%)" next-perc)
7664 (setq next-perc (1+ next-perc))))
7665 ;; Get a list of all twins
7666 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
7667 (if (memq routine done)
7668 (setq dtwins nil)
7669 (setq dtwins (idlwave-study-twins twins)))
7670 ;; Mark all twins as dealt with
7671 (setq done (append twins done))
7672 (when (or (> (length dtwins) 1)
7673 (> (idlwave-count-eq 'lib (nth 2 (car dtwins))) 1)
7674 (> (idlwave-count-eq 'buffer (nth 2 (car dtwins))) 1))
7675 (incf cnt)
7677 (idlwave-make-full-name (nth 2 routine) (car routine))
7678 (if (eq (nth 1 routine) 'fun) "()" "")))
7679 (while (setq twin (pop dtwins))
7680 (setq props1 (append (list 'find-args
7681 (list (nth 0 routine)
7682 (nth 1 routine)
7683 (nth 2 routine)
7684 (cons 'lib (nth 1 twin))))
7685 props))
7687 (goto-char (point-min))
7688 (setq buffer-read-only t))
7689 (setq loc (or loc ""))
7690 (if (> cnt 0)
7691 (progn
7692 (display-buffer (get-buffer "*Shadows*"))
7693 (message "%d case%s of shadowing found %s"
7694 cnt (if (= cnt 1) "" "s") loc))
7695 (message "No shadowing conflicts found %s" loc))))
7697 (defun idlwave-print-source (routine)
7698 (let* ((source (nth 3 routine))
7699 (stype (car source))
7700 (sfile (cdr source)))
7701 (if (and (eq stype 'lib) sfile)
7702 (progn
7703 (setq sfile (idlwave-expand-lib-file-name sfile))
7704 (if (idlwave-syslib-p sfile) (setq stype 'syslib))))
7705 (if (and (eq stype 'compiled)
7706 (or (not (stringp sfile))
7708 (setq stype 'unresolved))
7710 stype
7711 (if sfile sfile "No source code available")))))
7713 (defun idlwave-routine-twins (entry &optional list)
7714 "Return all twin entries of ENTRY in LIST.
7715 LIST defaults to `idlwave-routines'.
7716 Twin entries are those which have the same name, type, and class.
7717 ENTRY will also be returned, as the first item of this list."
7718 (let* ((name (car entry))
7719 (type (nth 1 entry))
7720 (class (nth 2 entry))
7721 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
7722 twins candidate)
7723 (while (setq candidate (pop candidates))
7724 (if (and (not (eq candidate entry))
7725 (eq type (nth 1 candidate))
7726 (eq class (nth 2 candidate)))
7727 (push candidate twins)))
7728 (if (setq candidate (idlwave-rinfo-assq name type class
7729 idlwave-unresolved-routines))
7730 (push candidate twins))
7731 (cons entry (nreverse twins))))
7733 (defun idlwave-study-twins (entries)
7734 "Return dangerous twins of first entry in TWINS.
7735 Dangerous twins are routines with same name, but in different files
7736 on the load path.
7737 If a file is in the system library and has an entry in the
7738 `idlwave-system-routines' list, we omit the latter because many IDL
7739 routines are implemented as library routines."
7740 (let* ((entry (car entries))
7741 (name (car entry)) ;
7742 (type (nth 1 entry)) ; Must be bound for
7743 (class (nth 2 entry)) ; idlwave-routine-twin-compare
7744 (cnt 0)
7745 source type file thefile alist syslibp key)
7746 (while (setq entry (pop entries))
7747 (incf cnt)
7748 (setq source (nth 3 entry)
7749 type (car source)
7750 file (cdr source))
7751 (if (eq type 'lib)
7752 (setq file (idlwave-expand-lib-file-name file)))
7753 ;; Make KEY to index entry properly
7754 (setq key (cond ((eq type 'system) type)
7755 (file (file-truename file))
7756 (t 'unresolved)))
7757 (if (and file
7758 (not syslibp)
7759 (idlwave-syslib-p file))
7760 ;; We do have an entry in the system library
7761 (setq syslibp t))
7763 (setq thefile (or thefile file))
7764 (if (setq entry (assoc key alist))
7765 (push type (nth 2 entry))
7766 (push (list key file (list type)) alist)))
7768 (setq alist (nreverse alist))
7770 (when syslibp
7771 ;; File is system *library* - remove any system entry
7772 (setq alist (delq (assoc 'system alist) alist)))
7774 (when (and (idlwave-syslib-scanned-p)
7775 (setq entry (assoc 'system alist)))
7776 (setcar entry 'builtin))
7777 (sort alist 'idlwave-routine-twin-compare)))
7779 (defvar name)
7780 (defvar type)
7781 (defvar class)
7782 (defvar idlwave-sort-prefer-buffer-info t
7783 "Internal variable used to influence `idlwave-routine-twin-compare'.")
7785 (defmacro idlwave-xor (a b)
7786 `(and (or ,a ,b)
7787 (not (and ,a ,b))))
7789 (defun idlwave-routine-entry-compare (a b)
7790 "Compare two routine info entries for sortiung. This is the general case.
7791 It first compates class, names, and type. If it turns out that A and B
7792 are twins (same name, class, and type), calls another routine which
7793 compares twins on the basis of their file names and path locations."
7794 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
7795 (cond
7796 ((not (equal (idlwave-downcase-safe class)
7797 (idlwave-downcase-safe (nth 2 b))))
7798 ;; Class decides
7799 (cond ((null (nth 2 b)) nil)
7800 ((null class) t)
7801 (t (string< (downcase class) (downcase (nth 2 b))))))
7802 ((not (equal (downcase name) (downcase (car b))))
7803 ;; Name decides
7804 (string< (downcase name) (downcase (car b))))
7805 ((not (eq type (nth 1 b)))
7806 ;; Type decides
7807 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
7808 (t
7809 ;; A and B are twins - so the decision is more complicated.
7810 ;; Call twin-compare with the proper arguments.
7811 (idlwave-routine-entry-compare-twins a b)))))
7813 (defun idlwave-routine-entry-compare-twins (a b)
7814 "Compare two routine entries, under the assumption that they are twins.
7815 This basically calles `idlwave-routine-twin-compare' with the correct args."
7816 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)) ; needed outside
7817 (atype (car (nth 3 a)))
7818 (btype (car (nth 3 b)))
7819 (afile (cdr (nth 3 a)))
7820 (bfile (cdr (nth 3 b))))
7821 (if (eq atype 'lib)
7822 (setq afile (idlwave-expand-lib-file-name afile)))
7823 (if (eq btype 'lib)
7824 (setq bfile (idlwave-expand-lib-file-name bfile)))
7825 (idlwave-routine-twin-compare
7826 (if (stringp afile)
7827 (list (file-truename afile) afile (list atype))
7828 (list atype afile (list atype)))
7829 (if (stringp bfile)
7830 (list (file-truename bfile) bfile (list btype))
7831 (list btype bfile (list btype))))
7832 ))
7834 (defun idlwave-routine-twin-compare (a b)
7835 "Compare two routine twin entries for sorting.
7836 In here, A and B are not normal routine info entries, but special
7837 lists (KEY FILENAME (TYPES...)).
7838 This expects NAME TYPE CLASS to be bound to the right values."
7839 (let* (;; Dis-assemble entries
7840 (akey (car a)) (bkey (car b))
7841 (afile (nth 1 a)) (bfile (nth 1 b))
7842 (atypes (nth 2 a)) (btypes (nth 2 b))
7843 ;; System routines?
7844 (asysp (memq akey '(builtin system)))
7845 (bsysp (memq bkey '(builtin system)))
7846 ;; Compiled routines?
7847 (acompp (memq 'compiled atypes))
7848 (bcompp (memq 'compiled btypes))
7849 ;; Unresolved?
7850 (aunresp (or (eq akey 'unresolved)
7851 (and acompp (not afile))))
7852 (bunresp (or (eq bkey 'unresolved)
7853 (and bcompp (not bfile))))
7854 ;; Buffer info available?
7855 (abufp (memq 'buffer atypes))
7856 (bbufp (memq 'buffer btypes))
7857 ;; On search path?
7858 (tpath-alist (idlwave-true-path-alist))
7859 (apathp (assoc akey tpath-alist))
7860 (bpathp (assoc bkey tpath-alist))
7861 ;; How early on search path? High number means early since we
7862 ;; measure the tail of the path list
7863 (anpath (length (memq apathp tpath-alist)))
7864 (bnpath (length (memq bpathp tpath-alist)))
7865 ;; Look at file names
7866 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
7867 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
7869 (regexp-quote (downcase class))
7870 (regexp-quote (downcase name)))
7872 ;; Is file name derived from the routine name?
7873 ;; Method file or class definition file?
7874 (anamep (string-match fname-re aname))
7875 (adefp (and class anamep (string= "define" (match-string 1 aname))))
7876 (bnamep (string-match fname-re bname))
7877 (bdefp (and class bnamep (string= "define" (match-string 1 bname)))))
7879 ;; Now: follow JD's ideas about sorting. Looks really simple now,
7880 ;; doesn't it? The difficult stuff is hidden above...
7881 (cond
7882 ((idlwave-xor asysp bsysp) asysp) ; System entries first
7883 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
7884 ((and idlwave-sort-prefer-buffer-info
7885 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
7886 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
7887 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
7888 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
7889 ((and class anamep bnamep ; both file names match ->
7890 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
7891 ((> anpath bnpath) t) ; Who is first on path?
7892 (t nil)))) ; Default
7894 (defun idlwave-downcase-safe (string)
7895 "Donwcase if string, else return unchanged."
7896 (if (stringp string)
7897 (downcase string)
7898 string))
7900 (defun idlwave-count-eq (elt list)
7901 "How often is ELT in LIST?"
7902 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
7904 (defun idlwave-syslib-p (file)
7905 "Non-nil of FILE is in the system library."
7906 (let* ((true-syslib (file-name-as-directory
7907 (file-truename
7908 (expand-file-name "lib" (idlwave-sys-dir)))))
7909 (true-file (file-truename file)))
7910 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
7912 (defun idlwave-lib-p (file)
7913 "Non-nil if file is in the library"
7914 (let ((true-dir (file-name-directory (file-truename file))))
7915 (assoc true-dir (idlwave-true-path-alist))))
7917 (defun idlwave-true-path-alist ()
7918 "Return `idlwave-path-alist' alist with true-names.
7919 Info is cached, but relies on the functons setting `idlwave-path-alist'
7920 to reset the variable `idlwave-true-path-alist' to nil."
7921 (or idlwave-true-path-alist
7922 (setq idlwave-true-path-alist
7923 (mapcar (lambda(x) (cons
7924 (file-name-as-directory
7925 (file-truename
7926 (directory-file-name
7927 (car x))))
7928 (cdr x)))
7929 idlwave-path-alist))))
7931 (defun idlwave-syslib-scanned-p ()
7932 "Non-nil if the system lib file !DIR/lib has been scanned."
7933 (let* ((true-syslib (file-name-as-directory
7934 (file-truename
7935 (expand-file-name "lib" (idlwave-sys-dir))))))
7936 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
7938 ;; ----------------------------------------------------------------------------
7939 ;;
7940 ;; Online Help display
7943 ;; ----------------------------------------------------------------------------
7944 ;;
7945 ;; Additions for use with imenu.el and func-menu.el
7946 ;; (pop-up a list of IDL units in the current file).
7947 ;;
7949 (defun idlwave-prev-index-position ()
7950 "Search for the previous procedure or function.
7951 Return nil if not found. For use with imenu.el."
7952 (save-match-data
7953 (cond
7955 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
7956 (t nil))))
7958 (defun idlwave-unit-name ()
7959 "Return the unit name.
7960 Assumes that point is at the beginning of the unit as found by
7961 `idlwave-prev-index-position'."
7962 (forward-sexp 2)
7963 (forward-sexp -1)
7964 (let ((begin (point)))
7966 (if (fboundp 'buffer-substring-no-properties)
7967 (buffer-substring-no-properties begin (point))
7968 (buffer-substring begin (point)))))
7970 (defalias 'idlwave-function-menu
7971 (condition-case nil
7972 (progn
7973 (require 'func-menu)
7974 'function-menu)
7975 (error (condition-case nil
7976 (progn
7977 (require 'imenu)
7978 'imenu)
7979 (error nil)))))
7981 ;; Here we kack func-menu.el in order to support this new mode.
7982 ;; The latest versions of func-menu.el already have this stuff in, so
7983 ;; we hack only if it is not already there.
7984 (when (fboundp 'eval-after-load)
7985 (eval-after-load "func-menu"
7986 '(progn
7987 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
7988 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
7989 (setq fume-function-name-regexp-alist
7990 (cons '(idlwave-mode . fume-function-name-regexp-idl)
7991 fume-function-name-regexp-alist)))
7992 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
7993 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
7994 (setq fume-find-function-name-method-alist
7995 (cons '(idlwave-mode . fume-find-next-idl-function-name)
7996 fume-find-function-name-method-alist))))))
7998 (defun idlwave-edit-in-idlde ()
7999 "Edit the current file in IDL Development environment."
8000 (interactive)
8001 (start-process "idldeclient" nil
8002 idlwave-shell-explicit-file-name "-c" "-e"
8003 (buffer-file-name) "&"))
8005 (defun idlwave-launch-idlhelp ()
8006 "Start the IDLhelp application."
8007 (interactive)
8008 (start-process "idlhelp" nil idlwave-help-application))
8010 ;; Menus - using easymenu.el
8011 (defvar idlwave-mode-menu-def
8012 `("IDLWAVE"
8013 ["PRO/FUNC menu" idlwave-function-menu t]
8014 ("Motion"
8015 ["Subprogram Start" idlwave-beginning-of-subprogram t]
8016 ["Subprogram End" idlwave-end-of-subprogram t]
8017 ["Block Start" idlwave-beginning-of-block t]
8018 ["Block End" idlwave-end-of-block t]
8019 ["Up Block" idlwave-backward-up-block t]
8020 ["Down Block" idlwave-down-block t]
8021 ["Skip Block Backward" idlwave-backward-block t]
8022 ["Skip Block Forward" idlwave-forward-block t])
8023 ("Mark"
8024 ["Subprogram" idlwave-mark-subprogram t]
8025 ["Block" idlwave-mark-block t]
8026 ["Header" idlwave-mark-doclib t])
8027 ("Format"
8028 ["Indent Subprogram" idlwave-indent-subprogram t]
8029 ["(Un)Comment Region" idlwave-toggle-comment-region "C-c ;"]
8030 ["Continue/Split line" idlwave-split-line t]
8031 "--"
8032 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
8033 :selected (symbol-value idlwave-fill-function)])
8034 ("Templates"
8035 ["Procedure" idlwave-procedure t]
8036 ["Function" idlwave-function t]
8037 ["Doc Header" idlwave-doc-header t]
8038 ["Log" idlwave-doc-modification t]
8039 "--"
8040 ["Case" idlwave-case t]
8041 ["For" idlwave-for t]
8042 ["Repeat" idlwave-repeat t]
8043 ["While" idlwave-while t]
8044 "--"
8045 ["Close Block" idlwave-close-block t])
8046 ("Completion"
8047 ["Complete" idlwave-complete t]
8048 ("Complete Special"
8049 ["1 Procedure Name" (idlwave-complete 'procedure) t]
8050 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
8051 "--"
8052 ["3 Function Name" (idlwave-complete 'function) t]
8053 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
8054 "--"
8055 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
8056 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
8057 "--"
8058 ["7 Function Method Name" (idlwave-complete 'function-method) t]
8059 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
8060 "--"
8061 ["9 Class Name" idlwave-complete-class t]))
8062 ("Routine Info"
8063 ["Show Routine Info" idlwave-routine-info t]
8064 ["Online Context Help" idlwave-context-help (idlwave-help-directory)]
8065 "--"
8066 ["Find Routine Source" idlwave-find-module t]
8067 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
8068 "--"
8069 ["Update Routine Info" idlwave-update-routine-info t]
8070 "--"
8071 "IDL Library Catalog"
8072 ["Select Catalog Directories" (idlwave-create-libinfo-file nil) t]
8073 ["Scan Directories" (idlwave-update-routine-info '(16))
8074 (and idlwave-path-alist (not idlwave-catalog-process))]
8075 ["Scan Directories &" (idlwave-update-routine-info '(64))
8076 (and idlwave-path-alist (not idlwave-catalog-process))]
8077 "--"
8078 "Routine Shadows"
8079 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
8080 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
8081 ["Check Everything" idlwave-list-all-load-path-shadows t])
8082 ("Misc"
8083 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
8084 "--"
8085 ["Insert TAB character" idlwave-hard-tab t])
8086 "--"
8087 ("External"
8088 ["Generate IDL tags" idlwave-make-tags t]
8089 ["Start IDL shell" idlwave-shell t]
8090 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
8091 ["Launch IDL Help" idlwave-launch-idlhelp t])
8092 "--"
8093 ("Customize"
8094 ["Browse IDLWAVE Group" idlwave-customize t]
8095 "--"
8096 ["Build Full Customize Menu" idlwave-create-customize-menu
8097 (fboundp 'customize-menu-create)])
8098 ("Documentation"
8099 ["Describe Mode" describe-mode t]
8100 ["Abbreviation List" idlwave-list-abbrevs t]
8101 "--"
8102 ["Commentary in idlwave.el" idlwave-show-commentary t]
8103 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
8104 "--"
8105 ["Info" idlwave-info t]
8106 "--"
8107 ["Launch IDL Help" idlwave-launch-idlhelp t])))
8109 (defvar idlwave-mode-debug-menu-def
8110 '("Debug"
8111 ["Start IDL shell" idlwave-shell t]
8112 ["Save and .RUN buffer" idlwave-shell-save-and-run
8113 (and (boundp 'idlwave-shell-automatic-start)
8114 idlwave-shell-automatic-start)]))
8116 (if (or (featurep 'easymenu) (load "easymenu" t))
8117 (progn
8118 (easy-menu-define idlwave-mode-menu idlwave-mode-map
8119 "IDL and WAVE CL editing menu"
8120 idlwave-mode-menu-def)
8121 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
8122 "IDL and WAVE CL editing menu"
8123 idlwave-mode-debug-menu-def)))
8125 (defun idlwave-customize ()
8126 "Call the customize function with idlwave as argument."
8127 (interactive)
8128 ;; Try to load the code for the shell, so that we can customize it
8129 ;; as well.
8130 (or (featurep 'idlw-shell)
8131 (load "idlw-shell" t))
8132 (customize-browse 'idlwave))
8134 (defun idlwave-create-customize-menu ()
8135 "Create a full customization menu for IDLWAVE, insert it into the menu."
8136 (interactive)
8137 (if (fboundp 'customize-menu-create)
8138 (progn
8139 ;; Try to load the code for the shell, so that we can customize it
8140 ;; as well.
8141 (or (featurep 'idlw-shell)
8142 (load "idlw-shell" t))
8143 (easy-menu-change
8144 '("IDLWAVE") "Customize"
8145 `(["Browse IDLWAVE group" idlwave-customize t]
8146 "--"
8147 ,(customize-menu-create 'idlwave)
8148 ["Set" Custom-set t]
8149 ["Save" Custom-save t]
8150 ["Reset to Current" Custom-reset-current t]
8151 ["Reset to Saved" Custom-reset-saved t]
8152 ["Reset to Standard Settings" Custom-reset-standard t]))
8154 (error "Cannot expand menu (outdated version of cus-edit.el)")))
8156 (defun idlwave-show-commentary ()
8157 "Use the finder to view the file documentation from `idlwave.el'."
8158 (interactive)
8159 (require 'finder)
8160 (finder-commentary "idlwave.el"))
8162 (defun idlwave-shell-show-commentary ()
8163 "Use the finder to view the file documentation from `idlw-shell.el'."
8164 (interactive)
8165 (require 'finder)
8166 (finder-commentary "idlw-shell.el"))
8168 (defun idlwave-info ()
8169 "Read documentation for IDLWAVE in the info system."
8170 (interactive)
8171 (require 'info)
8172 (Info-goto-node "(idlwave)"))
8174 (defun idlwave-list-abbrevs (arg)
8175 "Show the code abbreviations define in IDLWAVE mode.
8176 This lists all abbrevs where the replacement text differs from the input text.
8177 These are the ones the users want to learn to speed up their writing.
8179 The function does *not* list abbrevs which replace a word with itself
8180 to call a hook. These hooks are used to change the case of words or
8181 to blink the matching `begin', and the user does not need to know them.
8183 With arg, list all abbrevs with the corresponding hook.
8185 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
8187 (interactive "P")
8188 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
8189 abbrevs
8190 str rpl func fmt (len-str 0) (len-rpl 0))
8191 (mapatoms
8192 (lambda (sym)
8193 (if (symbol-value sym)
8194 (progn
8195 (setq str (symbol-name sym)
8196 rpl (symbol-value sym)
8197 func (symbol-function sym))
8198 (if arg
8199 (setq func (prin1-to-string func))
8200 (if (and (listp func) (stringp (nth 2 func)))
8201 (setq rpl (concat "EVAL: " (nth 2 func))
8202 func "")
8203 (setq func "")))
8204 (if (or arg (not (string= rpl str)))
8205 (progn
8206 (setq len-str (max len-str (length str)))
8207 (setq len-rpl (max len-rpl (length rpl)))
8208 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
8209 table)
8210 ;; sort the list
8211 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
8212 ;; Make the format
8214 (with-output-to-temp-buffer "*Help*"
8215 (if arg
8216 (progn
8219 (princ (format fmt "KEY" "REPLACE" "HOOK"))
8220 (princ (format fmt "---" "-------" "----")))
8223 (princ (format fmt "KEY" "ACTION" ""))
8224 (princ (format fmt "---" "------" "")))
8225 (mapcar
8226 (lambda (list)
8227 (setq str (car list)
8228 rpl (nth 1 list)
8229 func (nth 2 list))
8230 (princ (format fmt str rpl func)))
8231 abbrevs)))
8232 ;; Make sure each abbreviation uses only one display line
8233 (save-excursion
8234 (set-buffer "*Help*")
8235 (setq truncate-lines t)))
8237 ;; Add .pro files to speedbar for support, if it's loaded
8238 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
8240 ;; Try to load online help, but catch any errors.
8241 (condition-case nil
8242 (idlwave-require-online-help)
8243 (error nil))
8245 ;; Set an idle timer to load the routine info.
8246 ;; Will only work on systems which support this.
8247 (or idlwave-routines (idlwave-start-load-rinfo-timer))
8249 ;; Run the hook
8250 (run-hooks 'idlwave-load-hook)
8252 (provide 'idlwave)
8254 ;;; idlwave.el ends here