| blob | 3ee01d07b0aaef282f89b5516de3ac5ad034a5fd |
1 ;; idlwave.el --- IDL editing mode for GNU Emacs
2 ;; Copyright (c) 1999, 2000, 2001, 2002, 2003, 2004, 2005
3 ;; Free Software Foundation
5 ;; Authors: J.D. Smith <jdsmith@as.arizona.edu>
6 ;; Carsten Dominik <dominik@science.uva.nl>
7 ;; Chris Chase <chase@att.com>
8 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
9 ;; Version: 5.7_22
10 ;; Keywords: languages
12 ;; This file is part of GNU Emacs.
14 ;; GNU Emacs is free software; you can redistribute it and/or modify
15 ;; it under the terms of the GNU General Public License as published by
16 ;; the Free Software Foundation; either version 2, or (at your option)
17 ;; any later version.
19 ;; GNU Emacs is distributed in the hope that it will be useful,
20 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
21 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 ;; GNU General Public License for more details.
24 ;; You should have received a copy of the GNU General Public License
25 ;; along with GNU Emacs; see the file COPYING. If not, write to the
26 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
27 ;; Boston, MA 02110-1301, USA.
29 ;;; Commentary:
31 ;; IDLWAVE enables feature-rich development and interaction with IDL.
33 ;; In the remotely distant past, based on pascal.el, though bears
34 ;; little resemblance to it now.
35 ;;
36 ;; Incorporates many ideas, such as abbrevs, action routines, and
37 ;; continuation line indenting, from wave.el.
38 ;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder.
39 ;;
40 ;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode")
41 ;; for features, key bindings, and info.
42 ;; Also, Info format documentation is available with `M-x idlwave-info'
43 ;;
44 ;; New versions of IDLWAVE, documentation, and more information
45 ;; available from:
46 ;; http://idlwave.org
47 ;;
48 ;; INSTALLATION
49 ;; ============
50 ;;
51 ;; Follow the instructions in the INSTALL file of the distribution.
52 ;; In short, put this file on your load path and add the following
53 ;; lines to your .emacs file:
54 ;;
55 ;; (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
56 ;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
57 ;; (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
58 ;;
59 ;;
60 ;; SOURCE
61 ;; ======
62 ;;
63 ;; The newest version of this file is available from the maintainer's
64 ;; Webpage:
65 ;;
66 ;; http://idlwave.org
67 ;;
68 ;; DOCUMENTATION
69 ;; =============
70 ;;
71 ;; IDLWAVE is documented online in info format. A printable version
72 ;; of the documentation is available from the maintainers webpage (see
73 ;; SOURCE).
74 ;;
75 ;;
76 ;; ACKNOWLEDGMENTS
77 ;; ===============
78 ;;
79 ;; Thanks to the following people for their contributions and comments:
80 ;;
81 ;; Ulrik Dickow <dickow_at_nbi.dk>
82 ;; Eric E. Dors <edors_at_lanl.gov>
83 ;; Stein Vidar H. Haugan <s.v.h.haugan_at_astro.uio.no>
84 ;; David Huenemoerder <dph_at_space.mit.edu>
85 ;; Kevin Ivory <Kevin.Ivory_at_linmpi.mpg.de>
86 ;; Dick Jackson <dick_at_d-jackson.com>
87 ;; Xuyong Liu <liu_at_stsci.edu>
88 ;; Simon Marshall <Simon.Marshall_at_esrin.esa.it>
89 ;; Laurent Mugnier <mugnier_at_onera.fr>
90 ;; Lubos Pochman <lubos_at_rsinc.com>
91 ;; Bob Portmann <portmann_at_al.noaa.gov>
92 ;; Patrick M. Ryan <pat_at_jaameri.gsfc.nasa.gov>
93 ;; Marty Ryba <ryba_at_ll.mit.edu>
94 ;; Paul Sorenson <aardvark62_at_msn.com>
95 ;; Phil Sterne <sterne_at_dublin.llnl.gov>
96 ;; Phil Williams <williams_at_irc.chmcc.org>
97 ;;
98 ;; CUSTOMIZATION:
99 ;; =============
100 ;;
101 ;; IDLWAVE has extensive customize support; to learn about the
102 ;; variables which control the mode's behavior, use `M-x
103 ;; idlwave-customize'.
104 ;;
105 ;; You can set your own preferred values with Customize, or with Lisp
106 ;; code in .emacs. For an example of what to put into .emacs, check
107 ;; the TexInfo documentation or see a complete .emacs available at the
108 ;; website.
109 ;;
110 ;; KNOWN PROBLEMS:
111 ;; ==============
112 ;;
113 ;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual
114 ;; Numerics, Inc. is growing less and less complete as the two
115 ;; languages grow increasingly apart. The mode probably shouldn't
116 ;; even have "WAVE" in its title, but it's catchy, and was required
117 ;; to avoid conflict with the CORBA idl.el mode. Caveat WAVEor.
118 ;;
119 ;; Moving the point backwards in conjunction with abbrev expansion
120 ;; does not work as I would like it, but this is a problem with
121 ;; emacs abbrev expansion done by the self-insert-command. It ends
122 ;; up inserting the character that expanded the abbrev after moving
123 ;; point backward, e.g., "\cl" expanded with a space becomes
124 ;; "LONG( )" with point before the close paren. This is solved by
125 ;; using a temporary function in `post-command-hook' - not pretty,
126 ;; but it works.
127 ;;
128 ;; Tabs and spaces are treated equally as whitespace when filling a
129 ;; comment paragraph. To accomplish this, tabs are permanently
130 ;; replaced by spaces in the text surrounding the paragraph, which
131 ;; may be an undesirable side-effect. Replacing tabs with spaces is
132 ;; limited to comments only and occurs only when a comment
133 ;; paragraph is filled via `idlwave-fill-paragraph'.
134 ;;
135 ;; Muti-statement lines (using "&") on block begin and end lines can
136 ;; ruin the formatting. For example, multiple end statements on a
137 ;; line: endif & endif. Using "&" outside of block begin/end lines
138 ;; should be okay.
139 ;;
140 ;; Determining the expression at point for printing and other
141 ;; examination commands is somewhat rough: currently only fairly
142 ;; simple entities are found. You can always drag-select or examine
143 ;; a pre-selected region.
144 ;;
145 ;; When forcing completion of method keywords, the initial
146 ;; query for a method has multiple entries for some methods. Would
147 ;; be too difficult to fix this hardly used case.
148 ;;
149 \f
150 ;;; Code:
156 ;; For XEmacs
170 ;; Kludge to allow `defcustom' for Emacs 19.
173 nil ;; We've got what we needed
174 ;; We have the old or no custom-library, hack around it!
180 "Major mode for editing IDL .pro files."
192 ;;; Variables for indentation behavior ---------------------------------------
195 "Indentation and formatting options for IDLWAVE mode."
199 "*Extra indentation for the main block of code.
200 That is the block between the FUNCTION/PRO statement and the END
201 statement for that program unit."
206 "*Extra indentation applied to block lines.
207 If you change this, you probably also want to change `idlwave-end-offset'."
212 "*Extra indentation applied to block END lines.
213 A value equal to negative `idlwave-block-indent' will make END lines
214 line up with the block BEGIN lines."
219 "*Extra indentation applied to continuation lines.
220 This extra offset applies to the first of a set of continuation lines.
221 The following lines receive the same indentation as the first."
226 "*Maximum additional indentation for special continuation indent.
227 Several special indentations are tried to help line up continuation
228 lines in routine calls or definitions, other statements with
229 parentheses, or assignment statements. This variable specifies a
230 maximum amount by which this special indentation can exceed the
231 standard continuation indentation, otherwise defaulting to a fixed
232 offset. Set to 0 to effectively disable all special continuation
233 indentation, or to a large number (like 100) to enable it in all
234 cases. See also `idlwave-indent-to-open-paren', which can override
235 this variable."
240 "*Non-nil means, indent continuation lines to innermost open
241 parenthesis. This indentation occurs even if otherwise disallowed by
242 `idlwave-max-extra-continuation-indent'. Matching parens and the
243 interleaving args are lined up. Example:
245 x = function_a(function_b(function_c( a, b, [1,2,3, $
246 4,5,6 $
247 ], $
248 c, d $
249 )))
251 When this variable is nil, paren alignment may still occur, based on
252 the value of `max-extra-continuation-indent', which, if zero, would
253 yield:
255 x = function_a(function_b(function_c( a, b, [1,2,3, $
256 4,5,6 $
257 ], $
258 c, d $
259 )))"
264 "*Non-nil means, indent continuation lines with parens by nesting
265 lines at consecutively deeper levels."
271 "*If set non-nil then comment paragraphs are indented under the
272 hanging indent given by `idlwave-hang-indent-regexp' match in the first line
273 of the paragraph."
278 "*Regular expression matching the position of the hanging indent
279 in the first line of a comment paragraph. The size of the indent
280 extends to the end of the match for the regular expression."
285 "*If non-nil then use last match on line for `idlwave-indent-regexp'."
290 "*If non-nil then auto fill will only operate on comment lines."
295 "*If non-nil then auto fill will split strings with the IDL `+' operator.
296 When the line end falls within a string, string concatenation with the
297 '+' operator will be used to distribute a long string over lines.
298 If nil and a string is split then a terminal beep and warning are issued.
300 This variable is ignored when `idlwave-fill-comment-line-only' is
301 non-nil, since in this case code is not auto-filled."
306 "*If non-nil then `idlwave-split-line' will split strings with `+'.
307 When the splitting point of a line falls inside a string, split the string
308 using the `+' string concatenation operator. If nil and a string is
309 split then a terminal beep and warning are issued."
314 "*The indentation of a comment that starts with this regular
315 expression will not be changed. Note that the indentation of a comment
316 at the beginning of a line is never changed."
321 "*A comment anchored at the beginning of line.
322 A comment matching this regular expression will not have its
331 "*A comment that starts with this regular expression on a line by
332 itself is indented as if it is a part of IDL code. As a result if
333 the comment is not preceded by whitespace it is unchanged."
337 ;; Comments not matching any of the above will be indented as a
338 ;; right-margin comment, i.e., to a minimum of `comment-column'.
340 ;;; Routine Info and Completion ---------------------------------------
343 "Routine Info options for IDLWAVE mode."
347 "*Non-nil means search the IDL path for library catalog files.
349 These files, named .idlwave_catalog, document routine information for
350 individual directories and libraries of IDL .pro files. Many popular
351 libraries come with catalog files by default, so leaving this on is a
352 usually a good idea.."
357 "*Seconds of idle time before routine info is automatically initialized.
358 Initializing the routine info can take long, in particular if a large
359 library catalog is involved. When Emacs is idle for more than the number
360 of seconds specified by this variable, it starts the initialization.
361 The process is split into five steps, in order to keep possible work
362 interruption as short as possible. If one of the steps finishes, and no
363 user input has arrived in the mean time, initialization proceeds immediately
364 to the next step.
365 A good value for this variable is about 1/3 of the time initialization
366 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.
367 A Value of 0 means, don't initialize automatically."
372 "*Non-nil means, scan buffers for IDL programs when updating info.
373 The scanning is done by the command `idlwave-update-routine-info'.
374 The following values are allowed:
376 nil Don't scan any buffers.
377 t Scan all idlwave-mode buffers in the current editing session.
378 current Scan only the current buffer, but no other buffers."
386 "*Non-nil means query the shell for info about compiled routines.
387 Querying the shell is useful to get information about compiled modules,
388 and it is turned on by default. However, when you have a complete library
389 scan, this is not necessary."
395 "*Controls under what circumstances routine info is updated automatically.
396 Possible values:
397 nil Never
398 t All available
399 \(...) A list of circumstances. Allowed members are:
400 find-file Add info for new IDLWAVE buffers.
401 save-buffer Update buffer info when buffer is saved
402 kill-buffer Remove buffer info when buffer gets killed
403 compile-buffer Update shell info after `idlwave-shell-save-and...'"
415 "*Maximum number of source files displayed in the Routine Info window.
416 When an integer, it is the maximum number of source files displayed.
417 t means to show all source files."
422 "Library path for Windows and MacOS. Not needed under Unix. When
423 selecting the directories to scan for IDL user catalog routine info,
424 IDLWAVE can, under UNIX, query the shell for the exact search path
425 \(the value of !PATH). However, under Windows and MacOS (pre-OSX),
426 the IDLWAVE shell does not work. In this case, this variable can be
427 set to specify the paths where IDLWAVE can find PRO files. The shell
428 will only be asked for a list of paths when this variable is nil. The
429 value is a list of directories. A directory preceeded by a `+' will
430 be searched recursively. If you set this variable on a UNIX system,
431 the shell will not be queried. See also `idlwave-system-directory'."
436 "The IDL system directory for Windows and MacOS. Not needed under
437 UNIX. Set this to the value of the `!DIR' system variable in IDL.
438 IDLWAVE uses this to find out which of the library routines belong to
439 the official system library. All files inside the `lib' subdirectory
440 are considered system library files - so don't install private stuff
441 in this directory. On UNIX systems, IDLWAVE queries the shell for the
442 value of `!DIR'. See also `idlwave-library-path'."
448 "*Directory for configuration files and user-library catalog."
459 "Alist of regular expressions matching special library directories.
460 When listing routine source locations, IDLWAVE gives a short hint where
461 the file defining the routine is located. By default it lists `SystemLib'
462 for routines in the system library `!DIR/lib' and `Library' for anything
463 else. This variable can define additional types. The car of each entry
464 is a regular expression matching the file name (they normally will match
465 on the path). The cdr is the string to be used as identifier. Max 10
466 chars are allowed."
472 "Write out path (!PATH) and system directory (!DIR) info automatically.
473 Path info is needed to locate library catalog files. If non-nil,
474 whenever the path-list changes as a result of shell-query, etc., it is
476 used to force a write."
481 "Completion options for IDLWAVE mode."
498 "Association list setting the case of completed words.
500 This variable determines the case (UPPER/lower/Capitalized...) of
501 words inserted into the buffer by completion. The preferred case can
502 be specified separately for routine names, keywords, classes and
503 methods.
504 This alist should therefore have entries for `routine' (normal
505 functions and procedures, i.e. non-methods), `keyword', `class', and
506 `method'. Plausible values are
508 upcase upcase whole word, like `BOX_CURSOR'
509 downcase downcase whole word, like `read_ppm'
510 capitalize capitalize each part, like `Widget_Control'
511 preserve preserve case as is, like `IDLgrView'
513 The value can also be any Emacs Lisp function which transforms the
514 case of characters in a string.
516 A value of `preserve' means that the case of the completed word is
517 identical to the way it was written in the definition statement of the
518 routine. This was implemented to allow for mixed-case completion, in
519 particular of object classes and methods.
520 If a completable word is defined in multiple locations, the meaning of
521 `preserve' is not unique since the different definitions might be
522 cased differently. Therefore IDLWAVE always takes the case of the
523 *first* definition it encounters during routine info collection and
524 uses the case derived from it consistently.
526 Note that a lowercase-only string in the buffer will always be completed in
527 lower case (but see the variable `idlwave-completion-force-default-case').
529 After changing this variable, you need to either restart Emacs or press
530 `C-u C-c C-i' to update the internal lists."
537 "*Non-nil means, completion will always honor `idlwave-completion-case'.
538 When nil, only the completion of a mixed case or upper case string
539 will honor the default settings in `idlwave-completion-case', while
540 the completion of lower case strings will be completed entirely in
541 lower case."
546 "*Non-nil means, the empty string is considered downcase for completion.
547 The case of what is already in the buffer determines the case of completions.
548 When this variable is non-nil, the empty string is considered to be downcase.
549 Completing on the empty string then offers downcase versions of the possible
550 completions."
555 "Obsolete variable. See `idlwave-complete-empty-string-as-lower-case' and
559 "*Non-nil means, the case of tokens in buffers dominates over system stuff.
560 To make this possible, we need to re-case everything each time we update
561 the routine info from the buffers. This is slow.
562 The default is to consider the case given in the system and library files
563 first which makes updating much faster."
568 "*Non-nil means, highlight completions for which system help is available.
569 Help can then be accessed with mouse-3.
570 This option is only effective when the online help system is installed."
575 "Non-nil means, treat inheritance with completion, online help etc.
576 When nil, IDLWAVE only knows about the native methods and tags of a class,
577 not about inherited ones."
582 "List of regular expressions for class-driven keyword inheritance.
584 up the class tree. While it cannot be assumed that the presence of an
585 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
586 certain methods this assumption is almost always true. The methods
587 for which to assume this can be set here."
593 "*Number of classes to show when completing object methods and keywords.
594 When completing methods or keywords for an object with unknown class,
595 the *Completions* buffer will show the valid classes for each completion
596 like this:
598 MyMethod <Class1,Class2,Class3>
600 The value of this variable may be nil to inhibit display, or an integer to
601 indicate the maximum number of classes to display.
603 On XEmacs, a full list of classes will also be placed into a `help-echo'
604 property on the competion items, so that the list of classes for the current
605 item is displayed in the echo area. If the value of this variable is a
606 negative integer, the `help-echo' property will be suppressed."
612 "*Non-nil means, fontify the classes in completions buffer.
613 This makes it easier to distinguish the completion items from the extra
614 class info listed. See `idlwave-completion-show-classes'."
620 "Association list governing specification of object classes for completion.
622 When IDLWAVE tries to complete object-oriented methods, it usually
623 cannot determine the class of a given object from context. In order
624 to provide the user with a correct list of methods or keywords, it
625 needs to determine the appropriate class. IDLWAVE has two ways of
626 doing this (well, three ways if you count the shell... see
627 `idlwave-shell-query-for-class'):
629 1. Combine the items of all available classes which contain this
630 method for the purpose of completion. So when completing a method,
631 all methods of all known classes are available, and when completing
632 a keyword, all keywords allowed for this method in any class are
633 shown. This behavior is very much like normal completion and is
634 therefore the default. It works much better than one might think -
635 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
636 become uncomfortably long. See also
637 `idlwave-completion-show-classes'.
639 2. The second possibility is to ask the user on each occasion. To
640 make this less interruptive, IDLWAVE can store the class as a text
641 property on the object operator `->'. For a given object in the
642 source code, class selection will then be needed only once
643 - for example to complete the method. Keywords to the method can
644 then be completed directly, because the class is already known.
645 You will have to turn on the storage of the selected class
646 explicitly with the variable `idlwave-store-inquired-class'.
648 This variable allows you to configure IDLWAVE's method and
649 method-keyword completion behavior. Its value is an alist, which
650 should contain at least two elements: (method-default . VALUE) and
651 \(keyword-default . VALUE), where VALUE is either t or nil. These
652 specify if the class should be found during method and keyword
653 completion, respectively.
655 The alist may have additional entries specifying exceptions from the
656 keyword completion rule for specific methods, like INIT or
657 GETPROPERTY. In order to turn on class specification for the INIT
667 :inline t
672 "*Non-nil means, store class of a method call as text property on `->'.
673 IDLWAVE sometimes has to ask the user for the class associated with a
674 particular object method call. This happens during the commands
675 `idlwave-routine-info' and `idlwave-complete', depending upon the
676 value of the variable `idlwave-query-class'.
678 When you specify a class, this information can be stored as a text
679 property on the `->' arrow in the source code, so that during the same
680 editing session, IDLWAVE will not have to ask again. When this
681 variable is non-nil, IDLWAVE will store and reuse the class information.
683 on the arrow.
685 The default of this variable is nil, since the result of commands then
686 is more predictable. However, if you know what you are doing, it can
687 be nice to turn this on.
689 An arrow which knows the class will be highlighted with
691 displays (with prefix arg: deletes) the class stored on the arrow
692 at point."
697 "*Face to highlight object operator arrows `->' which carry a class property.
698 When IDLWAVE stores a class name as text property on an object arrow
699 \(see variable `idlwave-store-inquired-class', it highlights the arrow
700 with this font in order to remind the user that this arrow is special."
705 "*Non-nil means, resize the Routine-info *Help* window to fit the content."
710 "*Non-nil means, completion automatically adds `=' after completed keywords."
715 "*Non-nil means, completion automatically adds `(' after completed function.
716 nil means, don't add anything.
717 A value of `2' means, also add the closing parenthesis and position cursor
718 between the two."
725 "*Non-nil means, try to restore the window configuration after completion.
726 When completion is not unique, Emacs displays a list of completions.
727 This messes up your window configuration. With this variable set, IDLWAVE
728 restores the old configuration after successful completion."
732 ;;; Variables for abbrev and action behavior -----------------------------
735 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
736 The variables in this group govern this."
740 "*Non-nil means performs actions when indenting.
741 The actions that can be performed are listed in `idlwave-indent-action-table'."
746 "*A single character string used to start abbreviations in abbrev mode.
747 Possible characters to chose from: ~`\%
748 or even '?'. '.' is not a good choice because it can make structure
749 field names act like abbrevs in certain circumstances.
751 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
752 must set it directly using `setq' in the .emacs file before idlwave.el
753 is loaded."
758 "*Non-nil means, enable `idlwave-surround'.
759 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
760 `idlwave-surround'.
761 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
763 Also see the default key bindings for keys using `idlwave-surround'.
764 Keys are bound and made into actions calling `idlwave-surround' with
765 `idlwave-action-and-binding'.
766 See help for `idlwave-action-and-binding' for examples.
768 Also see help for `idlwave-surround'."
773 "*Non-nil means pad '=' in keywords (routine calls or defs) like assignment.
774 Whenever `idlwave-surround' is non-nil then this affects how '=' is
775 padded for keywords and for variables. If t, pad the same as for
776 assignments. If nil then spaces are removed. With any other value,
777 spaces are left unchanged."
785 "*Non-nil means point blinks to block beginning for `idlwave-show-begin'."
790 "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
795 "*Non-nil means re-indent line after END was typed."
800 "*Non-nil means the abbrev hook can move point.
801 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
802 definitions, use the command `list-abbrevs', for abbrevs that move
803 point. Moving point is useful, for example, to place point between
804 parentheses of expanded functions.
806 See `idlwave-check-abbrev'."
811 "*Non-nil means all abbrevs will be forced to either upper or lower case.
812 If the value t, all expanded abbrevs will be upper case.
813 If the value is 'down then abbrevs will be forced to lower case.
814 If nil, the case will not change.
815 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
816 upper case, regardless of this variable."
821 "*Non-nil means, reserved words will be made upper case via abbrev expansion.
822 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
823 Has effect only if in abbrev-mode."
827 ;;; Action/Expand Tables.
828 ;;
829 ;; The average user may have difficulty modifying this directly. It
830 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
831 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
832 ;; examples of how to add an action.
833 ;;
834 ;; The action table is used by `idlwave-indent-line' whereas both the
835 ;; action and expand tables are used by `idlwave-indent-and-action'. In
836 ;; general, the expand table is only used when a line is explicitly
837 ;; indented. Whereas, in addition to being used when the expand table
838 ;; is used, the action table is used when a line is indirectly
839 ;; indented via line splitting, auto-filling or a new line creation.
840 ;;
841 ;; Example actions:
842 ;;
843 ;; Capitalize system vars
844 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
845 ;;
846 ;; Capitalize procedure name
847 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
848 ;; '(capitalize-word 1) t)
849 ;;
850 ;; Capitalize common block name
851 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
852 ;; '(capitalize-word 1) t)
853 ;; Capitalize label
854 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
855 ;; '(capitalize-word -1) t)
858 "*Associated array containing action lists of search string (car),
859 and function as a cdr. This table is used by `idlwave-indent-line'.
860 See documentation for `idlwave-do-action' for a complete description of
861 the action lists.
863 Additions to the table are made with `idlwave-action-and-binding' when a
864 binding is not requested.
868 "*Associated array containing action lists of search string (car),
869 and function as a cdr. The table is used by the
870 `idlwave-indent-and-action' function. See documentation for
871 `idlwave-do-action' for a complete description of the action lists.
873 Additions to the table are made with `idlwave-action-and-binding' when a
874 binding is requested.
877 ;;; Documentation header and history keyword ---------------------------------
880 "Options for documenting IDLWAVE files."
883 ;; FIXME: make defcustom?
886 ";+
887 ; NAME:
888 ;
889 ;
890 ;
891 ; PURPOSE:
892 ;
893 ;
894 ;
895 ; CATEGORY:
896 ;
897 ;
898 ;
899 ; CALLING SEQUENCE:
900 ;
901 ;
902 ;
903 ; INPUTS:
904 ;
905 ;
906 ;
907 ; OPTIONAL INPUTS:
908 ;
909 ;
910 ;
911 ; KEYWORD PARAMETERS:
912 ;
913 ;
914 ;
915 ; OUTPUTS:
916 ;
917 ;
918 ;
919 ; OPTIONAL OUTPUTS:
920 ;
921 ;
922 ;
923 ; COMMON BLOCKS:
924 ;
925 ;
926 ;
927 ; SIDE EFFECTS:
928 ;
929 ;
930 ;
931 ; RESTRICTIONS:
932 ;
933 ;
934 ;
935 ; PROCEDURE:
936 ;
937 ;
938 ;
939 ; EXAMPLE:
940 ;
941 ;
942 ;
943 ; MODIFICATION HISTORY:
944 ;
945 ;-
947 "*A list (PATHNAME STRING) specifying the doc-header template to use for
948 summarizing a file. If PATHNAME is non-nil then this file will be included.
949 Otherwise STRING is used. If nil, the file summary will be omitted.
950 For example you might set PATHNAME to the path for the
954 "*Non-nil means, the documentation header will always be at start of file.
955 When nil, the header is positioned between the PRO/FUNCTION line of
956 the current routine and the code, allowing several routine headers in
957 a file."
962 "*The hook function used to update the timestamp of a function."
967 "*The modifications keyword to use with the log documentation commands.
968 A ':' is added to the keyword end.
969 Inserted by doc-header and used to position logs by doc-modification.
970 If nil it will not be inserted."
975 "*Regexp matching the start of a document library header."
980 "*Regexp matching the end of a document library header."
984 ;;; External Programs -------------------------------------------------------
987 "Path locations of external commands used by IDLWAVE."
990 ;; WARNING: The following variable has recently been moved from
991 ;; idlw-shell.el to this file. I hope this does not break
992 ;; anything.
995 "*If non-nil, this is the command to run IDL.
996 Should be an absolute file path or path relative to the current environment
997 execution search path. If you want to specify command line switches
998 for the idl program, use `idlwave-shell-command-line-options'.
1000 I know the name of this variable is badly chosen, but I cannot change
1001 it without compromizing backwards-compatibility."
1006 "*A list of command line options for calling the IDL program.
1007 Since IDL is executed directly without going through a shell like /bin/sh,
1009 string for each argument. But you may also give a single string which
1010 contains the options whitespace-separated. Emacs will be kind enough to
1011 split it for you."
1013 string
1018 "*The external application providing reference help for programming."
1022 ;;; Some Shell variables which must be defined here.-----------------------
1025 "List of modifiers to be used for the debugging commands.
1026 Will be used to bind debugging commands in the shell buffer and in all
1027 source buffers. These are additional convenience bindings, the debugging
1028 commands are always available with the `C-c C-d' prefix.
1029 If you set this to '(control shift), this means setting a breakpoint will
1030 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1031 are `control', `meta', `super', `hyper', `alt', and `shift'."
1042 "*If non-nil attempt invoke idlwave-shell if not already running.
1043 This is checked when an attempt to send a command to an
1044 IDL process is made."
1048 ;;; Miscellaneous variables -------------------------------------------------
1051 "Miscellaneous options for IDLWAVE mode."
1056 "*Non-nil displays a startup message when `idlwave-mode' is first called."
1062 common-blocks class-arrows)
1063 "Items which should be fontified on the default fontification level 2.
1064 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1065 is everything and level 2 is specified by this list.
1066 This variable must be set before IDLWAVE gets loaded. It is
1067 a list of symbols, the following symbols are allowed.
1069 pros-and-functions Procedure and Function definitions
1070 batch-files Batch Files
1071 idlwave-idl-keywords IDL Keywords
1072 label Statement Labels
1073 goto Goto Statements
1074 common-blocks Common Blocks
1075 keyword-parameters Keyword Parameters in routine definitions and calls
1076 system-variables System Variables
1077 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1078 class-arrows Object Arrows with class property"
1096 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1101 "Normal hook. Executed when idlwave.el is loaded."
1106 "Non-nil means turn on a few experimental features.
1107 This variable is only for the maintainer, to test difficult stuff,
1108 while still distributing stable releases.
1111 ;;;
1112 ;;; End customization variables section
1113 ;;;
1115 ;;; Non customization variables
1117 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1118 ;;; Simon Marshall <simon_at_gnu.ai.mit.edu>
1119 ;;; and Carsten Dominik...
1121 ;; The following are the reserved words in IDL. Maybe we should
1122 ;; highlight some more stuff as well?
1123 ;; Procedure declarations. Fontify keyword plus procedure name.
1125 ;; To update this regexp, update the list of keywords and
1126 ;; evaluate the form.
1127 ;; (insert
1128 ;; (prin1-to-string
1129 ;; (concat
1130 ;; "\\<\\("
1131 ;; (regexp-opt
1132 ;; '("||" "&&" "and" "or" "xor" "not"
1133 ;; "eq" "ge" "gt" "le" "lt" "ne"
1134 ;; "for" "do" "endfor"
1135 ;; "if" "then" "endif" "else" "endelse"
1136 ;; "case" "of" "endcase"
1137 ;; "switch" "break" "continue" "endswitch"
1138 ;; "begin" "end"
1139 ;; "repeat" "until" "endrep"
1140 ;; "while" "endwhile"
1141 ;; "goto" "return"
1142 ;; "inherits" "mod"
1143 ;; "compile_opt" "forward_function"
1144 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1145 ;; "\\)\\>")))
1146 "\\<\\(&&\\|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\\|||\\)\\>")
1150 ;; Function declarations. Fontify keyword plus function name.
1156 ;; Common blocks
1162 ;; Start with point after block name and comma
1164 nil
1166 )))
1168 ;; Batch files
1172 ;; FIXME warning.
1176 ;; Labels
1180 ;; The goto statement and its label
1186 ;; Tags in structure definitions. Note that this definition
1187 ;; actually collides with labels, so we have to use the same
1188 ;; face. It also matches named subscript ranges,
1189 ;; e.g. vec{bottom:top]. No good way around this.
1193 ;; Structure names
1198 ;; Keyword parameters, like /xlog or ,xrange=[]
1199 ;; This is anchored to the comma preceeding the keyword.
1200 ;; Treats continuation lines, works only during whole buffer
1201 ;; fontification. Slow, use it only in fancy fontification.
1203 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\\(\n[ \t]*;.*\\)*\n[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1206 ;; System variables start with a bang.
1211 ;; Special and unusual operators (not used because too noisy)
1215 ;; All operators (not used because too noisy)
1219 ;; Arrows with text property `idlwave-class'
1233 batch-files
1234 idlwave-idl-keywords
1235 label goto
1236 structtag
1237 structname
1238 common-blocks
1239 keyword-parameters
1240 system-variables
1241 class-arrows)
1245 ;; Match an object arrow with class property
1255 idlwave-font-lock-keywords-1
1256 idlwave-font-lock-keywords-2
1257 idlwave-font-lock-keywords-3)
1258 nil t
1260 beginning-of-line))
1266 "Regexp to match the start of a full-line comment.
1267 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1272 "Regular expression to find the beginning of a block. The case does
1276 "Regular expression to find the beginning of a unit. The case does
1280 "Regular expression to find the line that indicates the end of unit.
1281 This line is the end of buffer or the start of another unit. The case does
1289 "Regular expression to find the end of a block. The case does
1302 "Matches between statements and the corresponding END variant.
1303 The cars are the reserved words starting a block. If the block really
1304 begins with BEGIN, the cars are the reserved words before the begin
1305 which can be used to identify the block type.
1306 This is used to check for the correct END type, to close blocks and
1311 "Regular expression matching reserved words which can stand before
1312 blocks starting with a BEGIN statement. The matches must have associations
1329 ))
1333 ;; "endif else" is the only possible "end" that can be
1334 ;; followed by a statement on the same line.
1336 ;; all other "end"s can not be followed by a statement.
1349 idlwave-identifier
1353 idlwave-identifier
1358 "Associated list of statement matching regular expressions.
1359 Each regular expression matches the start of an IDL statement. The
1360 first element of each association is a symbol giving the statement
1361 type. The associated value is a list. The first element of this list
1362 is a regular expression matching the start of an IDL statement for
1363 identifying the statement type. The second element of this list is a
1364 regular expression for finding a substatement for the type. The
1365 substatement starts after the end of the found match modulo
1366 whitespace. If it is nil then the statement has no substatement. The
1367 list order matters since matching an assignment statement exactly is
1368 not possible without parsing. Thus assignment statement become just
1377 ;; Note that this is documented in the v18 manuals as being a string
1378 ;; of length one rather than a single character.
1379 ;; The code in this file accepts either format for compatibility.
1381 "Character to be inserted for IDL comment indentation.
1385 "Character which is inserted as a last character on previous line by
1391 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1395 ;; If I take the time I can replace idlwave-keyword-abbrev with
1396 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1397 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1398 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1399 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1402 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1403 Specifically, if the abbrev is in a comment or string it is unexpanded.
1404 Otherwise ARGS forms a list that is evaluated."
1449 "Execute BODY with a different syntax table."
1457 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1458 ; "Execute BODY with a different syntax table."
1459 ; `(let ((saved-syntax (syntax-table)))
1460 ; (unwind-protect
1461 ; (progn
1462 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1463 ; ,@body)
1464 ; (set-syntax-table saved-syntax))))
1467 "KEY and CMD are made into a key binding and an indent action.
1468 KEY is a string - same as for the `define-key' function. CMD is a
1469 function of no arguments or a list to be evaluated. CMD is bound to
1470 KEY in `idlwave-mode-map' by defining an anonymous function calling
1471 `self-insert-command' followed by CMD. If KEY contains more than one
1472 character a binding will only be set if SELECT is 'both.
1474 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1475 replacing any previous value for KEY. If a binding is not set then it
1476 will instead be placed in `idlwave-indent-action-table'.
1478 If the optional argument SELECT is nil then an action and binding are
1479 created. If SELECT is 'noaction, then a binding is always set and no
1480 action is created. If SELECT is 'both then an action and binding
1481 will both be created even if KEY contains more than one character.
1482 Otherwise, if SELECT is non-nil then only an action is created.
1484 Some examples:
1485 No spaces before and 1 after a comma
1487 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1489 Capitalize system variables - action only
1490 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1492 ;; Add action
1498 ;; Replace action command
1500 ;; New action
1502 ;; Make key binding for action
1511 cmd
1518 ;(define-key idlwave-mode-map "\C-c\C- " 'idlwave-hard-tab)
1537 ;; (define-key idlwave-mode-map "\r" 'idlwave-newline)
1538 ;; (define-key idlwave-mode-map "\t" 'idlwave-indent-line)
1550 ;; Bind the debug commands also with the special modifiers.
1567 ;; (define-key idlwave-mode-map "\C-c\C-f" 'idlwave-function)
1568 ;; (define-key idlwave-mode-map "\C-c\C-p" 'idlwave-procedure)
1591 ;; Pickup both forms of Esc/Meta binding
1601 ;; Set action and key bindings.
1602 ;; See description of the function `idlwave-action-and-binding'.
1603 ;; Automatically add spaces for the following characters
1604 ;(idlwave-action-and-binding "&" '(idlwave-surround -1 -1 '(?&) 1
1605 ; (lambda (char) 0)))
1607 ;; Binding works for both > and ->, by changing the length of the token.
1613 ;; Automatically add spaces to equal sign if not keyword
1616 ;;;
1617 ;;; Abbrev Section
1618 ;;;
1619 ;;; When expanding abbrevs and the abbrev hook moves backward, an extra
1620 ;;; space is inserted (this is the space typed by the user to expanded
1621 ;;; the abbrev).
1622 ;;;
1628 "Define-abbrev with backward compatibility.
1630 If NOPREFIX is non-nil, don't prepend prefix character. Installs into
1631 idlwave-mode-abbrev-table unless TABLE is non-nil."
1635 expansion
1636 hook)))
1646 ;;
1647 ;; Templates
1648 ;;
1658 ;;
1659 ;; Keywords, system functions, conversion routines
1660 ;;
1718 ;; This section is reserved words only. (From IDL user manual)
1719 ;;
1765 ;; defined later - so just make the compiler hush
1769 ;;;###autoload
1771 "Major mode for editing IDL source files (version 5.7_22).
1773 The main features of this mode are
1775 1. Indentation and Formatting
1776 --------------------------
1777 Like other Emacs programming modes, C-j inserts a newline and indents.
1778 TAB is used for explicit indentation of the current line.
1781 function can also be used in the middle of a line to split the line
1782 at that point. When used inside a long constant string, the string
1783 is split at that point with the `+' concatenation operator.
1785 Comments are indented as follows:
1787 `;;;' Indentation remains unchanged.
1788 `;;' Indent like the surrounding code
1789 `;' Indent to a minimum column.
1791 The indentation of comments starting in column 0 is never changed.
1794 comment. The indentation of the second line of the paragraph
1795 relative to the first will be retained. Use
1797 comments. When the variable `idlwave-fill-comment-line-only' is
1798 nil, code can also be auto-filled and auto-indented.
1800 To convert pre-existing IDL code to your formatting style, mark the
1805 2. Routine Info
1806 ------------
1807 IDLWAVE displays information about the calling sequence and the
1808 accepted keyword parameters of a procedure or function with
1810 source file of a module. These commands know about system
1811 routines, all routines in idlwave-mode buffers and (when the
1812 idlwave-shell is active) about all modules currently compiled under
1813 this shell. It also makes use of pre-compiled or custom-scanned
1814 user and library catalogs many popular libraries ship with by
1816 information, which is also used for completion (see item 4).
1818 3. Online IDL Help
1819 ---------------
1821 for the system variable, keyword, or routine at point. A single
1822 key stroke gets you directly to the right place in the docs. The
1823 HTML help files package must be installed for this to work -- check
1824 the IDLWAVE webpage for the correct package for your version. See
1825 the manual to configure where and how the HTML help is displayed.
1827 4. Completion
1828 ----------
1830 class names, keyword parameters, system variables and tags, class
1831 tags, structure tags, filenames and much more. It is context
1832 sensitive and figures out what is expected at point. Lower case
1833 strings are completed in lower case, other strings in mixed or
1834 upper case.
1836 5. Code Templates and Abbreviations
1837 --------------------------------
1838 Many Abbreviations are predefined to expand to code fragments and templates.
1853 have direct keybindings - see the list of keybindings below.
1856 beginning of the current program unit (pro, function or main).
1857 Change log entries can be added to the current program unit with
1860 6. Automatic Case Conversion
1861 -------------------------
1862 The case of reserved words and some abbrevs is controlled by
1863 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1865 7. Automatic END completion
1866 ------------------------
1867 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1868 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1870 8. Hooks
1871 -----
1872 Loading idlwave.el runs `idlwave-load-hook'.
1873 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1875 9. Documentation and Customization
1876 -------------------------------
1877 Info documentation for this package is available. Use
1879 not work). For Postscript, PDF, and HTML versions of the
1880 documentation, check IDLWAVE's homepage at `http://idlwave.org'.
1881 IDLWAVE has customize support - see the group `idlwave'.
1883 10.Keybindings
1884 -----------
1885 Here is a list of all keybindings of this mode.
1887 followed by the key sequence to see what the key sequence does.
1932 ;; Set tag table list to use IDLTAGS as file name.
1936 ;; Font-lock additions - originally Phil Williams, then Ulrik Dickow
1937 ;; Following line is for Emacs - XEmacs uses the corresponding property
1938 ;; on the `idlwave-mode' symbol.
1941 ;; Imenu setup
1949 ;; Make a local post-command-hook and add our hook to it
1952 ;; Make local hooks for buffer updates
1957 ;; Setup directories and file, if necessary
1960 ;; Update the routine info with info about current buffer?
1963 ;; Run the mode hook
1972 idlwave-user-catalog-file
1973 idlwave-config-directory)
1975 idlwave-path-file
1976 idlwave-config-directory))
1980 ;;
1981 ;; Code Formatting ----------------------------------------------------
1982 ;;
1985 "Push mark for compatibility with Emacs 18/19."
1991 "Inserts TAB in buffer in current position."
1995 ;;; This stuff is experimental
1998 "If non-nil, a list that can be evaluated using `eval'.
1999 It is evaluated in the lisp function `idlwave-command-hook' which is
2003 "Command run after every command.
2004 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
2005 sets the variable to zero afterwards."
2013 ;;; End experiment
2015 ;; It would be better to use expand.el for better abbrev handling and
2016 ;; versatility.
2019 "Reverses abbrev expansion if in comment or string.
2020 Argument ARG is the number of characters to move point
2021 backward if `idlwave-abbrev-move' is non-nil.
2022 If optional argument RESERVED is non-nil then the expansion
2023 consists of reserved words, which will be capitalized if
2024 `idlwave-reserved-word-upcase' is non-nil.
2025 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2026 is non-nil, unless its value is \`down in which case the abbrev will be
2027 made into all lowercase.
2028 Returns non-nil if abbrev is left expanded."
2031 nil)
2043 t))
2046 "Returns t if point is inside a comment, nil otherwise."
2052 "Move to start of comment delimiter on current line.
2053 Moves to end of line if there is no comment delimiter.
2054 Ignores comment delimiters in strings.
2055 Returns point if comment found and nil otherwise."
2058 found)
2059 ;; Look for first comment delimiter not in a string
2074 "Is transient-mark-mode on and the region active?
2075 Works on both Emacs and XEmacs."
2081 "Insert quote and show matching quote if this is end of a string."
2092 ;; Not the end of a string
2096 "Ensure that the previous word was a token before `idlwave-show-begin'.
2097 An END token must be preceded by whitespace."
2107 "Finds the start of current block and blinks to it for a second.
2108 Also checks if the correct end statement has been used."
2109 ;; All end statements are reserved words
2110 ;; Re-indent end line
2111 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2112 ;;(backward-char 1)
2116 begin-pos end-pos end end1 )
2120 idlwave-show-block)
2122 ;; Move inside current block
2135 end-pos))
2143 ;; A generic end
2154 end1 end)
2156 ;;(delete-char 1))
2170 ;; seems to be a case thing
2174 idlwave-block-matches))
2176 ;; Just a normal block
2181 "Terminate the current block with the correct END statement."
2184 ;; Start new line if we are not in a new line
2195 "Let the > symbol expand around -> if present. The new token length
2196 is returned."
2200 "Surround the LENGTH characters before point with blanks.
2201 LENGTH defaults to 1.
2202 Optional arguments BEFORE and AFTER affect the behavior before and
2203 after the characters (see also description of `idlwave-make-space'):
2205 nil do nothing
2206 0 force no spaces
2207 integer > 0 force exactly n spaces
2208 integer < 0 at least |n| spaces
2210 The function does nothing if any of the following conditions is true:
2211 - `idlwave-surround-by-blank' is nil
2212 - the character before point is inside a string or comment
2213 - the char preceeding the string to be surrounded is a member of ESCAPE-CHARS.
2214 This hack is used to avoid padding of `>' when it is part of
2215 the '->' operator. In this case, ESCAPE-CHARS would be '(?-).
2217 If a function is passed in EC-HOOK, and an ESCAPE-CHARS match occurs,
2218 the named function will be called with a single argument of the
2219 preceeding character. Then idlwave-surround will run as usual if
2220 EC-HOOK returns non-nil, and a new length will be taken from the
2221 return value."
2234 ;; avoid clobbering indent
2244 ;; Check to see if the line should auto wrap
2250 "Make space at point.
2251 The space affected is all the spaces and tabs around point.
2252 If n is non-nil then point is left abs(n) spaces from the beginning of
2253 the contiguous space.
2254 The amount of space at point is determined by N.
2255 If the value of N is:
2256 nil - do nothing.
2257 > 0 - exactly N spaces.
2258 < 0 - a minimum of -N spaces, i.e., do not change if there are
2259 already -N spaces.
2260 0 - no spaces (i.e. remove any existing space)."
2274 ;; n = 0, done
2275 ))))
2278 "Inserts a newline and indents the current and previous line."
2280 ;;
2281 ;; Handle unterminated single and double quotes
2282 ;; If not in a comment and in a string then insertion of a newline
2283 ;; will mean unbalanced quotes.
2284 ;;
2289 ;;
2290 ;; The current line is being split, the cursor should be at the
2291 ;; beginning of the new line skipping the leading indentation.
2292 ;;
2293 ;; The reason we insert the new line before indenting is that the
2294 ;; indenting could be confused by keywords (e.g. END) on the line
2295 ;; after the split point. This prevents us from just using
2296 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2297 ;;
2303 ;;
2304 ;; Use global variable 'comment-column' to set parallel comment
2305 ;;
2306 ;; Modeled on lisp.el
2307 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2309 "Compute indent for the beginning of the IDL comment delimiter."
2317 ;; On line by itself, indent as code
2320 ;; after code - do not change
2324 comment-column))))
2327 "Continue line by breaking line at point and indent the lines.
2328 For a code line insert continuation marker. If the line is a line comment
2329 then the new line will contain a comment with the same indentation.
2330 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2331 non-nil."
2333 ;; Expand abbreviation, just like normal RET would.
2337 ;; For code line add continuation.
2338 ;; Check if splitting a string.
2342 ;; Split the string.
2344 idlwave-continuation-char beg)
2348 ;; Do not split the string.
2352 ;; Not splitting a string.
2358 ;; Indent previous line
2363 ;; Reindent new line
2367 "Moves point to the beginning of the current program unit."
2372 "Moves point to the start of the next program unit."
2378 "Mark current IDL statement."
2386 "Mark containing block."
2398 "Put mark at beginning of program, point at end.
2399 The marks are pushed."
2409 "Move to beginning of enclosing block if prefix ARG >= 0.
2410 If prefix ARG < 0 then move forward to enclosing block end."
2415 "Go to the beginning of the current block."
2421 "Go to the beginning of the current block."
2427 "Move across next nested block."
2433 "Move backward across previous nested block."
2439 "Go down a block.
2440 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2441 Returns non-nil if successfull."
2445 ;; Backward
2453 ;; Forward
2461 status))
2464 "Put point at beginning of doc library header, mark at end.
2465 The marks are pushed."
2483 "Return (NAME TYPE CLASS) of current routine."
2487 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2496 "Move to beginning of the current statement.
2497 Skips back past statement continuations.
2498 Point is placed at the beginning of the line whether or not this is an
2499 actual statement."
2511 "Moves point to beginning of the previous statement.
2512 Returns t if the current line before moving is the beginning of
2513 the first non-comment statement in the file, and nil otherwise."
2517 ;; first line in file
2518 t
2519 ;; skip blank lines, label lines, include lines and line comments
2521 ;; The current statement is the first statement until we
2522 ;; reach another statement.
2530 ;; skip continuation lines
2536 first-statement)))
2539 "Moves point to the end of the current IDL statement.
2540 If not in a statement just moves to end of line. Returns position."
2550 "Moves point to the end of the current IDL statement.
2551 If not in a statement just moves to end of line. Returns position."
2559 "Moves point to beginning of the next IDL statement.
2560 Returns t if that statement is the last
2561 non-comment IDL statement in the file, and nil otherwise."
2565 ;; skip blank lines, label lines, include lines and line comments
2567 ;; The current statement is the last statement until
2568 ;; we reach a new statement.
2575 last-statement))
2578 "Skip past multiple commands on a line (with `&')."
2588 "Skip label or case statement element.
2589 Returns position after label.
2590 If there is no label point is not moved and nil is returned."
2591 ;; Case expressions and labels are terminated by a colon.
2592 ;; So we find the first colon in the line and make sure
2593 ;; - no `?' is before it (might be a ? b : c)
2594 ;; - it is not in a comment
2595 ;; - not in a string constant
2596 ;; - not in parenthesis (like a[0:3])
2597 ;; - not followed by another ":" in explicit class, ala a->b::c
2598 ;; As many in this mode, this function is heuristic and not an exact
2599 ;; parser.
2611 nil)))
2614 "Move to start of next IDL substatement after point.
2615 Uses the type of the current IDL statement to determine if the next
2616 statement is on a new line or is a subpart of the current statement.
2617 Returns point at start of substatement modulo whitespace.
2618 If optional argument is non-nil move to beginning of current
2619 substatement."
2623 st nst last)
2629 ;; Continue looking for substatements until we are past orig
2643 ;; If a continuation line starts here, move to next line
2649 "Return the type of the current IDL statement.
2650 Uses `idlwave-statement-match' to return a cons of (type . point) with
2651 point the ending position where the type was determined. Type is the
2652 association from `idlwave-statement-match', i.e. the cons cell from the
2653 list not just the type symbol. Returns nil if not an identifiable
2654 statement."
2656 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2657 ;; and possibly comments
2669 "Pad '=' with spaces. Two cases: Assignment statement, and keyword
2670 assignment. Which case is determined using
2671 `idlwave-start-of-substatement' and `idlwave-statement-type'. The
2672 equal sign will be surrounded by BEFORE and AFTER blanks. If
2673 `idlwave-pad-keyword' is t then keyword assignment is treated just
2674 like assignment statements. When nil, spaces are removed for keyword
2675 assignment. Any other value keeps the current space around the `='.
2676 Limits in for loops are treated as keyword assignment.
2678 Starting with IDL 6.0, a number of op= assignments are available.
2679 Since ambiguities of the form:
2681 r and= b
2682 rand= b
2684 can occur, alphanumeric operator assignment will never be pre-padded,
2685 only post-padded. You must use a space before these to disambiguate
2686 \(not just for padding, but for proper parsing by IDL too!). Other
2687 operators, such as ##=, ^=, etc., will be pre-padded.
2689 See `idlwave-surround'."
2702 ;; Why doesn't ##? work for both?
2706 ;(setq begin nil) ; won't modify begin
2710 ;; Everything gets padded equally
2712 ;; Treating keywords/for variables specially...
2730 "Call `idlwave-indent-line' and do expand actions.
2731 With prefix ARG non-nil, indent the entire sub-statement."
2739 ;;Expand the END abbreviation, just as RET or Space would have.
2750 "Indents current IDL line as code or as a comment.
2751 The actions in `idlwave-indent-action-table' are performed.
2752 If the optional argument EXPAND is non-nil then the actions in
2753 `idlwave-indent-expand-table' are performed."
2755 ;; Move point out of left margin.
2764 ;; Indentation for a line comment
2768 ;;
2769 ;; Code Line
2770 ;;
2771 ;; Before indenting, run action routines.
2772 ;;
2775 ;;
2778 ;;
2779 ;; No longer expand abbrevs on the line. The user can do this
2780 ;; manually using expand-region-abbrevs.
2781 ;;
2782 ;; Indent for code line
2783 ;;
2786 ;; a label line
2788 ;; a batch command
2790 ;; leave flush left
2791 nil
2792 ;; indent the line
2794 ;; Adjust parallel comment
2797 ;; Emacs 21 is too smart with fill-column on comment indent
2800 fill-column)))
2803 ;; Get rid of marker
2807 "Perform an action repeatedly on a line.
2808 ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is
2809 either a function name to be called with `funcall' or a list to be
2810 evaluated with `eval'. The action performed by FUNC should leave point
2811 after the match for REG - otherwise an infinite loop may be entered."
2821 "Indent from point with spaces until column COL.
2822 Inserts space before markers at point."
2828 "Indent the current line to column COL.
2829 Indents such that first non-whitespace character is at column COL
2830 Inserts spaces before markers at point."
2837 "Indents program unit which contains point."
2849 "Indent current statement, including all continuation lines."
2858 "Return appropriate indentation for current line as IDL code."
2862 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2863 ;; function
2866 ;; Check for continuation line
2871 ;; calculate indent based on previous and current statements
2874 ;; calculate indent based on previous statement
2877 ;; Beginning of file
2882 ;; Main block
2885 idlwave-main-block-indent))
2886 ;; Begin block
2889 idlwave-block-indent))
2890 ;; End Block
2893 ;; Match to the *beginning* of the block opener
2897 ;; idlwave-end-offset
2898 ;; idlwave-block-indent))
2900 ;; Default to current indent
2902 ;; adjust the indentation based on the current statement
2904 ;; End block
2909 ;;
2910 ;; Parentheses indent
2911 ;;
2914 "Calculate the continuation indent inside a paren group.
2915 Returns a cons-cell with (open . indent), where open is the
2916 location of the open paren"
2918 ;; Found an innermost open paren.
2921 ;; Line up with next word unless this is a closing paren.
2924 ;; Plain Kernighan-style nested indent
2928 ;; This is a closed paren - line up under open paren.
2932 ;; Empty (or just comment) follows -- revert to basic indent
2934 ;; Skip paren
2937 nil)
2939 ;; Line up with first word after any blank space
2945 "Calculates the IDL continuation indent column from the previous
2946 statement. Note that here previous statement usually means the
2947 beginning of the current statement if this statement is a continuation
2948 of the previous line. Various special types of continuations,
2949 including assignments, routine definitions, and parenthetical
2950 groupings, are treated separately."
2961 idlwave-continuation-indent))
2962 fancy-nonparen-indent fancy-paren-indent)
2964 ;; Align then with its matching if, etc.
2971 match cont-re)
2986 ;; Indent in from the previous line for continuing statements
2991 match)
3003 ;; Parenthetical indent, either traditional or Kernighan style
3010 indent-cons)
3013 beg-reg end-reg close-exp))
3014 ;; First permitted containing paren
3016 idlwave-indent-to-open-paren
3017 idlwave-indent-parens-nested
3020 idlwave-max-extra-continuation-indent))
3023 fancy-paren-indent)
3025 ;; A continued assignment, or procedure call/definition
3033 ;; A continued Procedure call or definition
3036 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3038 ;; Comment only, or blank line with "$"? Basic indent.
3040 nil
3043 ;; Continued assignment (with =):
3057 idlwave-max-extra-continuation-indent))
3060 fancy-nonparen-indent))
3062 ;; Basic indent, by default
3068 "Move to next match of the regular expression KEY-RE.
3069 Matches inside comments or string constants will be ignored.
3070 If DIR is negative, the search will be backwards.
3071 At a successful match, the mark is pushed unless NOMARK is non-nil.
3072 Searches are limited to LIMIT.
3073 Searches are case-insensitive and use a special syntax table which
3074 treats `$' and `_' as word characters.
3075 Return value is the beginning of the match or (in case of failure) nil."
3079 found)
3093 found)
3094 nil)))
3097 "When optional argument DIR is non-negative, move forward to end of
3098 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3099 regular expressions. When DIR is negative, move backwards to block beginning.
3100 Recursively calls itself to skip over nested blocks. DIR defaults to
3101 forward. Calls `push-mark' unless the optional argument NOMARK is
3102 non-nil. Movement is limited by the start of program units because of
3103 possibility of unbalanced blocks."
3110 idlwave-begin-block-reg
3111 idlwave-end-block-reg))
3112 found
3114 idlwave-end-block-reg))
3118 idlwave-begin-unit-reg dir t limit)
3121 idlwave-end-unit-reg dir t limit)))
3122 limit)))
3134 "The minimum indent in the current statement."
3145 min
3149 "Return indentation of the current statement.
3150 If in a statement, moves to beginning of statement before finding indent."
3157 "Return the column of the indentation of the current line.
3158 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3162 ;; if we are at the end of blank line return 0
3167 "Tests if current line is continuation line.
3168 Blank or comment-only lines following regular continuation lines (with
3169 `$') count as continuations too."
3179 "Tests if the current line is a comment line."
3185 "Tests if the current line is a comment line."
3191 "Searches current line from current point for REGEXP.
3192 If optional argument CONT is non-nil, searches to the end of
3193 the current statement.
3194 If optional arg BEG is non-nil, search starts from the beginning of the
3195 current statement.
3196 Ignores matches that end in a comment or inside a string expression.
3197 Returns point if successful, nil otherwise.
3198 This function produces unexpected results if REGEXP contains quotes or
3199 a comment delimiter. The search is case insensitive.
3200 If successful leaves point after the match, otherwise, does not move point."
3206 found)
3212 found))
3215 "Fills paragraphs in comments.
3216 A paragraph is made up of all contiguous lines having the same comment
3217 leader (the leading whitespace before the comment delimiter and the
3218 comment delimiter). In addition, paragraphs are separated by blank
3219 line comments. The indentation is given by the hanging indent of the
3220 first line, otherwise by the minimum indentation of the lines after
3221 the first line. The indentation of the first line does not change.
3222 Does not effect code lines. Does not fill comments on the same line
3223 with code. The hanging indent is given by the end of the first match
3224 matching `idlwave-hang-indent-regexp' on the paragraph's first line . If the
3225 optional argument NOHANG is non-nil then the hanging indent is
3226 ignored."
3228 ;; check if this is a line comment
3235 pre here diff fill-prefix-reg bcl first-indent
3236 hang start end)
3237 ;; Change tabs to spaces in the surrounding paragraph.
3238 ;; The surrounding paragraph will be the largest containing block of
3239 ;; contiguous line comments. Thus, we may be changing tabs in
3240 ;; a much larger area than is needed, but this is the easiest
3241 ;; brute force way to do it.
3242 ;;
3243 ;; This has the undesirable side effect of replacing the tabs
3244 ;; permanently without the user's request or knowledge.
3252 ;;
3259 t)
3260 ;; Get the comment leader on the line and its length
3262 ;; the comment leader is the indentation plus exactly the
3263 ;; number of consecutive ";".
3273 ;; Mark the beginning and end of the paragraph
3279 ;; Move to first line of paragraph
3293 ;; if at end of buffer add a newline (need this because
3294 ;; fill-region needs END to be at the beginning of line after
3295 ;; the paragraph or it will add a line).
3298 ;; Set END to the beginning of line after the paragraph
3299 ;; END is calculated as distance from end of buffer
3301 ;;
3302 ;; Calculate the indentation for the paragraph.
3303 ;;
3304 ;; In the following while statements, after one iteration
3305 ;; point will be at the beginning of a line in which case
3306 ;; the while will not be executed for the
3307 ;; the first paragraph line and thus will not affect the
3308 ;; indentation.
3309 ;;
3310 ;; First check to see if indentation is based on hanging indent.
3316 ;; Adjust lines of paragraph by inserting spaces so that
3317 ;; each line's indent is at least as great as the hanging
3318 ;; indent. This is needed for fill-paragraph to work with
3319 ;; a fill-prefix.
3326 t)
3330 ;; adjust the original location for the
3331 ;; inserted text.
3335 )
3337 ;; No hang. Instead find minimum indentation of paragraph
3338 ;; after first line.
3339 ;; For the following while statement, since START is at the
3340 ;; beginning of line and END is at the end of line
3341 ;; point is greater than START at least once (which would
3342 ;; be the case for a single line paragraph).
3349 comment-start-skip
3351 t)
3354 )
3357 ?\ )))
3358 ;; first-line indent
3363 comment-start-skip
3365 t)
3367 indent))
3369 ;; try to keep point at its original place
3372 ;; In place of the more modern fill-region-as-paragraph, a hack
3373 ;; to keep whitespace untouched on the first line within the
3374 ;; indent length and to preserve any indent on the first line
3375 ;; (first indent).
3381 start
3384 nil)
3388 ;; When we want the point at the beginning of the comment
3389 ;; body fill-region will put it at the beginning of the line.
3394 "Calculate the position of the hanging indent for the comment
3395 paragraph. The hanging indent position is given by the first match
3396 with the `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3397 non-nil then use last occurrence matching `idlwave-hang-indent-regexp' on
3398 the line.
3399 If not found returns nil."
3404 idlwave-hang-indent-regexp
3406 t)
3411 idlwave-hang-indent-regexp
3413 t)
3417 "Called to break lines in auto fill mode.
3418 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3419 non-nil. Places a continuation character at the end of the line if
3420 not in a comment. Splits strings with IDL concatenation operator `+'
3421 if `idlwave-auto-fill-split-string' is non-nil."
3423 nil ; do not to fill
3426 ;; Check for comment line
3431 ;; Prevent actions do-auto-fill which calls indent-line-function.
3437 idlwave-auto-fill-split-string)
3440 ))))
3444 ;; Indent the split line
3446 )
3450 ;; A continued line comment
3451 ;; We treat continued line comments as part of a comment
3452 ;; paragraph. So we check for a hanging indent.
3461 ;; Remove whitespace between comment delimiter and
3462 ;; text, insert spaces for appropriate indentation.
3465 comment-start-skip
3470 )))
3471 ;; Split code or comment?
3475 ;; Splitting a non-full-line comment.
3476 ;; Insert the comment delimiter from split line
3481 ;; Insert blank to keep off beginning of line
3490 ;; Split code line - add continuation character
3493 ;; Check to see if we split a string
3495 idlwave-auto-fill-split-string)
3496 ;; Split the string and concatenate.
3497 ;; The first extra space is for the space
3498 ;; the line was split. That space was removed.
3503 ;; Make the second part of continued string
3508 ;; Warning
3511 ;; Although do-auto-fill (via indent-new-comment-line) calls
3512 ;; idlwave-indent-line for the new line, re-indent again
3513 ;; because of the addition of the continuation character.
3515 )))))
3518 "Toggle auto-fill mode for IDL mode.
3519 With arg, turn auto-fill mode on if arg is positive.
3520 In auto-fill mode, inserting a space at a column beyond `fill-column'
3521 automatically breaks the line at a previous space."
3527 'idlwave-auto-fill
3528 nil))
3529 ;; update mode-line
3532 ;(defun idlwave-fill-routine-call ()
3533 ; "Fill a routine definition or statement, indenting appropriately."
3534 ; (let ((where (idlwave-where)))))
3538 "Insert a documentation header at the beginning of the unit.
3539 Inserts the value of the variable idlwave-file-header. Sets mark before
3540 moving to do insertion unless the optional prefix argument NOMARK
3541 is non-nil."
3544 ;; make sure we catch the current line if it begins the unit
3550 ;; skip function or procedure line
3564 "Default timestamp insertion function"
3570 ;; Remove extra spaces from line
3572 ;; Insert a blank line comment to separate from the date entry -
3573 ;; will keep the entry from flowing onto date line if re-filled.
3577 "Insert a brief modification log at the beginning of the current program.
3578 Looks for an occurrence of the value of user variable
3579 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user name
3580 and places the point for the user to add a log. Before moving, saves
3581 location on mark ring so that the user can return to previous point."
3596 end t)
3606 ;;; CJC 3/16/93
3607 ;;; Interface to expand-region-abbrevs which did not work when the
3608 ;;; abbrev hook associated with an abbrev moves point backwards
3609 ;;; after abbrev expansion, e.g., as with the abbrev '.n'.
3610 ;;; The original would enter an infinite loop in attempting to expand
3611 ;;; .n (it would continually expand and unexpand the abbrev without expanding
3612 ;;; because the point would keep going back to the beginning of the
3613 ;;; abbrev instead of to the end of the abbrev). We now keep the
3614 ;;; abbrev hook from moving backwards.
3615 ;;;
3617 "Expand each abbrev occurrence in the region.
3618 Calling from a program, arguments are START END."
3627 "Returns t if point is in a comment or quoted string.
3628 nil otherwise."
3632 "Returns location of the opening quote
3633 if point is in a IDL string constant, nil otherwise.
3634 Ignores comment delimiters on the current line.
3635 Properly handles nested quotation marks and octal
3636 constants - a double quote followed by an octal digit."
3637 ;;; Treat an octal inside an apostrophe to be a normal string. Treat a
3638 ;;; double quote followed by an octal digit to be an octal constant
3639 ;;; rather than a string. Therefore, there is no terminating double
3640 ;;; quote.
3642 ;; Because single and double quotes can quote each other we must
3643 ;; search for the string start from the beginning of line.
3649 delim
3650 found)
3652 ;; Find string start
3653 ;; Don't find an octal constant beginning with a double quote
3655 ;; Find the string end.
3656 ;; In IDL, two consecutive delimiters after the start of a
3657 ;; string act as an
3658 ;; escape for the delimiter in the string.
3659 ;; Two consecutive delimiters alone (i.e., not after the
3660 ;; start of a string) is the null string.
3662 ;; Move to position after quote
3665 ;; Get the string delimiter
3667 ;; Check for null string
3670 ;; Look for next unpaired delimiter
3678 ))
3681 ;; return string beginning position or nil
3685 "Determines if the character after point is a pointer dereference *."
3696 ;; Statement templates
3698 ;; Replace these with a general template function, something like
3699 ;; expand.el (I think there was also something with a name similar to
3700 ;; dmacro.el)
3703 "Build a template with optional prompt expression.
3705 Opens a line if point is not followed by a newline modulo intervening
3706 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3707 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3708 adjusted according to `idlwave-abbrev-change-case'. If optional argument
3709 PROMPT is a string then it is displayed as a message in the
3710 minibuffer. The PROMPT serves as a reminder to the user of an
3711 expression to enter.
3713 The lines containing S1 and S2 are reindented using `indent-region'
3714 unless the optional second argument NOINDENT is non-nil."
3716 ;; This is a gross hack to avoit template abbrev expansion
3717 ;; in the shell. FIXME: This is a dirty hack.
3727 end)
3740 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3743 string))
3746 "Build skeleton IDL if-else block."
3754 "Build skeleton IDL case statement."
3762 "Build skeleton IDL switch statement."
3770 "Build skeleton for loop statment."
3778 "Build skeleton for loop statment."
3814 "Return a list of substrings of STRING which are separated by PATTERN.
3828 end)
3836 ;; Return the buffer currently visiting FILE
3846 "List of buffer pulled up by idlwave for special reasons.
3850 ;; Return a buffer visiting file.
3854 buf)))
3857 "Kill buffers created automatically by IDLWAVE.
3858 Function prompts for a letter to identify the buffers to kill.
3859 Possible letters are:
3862 clicks in the routine info window.
3863 s Buffers created by the IDLWAVE Shell to display where execution
3864 stopped or an error was found.
3865 a Both of the above.
3867 Buffer containing unsaved changes require confirmation before they are killed."
3871 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3885 "How many outlawed buffers have tag TAG?"
3889 idlwave-outlawed-buffers))))
3892 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3895 entry)
3909 "Remove BUFFER from the buffers which may be killed.
3910 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3911 Intended for `after-save-hook'."
3914 ;; Revoke license
3918 ;; Remove this function from the hook.
3923 ;; Find FILE on the scanned lib path and return a buffer visiting it
3925 dir efile)
3933 ;; Find FILE on the scanned lib path and return a buffer visiting it
3934 ;; This is for, e.g., finding source with no user catalog
3941 "Creates the IDL tags file IDLTAGS in the current directory from
3942 the list of directories specified in the minibuffer. Directories may be
3943 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
3944 specified top directories are searched if the directory name is prefixed
3945 by @. Specify @ directories with care, it may take a long, long time if
3946 you specify /."
3949 buffer save_buffer files numfiles item errbuf)
3951 ;;
3952 ;; Read list of directories
3955 ;;
3956 ;; Set etags command, vars
3962 ;;
3963 ;; For each directory
3967 ;;
3968 ;; Find the subdirectories
3990 ;;
3991 ;; For each subdirectory
3995 ;;
3996 ;; Call etags
4005 0
4007 ;;
4008 ;; Append additional tags
4015 )))
4027 ))
4030 "Comment the lines in the region if the first non-blank line is
4031 commented, and conversely, uncomment region. If optional prefix arg
4032 N is non-nil, then for N positive, add N comment delimiters or for N
4033 negative, remove N comment delimiters.
4034 Uses `comment-region' which does not place comment delimiters on
4035 blank lines."
4042 ;; skip blank lines
4054 ;; ----------------------------------------------------------------------------
4055 ;; ----------------------------------------------------------------------------
4056 ;; ----------------------------------------------------------------------------
4057 ;; ----------------------------------------------------------------------------
4058 ;;
4059 ;; Completion and Routine Info
4060 ;;
4062 ;; String "intern" functions
4064 ;; For the completion and routine info function, we want to normalize
4065 ;; the case of procedure names etc. We do this by "interning" these
4066 ;; string is a hand-crafted way. Hashes are used to map the downcase
4067 ;; version of the strings to the cased versions. Most *-sint-*
4068 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4069 ;; system hash. The former is re-scanned, and the latter takes case
4070 ;; precedence.
4071 ;;
4072 ;; Since these cased versions are really lisp objects, we can use `eq'
4073 ;; to search, which is a large performance boost. All new strings
4074 ;; need to be "sinterned". We do this as early as possible after
4075 ;; getting these strings from completion or buffer substrings. So
4076 ;; most of the code can simply assume to deal with "sinterned"
4077 ;; strings. The only exception is that the functions which scan whole
4078 ;; buffers for routine information do not intern the grabbed strings.
4079 ;; This is only done afterwards. Therefore in these functions it is
4080 ;; *not* safe to assume the strings can be compared with `eq' and be
4081 ;; fed into the routine assq functions.
4083 ;; Here we define the hashing functions.
4085 ;; The variables which hold the hashes.
4094 "Reset all sintern hashes."
4095 ;; Make sure the hash functions are accessible.
4107 ;; Make sure these are lists
4114 ;; Reset the system & library hash
4120 idlwave-sint-libnames nil))
4124 ;; Reset the buffer & shell hash
4138 ;;(defmacro idlwave-sintern (type var)
4139 ;; `(cond ((not (stringp name)) name)
4140 ;; ((gethash (downcase name) (cdr ,var)))
4141 ;; ((gethash (downcase name) (car ,var)))
4142 ;; (set (idlwave-sintern-set name ,type ,var set))
4143 ;; (name)))
4183 iname))
4186 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4190 kwd-list)
4193 "Sintern all strings in the rinfo LIST. With optional parameter
4194 SET: also set new patterns. Probably this will always have to be t.
4195 If DEFAULT-DIR is passed, it is used as the base of the directory"
4207 ;; The class and name
4215 ;; The source
4228 ;; The keywords
4231 kwds))
4233 ;; Build a canonicalized list
4238 ;; Creating new sintern tables
4241 "Define a variable and a function to sintern the new type TAG.
4242 This defines the function `idlwave-sintern-TAG' and the variable
4243 `idlwave-sint-TAGs'."
4255 name)
4259 "Reset the sintern variable associated with TAG."
4262 ;;---------------------------------------------------------------------------
4265 ;; The variables which hold the information
4281 "Alist with !PATH directories and zero or more flags if the dir has
4282 been scanned in a user catalog ('user) or discovered in a library
4298 ;;
4299 ;; The code to get routine info from different sources.
4306 "Provide a list of IDL routines.
4307 This routine loads the builtin routines on the first call. Later it
4308 only returns the value of the variable."
4318 ;; Keep it running...
4319 )
4321 ;; Something is wrong, get rid of the process
4330 ;; return the current value
4331 idlwave-routines)))
4334 "List of functions which should run after a global rinfo update.
4338 "Rescan the previously selected directories. For batch processing."
4342 "Dispatch another emacs instance to update the idlwave catalog.
4343 After the process finishes normally, the first access to routine info
4344 will re-read the catalog."
4368 nil emacs args)))
4371 process
4375 idlwave-system-routines nil
4376 idlwave-catalog-process nil)
4382 ;; Format for all routine info user catalog, library catalogs, etc.:
4383 ;;
4384 ;; ("ROUTINE" type class
4385 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4386 ;; (buffer pro_file dir) | (compiled pro_file dir)
4387 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...)))
4388 ;;
4389 ;; DIR will be supplied dynamically while loading library catalogs,
4390 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4391 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4392 ;; be nil, as can LINK1, etc., if no HTML help is available.
4399 "Update the internal routine-info lists.
4402 about individual routines.
4404 The information can come from 4 sources:
4405 1. IDL programs in the current editing session
4406 2. Compiled modules in an IDL shell running as Emacs subprocess
4407 3. A list which covers the IDL system routines.
4408 4. A list which covers the prescanned library files.
4410 Scans all IDLWAVE-mode buffers of the current editing session (see
4411 `idlwave-scan-all-buffers-for-routine-info').
4412 When an IDL shell is running, this command also queries the IDL program
4413 for currently compiled routines.
4415 With prefix ARG, also reload the system and library lists.
4416 With two prefix ARG's, also rescans the chosen user catalog tree.
4417 With three prefix args, dispatch asynchronous process to do the update.
4419 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4420 lists, but instead wait for the shell query to complete and
4421 asynchronously finish updating routine info. This is set
4422 automatically when called interactively. When you need routine
4423 information updated immediately, leave NO-CONCATENATE nil."
4425 ;; Stop any idle processing
4433 ;; Start a background process which updates the catalog.
4436 ;; Update the user catalog now, and wait for them.
4440 idlwave-buffer-case-takes-precedence
4442 ;; The override-idle means, even if the idle timer has done some
4443 ;; preparing work, load and renormalize everything anyway.
4447 idlwave-compiled-routines nil
4448 idlwave-unresolved-routines nil)
4449 ;; Reset the appropriate hashes
4451 ;; reset was already done in idle time, so skip this step now once
4458 ;; We can safely scan the buffer stuff first
4462 ;; We first do the system info, and then the buffers
4466 ;; Let's see if there is a shell
4470 idlwave-query-shell-for-routine-info)))
4472 ;; Load the library catalogs again, first re-scanning the path
4484 ;; 1. If we are not going to ask the shell, we need to do the
4485 ;; concatenation now.
4486 ;; 2. When this function is called non-interactively, it
4487 ;; means that someone needs routine info *now*. The
4488 ;; shell update causes the concatenation to be
4489 ;; *delayed*, so not in time for the current command.
4490 ;; Therefore, we do a concatenation now, even though
4491 ;; the shell might do it again.
4495 ;; Ask the shell about the routines it knows of.
4518 idlwave-init-rinfo-when-idle-after
4550 ;; Check for the old style catalog and warn
4553 idlwave-library-routines)
4558 idlwave-user-catalog-file))
4582 ;; restart the timer
4587 idlwave-init-rinfo-when-idle-after
4591 ;; Load and case-treat the system and catalog files.
4628 ;; Scan all buffers, current buffer last
4633 ;; Don't scan any buffers
4636 ;; Just scan this buffer
4642 ;; Put the result into the correct variable
4647 "Put the different sources for routine information together."
4648 ;; The sequence here is important because earlier definitions shadow
4649 ;; later ones. We assume that if things in the buffers are newer
4650 ;; then in the shell of the system, they are meant to be different.
4653 idlwave-compiled-routines
4654 idlwave-library-catalog-routines
4655 idlwave-user-catalog-routines))
4658 ;; Give a message with information about the number of routines we have.
4661 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
4671 "Return the class alist - make it if necessary."
4678 idlwave-class-alist)))
4680 ;; Three functions for the hooks
4689 "Update idlwave-routines for current buffer. Can run from after-save-hook."
4693 idlwave-scan-all-buffers-for-routine-info
4694 idlwave-routines)
4700 nil
4706 routines)
4710 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
4712 found)
4714 ;; The following test uses eq to make sure it works correctly
4715 ;; when two buffers visit the same file. Then the file names
4716 ;; will be equal, but not eq.
4722 ;; End of that section reached. Jump.
4728 ;;----- Scanning buffers -------------------
4731 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
4737 buffer-file-name)
4738 ;; yes, this buffer has the right mode.
4743 ;; Concatenate the individual lists and return the result
4747 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
4749 routine-list string entry)
4763 routine-list))
4767 "Parse a module definition."
4769 start name args type keywords class)
4770 ;; Remove comments
4773 ;; Remove the continuation line stuff
4778 ;; Match the name and type.
4786 ;; Match normal args and keyword args
4789 string start)
4794 ;; Normalize and sort.
4798 ;; Make and return the entry
4799 ;; We don't know which argument are optional, so this information
4800 ;; will not be contained in the calling sequence.
4803 class
4806 ; ((string= (downcase
4807 ; (file-name-sans-extension
4808 ; (file-name-nondirectory (buffer-file-name))))
4809 ; (downcase name))
4810 ; (list 'lib))
4811 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
4817 "%s"
4825 nil))))
4828 ;;----- Scanning the user catalog -------------------
4831 "Return the syslib directory, or a dummy that never matches."
4835 idlwave-system-directory)
4842 "Scan all files on selected dirs of IDL search path for routine information.
4844 A widget checklist will allow you to choose the directories. Write
4845 the result as a file `idlwave-user-catalog-file'. When this file
4846 exists, will be automatically loaded to give routine information about
4847 library routines. With ARG, just rescan the same directories as last
4848 time - so no widget will pop up."
4850 ;; Make sure the file is loaded if it exists.
4856 ;; Make sure the file name makes sense
4862 idlwave-user-catalog-file))))
4866 ;; Rescan the known directories
4871 ;; Expand the directories from library-path and run the widget
4875 ;; Propagate any flags on the existing path-alist
4878 idlwave-true-path-alist)))
4885 ;; Ask the shell for the path and then run the widget
4894 ;; Parse shell path information and select among it.
4896 ;; Command hook used by `idlwave-create-user-catalog-file'.
4898 ;; Scan immediately
4900 ;; Set the path and display the widget
4906 "This is the front-end to the creation of the IDLWAVE user catalog.
4907 Please select the directories on IDL's search path from which you
4908 would like to extract routine information, to be stored in the file:
4910 %s
4912 If this is not the correct file, first set variable
4913 `idlwave-user-catalog-file', and call this command again.
4915 N.B. Many libraries include pre-scanned catalog files
4917 not be scanned. You can scan your own libraries off-line using the
4918 perl script `idlwave_catalog'.
4920 After selecting the directories, choose [Scan & Save] to scan the library
4921 directories and save the routine info.
4927 "Create the widget to select IDL search path directories for scanning."
4939 idlwave-user-catalog-file))
4950 :notify
4956 path-list)
4961 :notify
4966 path-list)
4980 'checklist
4984 dirs-list))
4985 :greedy t
5007 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
5012 dir-entry)
5018 selected-dirs)
5025 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5029 dirs-alist dir files file)
5031 idlwave-path-alist path-alist ; for library-path instead
5032 idlwave-true-path-alist nil)
5054 idlwave-user-catalog-routines)))))))))
5062 font-lock-mode)
5068 ;; Define the routine info list
5075 idlwave-user-catalog-routines))
5079 ;; Save the buffer
5085 idlwave-user-catalog-file)
5103 font-lock-mode)
5108 ;; Define the variable which knows the value of "!DIR"
5110 idlwave-system-directory))
5112 ;; Define the variable which contains a list of all scanned directories
5119 idlwave-path-alist))
5126 ;; Expand parts of path starting with '+' recursively into directory list.
5127 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5137 ;; Expand recursively
5139 ;; Keep unchanged
5145 ;; Return a list of all directories below DIR, including DIR itself
5154 path1))
5157 ;;----- Scanning the library catalogs ------------------
5163 "Scan for library catalog files (.idlwave_catalog) and ingest.
5165 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5166 instead, if present) are searched. Print MESSAGE-BASE along with the
5167 libraries being loaded, if passed, and skip loading/normalizing if
5168 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5169 be set to nil to disable library catalog scanning."
5176 dir-entry dir flags catalog all-routines)
5184 ;; Load the catalog file
5189 message-base
5191 old-libname)))
5193 idlwave-library-catalog-libname))
5200 all-routines))))
5202 ;; Add a 'lib flag if on path-alist
5209 ;;----- Communicating with the Shell -------------------
5211 ;; First, here is the idl program which can be used to query IDL for
5212 ;; defined routines.
5214 "
5215 ;; START OF IDLWAVE SUPPORT ROUTINES
5216 pro idlwave_print_info_entry,name,func=func,separator=sep
5217 ;; See if it's an object method
5218 if name eq '' then return
5219 func = keyword_set(func)
5220 methsep = strpos(name,'::')
5221 meth = methsep ne -1
5223 ;; Get routine info
5224 pars = routine_info(name,/parameters,functions=func)
5225 source = routine_info(name,/source,functions=func)
5226 nargs = pars.num_args
5227 nkw = pars.num_kw_args
5228 if nargs gt 0 then args = pars.args
5229 if nkw gt 0 then kwargs = pars.kw_args
5231 ;; Trim the class, and make the name
5232 if meth then begin
5233 class = strmid(name,0,methsep)
5234 name = strmid(name,methsep+2,strlen(name)-1)
5235 if nargs gt 0 then begin
5236 ;; remove the self argument
5237 wh = where(args ne 'SELF',nargs)
5238 if nargs gt 0 then args = args[wh]
5239 endif
5240 endif else begin
5241 ;; No class, just a normal routine.
5243 endelse
5245 ;; Calling sequence
5247 if func then cs = 'Result = '
5248 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5249 cs = cs + '%s'
5250 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5251 if nargs gt 0 then begin
5252 for j=0,nargs-1 do begin
5253 cs = cs + args[j]
5254 if j lt nargs-1 then cs = cs + ', '
5255 endfor
5256 end
5257 if func then cs = cs + ')'
5258 ;; Keyword arguments
5259 kwstring = ''
5260 if nkw gt 0 then begin
5261 for j=0,nkw-1 do begin
5262 kwstring = kwstring + ' ' + kwargs[j]
5263 endfor
5264 endif
5266 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5268 print,ret + ': ' + name + sep + class + sep + source[0].path $
5269 + sep + cs + sep + kwstring
5270 end
5272 pro idlwave_routine_info
5273 on_error,1
5274 sep = '<@>'
5276 all = routine_info()
5277 for i=0,n_elements(all)-1 do $
5278 idlwave_print_info_entry,all[i],separator=sep
5279 all = routine_info(/functions)
5280 for i=0,n_elements(all)-1 do $
5281 idlwave_print_info_entry,all[i],/func,separator=sep
5282 print,'>>>END OF IDLWAVE ROUTINE INFO'
5283 end
5285 pro idlwave_get_sysvars
5286 on_error,1
5287 catch,error_status
5288 if error_status ne 0 then begin
5289 print, 'Cannot get info about system variables'
5290 endif else begin
5291 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5292 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5293 v = strsplit(s,' +',/regex,/extract) ; get variables
5294 for i=0,n_elements(v)-1 do begin
5295 t = [''] ; get tag list
5296 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5297 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5298 endfor
5299 endelse
5300 end
5302 pro idlwave_get_class_tags, class
5303 res = execute('tags=tag_names({'+class+'})')
5304 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5305 end
5306 ;; END OF IDLWAVE SUPPORT ROUTINES
5307 "
5316 "Query the shell for routine_info of compiled modules and update the lists."
5317 ;; Save and compile the procedure. The compiled procedure is then
5318 ;; saved into an IDL SAVE file, to allow for fast RESTORE.
5319 ;; We need to RESTORE the procedure each time we use it, since
5320 ;; the user may have killed or redefined it. In particular,
5321 ;; .RESET_SESSION will kill all user procedures.
5333 ; (message "SENDING SAVE") ; ????????????????????????
5335 (format "save,'idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5339 ;; Restore and execute the procedure, analyze the output
5340 ; (message "SENDING RESTORE & EXECUTE") ; ????????????????????????
5343 idlwave-shell-temp-rinfo-save-file)
5349 ;; ---------------------------------------------------------------------------
5350 ;;
5351 ;; Completion and displaying routine calling sequences
5359 "Complete a function, procedure or keyword name at point.
5360 This function is smart and figures out what can be completed
5361 at this point.
5362 - At the beginning of a statement it completes procedure names.
5363 - In the middle of a statement it completes function names.
5364 - after a `(' or `,' in the argument list of a function or procedure,
5365 it completes a keyword of the relevant function or procedure.
5366 - In the first arg of `OBJ_NEW', it completes a class name.
5368 When several completions are possible, a list will be displayed in the
5369 *Completions* buffer. If this list is too long to fit into the
5370 window, scrolling can be achieved by repeatedly pressing
5373 The function also knows about object methods. When it needs a class
5374 name, the action depends upon `idlwave-query-class', which see. You
5375 can force IDLWAVE to ask you for a class name with a
5378 See also the variables `idlwave-keyword-completion-adds-equal' and
5379 `idlwave-function-completion-adds-paren'.
5381 The optional ARG can be used to specify the completion type in order
5382 to override IDLWAVE's idea of what should be completed at point.
5383 Possible values are:
5385 0 <=> query for the completion type
5386 1 <=> 'procedure
5387 2 <=> 'procedure-keyword
5388 3 <=> 'function
5389 4 <=> 'function-keyword
5390 5 <=> 'procedure-method
5391 6 <=> 'procedure-method-keyword
5392 7 <=> 'function-method
5393 8 <=> 'function-method-keyword
5394 9 <=> 'class
5396 As a special case, the universal argument C-u forces completion of
5397 function names in places where the default would be a keyword.
5399 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5400 completion.
5402 For Lisp programmers only:
5403 When we force a keyword, optional argument MODULE can contain the module name.
5404 When we force a method or a method keyword, CLASS can specify the class."
5431 ;; Complete a filename in quotes
5436 ;; Check for any special completion functions
5443 ;; Complete a class
5449 ;; Complete a procedure name
5462 isa
5468 isa
5472 ;; Complete a function name
5485 isa
5491 isa
5499 ;; Complete a procedure keyword
5516 super-classes system))
5528 isa
5532 ;; Complete a function keyword
5545 msg-name)
5550 super-classes system))
5551 ;; OBJ_NEW: Messages mention the proper Init method
5558 msg-name))
5567 isa
5573 "List of special completion functions.
5574 These functions are called for each completion. Each function must
5575 check if its own special completion context is present. If yes, it
5576 should use `idlwave-complete-in-buffer' to do some completion and
5577 return t. If such a function returns t, *no further* attempts to
5578 complete other contexts will be done. If the function returns nil,
5583 fun ret)
5588 nil)))
5591 ;; Return an artificial WHERE specification to force the completion
5592 ;; routine to complete a specific item independent of context.
5593 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
5594 ;; MODULE and CLASS can be used to specify the routine name and class.
5595 ;; The class name will also be found in MODULE if that is like "class::mod".
5613 what)
5686 ;; Completing read, case insensitive
5696 "Use the comint stuff to complete a file name."
5704 idlwave-shell-default-directory
5705 default-directory)))
5709 ;; Make a fully qualified module name including the class name
5713 "Like `idlwave-rinfo-assq', but sintern strings first."
5719 ;; Works like assq, but also checks type and class
5730 ;; Return the first matching method on the inheritance list
5732 class rtn)
5736 rtn))
5739 keep-system)
5740 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
5741 If WITH-FILE is passed, find the best rinfo entry with a file
5742 included. If KEEP-SYSTEM is set, don't prune system for compiled
5743 syslib files."
5746 list))
5747 syslibp)
5754 ;; Its a compiled syslib, so we need to remove the system entry
5760 twins)))))
5764 keep-system)
5765 "Like `idlwave-best-rinfo-assq', but sintern strings first."
5771 "Does the entry list ENTRIES contain a syslib entry?
5772 If yes, return the index (>=1)."
5781 nil)))
5784 "Return a list of all associations of Key in LIST."
5792 "Return all classes which have a method METHOD. TYPE is 'fun or 'pro.
5793 When TYPE is not specified, both procedures and functions will be considered."
5806 "Return all classes which have a method METHOD with keyword KEYWORD.
5807 TYPE is 'fun or 'pro.
5808 When TYPE is not specified, both procedures and functions will be considered."
5811 nil
5823 "Return list of all elements in LIST which are also in CLUB."
5832 "Return list of all elements in LIST which are not in CLUB."
5836 nil
5842 "Return whether or not the class is listed explicitly, ala a->b::c.
5843 INFO is as returned by idlwave-what-function or -procedure."
5850 "List of special functions for determining class.
5854 ;; Determine the class of a routine call.
5855 ;; INFO is the `cw-list' structure as returned by idlwave-where.
5856 ;; The second element in this structure is the class. When nil, we
5857 ;; return nil. When t, try to get the class from text properties at
5858 ;; the arrow. When the object is "self", we use the class of the
5859 ;; current routine. otherwise prompt the user for a class name.
5860 ;; Also stores the selected class as a text property at the arrow.
5861 ;; TYPE is 'fun or 'pro.
5867 idlwave-query-class))
5869 idlwave-query-class))
5881 store special-class class-alist)
5885 ;; There is an object which would like to know its class
5887 idlwave-store-inquired-class
5894 ;; Before prompting, try any special class determination routines
5896 idlwave-determine-class-special
5902 store idlwave-store-inquired-class)))
5904 ;; Prompt for a class, if we need to
5925 ;; Store it, if requested
5927 ;; We have a real class here
5933 rear-nonsticky t))
5936 ;; Return the class
5937 class)
5938 ;; Default as fallback
5952 ;; Record a file link, if any, for the tested names during selection.
5956 sel))
5960 "Find out where we are.
5961 The return value is a list with the following stuff:
5962 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
5964 PRO-LIST (PRO POINT CLASS ARROW)
5965 FUNC-LIST (FUNC POINT CLASS ARROW)
5966 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
5967 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
5968 be completed here.
5969 LAST-CHAR last relevant character before point (non-white non-comment,
5970 not part of current identifier or leading slash).
5972 In the lists, we have these meanings:
5973 PRO: Procedure name
5974 FUNC: Function name
5975 POINT: Where is this
5976 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
5977 ARROW: Location of the arrow"
5995 cw cw-mod cw-arrow cw-class cw-point)
5999 match-string)
6005 match-string))
6007 cw-arrow pro-arrow))
6009 match-string)
6010 nil)
6012 match-string)
6015 match-string)
6022 cw-class func-class cw-arrow func-arrow))
6025 cw-class pro-class cw-arrow pro-arrow))
6026 ; ((member last-char '(?\' ?\) ?\] ?!))
6027 ; ;; after these chars, a function makes no sense
6028 ; ;; FIXME: I am sure there can be more in this list
6029 ; ;; FIXME: Do we want to do this at all?
6030 ; nil)
6031 ;; Everywhere else we try a function.
6035 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t)
6039 t))))))
6042 cw
6044 last-char)))
6047 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6055 ;; Find out if point is within the argument list of a function.
6056 ;; The return value is ("function-name" class arrow-start (point) level).
6057 ;; Level is 1 on the top level parentheses, higher further down.
6059 ;; If the optional BOUND is an integer, bound backwards directed
6060 ;; searches to this point.
6064 func-point
6066 func arrow-start class)
6071 ;; move back out of the current parenthesis
6080 bound t))
6083 pos func-point)
6089 'exit
6093 arrow-start func-point cnt)))
6098 ;; Find out if point is within the argument list of a procedure.
6099 ;; The return value is ("procedure-name" class arrow-pos (point)).
6101 ;; If the optional BOUND is an integer, bound backwards directed
6102 ;; searches to this point.
6104 pro class arrow-start string)
6106 ;;(idlwave-beginning-of-statement)
6116 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6117 string))
6122 pos)
6127 arrow-start
6128 pro-point)))
6131 ;; If there is an object at point, move over it and return t.
6141 nil)
6159 nil)))
6162 "Return the last character before point which is not white or a comment
6163 and also not part of the current identifier. Since we do this in
6164 order to identify places where keywords are, we consider the initial
6165 `/' of a keyword as part of the identifier.
6166 This function is not general, can only be used for completion stuff."
6169 ;; skip the current identifier
6171 ;; also skip a leading slash which might be belong to the keyword
6174 ;; FIXME: does not check if this is a valid identifier
6182 ;; continuation line
6195 &optional prepare-display-function
6196 special-selector)
6197 "Perform TYPE completion of word before point against LIST.
6198 SELECTOR is the PREDICATE argument for the completion function. Show
6199 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6200 'procedure, 'class-tag, 'keyword, 'sysvar, etc.. SPECIAL-SELECTOR is
6201 used only once, for `all-completions', and can be used to, e.g.,
6202 accumulate information on matching completions."
6205 dpart dcompletion)
6210 ;; What is already in the buffer?
6215 idlwave-complete-after-success-form
6218 idlwave-complete-after-success-form-force
6222 ;; Try a completion
6228 idlwave-completion-help-links nil)
6231 ;; nothing available.
6235 ;; We can add something
6239 idlwave-complete-empty-string-as-lower-case)
6244 ;; Now this is a unique match
6246 t)
6252 selector))))))
6254 ;; This is already complete
6257 nil)
6259 ;; We cannot add something - offer a list.
6267 idlwave-completion-help-links))))
6268 list))
6270 ;; "complete" means, this is already a valid completion
6273 ; (completion-fixup-function ; Emacs
6274 ; (lambda () (and (eq (preceding-char) ?>)
6275 ; (re-search-backward " <" beg t)))))
6283 idlwave-complete-empty-string-as-lower-case)
6289 x)
6290 list)))
6292 t))))
6295 "Complete a class at point."
6297 ;; Call `idlwave-routines' to make sure the class list will be available
6299 ;; Check for the special case of completing empty string after pro/function
6308 ;; Yank the full class specification
6310 ;; Do the completion, using list gathered from `idlwave-routines'
6319 idlwave-completion-help-links))
6320 x))
6321 list)))))
6324 ;; Attach the proper class list to a LIST of completion items.
6325 ;; TYPE, when 'kwd, shows classes for method keywords, when
6326 ;; 'class-tag, for class tags, and otherwise for methods.
6327 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6333 ;; In these cases, we do not have to do anything
6334 list
6338 ;; (do-dots (featurep 'xemacs))
6344 classes nclasses class-info space)
6347 ;; get the classes
6349 ;; Just one class for tags
6353 ;; Multiple classes for method or method-keyword
6357 method-selector x type-selector)
6363 classes)))))
6365 ;; Make the separator between item and class-info
6370 ;; We do want info in the buffer
6373 space
6378 ;; We do want properties
6382 x))
6385 x))
6386 list))))
6389 ;; Call idlwave-attach-classes with method parameters
6392 ;; Call idlwave-attach-classes with keyword parameters
6395 ;; Call idlwave-attach-classes with class structure tags
6399 ;;----------------------------------------------------------------------
6400 ;;----------------------------------------------------------------------
6401 ;;----------------------------------------------------------------------
6402 ;;----------------------------------------------------------------------
6403 ;;----------------------------------------------------------------------
6409 "Select an item in LIST with a popup menu.
6410 TITLE is the title to put atop the popup. If SORT is non-nil,
6411 sort the list before displaying"
6413 rtn menu resp)
6423 x)))
6424 list)))
6437 rtn))
6440 "Split the MENU into submenus of maximum length N."
6442 ;; No splitting needed
6443 menu
6458 nextmenu))
6460 nextmenu nil
6465 "Split the MENU into submenus of maximum length N."
6467 ;; No splitting needed
6468 menu
6484 nextmenu))
6486 nextmenu nil
6490 menu)))
6495 "Scroll the completion window on this frame."
6513 "Display the completions in LIST in the completions buffer and echo MESSAGE."
6521 list)
6524 ;; Store a special value in `this-command'. When `idlwave-complete'
6525 ;; finds this in `last-command', it will scroll the *Completions* buffer.
6528 ;; Mark the completions buffer as created by cib
6531 ;; Fontify the classes
6536 ;; Run the hook
6539 ;; Display the message
6543 "Call FUNCTION as a completion chooser and pass ARGS to it."
6549 ;; For the shell, remove the fontification of the word before point
6564 "Restore the old (before completion) window configuration."
6566 idlwave-before-completion-wconf
6570 "Make the user select an element from the alist in the variable SYM.
6571 The keys of the alist are expected to be strings. The function returns the
6572 car of the selected association.
6573 To do this, PROMPT is displayed and and the user must hit a letter key to
6574 select an entry. If the user does not reply within DELAY seconds, a help
6575 window with the options is displayed automatically.
6576 The key which is associated with each option is generated automatically.
6578 If these don't exist, a letter in the string is automatically selected."
6582 keys-alist char)
6583 ;; First check the cache
6586 ;; Need to make new list
6590 ;; Display prompt and wait for quick reply
6595 ;; No quick reply: Show help
6601 keys-alist))
6605 ;; Return the selected result
6608 ;; Used for, e.g., electric debug super-examine.
6610 "Make an alist for single key selection."
6618 ;; First check if the configuration predetermined a key
6625 ;; Then check for capital letters
6635 t t name))
6638 ;; Now check for lowercase letters
6648 t t name))
6651 ;; Bummer, nothing found! Use a stupid number
6658 "Set the buffer-local value of VAR in BUFFER to VALUE."
6664 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
6670 ;; In XEmacs, we can use :activate-callback directly to advice the
6671 ;; choose functions. We use the private keymap only for the online
6672 ;; help feature.
6681 cl-args))
6691 "Execute `default-choose-completion' and then restore the win-conf."
6695 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
6698 (define-key new-map [button3] (lambda ()
6699 (interactive)
6700 (setq this-command last-command)))
6701 new-map))
6703 ;; In Emacs we also replace keybindings in the completion
6704 ;; map in order to install our wrappers.
6706 (defun idlwave-display-completion-list-emacs (list)
6707 "Display completion list and install the choose wrappers."
6708 (with-output-to-temp-buffer "*Completions*"
6709 (display-completion-list list))
6710 (save-excursion
6711 (set-buffer "*Completions*")
6712 (use-local-map
6713 (or idlwave-completion-map
6714 (setq idlwave-completion-map
6715 (idlwave-make-modified-completion-map-emacs
6716 (current-local-map)))))))
6718 (defun idlwave-make-modified-completion-map-emacs (old-map)
6719 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
6720 (let ((new-map (copy-keymap old-map)))
6721 (substitute-key-definition
6722 'choose-completion 'idlwave-choose-completion new-map)
6723 (substitute-key-definition
6724 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
6725 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
6726 new-map))
6728 (defun idlwave-choose-completion (&rest args)
6729 "Choose the completion that point is in or next to."
6730 (interactive)
6731 (apply 'idlwave-choose 'choose-completion args))
6733 (defun idlwave-mouse-choose-completion (&rest args)
6734 "Click on an alternative in the `*Completions*' buffer to choose it."
6735 (interactive "e")
6736 (apply 'idlwave-choose 'mouse-choose-completion args))
6738 ;;----------------------------------------------------------------------
6739 ;;----------------------------------------------------------------------
6741 ;;; ------------------------------------------------------------------------
6742 ;;; Stucture parsing code, and code to manage class info
6744 ;;
6745 ;; - Go again over the documentation how to write a completion
6746 ;; plugin. It is in self.el, but currently still very bad.
6747 ;; This could be in a separate file in the distribution, or
6748 ;; in an appendix for the manual.
6750 (defvar idlwave-struct-skip
6752 "Regexp for skipping continued blank or comment-only lines in
6753 structures")
6755 (defvar idlwave-struct-tag-regexp
6756 (concat "[{,]" ;leading comma/brace
6757 idlwave-struct-skip ; 4 groups
6760 "Regexp for structure tags.")
6762 (defun idlwave-struct-tags ()
6763 "Return a list of all tags in the structure defined at point.
6764 Point is expected just before the opening `{' of the struct definition."
6765 (save-excursion
6766 (let* ((borders (idlwave-struct-borders))
6767 (beg (car borders))
6768 (end (cdr borders))
6769 tags)
6770 (goto-char beg)
6771 (save-restriction
6772 (narrow-to-region beg end)
6773 (while (re-search-forward idlwave-struct-tag-regexp end t)
6774 ;; Check if we are still on the top level of the structure.
6775 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
6776 (= (point) beg))
6777 (push (match-string-no-properties 5) tags))
6778 (goto-char (match-end 0))))
6779 (nreverse tags))))
6781 (defun idlwave-find-struct-tag (tag)
6782 "Find a given TAG in the structure defined at point."
6783 (let* ((borders (idlwave-struct-borders))
6784 (beg (car borders))
6785 (end (cdr borders))
6786 (case-fold-search t))
6788 end t)))
6790 (defun idlwave-struct-inherits ()
6791 "Return a list of all `inherits' names in the struct at point.
6792 Point is expected just before the opening `{' of the struct definition."
6793 (save-excursion
6794 (let* ((borders (idlwave-struct-borders))
6795 (beg (car borders))
6796 (end (cdr borders))
6797 (case-fold-search t)
6798 names)
6799 (goto-char beg)
6800 (save-restriction
6801 (narrow-to-region beg end)
6802 (while (re-search-forward
6803 (concat "[{,]" ;leading comma/brace
6804 idlwave-struct-skip ; 4 groups
6805 "inherits" ; The INHERITS tag
6806 idlwave-struct-skip ; 4 more
6808 end t)
6809 ;; Check if we are still on the top level of the structure.
6810 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
6811 (= (point) beg))
6812 (push (match-string-no-properties 9) names))
6813 (goto-char (match-end 0))))
6814 (nreverse names))))
6816 (defun idlwave-in-structure ()
6817 "Return t if point is inside an IDL structure definition."
6818 (let ((beg (point)))
6819 (save-excursion
6820 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
6821 (if (idlwave-find-structure-definition nil nil 'back)
6822 (let ((borders (idlwave-struct-borders)))
6823 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
6824 (and (> beg (car borders)) (< beg (cdr borders))))))))))
6826 (defun idlwave-struct-borders ()
6827 "Return the borders of the {...} after point as a cons cell."
6828 (let (beg)
6829 (save-excursion
6830 (skip-chars-forward "^{")
6831 (setq beg (point))
6832 (condition-case nil (forward-list 1)
6833 (error (goto-char beg)))
6834 (cons beg (point)))))
6836 (defun idlwave-find-structure-definition (&optional var name bound)
6837 "Search forward for a structure definition. If VAR is non-nil,
6838 search for a structure assigned to variable VAR. If NAME is non-nil,
6839 search for a named structure NAME, if a string, or a generic named
6840 structure otherwise. If BOUND is an integer, limit the search. If
6841 BOUND is the symbol `all', we search first back and then forward
6842 through the entire file. If BOUND is the symbol `back' we search only
6843 backward."
6845 (case-fold-search t)
6846 (lim (if (integerp bound) bound nil))
6847 (re (concat
6848 (if var
6852 (if name
6853 (if (stringp name)
6855 ;; Just a generic name
6857 ""))))
6858 (if (or (and (or (eq bound 'all) (eq bound 'back))
6859 (re-search-backward re nil t))
6860 (and (not (eq bound 'back)) (re-search-forward re lim t)))
6861 (progn
6862 (goto-char (match-beginning 3))
6863 (match-string-no-properties 5)))))
6865 (defvar idlwave-class-info nil)
6866 (defvar idlwave-system-class-info nil) ; Gathered from idlw-rinfo
6867 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
6869 (add-hook 'idlwave-update-rinfo-hook
6870 (lambda () (setq idlwave-class-reset t)))
6871 (add-hook 'idlwave-after-load-rinfo-hook
6872 (lambda () (setq idlwave-class-info nil)))
6874 (defun idlwave-class-info (class)
6875 (let (list entry)
6876 (if idlwave-class-info
6877 (if idlwave-class-reset
6878 (setq
6879 idlwave-class-reset nil
6880 idlwave-class-info ; Remove any visited in a buffer
6881 (delq nil (mapcar
6882 (lambda (x)
6883 (let ((filebuf
6884 (idlwave-class-file-or-buffer
6885 (or (cdr (assq 'found-in x)) (car x)))))
6886 (if (cdr filebuf)
6887 nil
6888 x)))
6889 idlwave-class-info))))
6890 ;; Info is nil, put in the system stuff to start.
6891 (setq idlwave-class-info idlwave-system-class-info)
6892 (setq list idlwave-class-info)
6893 (while (setq entry (pop list))
6894 (idlwave-sintern-class-info entry)))
6895 (setq class (idlwave-sintern-class class))
6896 (or (assq class idlwave-class-info)
6897 (progn (idlwave-scan-class-info class)
6898 (assq class idlwave-class-info)))))
6900 (defun idlwave-sintern-class-info (entry)
6901 "Sintern the class names in a class-info entry."
6902 (let ((taglist (assq 'tags entry))
6903 (inherits (assq 'inherits entry)))
6904 (setcar entry (idlwave-sintern-class (car entry) 'set))
6905 (if inherits
6906 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
6907 (cdr inherits))))))
6909 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
6910 "Find class structure definition(s)
6911 If ALL-HOOK is set, find all named structure definitions in a given
6912 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
6913 set, look for the name__define pro, and inside of it, for the ALT-CLASS
6914 class/struct definition"
6915 (let ((case-fold-search t) end-lim list name)
6916 (when (re-search-forward
6918 (if all-hook
6919 (progn
6920 ;; For everything there
6921 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
6922 (while (setq name
6923 (idlwave-find-structure-definition nil t end-lim))
6924 (funcall all-hook name)))
6925 (idlwave-find-structure-definition nil (or alt-class class))))))
6928 (defun idlwave-class-file-or-buffer (class)
6929 "Find buffer visiting CLASS definition"
6930 (let* ((pro (concat (downcase class) "__define"))
6931 (file (idlwave-routine-source-file
6932 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
6933 (idlwave-routines))))))
6934 (cons file (if file (idlwave-get-buffer-visiting file)))))
6937 (defun idlwave-scan-class-info (class)
6938 "Scan all class and named structure info in the class__define pro"
6939 (let* ((idlwave-auto-routine-info-updates nil)
6940 (filebuf (idlwave-class-file-or-buffer class))
6941 (file (car filebuf))
6942 (buf (cdr filebuf))
6943 (class (idlwave-sintern-class class)))
6944 (if (or
6945 (not file)
6946 (and ;; neither a regular file nor a visited buffer
6947 (not buf)
6948 (not (file-regular-p file))))
6949 nil ; Cannot find the file/buffer to get any info
6950 (save-excursion
6951 (if buf (set-buffer buf)
6952 ;; Read the file in temporarily
6953 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
6954 (erase-buffer)
6955 (unless (eq major-mode 'idlwave-mode)
6956 (idlwave-mode))
6957 (insert-file-contents file))
6958 (save-excursion
6959 (goto-char 1)
6960 (idlwave-find-class-definition class
6961 ;; Scan all of the structures found there
6962 (lambda (name)
6963 (let* ((this-class (idlwave-sintern-class name))
6964 (entry
6965 (list this-class
6966 (cons 'tags (idlwave-struct-tags))
6967 (cons 'inherits (idlwave-struct-inherits)))))
6968 (if (not (eq this-class class))
6969 (setq entry (nconc entry (list (cons 'found-in class)))))
6970 (idlwave-sintern-class-info entry)
6971 (push entry idlwave-class-info)))))))))
6973 (defun idlwave-class-found-in (class)
6974 "Return the FOUND-IN property of the class."
6975 (cdr (assq 'found-in (idlwave-class-info class))))
6976 (defun idlwave-class-tags (class)
6977 "Return the native tags in CLASS."
6978 (cdr (assq 'tags (idlwave-class-info class))))
6979 (defun idlwave-class-inherits (class)
6980 "Return the direct superclasses of CLASS."
6981 (cdr (assq 'inherits (idlwave-class-info class))))
6984 (defun idlwave-all-class-tags (class)
6985 "Return a list of native and inherited tags in CLASS."
6986 (condition-case err
6987 (apply 'append (mapcar 'idlwave-class-tags
6988 (cons class (idlwave-all-class-inherits class))))
6989 (error
6990 (idlwave-class-tag-reset)
6991 (error "%s" (error-message-string err)))))
6994 (defun idlwave-all-class-inherits (class)
6995 "Return a list of all superclasses of CLASS (recursively expanded).
6996 The list is cached in `idlwave-class-info' for faster access."
6997 (cond
6998 ((not idlwave-support-inheritance) nil)
6999 ((eq class nil) nil)
7000 ((eq class t) nil)
7001 (t
7002 (let ((info (idlwave-class-info class))
7003 entry)
7004 (if (setq entry (assq 'all-inherits info))
7005 (cdr entry)
7006 ;; Save the depth of inheritance scan to check for circular references
7007 (let ((inherits (mapcar (lambda (x) (cons x 0))
7008 (idlwave-class-inherits class)))
7009 rtn all-inherits cl)
7010 (while inherits
7011 (setq cl (pop inherits)
7012 rtn (cons (car cl) rtn)
7013 inherits (append (mapcar (lambda (x)
7014 (cons x (1+ (cdr cl))))
7015 (idlwave-class-inherits (car cl)))
7016 inherits))
7017 (if (> (cdr cl) 999)
7018 (error
7019 "Class scan: inheritance depth exceeded. Circular inheritance?")
7020 ))
7021 (setq all-inherits (nreverse rtn))
7022 (nconc info (list (cons 'all-inherits all-inherits)))
7023 all-inherits))))))
7025 (defun idlwave-entry-keywords (entry &optional record-link)
7026 "Return the flat entry keywords alist from routine-info entry.
7027 If RECORD-LINK is non-nil, the keyword text is copied and a text
7028 property indicating the link is added."
7029 (let (kwds)
7030 (mapcar
7031 (lambda (key-list)
7032 (let ((file (car key-list)))
7033 (mapcar (lambda (key-cons)
7034 (let ((key (car key-cons))
7035 (link (cdr key-cons)))
7036 (when (and record-link file)
7037 (setq key (copy-sequence key))
7038 (put-text-property
7039 0 (length key)
7040 'link
7041 (concat
7042 file
7043 (if link
7044 (concat idlwave-html-link-sep
7045 (number-to-string link))))
7046 key))
7047 (push (list key) kwds)))
7048 (cdr key-list))))
7049 (nthcdr 5 entry))
7050 (nreverse kwds)))
7052 (defun idlwave-entry-find-keyword (entry keyword)
7053 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set"
7054 (catch 'exit
7055 (mapc
7056 (lambda (key-list)
7057 (let ((file (car key-list))
7058 (kwd (assoc keyword (cdr key-list))))
7059 (when kwd
7060 (setq kwd (cons (car kwd)
7061 (if (and file (cdr kwd))
7062 (concat file
7063 idlwave-html-link-sep
7064 (number-to-string (cdr kwd)))
7065 (cdr kwd))))
7066 (throw 'exit kwd))))
7067 (nthcdr 5 entry))))
7069 ;;==========================================================================
7070 ;;
7071 ;; Completing class structure tags. This is a completion plugin.
7072 ;; The necessary taglist is constructed dynamically
7074 (defvar idlwave-current-tags-class nil)
7075 (defvar idlwave-current-class-tags nil)
7076 (defvar idlwave-current-native-class-tags nil)
7077 (defvar idlwave-sint-class-tags nil)
7078 (idlwave-new-sintern-type 'class-tag)
7079 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7080 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7082 (defun idlwave-complete-class-structure-tag ()
7083 "Complete a structure tag on a `self' argument in an object method."
7084 (interactive)
7085 (let ((pos (point))
7086 (case-fold-search t))
7087 (if (save-excursion
7088 ;; Check if the context is right
7089 (skip-chars-backward "a-zA-Z0-9._$")
7090 (and (< (point) (- pos 4))
7092 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7093 (super-classes (idlwave-all-class-inherits class-selector)))
7094 ;; Check if we are in a class routine
7095 (unless class-selector
7096 (error "Not in a method procedure or function"))
7097 ;; Check if we need to update the "current" class
7098 (if (not (equal class-selector idlwave-current-tags-class))
7099 (idlwave-prepare-class-tag-completion class-selector))
7100 (setq idlwave-completion-help-info
7101 (list 'idlwave-complete-class-structure-tag-help
7102 (idlwave-sintern-routine
7103 (concat class-selector "__define"))
7104 nil))
7105 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7106 (idlwave-complete-in-buffer
7107 'class-tag 'class-tag
7108 idlwave-current-class-tags nil
7109 (format "Select a tag of class %s" class-selector)
7110 "class tag"
7111 'idlwave-attach-class-tag-classes))
7112 t) ; return t to skip other completions
7113 nil)))
7115 (defun idlwave-class-tag-reset ()
7116 (setq idlwave-current-tags-class nil))
7118 (defun idlwave-prepare-class-tag-completion (class)
7119 "Find and parse the necessary class definitions for class structure tags."
7120 (setq idlwave-sint-class-tags nil)
7121 (setq idlwave-current-tags-class class)
7122 (setq idlwave-current-class-tags
7123 (mapcar (lambda (x)
7124 (list (idlwave-sintern-class-tag x 'set)))
7125 (idlwave-all-class-tags class)))
7126 (setq idlwave-current-native-class-tags
7127 (mapcar 'downcase (idlwave-class-tags class))))
7129 ;===========================================================================
7130 ;;
7131 ;; Completing system variables and their structure fields
7132 ;; This is also a plugin.
7134 (defvar idlwave-sint-sysvars nil)
7135 (defvar idlwave-sint-sysvartags nil)
7136 (idlwave-new-sintern-type 'sysvar)
7137 (idlwave-new-sintern-type 'sysvartag)
7138 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7139 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7140 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7142 (defvar idlwave-executive-commands-alist nil
7143 "Alist of system variables and their help files.")
7145 (defvar idlwave-system-variables-alist nil
7146 "Alist of system variables and the associated structure tags.
7147 Gets set in `idlw-rinfo.el'.")
7149 (defun idlwave-complete-sysvar-or-tag ()
7150 "Complete a system variable."
7151 (interactive)
7152 (let ((pos (point))
7153 (case-fold-search t))
7154 (cond ((save-excursion
7155 ;; Check if the context is right for system variable
7156 (skip-chars-backward "[a-zA-Z0-9_$]")
7157 (equal (char-before) ?!))
7158 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7159 (idlwave-complete-in-buffer 'sysvar 'sysvar
7160 idlwave-system-variables-alist nil
7161 "Select a system variable"
7162 "system variable")
7163 t) ; return t to skip other completions
7164 ((save-excursion
7165 ;; Check if the context is right for sysvar tag
7166 (skip-chars-backward "a-zA-Z0-9_$.")
7167 (and (equal (char-before) ?!)
7169 (<= (match-end 0) pos)))
7170 ;; Complete a system variable tag
7171 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7172 (entry (assq var idlwave-system-variables-alist))
7173 (tags (cdr (assq 'tags entry))))
7174 (or entry (error "!%s is not a known system variable" var))
7175 (or tags (error "System variable !%s is not a structure" var))
7176 (setq idlwave-completion-help-info
7177 (list 'idlwave-complete-sysvar-tag-help var))
7178 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7179 tags nil
7180 "Select a system variable tag"
7181 "system variable tag")
7182 t)) ; return t to skip other completions
7183 (t nil))))
7185 (defvar link) ;dynamic
7186 (defun idlwave-complete-sysvar-help (mode word)
7187 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7188 (entry (assoc word idlwave-system-variables-alist)))
7189 (cond
7190 ((eq mode 'test)
7191 (and (stringp word) entry (nth 1 (assq 'link entry))))
7192 ((eq mode 'set)
7193 (if entry (setq link (nth 1 (assq 'link entry))))) ;; setting dynamic!!!
7194 (t (error "This should not happen")))))
7196 (defun idlwave-complete-sysvar-tag-help (mode word)
7197 (let* ((var (nth 1 idlwave-completion-help-info))
7198 (entry (assoc var idlwave-system-variables-alist))
7199 (tags (cdr (assq 'tags entry)))
7200 (main (nth 1 (assq 'link entry)))
7201 target main-base)
7202 (cond
7203 ((eq mode 'test) ; we can at least link the main
7204 (and (stringp word) entry main))
7205 ((eq mode 'set)
7206 (if entry
7207 (setq link
7208 (if (setq target (cdr (assoc word tags)))
7209 (idlwave-substitute-link-target main target)
7210 main)))) ;; setting dynamic!!!
7211 (t (error "This should not happen")))))
7213 (defun idlwave-substitute-link-target (link target)
7214 "Substitute the target anchor for the given link."
7215 (let (main-base)
7216 (setq main-base (if (string-match "#" link)
7217 (substring link 0 (match-beginning 0))
7218 link))
7219 (if target
7220 (concat main-base idlwave-html-link-sep (number-to-string target))
7221 link)))
7223 ;; Fake help in the source buffer for class structure tags.
7224 ;; KWD AND NAME ARE GLOBAL-VARIABLES HERE.
7225 (defvar name)
7226 (defvar kwd)
7227 (defvar idlwave-help-do-class-struct-tag nil)
7228 (defun idlwave-complete-class-structure-tag-help (mode word)
7229 (cond
7230 ((eq mode 'test) ; nothing gets fontified for class tags
7231 nil)
7232 ((eq mode 'set)
7233 (let (class-with found-in)
7234 (when (setq class-with
7235 (idlwave-class-or-superclass-with-tag
7236 idlwave-current-tags-class
7237 word))
7238 (if (assq (idlwave-sintern-class class-with)
7239 idlwave-system-class-info)
7240 (error "No help available for system class tags"))
7241 (if (setq found-in (idlwave-class-found-in class-with))
7242 (setq name (cons (concat found-in "__define") class-with))
7243 (setq name (concat class-with "__define")))))
7244 (setq kwd word
7245 idlwave-help-do-class-struct-tag t))
7246 (t (error "This should not happen"))))
7248 (defun idlwave-class-or-superclass-with-tag (class tag)
7249 "Find and return the CLASS or one of its superclass with the
7250 associated TAG, if any."
7251 (let ((sclasses (cons class (cdr (assq 'all-inherits
7252 (idlwave-class-info class)))))
7253 cl)
7254 (catch 'exit
7255 (while sclasses
7256 (setq cl (pop sclasses))
7257 (let ((tags (idlwave-class-tags cl)))
7258 (while tags
7259 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7260 (throw 'exit cl))
7261 (setq tags (cdr tags))))))))
7264 (defun idlwave-sysvars-reset ()
7265 (if (and (fboundp 'idlwave-shell-is-running)
7266 (idlwave-shell-is-running)
7267 idlwave-idlwave_routine_info-compiled)
7268 (idlwave-shell-send-command "idlwave_get_sysvars"
7269 'idlwave-process-sysvars 'hide)))
7271 (defun idlwave-process-sysvars ()
7272 (idlwave-shell-filter-sysvars)
7273 (setq idlwave-sint-sysvars nil
7274 idlwave-sint-sysvartags nil)
7275 (idlwave-sintern-sysvar-alist))
7277 (defun idlwave-sintern-sysvar-alist ()
7278 (let ((list idlwave-system-variables-alist) entry tags)
7279 (while (setq entry (pop list))
7280 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7281 (setq tags (assq 'tags entry))
7282 (if tags
7283 (setcdr tags
7284 (mapcar (lambda (x)
7285 (cons (idlwave-sintern-sysvartag (car x) 'set)
7286 (cdr x)))
7287 (cdr tags)))))))
7289 (defvar idlwave-shell-command-output)
7290 (defun idlwave-shell-filter-sysvars ()
7291 "Get any new system variables and tags."
7292 (let ((text idlwave-shell-command-output)
7293 (start 0)
7294 (old idlwave-system-variables-alist)
7295 var tags type name class link old-entry)
7296 (setq idlwave-system-variables-alist nil)
7298 text start)
7299 (setq start (match-end 0)
7300 var (match-string 1 text)
7301 tags (if (match-end 3)
7302 (idlwave-split-string (match-string 3 text))))
7303 ;; Maintain old links, if present
7304 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7305 (setq link (assq 'link old-entry))
7306 (setq idlwave-system-variables-alist
7307 (cons (list var
7308 (cons
7309 'tags
7310 (mapcar (lambda (x)
7311 (cons x
7312 (cdr (assq
7313 (idlwave-sintern-sysvartag x)
7314 (cdr (assq 'tags old-entry))))))
7315 tags)) link)
7316 idlwave-system-variables-alist)))
7317 ;; Keep the old value if query was not successful
7318 (setq idlwave-system-variables-alist
7319 (or idlwave-system-variables-alist old))))
7321 (defun idlwave-completion-fontify-classes ()
7322 "Goto the *Completions* buffer and fontify the class info."
7323 (when (featurep 'font-lock)
7324 (save-excursion
7325 (set-buffer "*Completions*")
7326 (save-excursion
7327 (goto-char (point-min))
7328 (let ((buffer-read-only nil))
7330 (put-text-property (match-beginning 0) (match-end 0)
7331 'face 'font-lock-string-face)))))))
7333 (defun idlwave-uniquify (list)
7334 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7335 (delq nil
7336 (mapcar (lambda (x)
7337 (unless (gethash x ht)
7338 (puthash x t ht)
7339 x))
7340 list))))
7342 (defun idlwave-after-successful-completion (type slash &optional verify)
7343 "Add `=' or `(' after successful completion of keyword and function.
7344 Restore the pre-completion window configuration if possible."
7345 (cond
7346 ((eq type 'procedure)
7347 nil)
7348 ((eq type 'function)
7349 (cond
7350 ((equal idlwave-function-completion-adds-paren nil) nil)
7351 ((or (equal idlwave-function-completion-adds-paren t)
7352 (equal idlwave-function-completion-adds-paren 1))
7353 (insert "("))
7354 ((equal idlwave-function-completion-adds-paren 2)
7355 (insert "()")
7356 (backward-char 1))
7357 (t nil)))
7358 ((eq type 'keyword)
7359 (if (and idlwave-keyword-completion-adds-equal
7360 (not slash))
7361 (progn (insert "=") t)
7362 nil)))
7364 ;; Restore the pre-completion window configuration if this is safe.
7366 (if (or (eq verify 'force) ; force
7367 (and
7368 (get-buffer-window "*Completions*") ; visible
7369 (idlwave-local-value 'idlwave-completion-p
7370 "*Completions*") ; cib-buffer
7371 (eq (marker-buffer idlwave-completion-mark)
7372 (current-buffer)) ; buffer OK
7373 (equal (marker-position idlwave-completion-mark)
7374 verify))) ; pos OK
7375 (idlwave-restore-wconf-after-completion))
7376 (move-marker idlwave-completion-mark nil)
7377 (setq idlwave-before-completion-wconf nil))
7379 (defun idlwave-mouse-context-help (ev &optional arg)
7380 "Call `idlwave-context-help' on the clicked location."
7381 (interactive "eP")
7382 (mouse-set-point ev)
7383 (idlwave-context-help arg))
7385 (defvar idlwave-last-context-help-pos nil)
7386 (defun idlwave-context-help (&optional arg)
7387 "Display IDL Online Help on context.
7388 If point is on a keyword, help for that keyword will be shown. If
7389 point is on a routine name or in the argument list of a routine, help
7390 for that routine will be displayed. Works for system routines and
7391 keywords, it pulls up text help. For other routies and keywords,
7392 visits the source file, finding help in the header (if
7393 `idlwave-help-source-try-header' is non-nil) or the routine definition
7394 itself."
7395 (interactive "P")
7396 (idlwave-do-context-help arg))
7398 (defun idlwave-mouse-completion-help (ev)
7399 "Display online help about the completion at point."
7400 (interactive "eP")
7401 ;; Restore last-command for next command, to make
7402 ;; scrolling/cancelling of completions work.
7403 (setq this-command last-command)
7404 (idlwave-do-mouse-completion-help ev))
7406 (defun idlwave-routine-info (&optional arg external)
7407 "Display a routines calling sequence and list of keywords. When
7408 point is on the name a function or procedure, or in the argument list
7409 of a function or procedure, this command displays a help buffer with
7410 the information. When called with prefix arg, enforce class query.
7412 When point is on an object operator `->', display the class stored in
7413 this arrow, if any (see `idlwave-store-inquired-class'). With a
7414 prefix arg, the class property is cleared out."
7416 (interactive "P")
7417 (idlwave-routines)
7418 (if (string-match "->" (buffer-substring
7419 (max (point-min) (1- (point)))
7420 (min (+ 2 (point)) (point-max))))
7421 ;; Cursor is on an arrow
7422 (if (get-text-property (point) 'idlwave-class)
7423 ;; arrow has class property
7424 (if arg
7425 ;; Remove property
7426 (save-excursion
7427 (backward-char 1)
7429 (remove-text-properties (match-beginning 1) (match-end 1)
7430 '(idlwave-class nil face nil))
7431 (message "Class property removed from arrow")))
7432 ;; Echo class property
7433 (message "Arrow has text property identifying object to be class %s"
7434 (get-text-property (point) 'idlwave-class)))
7435 ;; No property found
7436 (message "Arrow has no class text property"))
7438 ;; Not on an arrow...
7439 (let* ((idlwave-query-class nil)
7440 (idlwave-force-class-query (equal arg '(4)))
7441 (module (idlwave-what-module)))
7442 (if (car module)
7443 (apply 'idlwave-display-calling-sequence
7444 (idlwave-fix-module-if-obj_new module))
7445 (error "Don't know which calling sequence to show")))))
7447 (defun idlwave-resolve (&optional arg)
7448 "Call RESOLVE_ROUTINE on the module name at point.
7449 Like `idlwave-routine-info', this looks for a routine call at point.
7450 After confirmation in the minibuffer, it will use the shell to issue
7451 a RESOLVE call for this routine, to attempt to make it defined and its
7452 routine info available for IDLWAVE. If the routine is a method call,
7453 both `class__method' and `class__define' will be tried.
7454 With ARG, enforce query for the class of object methods."
7455 (interactive "P")
7456 (let* ((idlwave-query-class nil)
7457 (idlwave-force-class-query (equal arg '(4)))
7458 (module (idlwave-what-module))
7459 (name (idlwave-make-full-name (nth 2 module) (car module)))
7460 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7461 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7462 (kwd "")
7463 class)
7465 resolve)
7466 (setq type (match-string 1 resolve)
7467 class (if (match-beginning 2)
7468 (match-string 3 resolve)
7469 nil)
7470 name (match-string 4 resolve)))
7471 (if (string= (downcase type) "function")
7472 (setq kwd ",/is_function"))
7474 (cond
7475 ((null class)
7476 (idlwave-shell-send-command
7477 (format "resolve_routine,'%s'%s" (downcase name) kwd)
7478 'idlwave-update-routine-info
7479 nil t))
7480 (t
7481 (idlwave-shell-send-command
7482 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
7483 (list 'idlwave-shell-send-command
7484 (format "resolve_routine,'%s__%s'%s"
7485 (downcase class) (downcase name) kwd)
7486 '(idlwave-update-routine-info)
7487 nil t))))))
7489 (defun idlwave-find-module-this-file ()
7490 (interactive)
7491 (idlwave-find-module '(4)))
7493 (defun idlwave-find-module (&optional arg)
7494 "Find the source code of an IDL module.
7495 Works for modules for which IDLWAVE has routine info available. The
7496 function offers as default the module name `idlwave-routine-info'
7497 would use. With ARG limit to this buffer. With two prefix ARG's
7498 force class query for object methods."
7499 (interactive "P")
7500 (let* ((idlwave-query-class nil)
7501 (idlwave-force-class-query (equal arg '(16)))
7502 (this-buffer (equal arg '(4)))
7503 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
7504 (default (if module
7505 (concat (idlwave-make-full-name
7506 (nth 2 module) (car module))
7507 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
7508 "none"))
7509 (list
7510 (idlwave-uniquify
7511 (delq nil
7512 (mapcar (lambda (x)
7513 (if (eq 'system (car-safe (nth 3 x)))
7514 ;; Take out system routines with no source.
7515 nil
7516 (list
7517 (concat (idlwave-make-full-name
7518 (nth 2 x) (car x))
7519 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
7520 (if this-buffer
7521 (idlwave-save-buffer-update)
7522 (idlwave-routines))))))
7523 (name (idlwave-completing-read
7524 (if (or (not this-buffer)
7525 (assoc default list))
7526 (format "Module (Default %s): " default)
7527 (format "Module in this file: "))
7528 list))
7529 type class)
7531 ;; Nothing, use the default.
7532 (setq name default))
7533 (if (string-match "<[fp]>" name)
7534 (setq type (substring name -2 -1)
7535 name (substring name 0 -3)))
7537 (setq class (match-string 1 name)
7538 name (match-string 2 name)))
7539 (setq name (idlwave-sintern-routine-or-method name class)
7540 class (idlwave-sintern-class class)
7541 type (cond ((equal type "f") 'fun)
7542 ((equal type "p") 'pro)
7543 (t t)))
7544 (idlwave-do-find-module name type class nil this-buffer)))
7546 (defun idlwave-do-find-module (name type class
7547 &optional force-source this-buffer)
7548 (let ((name1 (idlwave-make-full-name class name))
7549 source buf1 entry
7550 (buf (current-buffer))
7551 (pos (point))
7552 file name2)
7553 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
7554 'WITH-FILE)
7555 source (or force-source (nth 3 entry))
7556 name2 (if (nth 2 entry)
7557 (idlwave-make-full-name (nth 2 entry) name)
7558 name1))
7559 (if source
7560 (setq file (idlwave-routine-source-file source)))
7561 (unless file ; Try to find it on the path.
7562 (setq file
7563 (idlwave-expand-lib-file-name
7564 (if class
7565 (format "%s__define.pro" (downcase class))
7566 (format "%s.pro" (downcase name))))))
7567 (cond
7568 ((or (null name) (equal name ""))
7569 (error "Abort"))
7570 ((eq (car source) 'system)
7571 (error "Source code for system routine %s is not available"
7572 name2))
7573 ((or (not file) (not (file-regular-p file)))
7574 (error "Source code for routine %s is not available"
7575 name2))
7576 (t
7577 (when (not this-buffer)
7578 (setq buf1
7579 (idlwave-find-file-noselect file 'find))
7580 (pop-to-buffer buf1 t))
7581 (goto-char (point-max))
7582 (let ((case-fold-search t))
7583 (if (re-search-backward
7585 (cond ((eq type 'fun) "function")
7586 ((eq type 'pro) "pro")
7589 (regexp-quote (downcase name2))
7590 "[^a-zA-Z0-9_$]")
7591 nil t)
7592 (goto-char (match-beginning 0))
7593 (pop-to-buffer buf)
7594 (goto-char pos)
7595 (error "Could not find routine %s" name2)))))))
7597 (defun idlwave-what-module ()
7598 "Return a default module for stuff near point.
7599 Used by `idlwave-routine-info' and `idlwave-find-module'."
7600 (idlwave-routines)
7601 (if (let ((case-fold-search t))
7602 (save-excursion
7603 (idlwave-beginning-of-statement)
7604 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
7605 ;; This is a function or procedure definition statement
7606 ;; We return the defined routine as module.
7607 (list
7608 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
7609 (match-string-no-properties 2))
7610 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
7611 (idlwave-sintern-class (match-string 3)))
7613 ;; Not a definition statement - analyze precise position.
7614 (let* ((where (idlwave-where))
7615 (cw (nth 2 where))
7616 (pro (car (nth 0 where)))
7617 (func (car (nth 1 where)))
7618 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
7619 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
7620 (following-char)))
7621 )
7622 (cond
7623 ((and (eq cw 'procedure)
7624 (not (equal this-word "")))
7625 (setq this-word (idlwave-sintern-routine-or-method
7626 this-word (nth 2 (nth 3 where))))
7627 (list this-word 'pro
7628 (idlwave-determine-class
7629 (cons this-word (cdr (nth 3 where)))
7630 'pro)))
7631 ((and (eq cw 'function)
7632 (not (equal this-word ""))
7633 (or (eq next-char ?\() ; exclude arrays, vars.
7635 (setq this-word (idlwave-sintern-routine-or-method
7636 this-word (nth 2 (nth 3 where))))
7637 (list this-word 'fun
7638 (idlwave-determine-class
7639 (cons this-word (cdr (nth 3 where)))
7640 'fun)))
7641 ((and (memq cw '(function-keyword procedure-keyword))
7642 (not (equal this-word ""))
7643 (eq next-char ?\()) ; A function!
7644 (setq this-word (idlwave-sintern-routine this-word))
7645 (list this-word 'fun nil))
7646 (func
7647 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
7648 (pro
7649 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
7650 (t nil)))))
7652 (defun idlwave-what-module-find-class ()
7653 "Call idlwave-what-module and find the inherited class if necessary."
7654 (let* ((module (idlwave-what-module))
7655 (class (nth 2 module))
7656 classes)
7657 (if (and (= (length module) 3)
7658 (stringp class))
7659 (list (car module)
7660 (nth 1 module)
7661 (apply 'idlwave-find-inherited-class module))
7662 module)))
7664 (defun idlwave-find-inherited-class (name type class)
7665 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
7666 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
7667 (if entry
7668 (nth 2 entry)
7669 class)))
7671 (defun idlwave-fix-module-if-obj_new (module)
7672 "Check if MODULE points to obj_new.
7673 If yes, and if the cursor is in the keyword region, change to the
7674 appropriate Init method."
7675 (let* ((name (car module))
7676 (pos (point))
7677 (case-fold-search t)
7678 string)
7679 (if (and (stringp name)
7680 (equal (downcase name) "obj_new")
7681 (save-excursion
7682 (idlwave-beginning-of-statement)
7683 (setq string (buffer-substring (point) pos))
7685 string)))
7686 (let ((name "Init")
7687 (class (match-string 1 string)))
7688 (setq module (list (idlwave-sintern-method "Init")
7689 'fun
7690 (idlwave-sintern-class class)))))
7691 module))
7693 (defun idlwave-fix-keywords (name type class keywords
7694 &optional super-classes system)
7695 "Update a list of keywords.
7696 Translate OBJ_NEW, adding all super-class keywords, or all keywords
7697 from all classes if class equals t. If SYSTEM is non-nil, don't
7698 demand _EXTRA in the keyword list."
7699 (let ((case-fold-search t))
7701 ;; If this is the OBJ_NEW function, try to figure out the class and use
7702 ;; the keywords from the corresponding INIT method.
7703 (if (and (equal (upcase name) "OBJ_NEW")
7704 (or (eq major-mode 'idlwave-mode)
7705 (eq major-mode 'idlwave-shell-mode)))
7706 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
7707 (string (buffer-substring bos (point)))
7708 (case-fold-search t)
7709 class)
7711 string)
7712 (setq class (idlwave-sintern-class (match-string 1 string)))
7713 (setq idlwave-current-obj_new-class class)
7714 (setq keywords
7715 (append keywords
7716 (idlwave-entry-keywords
7717 (idlwave-rinfo-assq
7718 (idlwave-sintern-method "INIT")
7719 'fun
7720 class
7721 (idlwave-routines)) 'do-link))))))
7723 ;; If the class is `t', combine all keywords of all methods NAME
7724 (when (eq class t)
7725 (mapc (lambda (entry)
7726 (and
7727 (nth 2 entry) ; non-nil class
7728 (eq (nth 1 entry) type) ; correct type
7729 (setq keywords
7730 (append keywords
7731 (idlwave-entry-keywords entry 'do-link)))))
7732 (idlwave-all-assq name (idlwave-routines)))
7733 (setq keywords (idlwave-uniquify keywords)))
7735 ;; If we have inheritance, add all keywords from superclasses, if
7736 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
7737 (when (and
7738 super-classes
7739 idlwave-keyword-class-inheritance
7740 (stringp class)
7741 (or
7742 system
7743 (assq (idlwave-sintern-keyword "_extra") keywords)
7744 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
7745 ;; Check if one of the keyword-class regexps matches the name
7746 (let ((regexps idlwave-keyword-class-inheritance) re)
7747 (catch 'exit
7748 (while (setq re (pop regexps))
7749 (if (string-match re name) (throw 'exit t))))))
7751 (loop for entry in (idlwave-routines) do
7752 (and (nth 2 entry) ; non-nil class
7753 (memq (nth 2 entry) super-classes) ; an inherited class
7754 (eq (nth 1 entry) type) ; correct type
7755 (eq (car entry) name) ; correct name
7756 (mapcar (lambda (k) (add-to-list 'keywords k))
7757 (idlwave-entry-keywords entry 'do-link))))
7758 (setq keywords (idlwave-uniquify keywords)))
7760 ;; Return the final list
7761 keywords))
7763 (defun idlwave-expand-keyword (keyword module)
7764 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
7765 KEYWORD may be an exact match or an abbreviation of a keyword.
7766 If the match is exact, KEYWORD itself is returned, even if there may be other
7767 keywords of which KEYWORD is an abbreviation. This is necessary because some
7768 system routines have keywords which are prefixes of other keywords.
7769 If KEYWORD is an abbreviation of several keywords, a list of all possible
7770 completions is returned.
7771 If the abbreviation was unique, the correct keyword is returned.
7772 If it cannot be a keyword, the function return nil.
7773 If we do not know about MODULE, just return KEYWORD literally."
7774 (let* ((name (car module))
7775 (type (nth 1 module))
7776 (class (nth 2 module))
7777 (kwd (idlwave-sintern-keyword keyword))
7778 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
7779 (kwd-alist (idlwave-entry-keywords entry))
7780 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
7781 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
7782 (completion-ignore-case t)
7783 candidates)
7784 (cond ((assq kwd kwd-alist)
7785 kwd)
7786 ((setq candidates (all-completions kwd kwd-alist))
7787 (if (= (length candidates) 1)
7788 (car candidates)
7789 candidates))
7790 ((and entry extra)
7791 ;; Inheritance may cause this keyword to be correct
7792 keyword)
7793 (entry
7794 ;; We do know the function, which does not have the keyword.
7795 nil)
7796 (t
7797 ;; We do not know the function, so this just might be a correct
7798 ;; keyword - return it as it is.
7799 keyword))))
7801 (defvar idlwave-rinfo-mouse-map (make-sparse-keymap))
7802 (defvar idlwave-rinfo-map (make-sparse-keymap))
7803 (define-key idlwave-rinfo-mouse-map
7804 (if (featurep 'xemacs) [button2] [mouse-2])
7805 'idlwave-mouse-active-rinfo)
7806 (define-key idlwave-rinfo-mouse-map
7807 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
7808 'idlwave-mouse-active-rinfo-shift)
7809 (define-key idlwave-rinfo-mouse-map
7810 (if (featurep 'xemacs) [button3] [mouse-3])
7811 'idlwave-mouse-active-rinfo-right)
7812 (define-key idlwave-rinfo-mouse-map " " 'idlwave-active-rinfo-space)
7813 (define-key idlwave-rinfo-map "q" 'idlwave-quit-help)
7814 (define-key idlwave-rinfo-mouse-map "q" 'idlwave-quit-help)
7815 (defvar idlwave-popup-source nil)
7816 (defvar idlwave-rinfo-marker (make-marker))
7818 (defun idlwave-quit-help ()
7819 (interactive)
7820 (let ((ri-window (get-buffer-window "*Help*"))
7821 (olh-window (get-buffer-window "*IDLWAVE Help*")))
7822 (when (and olh-window
7823 (fboundp 'idlwave-help-quit))
7824 (select-window olh-window)
7825 (idlwave-help-quit))
7826 (when (window-live-p ri-window)
7827 (delete-window ri-window))))
7829 (defun idlwave-display-calling-sequence (name type class
7830 &optional initial-class)
7831 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
7832 (let* ((initial-class (or initial-class class))
7833 (entry (or (idlwave-best-rinfo-assq name type class
7834 (idlwave-routines))
7835 (idlwave-rinfo-assq name type class
7836 idlwave-unresolved-routines)))
7837 (name (or (car entry) name))
7838 (class (or (nth 2 entry) class))
7839 (superclasses (idlwave-all-class-inherits initial-class))
7840 (twins (idlwave-routine-twins entry))
7841 (dtwins (idlwave-study-twins twins))
7842 (all dtwins)
7843 (system (eq (car (nth 3 entry)) 'system))
7844 (calling-seq (nth 4 entry))
7845 (keywords (idlwave-entry-keywords entry 'do-link))
7846 (html-file (car (nth 5 entry)))
7847 (help-echo-kwd
7848 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
7849 (help-echo-use
7850 "Button2/3: Online Help")
7851 (help-echo-src
7852 "Button2: Jump to source and back | Button3: Source in Help window.")
7853 (help-echo-class
7854 "Button2: Display info about same method in superclass")
7855 (col 0)
7856 (data (list name type class (current-buffer) nil initial-class))
7857 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
7858 (face 'idlwave-help-link-face)
7859 beg props win cnt total)
7860 ;; Fix keywords, but don't add chained super-classes, since these
7861 ;; are shown separately for that super-class
7862 (setq keywords (idlwave-fix-keywords name type class keywords))
7863 (cond
7864 ((null entry)
7865 (error "No %s %s known %s" type name
7866 (if initial-class (concat "in class " initial-class) "")))
7867 ((or (null name) (equal name ""))
7868 (error "No function or procedure call at point"))
7869 ((null calling-seq)
7870 (error "Calling sequence of %s %s not available" type name))
7871 (t
7872 (save-excursion
7873 (move-marker idlwave-rinfo-marker (point))
7874 (set-buffer (get-buffer-create "*Help*"))
7875 (use-local-map idlwave-rinfo-map)
7876 (setq buffer-read-only nil)
7877 (erase-buffer)
7878 (set (make-local-variable 'idlwave-popup-source) nil)
7879 (set (make-local-variable 'idlwave-current-obj_new-class)
7880 idlwave-current-obj_new-class)
7881 (when superclasses
7882 (setq props (list 'mouse-face 'highlight
7883 km-prop idlwave-rinfo-mouse-map
7884 'help-echo help-echo-class
7885 'data (cons 'class data)))
7886 (let ((classes (cons initial-class superclasses)) c)
7887 (insert "Classes: ")
7888 (while (setq c (pop classes))
7889 (insert " ")
7890 (setq beg (point))
7891 (insert c)
7892 (if (equal (downcase c) (downcase class))
7893 (add-text-properties beg (point) (list 'face 'bold))
7894 ;; If Method exists in a different class link it
7895 (if (idlwave-rinfo-assq name type c (idlwave-routines))
7896 (add-text-properties beg (point) props))))
7898 (setq props (list 'mouse-face 'highlight
7899 km-prop idlwave-rinfo-mouse-map
7900 'help-echo help-echo-use
7901 'data (cons 'usage data)))
7902 (if html-file (setq props (append (list 'face face 'link html-file)
7903 props)))
7904 (insert "Usage: ")
7905 (setq beg (point))
7906 (insert (if class
7907 (format calling-seq class name class name class name)
7908 (format calling-seq name name name name))
7910 (add-text-properties beg (point) props)
7912 (insert "Keywords:")
7913 (if (null keywords)
7914 (insert " No keywords accepted.")
7915 (setq col 9)
7916 (mapcar
7917 (lambda (x)
7918 (if (>= (+ col 1 (length (car x)))
7919 (window-width))
7920 (progn
7922 (setq col 9)))
7923 (insert " ")
7924 (setq beg (point)
7925 ;; Relevant keywords already have link property attached
7926 props (list 'mouse-face 'highlight
7927 km-prop idlwave-rinfo-mouse-map
7928 'data (cons 'keyword data)
7929 'help-echo help-echo-kwd
7930 'keyword (car x)))
7931 (if system (setq props (append (list 'face face) props)))
7932 (insert (car x))
7933 (add-text-properties beg (point) props)
7934 (setq col (+ col 1 (length (car x)))))
7935 keywords))
7937 (setq cnt 1 total (length all))
7938 ;; Here entry is (key file (list of type-conses))
7939 (while (setq entry (pop all))
7940 (setq props (list 'mouse-face 'highlight
7941 km-prop idlwave-rinfo-mouse-map
7942 'help-echo help-echo-src
7943 'source (list (car (car (nth 2 entry))) ;type
7944 (nth 1 entry)
7945 nil
7946 (cdr (car (nth 2 entry))))
7947 'data (cons 'source data)))
7948 (idlwave-insert-source-location
7950 (if (equal cnt 1)
7951 (if (> total 1) "Sources:" "Source:")
7952 "")
7953 (if (> total 1) "- " ""))
7954 entry props)
7955 (incf cnt)
7956 (when (and all (> cnt idlwave-rinfo-max-source-lines))
7957 ;; No more source lines, please
7958 (insert (format
7960 idlwave-rinfo-max-source-lines))
7961 (setq all nil)))
7962 (goto-char (point-min))
7963 (setq buffer-read-only t))
7964 (display-buffer "*Help*")
7965 (if (and (setq win (get-buffer-window "*Help*"))
7966 idlwave-resize-routine-help-window)
7967 (progn
7968 (let ((ww (selected-window)))
7969 (unwind-protect
7970 (progn
7971 (select-window win)
7972 (enlarge-window (- (/ (frame-height) 2)
7973 (window-height)))
7974 (shrink-window-if-larger-than-buffer))
7975 (select-window ww)))))))))
7977 (defun idlwave-insert-source-location (prefix entry &optional file-props)
7978 "Insert a source location into the routine info buffer.
7979 Start line with PREFIX. If a file name is inserted, add FILE-PROPS to
7980 it."
7981 (let* ((key (car entry))
7982 (file (nth 1 entry))
7983 (types (nth 2 entry))
7984 (shell-flag (assq 'compiled types))
7985 (buffer-flag (assq 'buffer types))
7986 (user-flag (assq 'user types))
7987 (lib-flag (assq 'lib types))
7988 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
7989 (and user-flag (idlwave-count-memq 'user types))
7990 (and lib-flag (idlwave-count-memq 'lib types))
7991 1))
7992 (doflags t)
7993 beg special)
7995 (insert prefix)
7997 (cond
7998 ((eq key 'system)
7999 (setq doflags nil)
8000 (insert "System "))
8002 ((eq key 'builtin)
8003 (setq doflags nil)
8004 (insert "Builtin "))
8006 ((and (not file) shell-flag)
8007 (insert "Unresolved"))
8009 ((null file)
8010 (insert "ERROR"))
8012 ((idlwave-syslib-p file)
8013 (if (string-match "obsolete" (file-name-directory file))
8014 (insert "Obsolete ")
8015 (insert "SystemLib ")))
8017 ;; New special syntax: taken directly from routine-info for
8018 ;; library catalog routines
8019 ((setq special (or (cdr lib-flag) (cdr user-flag)))
8020 (insert (format "%-10s" special)))
8022 ;; Old special syntax: a matching regexp
8023 ((setq special (idlwave-special-lib-test file))
8024 (insert (format "%-10s" special)))
8026 ;; Catch-all with file
8027 ((idlwave-lib-p file) (insert "Library "))
8029 ;; Sanity catch all
8030 (t (insert "Other ")))
8032 (when doflags
8033 (insert (concat
8034 " ["
8035 (if lib-flag "L" "-")
8036 (if user-flag "C" "-")
8037 (if shell-flag "S" "-")
8038 (if buffer-flag "B" "-")
8039 "] ")))
8040 (when (> ndupl 1)
8041 (setq beg (point))
8042 (insert (format "(%dx) " ndupl))
8043 (add-text-properties beg (point) (list 'face 'bold)))
8044 (when (and file (not (equal file "")))
8045 (setq beg (point))
8046 (insert (apply 'abbreviate-file-name
8047 (if (featurep 'xemacs) (list file t) (list file))))
8048 (if file-props
8049 (add-text-properties beg (point) file-props)))))
8051 (defun idlwave-special-lib-test (file)
8052 "Check the path of FILE against the regexps which define special libs.
8053 Return the name of the special lib if there is a match."
8054 (let ((alist idlwave-special-lib-alist)
8055 entry rtn)
8056 (cond
8057 ((stringp file)
8058 (while (setq entry (pop alist))
8059 (if (string-match (car entry) file)
8060 (setq rtn (cdr entry)
8061 alist nil)))
8062 rtn)
8063 (t nil))))
8065 (defun idlwave-mouse-active-rinfo-right (ev)
8066 (interactive "e")
8067 (idlwave-mouse-active-rinfo ev 'right))
8069 (defun idlwave-mouse-active-rinfo-shift (ev)
8070 (interactive "e")
8071 (idlwave-mouse-active-rinfo ev nil 'shift))
8073 (defun idlwave-active-rinfo-space ()
8074 (interactive)
8075 (idlwave-mouse-active-rinfo nil 'right))
8077 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8078 "Does the mouse actions in the routine info buffer.
8079 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8080 was pressed."
8081 (interactive "e")
8082 (if ev (mouse-set-point ev))
8083 (let (data id name type class buf bufwin source link keyword
8084 word initial-class)
8085 (setq data (get-text-property (point) 'data)
8086 source (get-text-property (point) 'source)
8087 keyword (get-text-property (point) 'keyword)
8088 link (get-text-property (point) 'link)
8089 id (car data)
8090 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8091 buf (nth 4 data)
8092 initial-class (nth 6 data)
8093 word (idlwave-this-word)
8094 bufwin (get-buffer-window buf t))
8096 (cond ((eq id 'class) ; Switch class being displayed
8097 (if (window-live-p bufwin) (select-window bufwin))
8098 (idlwave-display-calling-sequence
8099 (idlwave-sintern-method name)
8100 type (idlwave-sintern-class word)
8101 initial-class))
8102 ((eq id 'usage) ; Online help on this routine
8103 (idlwave-online-help link name type class))
8104 ((eq id 'source) ; Source in help or buffer
8105 (if right ; In help
8106 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8107 (idlwave-help-source-try-header nil)
8108 ;; Fake idlwave-routines so help will find the right entry
8109 (idlwave-routines
8110 (list (list name type class source ""))))
8111 (idlwave-help-get-special-help name type class nil))
8112 ;; Otherwise just pop to the source
8113 (setq idlwave-popup-source (not idlwave-popup-source))
8114 (if idlwave-popup-source
8115 (condition-case err
8116 (idlwave-do-find-module name type class source)
8117 (error
8118 (setq idlwave-popup-source nil)
8119 (if (window-live-p bufwin) (select-window bufwin))
8120 (error (nth 1 err))))
8121 (if bufwin
8122 (select-window bufwin)
8123 (pop-to-buffer buf))
8124 (goto-char (marker-position idlwave-rinfo-marker)))))
8125 ((eq id 'keyword)
8126 (if right
8127 (idlwave-online-help link name type class keyword)
8128 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8130 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8131 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8132 (let ((bwin (get-buffer-window buffer)))
8133 (if idlwave-complete-empty-string-as-lower-case
8134 (setq keyword (downcase keyword)))
8135 (if bwin
8136 (select-window bwin)
8137 (pop-to-buffer buffer)
8138 (setq bwin (get-buffer-window buffer)))
8139 (if (eq (preceding-char) ?/)
8140 (insert keyword)
8141 (unless (save-excursion
8142 (re-search-backward
8144 (min (- (point) 100) (point-min)) t))
8145 (insert ", "))
8146 (if shift (insert "/"))
8147 (insert keyword)
8148 (if (and (not shift)
8149 idlwave-keyword-completion-adds-equal)
8150 (insert "=")))))
8152 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8153 "List the load path shadows of all routines defined in current buffer."
8154 (interactive "P")
8155 (idlwave-routines)
8156 (if (eq major-mode 'idlwave-mode)
8157 (idlwave-list-load-path-shadows
8158 nil (idlwave-update-current-buffer-info 'save-buffer)
8159 "in current buffer")
8160 (error "Current buffer is not in idlwave-mode")))
8162 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8163 "List the load path shadows of all routines compiled under the shell.
8164 This is very useful for checking an IDL application. Just compile the
8165 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8166 routines and update IDLWAVE internal info. Then check for shadowing
8167 with this command."
8168 (interactive "P")
8169 (cond
8170 ((or (not (fboundp 'idlwave-shell-is-running))
8171 (not (idlwave-shell-is-running)))
8172 (error "Shell is not running"))
8173 ((null idlwave-compiled-routines)
8174 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8175 (t
8176 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8177 "in the shell"))))
8179 (defun idlwave-list-all-load-path-shadows (&optional arg)
8180 "List the load path shadows of all routines known to IDLWAVE."
8181 (interactive "P")
8182 (idlwave-list-load-path-shadows nil nil "globally"))
8184 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8185 "List the routines which are defined multiple times.
8186 Search the information IDLWAVE has about IDL routines for multiple
8187 definitions.
8188 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8190 When IDL hits a routine call which is not defined, it will search on
8191 the load path in order to find a definition. The output of this
8192 command can be used to detect possible name clashes during this process."
8193 (idlwave-routines) ; Make sure everything is loaded.
8194 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8195 (or (y-or-n-p
8196 "You don't have any user or library catalogs. Continue anyway? ")
8197 (error "Abort")))
8198 (let* ((routines (append idlwave-system-routines
8199 idlwave-compiled-routines
8200 idlwave-library-catalog-routines
8201 idlwave-user-catalog-routines
8202 idlwave-buffer-routines
8203 nil))
8204 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8205 (keymap (make-sparse-keymap))
8206 (props (list 'mouse-face 'highlight
8207 km-prop keymap
8208 'help-echo "Mouse2: Find source"))
8209 (nroutines (length (or special-routines routines)))
8210 (step (/ nroutines 99))
8211 (n 0)
8212 (next-perc 1)
8213 (cnt 0)
8214 (idlwave-sort-prefer-buffer-info nil)
8215 routine twins dtwins twin done props1 lroutines)
8217 (if special-routines
8218 ;; Just looking for shadows of a few special routines
8219 (setq lroutines routines
8220 routines special-routines))
8222 (message "Sorting routines...")
8223 (setq routines (sort routines
8224 (lambda (a b)
8225 (string< (downcase (idlwave-make-full-name
8226 (nth 2 a) (car a)))
8227 (downcase (idlwave-make-full-name
8228 (nth 2 b) (car b)))))))
8229 (message "Sorting routines...done")
8231 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8232 (lambda (ev)
8233 (interactive "e")
8234 (mouse-set-point ev)
8235 (apply 'idlwave-do-find-module
8236 (get-text-property (point) 'find-args))))
8237 (define-key keymap [(return)]
8238 (lambda ()
8239 (interactive)
8240 (apply 'idlwave-do-find-module
8241 (get-text-property (point) 'find-args))))
8242 (message "Compiling list...( 0%%)")
8243 (save-excursion
8244 (set-buffer (get-buffer-create "*Shadows*"))
8245 (setq buffer-read-only nil)
8246 (erase-buffer)
8247 (while (setq routine (pop routines))
8248 (setq n (1+ n))
8249 (if (= (* next-perc step) n)
8250 (progn
8251 (message "Compiling list...(%2d%%)" next-perc)
8252 (setq next-perc (1+ next-perc))))
8253 ;; Get a list of all twins
8254 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8255 (if (memq routine done)
8256 (setq dtwins nil)
8257 (setq dtwins (idlwave-study-twins twins)))
8258 ;; Mark all twins as dealt with
8259 (setq done (append twins done))
8260 (when (or (> (length dtwins) 1)
8261 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8262 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8263 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8264 (incf cnt)
8266 (idlwave-make-full-name (nth 2 routine)
8267 (car routine))
8268 (if (eq (nth 1 routine) 'fun) "()" "")))
8269 (while (setq twin (pop dtwins))
8270 (setq props1 (append (list 'find-args
8271 (list (nth 0 routine)
8272 (nth 1 routine)
8273 (nth 2 routine)))
8274 props))
8276 (goto-char (point-min))
8277 (setq buffer-read-only t))
8278 (setq loc (or loc ""))
8279 (if (> cnt 0)
8280 (progn
8281 (display-buffer (get-buffer "*Shadows*"))
8282 (message "%d case%s of shadowing found %s"
8283 cnt (if (= cnt 1) "" "s") loc))
8284 (message "No shadowing conflicts found %s" loc))))
8286 (defun idlwave-print-source (routine)
8287 (let* ((source (nth 3 routine))
8288 (stype (car source))
8289 (sfile (idlwave-routine-source-file source)))
8290 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8291 (if (and (eq stype 'compiled)
8292 (or (not (stringp sfile))
8294 (setq stype 'unresolved))
8296 stype
8297 (if sfile sfile "No source code available")))))
8299 (defun idlwave-routine-twins (entry &optional list)
8300 "Return all twin entries of ENTRY in LIST.
8301 LIST defaults to `idlwave-routines'.
8302 Twin entries are those which have the same name, type, and class.
8303 ENTRY will also be returned, as the first item of this list."
8304 (let* ((name (car entry))
8305 (type (nth 1 entry))
8306 (class (nth 2 entry))
8307 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8308 twins candidate)
8309 (while (setq candidate (pop candidates))
8310 (if (and (not (eq candidate entry))
8311 (eq type (nth 1 candidate))
8312 (eq class (nth 2 candidate)))
8313 (push candidate twins)))
8314 (if (setq candidate (idlwave-rinfo-assq name type class
8315 idlwave-unresolved-routines))
8316 (push candidate twins))
8317 (cons entry (nreverse twins))))
8319 (defun idlwave-study-twins (entries)
8320 "Return dangerous twins of first entry in ENTRIES.
8321 Dangerous twins are routines with same name, but in different files on
8322 the load path. If a file is in the system library and has an entry in
8323 the `idlwave-system-routines' list, we omit the latter as
8324 non-dangerous because many IDL routines are implemented as library
8325 routines, and may have been scanned."
8326 (let* ((entry (car entries))
8327 (name (car entry)) ;
8328 (type (nth 1 entry)) ; Must be bound for
8329 (class (nth 2 entry)) ; idlwave-routine-twin-compare
8330 (cnt 0)
8331 source type type-cons file alist syslibp key)
8332 (while (setq entry (pop entries))
8333 (incf cnt)
8334 (setq source (nth 3 entry)
8335 type (car source)
8336 type-cons (cons type (nth 3 source))
8337 file (idlwave-routine-source-file source))
8339 ;; Make KEY to index entry properly
8340 (setq key (cond ((eq type 'system) type)
8341 (file (file-truename file))
8342 (t 'unresolved)))
8344 ;; Check for an entry in the system library
8345 (if (and file
8346 (not syslibp)
8347 (idlwave-syslib-p file))
8348 (setq syslibp t))
8350 ;; If there's more than one matching entry for the same file, just
8351 ;; append the type-cons to the type list.
8352 (if (setq entry (assoc key alist))
8353 (push type-cons (nth 2 entry))
8354 (push (list key file (list type-cons)) alist)))
8356 (setq alist (nreverse alist))
8358 (when syslibp
8359 ;; File is in system *library* - remove any 'system entry
8360 (setq alist (delq (assq 'system alist) alist)))
8362 ;; If 'system remains and we've scanned the syslib, it's a builtin
8363 ;; (rather than a !DIR/lib/.pro file bundled as source).
8364 (when (and (idlwave-syslib-scanned-p)
8365 (setq entry (assoc 'system alist)))
8366 (setcar entry 'builtin))
8367 (sort alist 'idlwave-routine-twin-compare)))
8369 (defvar type)
8370 (defvar class)
8371 (defvar idlwave-sort-prefer-buffer-info t
8372 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8374 (defmacro idlwave-xor (a b)
8375 `(and (or ,a ,b)
8376 (not (and ,a ,b))))
8378 (defun idlwave-routine-entry-compare (a b)
8379 "Compare two routine info entries for sortiung. This is the general case.
8380 It first compates class, names, and type. If it turns out that A and B
8381 are twins (same name, class, and type), calls another routine which
8382 compares twins on the basis of their file names and path locations."
8383 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8384 (cond
8385 ((not (equal (idlwave-downcase-safe class)
8386 (idlwave-downcase-safe (nth 2 b))))
8387 ;; Class decides
8388 (cond ((null (nth 2 b)) nil)
8389 ((null class) t)
8390 (t (string< (downcase class) (downcase (nth 2 b))))))
8391 ((not (equal (downcase name) (downcase (car b))))
8392 ;; Name decides
8393 (string< (downcase name) (downcase (car b))))
8394 ((not (eq type (nth 1 b)))
8395 ;; Type decides
8396 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8397 (t
8398 ;; A and B are twins - so the decision is more complicated.
8399 ;; Call twin-compare with the proper arguments.
8400 (idlwave-routine-entry-compare-twins a b)))))
8402 (defun idlwave-routine-entry-compare-twins (a b)
8403 "Compare two routine entries, under the assumption that they are
8404 twins. This basically calls `idlwave-routine-twin-compare' with the
8405 correct args."
8406 (let* ((name (car a)) (type (nth 1 a)) (class (nth 2 a)) ; needed outside
8407 (asrc (nth 3 a))
8408 (atype (car asrc))
8409 (bsrc (nth 3 b))
8410 (btype (car bsrc))
8411 (afile (idlwave-routine-source-file asrc))
8412 (bfile (idlwave-routine-source-file bsrc)))
8413 (idlwave-routine-twin-compare
8414 (if (stringp afile)
8415 (list (file-truename afile) afile (list atype))
8416 (list atype afile (list atype)))
8417 (if (stringp bfile)
8418 (list (file-truename bfile) bfile (list btype))
8419 (list btype bfile (list btype))))
8420 ))
8422 (defun idlwave-routine-twin-compare (a b)
8423 "Compare two routine twin entries for sorting.
8424 In here, A and B are not normal routine info entries, but special
8425 lists (KEY FILENAME (TYPES...)).
8426 This expects NAME TYPE CLASS to be bound to the right values."
8427 (let* (;; Dis-assemble entries
8428 (akey (car a)) (bkey (car b))
8429 (afile (nth 1 a)) (bfile (nth 1 b))
8430 (atypes (nth 2 a)) (btypes (nth 2 b))
8431 ;; System routines?
8432 (asysp (memq akey '(builtin system)))
8433 (bsysp (memq bkey '(builtin system)))
8434 ;; Compiled routines?
8435 (acompp (memq 'compiled atypes))
8436 (bcompp (memq 'compiled btypes))
8437 ;; Unresolved?
8438 (aunresp (or (eq akey 'unresolved)
8439 (and acompp (not afile))))
8440 (bunresp (or (eq bkey 'unresolved)
8441 (and bcompp (not bfile))))
8442 ;; Buffer info available?
8443 (abufp (memq 'buffer atypes))
8444 (bbufp (memq 'buffer btypes))
8445 ;; On search path?
8446 (tpath-alist (idlwave-true-path-alist))
8447 (apathp (and (stringp akey)
8448 (assoc (file-name-directory akey) tpath-alist)))
8449 (bpathp (and (stringp bkey)
8450 (assoc (file-name-directory bkey) tpath-alist)))
8451 ;; How early on search path? High number means early since we
8452 ;; measure the tail of the path list
8453 (anpath (length (memq apathp tpath-alist)))
8454 (bnpath (length (memq bpathp tpath-alist)))
8455 ;; Look at file names
8456 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8457 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8459 (regexp-quote (downcase class))
8460 (regexp-quote (downcase name)))
8462 ;; Is file name derived from the routine name?
8463 ;; Method file or class definition file?
8464 (anamep (string-match fname-re aname))
8465 (adefp (and class anamep (string= "define" (match-string 1 aname))))
8466 (bnamep (string-match fname-re bname))
8467 (bdefp (and class bnamep (string= "define" (match-string 1 bname)))))
8469 ;; Now: follow JD's ideas about sorting. Looks really simple now,
8470 ;; doesn't it? The difficult stuff is hidden above...
8471 (cond
8472 ((idlwave-xor asysp bsysp) asysp) ; System entries first
8473 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
8474 ((and idlwave-sort-prefer-buffer-info
8475 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
8476 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
8477 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
8478 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
8479 ((and class anamep bnamep ; both file names match ->
8480 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
8481 ((> anpath bnpath) t) ; Who is first on path?
8482 (t nil)))) ; Default
8484 (defun idlwave-routine-source-file (source)
8485 (if (nth 2 source)
8486 (expand-file-name (nth 1 source) (nth 2 source))
8487 (nth 1 source)))
8489 (defun idlwave-downcase-safe (string)
8490 "Donwcase if string, else return unchanged."
8491 (if (stringp string)
8492 (downcase string)
8493 string))
8495 (defun idlwave-count-eq (elt list)
8496 "How often is ELT in LIST?"
8497 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
8499 (defun idlwave-count-memq (elt alist)
8500 "How often is ELT a key in ALIST?"
8501 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
8503 (defun idlwave-syslib-p (file)
8504 "Non-nil if FILE is in the system library."
8505 (let* ((true-syslib (file-name-as-directory
8506 (file-truename
8507 (expand-file-name "lib" (idlwave-sys-dir)))))
8508 (true-file (file-truename file)))
8509 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
8511 (defun idlwave-lib-p (file)
8512 "Non-nil if file is in the library"
8513 (let ((true-dir (file-name-directory (file-truename file))))
8514 (assoc true-dir (idlwave-true-path-alist))))
8516 (defun idlwave-path-alist-add-flag (list-entry flag)
8517 "Add a flag to the path list entry, if not set."
8518 (let ((flags (cdr list-entry)))
8519 (add-to-list 'flags flag)
8520 (setcdr list-entry flags)))
8522 (defun idlwave-path-alist-remove-flag (list-entry flag)
8523 "Remove a flag to the path list entry, if set."
8524 (let ((flags (delq flag (cdr list-entry))))
8525 (setcdr list-entry flags)))
8527 (defun idlwave-true-path-alist ()
8528 "Return `idlwave-path-alist' alist with true-names.
8529 Info is cached, but relies on the functions setting `idlwave-path-alist'
8530 to reset the variable `idlwave-true-path-alist' to nil."
8531 (or idlwave-true-path-alist
8532 (setq idlwave-true-path-alist
8533 (mapcar (lambda(x) (cons
8534 (file-name-as-directory
8535 (file-truename
8536 (directory-file-name
8537 (car x))))
8538 (cdr x)))
8539 idlwave-path-alist))))
8541 (defun idlwave-syslib-scanned-p ()
8542 "Non-nil if the system lib file !DIR/lib has been scanned."
8543 (let* ((true-syslib (file-name-as-directory
8544 (file-truename
8545 (expand-file-name "lib" (idlwave-sys-dir))))))
8546 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
8548 ;; ----------------------------------------------------------------------------
8549 ;;
8550 ;; Online Help display
8553 ;; ----------------------------------------------------------------------------
8554 ;;
8555 ;; Additions for use with imenu.el and func-menu.el
8556 ;; (pop-up a list of IDL units in the current file).
8557 ;;
8559 (defun idlwave-prev-index-position ()
8560 "Search for the previous procedure or function.
8561 Return nil if not found. For use with imenu.el."
8562 (save-match-data
8563 (cond
8565 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
8566 (t nil))))
8568 (defun idlwave-unit-name ()
8569 "Return the unit name.
8570 Assumes that point is at the beginning of the unit as found by
8571 `idlwave-prev-index-position'."
8572 (forward-sexp 2)
8573 (forward-sexp -1)
8574 (let ((begin (point)))
8575 (re-search-forward
8577 (if (fboundp 'buffer-substring-no-properties)
8578 (buffer-substring-no-properties begin (point))
8579 (buffer-substring begin (point)))))
8581 (defalias 'idlwave-function-menu
8582 (condition-case nil
8583 (progn
8584 (require 'func-menu)
8585 'function-menu)
8586 (error (condition-case nil
8587 (progn
8588 (require 'imenu)
8589 'imenu)
8590 (error nil)))))
8592 ;; Here we hack func-menu.el in order to support this new mode.
8593 ;; The latest versions of func-menu.el already have this stuff in, so
8594 ;; we hack only if it is not already there.
8595 (when (fboundp 'eval-after-load)
8596 (eval-after-load "func-menu"
8597 '(progn
8598 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
8599 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
8600 (setq fume-function-name-regexp-alist
8601 (cons '(idlwave-mode . fume-function-name-regexp-idl)
8602 fume-function-name-regexp-alist)))
8603 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
8604 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
8605 (setq fume-find-function-name-method-alist
8606 (cons '(idlwave-mode . fume-find-next-idl-function-name)
8607 fume-find-function-name-method-alist))))))
8609 (defun idlwave-edit-in-idlde ()
8610 "Edit the current file in IDL Development environment."
8611 (interactive)
8612 (start-process "idldeclient" nil
8613 idlwave-shell-explicit-file-name "-c" "-e"
8614 (buffer-file-name) "&"))
8616 (defun idlwave-launch-idlhelp ()
8617 "Start the IDLhelp application."
8618 (interactive)
8619 (start-process "idlhelp" nil idlwave-help-application))
8621 ;; Menus - using easymenu.el
8622 (defvar idlwave-mode-menu-def
8623 `("IDLWAVE"
8624 ["PRO/FUNC menu" idlwave-function-menu t]
8625 ("Motion"
8626 ["Subprogram Start" idlwave-beginning-of-subprogram t]
8627 ["Subprogram End" idlwave-end-of-subprogram t]
8628 ["Block Start" idlwave-beginning-of-block t]
8629 ["Block End" idlwave-end-of-block t]
8630 ["Up Block" idlwave-backward-up-block t]
8631 ["Down Block" idlwave-down-block t]
8632 ["Skip Block Backward" idlwave-backward-block t]
8633 ["Skip Block Forward" idlwave-forward-block t])
8634 ("Mark"
8635 ["Subprogram" idlwave-mark-subprogram t]
8636 ["Block" idlwave-mark-block t]
8637 ["Header" idlwave-mark-doclib t])
8638 ("Format"
8639 ["Indent Subprogram" idlwave-indent-subprogram t]
8640 ["(Un)Comment Region" idlwave-toggle-comment-region "C-c ;"]
8641 ["Continue/Split line" idlwave-split-line t]
8642 "--"
8643 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
8644 :selected (symbol-value idlwave-fill-function)])
8645 ("Templates"
8646 ["Procedure" idlwave-procedure t]
8647 ["Function" idlwave-function t]
8648 ["Doc Header" idlwave-doc-header t]
8649 ["Log" idlwave-doc-modification t]
8650 "--"
8651 ["Case" idlwave-case t]
8652 ["For" idlwave-for t]
8653 ["Repeat" idlwave-repeat t]
8654 ["While" idlwave-while t]
8655 "--"
8656 ["Close Block" idlwave-close-block t])
8657 ("Completion"
8658 ["Complete" idlwave-complete t]
8659 ("Complete Special"
8660 ["1 Procedure Name" (idlwave-complete 'procedure) t]
8661 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
8662 "--"
8663 ["3 Function Name" (idlwave-complete 'function) t]
8664 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
8665 "--"
8666 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
8667 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
8668 "--"
8669 ["7 Function Method Name" (idlwave-complete 'function-method) t]
8670 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
8671 "--"
8672 ["9 Class Name" idlwave-complete-class t]))
8673 ("Routine Info"
8674 ["Show Routine Info" idlwave-routine-info t]
8675 ["Online Context Help" idlwave-context-help t]
8676 "--"
8677 ["Find Routine Source" idlwave-find-module t]
8678 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
8679 "--"
8680 ["Update Routine Info" idlwave-update-routine-info t]
8681 "--"
8682 "IDL User Catalog"
8683 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
8684 ["Scan Directories" (idlwave-update-routine-info '(16))
8685 (and idlwave-path-alist (not idlwave-catalog-process))]
8686 ["Scan Directories &" (idlwave-update-routine-info '(64))
8687 (and idlwave-path-alist (not idlwave-catalog-process))]
8688 "--"
8689 "Routine Shadows"
8690 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
8691 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
8692 ["Check Everything" idlwave-list-all-load-path-shadows t])
8693 ("Misc"
8694 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
8695 "--"
8696 ["Insert TAB character" idlwave-hard-tab t])
8697 "--"
8698 ("External"
8699 ["Generate IDL tags" idlwave-make-tags t]
8700 ["Start IDL shell" idlwave-shell t]
8701 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
8702 ["Launch IDL Help" idlwave-launch-idlhelp t])
8703 "--"
8704 ("Customize"
8705 ["Browse IDLWAVE Group" idlwave-customize t]
8706 "--"
8707 ["Build Full Customize Menu" idlwave-create-customize-menu
8708 (fboundp 'customize-menu-create)])
8709 ("Documentation"
8710 ["Describe Mode" describe-mode t]
8711 ["Abbreviation List" idlwave-list-abbrevs t]
8712 "--"
8713 ["Commentary in idlwave.el" idlwave-show-commentary t]
8714 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
8715 "--"
8716 ["Info" idlwave-info t]
8717 "--"
8718 ["Launch IDL Help" idlwave-launch-idlhelp t])))
8720 (defvar idlwave-mode-debug-menu-def
8721 '("Debug"
8722 ["Start IDL shell" idlwave-shell t]
8723 ["Save and .RUN buffer" idlwave-shell-save-and-run
8724 (and (boundp 'idlwave-shell-automatic-start)
8725 idlwave-shell-automatic-start)]))
8727 (if (or (featurep 'easymenu) (load "easymenu" t))
8728 (progn
8729 (easy-menu-define idlwave-mode-menu idlwave-mode-map
8730 "IDL and WAVE CL editing menu"
8731 idlwave-mode-menu-def)
8732 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
8733 "IDL and WAVE CL editing menu"
8734 idlwave-mode-debug-menu-def)))
8736 (defun idlwave-customize ()
8737 "Call the customize function with idlwave as argument."
8738 (interactive)
8739 ;; Try to load the code for the shell, so that we can customize it
8740 ;; as well.
8741 (or (featurep 'idlw-shell)
8742 (load "idlw-shell" t))
8743 (customize-browse 'idlwave))
8745 (defun idlwave-create-customize-menu ()
8746 "Create a full customization menu for IDLWAVE, insert it into the menu."
8747 (interactive)
8748 (if (fboundp 'customize-menu-create)
8749 (progn
8750 ;; Try to load the code for the shell, so that we can customize it
8751 ;; as well.
8752 (or (featurep 'idlw-shell)
8753 (load "idlw-shell" t))
8754 (easy-menu-change
8755 '("IDLWAVE") "Customize"
8756 `(["Browse IDLWAVE group" idlwave-customize t]
8757 "--"
8758 ,(customize-menu-create 'idlwave)
8759 ["Set" Custom-set t]
8760 ["Save" Custom-save t]
8761 ["Reset to Current" Custom-reset-current t]
8762 ["Reset to Saved" Custom-reset-saved t]
8763 ["Reset to Standard Settings" Custom-reset-standard t]))
8765 (error "Cannot expand menu (outdated version of cus-edit.el)")))
8767 (defun idlwave-show-commentary ()
8768 "Use the finder to view the file documentation from `idlwave.el'."
8769 (interactive)
8770 (require 'finder)
8771 (finder-commentary "idlwave.el"))
8773 (defun idlwave-shell-show-commentary ()
8774 "Use the finder to view the file documentation from `idlw-shell.el'."
8775 (interactive)
8776 (require 'finder)
8777 (finder-commentary "idlw-shell.el"))
8779 (defun idlwave-info ()
8780 "Read documentation for IDLWAVE in the info system."
8781 (interactive)
8782 (require 'info)
8783 (Info-goto-node "(idlwave)"))
8785 (defun idlwave-list-abbrevs (arg)
8786 "Show the code abbreviations define in IDLWAVE mode.
8787 This lists all abbrevs where the replacement text differs from the input text.
8788 These are the ones the users want to learn to speed up their writing.
8790 The function does *not* list abbrevs which replace a word with itself
8791 to call a hook. These hooks are used to change the case of words or
8792 to blink the matching `begin', and the user does not need to know them.
8794 With arg, list all abbrevs with the corresponding hook.
8796 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
8798 (interactive "P")
8799 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
8800 abbrevs
8801 str rpl func fmt (len-str 0) (len-rpl 0))
8802 (mapatoms
8803 (lambda (sym)
8804 (if (symbol-value sym)
8805 (progn
8806 (setq str (symbol-name sym)
8807 rpl (symbol-value sym)
8808 func (symbol-function sym))
8809 (if arg
8810 (setq func (prin1-to-string func))
8811 (if (and (listp func) (stringp (nth 2 func)))
8812 (setq rpl (concat "EVAL: " (nth 2 func))
8813 func "")
8814 (setq func "")))
8815 (if (or arg (not (string= rpl str)))
8816 (progn
8817 (setq len-str (max len-str (length str)))
8818 (setq len-rpl (max len-rpl (length rpl)))
8819 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
8820 table)
8821 ;; sort the list
8822 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
8823 ;; Make the format
8825 (with-output-to-temp-buffer "*Help*"
8826 (if arg
8827 (progn
8830 (princ (format fmt "KEY" "REPLACE" "HOOK"))
8831 (princ (format fmt "---" "-------" "----")))
8834 (princ (format fmt "KEY" "ACTION" ""))
8835 (princ (format fmt "---" "------" "")))
8836 (mapcar
8837 (lambda (list)
8838 (setq str (car list)
8839 rpl (nth 1 list)
8840 func (nth 2 list))
8841 (princ (format fmt str rpl func)))
8842 abbrevs)))
8843 ;; Make sure each abbreviation uses only one display line
8844 (save-excursion
8845 (set-buffer "*Help*")
8846 (setq truncate-lines t)))
8848 ;; Add .pro files to speedbar for support, if it's loaded
8849 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
8851 ;; Set an idle timer to load the routine info.
8852 ;; Will only work on systems which support this.
8853 (or idlwave-routines (idlwave-start-load-rinfo-timer))
8857 ;; Run the hook
8858 (run-hooks 'idlwave-load-hook)
8860 (provide 'idlwave)
8862 ;; arch-tag: f77f3b0c-c37c-424f-a328-0886fd42b6fb
8863 ;;; idlwave.el ends here