| blob | 6bd7e0eaced8ff1743a02265c7a00514b570c237 |
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.5
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., 59 Temple Place - Suite 330,
27 ;; Boston, MA 02111-1307, USA.
29 ;;; Commentary:
31 ;; In the remotely distant past, based on pascal.el, though bears
32 ;; little resemblance to it now.
33 ;;
34 ;; Incorporates many ideas, such as abbrevs, action routines, and
35 ;; continuation line indenting, from wave.el.
36 ;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder.
37 ;;
38 ;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode")
39 ;; for features, key bindings, and info.
40 ;; Also, Info format documentation is available with `M-x idlwave-info'
41 ;;
42 ;; New versions of IDLWAVE, documentation, and more information
43 ;; available from:
44 ;; http://idlwave.org
45 ;;
46 ;; INSTALLATION
47 ;; ============
48 ;;
49 ;; Follow the instructions in the INSTALL file of the distribution.
50 ;; In short, put this file on your load path and add the following
51 ;; lines to your .emacs file:
52 ;;
53 ;; (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
54 ;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
55 ;; (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
56 ;;
57 ;;
58 ;; SOURCE
59 ;; ======
60 ;;
61 ;; The newest version of this file is available from the maintainer's
62 ;; Webpage:
63 ;;
64 ;; http://idlwave.org
65 ;;
66 ;; DOCUMENTATION
67 ;; =============
68 ;;
69 ;; IDLWAVE is documented online in info format. A printable version
70 ;; of the documentation is available from the maintainers webpage (see
71 ;; SOURCE).
72 ;;
73 ;;
74 ;; ACKNOWLEDGMENTS
75 ;; ===============
76 ;;
77 ;; Thanks to the following people for their contributions and comments:
78 ;;
79 ;; Ulrik Dickow <dickow_at_nbi.dk>
80 ;; Eric E. Dors <edors_at_lanl.gov>
81 ;; Stein Vidar H. Haugan <s.v.h.haugan_at_astro.uio.no>
82 ;; David Huenemoerder <dph_at_space.mit.edu>
83 ;; Kevin Ivory <Kevin.Ivory_at_linmpi.mpg.de>
84 ;; Dick Jackson <dick_at_d-jackson.com>
85 ;; Xuyong Liu <liu_at_stsci.edu>
86 ;; Simon Marshall <Simon.Marshall_at_esrin.esa.it>
87 ;; Laurent Mugnier <mugnier_at_onera.fr>
88 ;; Lubos Pochman <lubos_at_rsinc.com>
89 ;; Bob Portmann <portmann_at_al.noaa.gov>
90 ;; Patrick M. Ryan <pat_at_jaameri.gsfc.nasa.gov>
91 ;; Marty Ryba <ryba_at_ll.mit.edu>
92 ;; Paul Sorenson <aardvark62_at_msn.com>
93 ;; Phil Sterne <sterne_at_dublin.llnl.gov>
94 ;; Phil Williams <williams_at_irc.chmcc.org>
95 ;;
96 ;; CUSTOMIZATION:
97 ;; =============
98 ;;
99 ;; IDLWAVE has extensive customize support; to learn about the
100 ;; variables which control the mode's behavior, use `M-x
101 ;; idlwave-customize'.
102 ;;
103 ;; You can set your own preferred values with Customize, or with Lisp
104 ;; code in .emacs. For an example of what to put into .emacs, check
105 ;; the TexInfo documentation or see a complete .emacs available at the
106 ;; website.
107 ;;
108 ;; KNOWN PROBLEMS:
109 ;; ==============
110 ;;
111 ;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual
112 ;; Numerics, Inc. is growing less and less complete as the two
113 ;; languages grow increasingly apart. The mode probably shouldn't
114 ;; even have "WAVE" in it's title, but it's catchy, and was required
115 ;; to avoid conflict with the CORBA idl.el mode. Caveat WAVEor.
116 ;;
117 ;; Moving the point backwards in conjunction with abbrev expansion
118 ;; does not work as I would like it, but this is a problem with
119 ;; emacs abbrev expansion done by the self-insert-command. It ends
120 ;; up inserting the character that expanded the abbrev after moving
121 ;; point backward, e.g., "\cl" expanded with a space becomes
122 ;; "LONG( )" with point before the close paren. This is solved by
123 ;; using a temporary function in `post-command-hook' - not pretty,
124 ;; but it works.
125 ;;
126 ;; Tabs and spaces are treated equally as whitespace when filling a
127 ;; comment paragraph. To accomplish this, tabs are permanently
128 ;; replaced by spaces in the text surrounding the paragraph, which
129 ;; may be an undesirable side-effect. Replacing tabs with spaces is
130 ;; limited to comments only and occurs only when a comment
131 ;; paragraph is filled via `idlwave-fill-paragraph'.
132 ;;
133 ;; Muti-statement lines (using "&") on block begin and end lines can
134 ;; ruin the formatting. For example, multiple end statements on a
135 ;; line: endif & endif. Using "&" outside of block begin/end lines
136 ;; should be okay.
137 ;;
138 ;; Determining the expression at point for printing and other
139 ;; examination commands is somewhat rough: currently only fairly
140 ;; simple entities are found. You can always drag-select or examine
141 ;; a pre-selected region.
142 ;;
143 ;; When forcing completion of method keywords, the initial
144 ;; query for a method has multiple entries for some methods. Would
145 ;; be too difficult to fix this hardly used case.
146 ;;
147 \f
148 ;;; Code:
154 ;; For XEmacs
163 ;; Kludge to allow `defcustom' for Emacs 19.
166 nil ;; We've got what we needed
167 ;; We have the old or no custom-library, hack around it!
173 "Major mode for editing IDL .pro files"
185 ;;; Variables for indentation behavior ---------------------------------------
188 "Indentation and formatting options for IDLWAVE mode."
192 "*Extra indentation for the main block of code.
193 That is the block between the FUNCTION/PRO statement and the END
194 statement for that program unit."
199 "*Extra indentation applied to block lines.
200 If you change this, you probably also want to change `idlwave-end-offset'."
205 "*Extra indentation applied to block END lines.
206 A value equal to negative `idlwave-block-indent' will make END lines
207 line up with the block BEGIN lines."
212 "*Extra indentation applied to continuation lines.
213 This extra offset applies to the first of a set of continuation lines.
214 The following lines receive the same indentation as the first."
219 "*Maximum additional indentation for special continuation indent.
220 Several special indentations are tried to help line up continuation
221 lines in routine calls or definitions, other statements with
222 parentheses, or assignment statements. This variable specifies a
223 maximum amount by which this special indentation can exceed the
224 standard continuation indentation, otherwise defaulting to a fixed
225 offset. Set to 0 to effectively disable all special continuation
226 indentation, or to a large number (like 100) to enable it in all
227 cases. See also `idlwave-indent-to-open-paren', which can override
228 this variable."
233 "*Non-nil means, indent continuation lines to innermost open
234 parenthesis. This indentation occurs even if otherwise disallowed by
235 `idlwave-max-extra-continuation-indent'. Matching parens and the
236 interleaving args are lined up. Example:
238 x = function_a(function_b(function_c( a, b, [1,2,3, $
239 4,5,6 $
240 ], $
241 c, d $
242 )))
244 When this variable is nil, paren alignment may still occur, based on
245 the value of `max-extra-continuation-indent', which, if zero, would
246 yield:
248 x = function_a(function_b(function_c( a, b, [1,2,3, $
249 4,5,6 $
250 ], $
251 c, d $
252 )))"
257 "*Non-nil means, indent continuation lines with parens by nesting
258 lines at consecutively deeper levels."
264 "*If set non-nil then comment paragraphs are indented under the
265 hanging indent given by `idlwave-hang-indent-regexp' match in the first line
266 of the paragraph."
271 "*Regular expression matching the position of the hanging indent
272 in the first line of a comment paragraph. The size of the indent
273 extends to the end of the match for the regular expression."
278 "*If non-nil then use last match on line for `idlwave-indent-regexp'."
283 "*If non-nil then auto fill will only operate on comment lines."
288 "*If non-nil then auto fill will split strings with the IDL `+' operator.
289 When the line end falls within a string, string concatenation with the
290 '+' operator will be used to distribute a long string over lines.
291 If nil and a string is split then a terminal beep and warning are issued.
293 This variable is ignored when `idlwave-fill-comment-line-only' is
294 non-nil, since in this case code is not auto-filled."
299 "*If non-nil then `idlwave-split-line' will split strings with `+'.
300 When the splitting point of a line falls inside a string, split the string
301 using the `+' string concatenation operator. If nil and a string is
302 split then a terminal beep and warning are issued."
307 "*The indentation of a comment that starts with this regular
308 expression will not be changed. Note that the indentation of a comment
309 at the beginning of a line is never changed."
314 "*A comment anchored at the beginning of line.
315 A comment matching this regular expression will not have its
324 "*A comment that starts with this regular expression on a line by
325 itself is indented as if it is a part of IDL code. As a result if
326 the comment is not preceded by whitespace it is unchanged."
330 ;; Comments not matching any of the above will be indented as a
331 ;; right-margin comment, i.e., to a minimum of `comment-column'.
333 ;;; Routine Info and Completion ---------------------------------------
336 "Routine Info options for IDLWAVE mode."
340 "*Non-nil means search the IDL path for library catalog files.
342 These files, named .idlwave_catalog, document routine information for
343 individual directories and libraries of IDL .pro files. Many popular
344 libraries come with catalog files by default, so leaving this on is a
345 usually a good idea.."
350 "*Seconds of idle time before routine info is automatically initialized.
351 Initializing the routine info can take long, in particular if a large
352 library catalog is involved. When Emacs is idle for more than the number
353 of seconds specified by this variable, it starts the initialization.
354 The process is split into five steps, in order to keep possible work
355 interruption as short as possible. If one of the steps finishes, and no
356 user input has arrived in the mean time, initialization proceeds immediately
357 to the next step.
358 A good value for this variable is about 1/3 of the time initialization
359 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.
360 A Value of 0 means, don't initialize automatically."
365 "*Non-nil means, scan buffers for IDL programs when updating info.
366 The scanning is done by the command `idlwave-update-routine-info'.
367 The following values are allowed:
369 nil Don't scan any buffers.
370 t Scan all idlwave-mode buffers in the current editing session.
371 current Scan only the current buffer, but no other buffers."
379 "*Non-nil means query the shell for info about compiled routines.
380 Querying the shell is useful to get information about compiled modules,
381 and it is turned on by default. However, when you have a complete library
382 scan, this is not necessary."
388 "*Controls under what circumstances routine info is updated automatically.
389 Possible values:
390 nil Never
391 t All available
392 \(...) A list of circumstances. Allowed members are:
393 find-file Add info for new IDLWAVE buffers.
394 save-buffer Update buffer info when buffer is saved
395 kill-buffer Remove buffer info when buffer gets killed
396 compile-buffer Update shell info after `idlwave-shell-save-and...'"
408 "*Maximum number of source files displayed in the Routine Info window.
409 When an integer, it is the maximum number of source files displayed.
410 t means to show all source files."
415 "Library path for Windows and MacOS. Not needed under Unix. When
416 selecting the directories to scan for IDL user catalog routine info,
417 IDLWAVE can, under UNIX, query the shell for the exact search path
418 \(the value of !PATH). However, under Windows and MacOS (pre-OSX),
419 the IDLWAVE shell does not work. In this case, this variable can be
420 set to specify the paths where IDLWAVE can find PRO files. The shell
421 will only be asked for a list of paths when this variable is nil. The
422 value is a list of directories. A directory preceeded by a `+' will
423 be searched recursively. If you set this variable on a UNIX system,
424 the shell will not be queried. See also `idlwave-system-directory'."
429 "The IDL system directory for Windows and MacOS. Not needed under
430 UNIX. Set this to the value of the `!DIR' system variable in IDL.
431 IDLWAVE uses this to find out which of the library routines belong to
432 the official system library. All files inside the `lib' subdirectory
433 are considered system library files - so don't install private stuff
434 in this directory. On UNIX systems, IDLWAVE queries the shell for the
435 value of `!DIR'. See also `idlwave-library-path'."
441 "*Directory for configuration files and user-library catalog."
452 "Alist of regular expressions matching special library directories.
453 When listing routine source locations, IDLWAVE gives a short hint where
454 the file defining the routine is located. By default it lists `SystemLib'
455 for routines in the system library `!DIR/lib' and `Library' for anything
456 else. This variable can define additional types. The car of each entry
457 is a regular expression matching the file name (they normally will match
458 on the path). The cdr is the string to be used as identifier. Max 10
459 chars are allowed."
465 "Write out path (!PATH) and system directory (!DIR) info automatically.
466 Path info is needed to locate library catalog files. If non-nil,
467 whenever the path-list changes as a result of shell-query, etc., it is
469 used to force a write."
474 "Completion options for IDLWAVE mode."
491 "Association list setting the case of completed words.
493 This variable determines the case (UPPER/lower/Capitalized...) of
494 words inserted into the buffer by completion. The preferred case can
495 be specified separately for routine names, keywords, classes and
496 methods.
497 This alist should therefore have entries for `routine' (normal
498 functions and procedures, i.e. non-methods), `keyword', `class', and
499 `method'. Plausible values are
501 upcase upcase whole word, like `BOX_CURSOR'
502 downcase downcase whole word, like `read_ppm'
503 capitalize capitalize each part, like `Widget_Control'
504 preserve preserve case as is, like `IDLgrView'
506 The value can also be any Emacs Lisp function which transforms the
507 case of characters in a string.
509 A value of `preserve' means that the case of the completed word is
510 identical to the way it was written in the definition statement of the
511 routine. This was implemented to allow for mixed-case completion, in
512 particular of object classes and methods.
513 If a completable word is defined in multiple locations, the meaning of
514 `preserve' is not unique since the different definitions might be
515 cased differently. Therefore IDLWAVE always takes the case of the
516 *first* definition it encounters during routine info collection and
517 uses the case derived from it consistently.
519 Note that a lowercase-only string in the buffer will always be completed in
520 lower case (but see the variable `idlwave-completion-force-default-case').
522 After changing this variable, you need to either restart Emacs or press
523 `C-u C-c C-i' to update the internal lists."
530 "*Non-nil means, completion will always honor `idlwave-completion-case'.
531 When nil, only the completion of a mixed case or upper case string
532 will honor the default settings in `idlwave-completion-case', while
533 the completion of lower case strings will be completed entirely in
534 lower case."
539 "*Non-nil means, the empty string is considered downcase for completion.
540 The case of what is already in the buffer determines the case of completions.
541 When this variable is non-nil, the empty string is considered to be downcase.
542 Completing on the empty string then offers downcase versions of the possible
543 completions."
548 "Obsolete variable. See `idlwave-complete-empty-string-as-lower-case' and
552 "*Non-nil means, the case of tokens in buffers dominates over system stuff.
553 To make this possible, we need to re-case everything each time we update
554 the routine info from the buffers. This is slow.
555 The default is to consider the case given in the system and library files
556 first which makes updating much faster."
561 "*Non-nil means, highlight completions for which system help is available.
562 Help can then be accessed with mouse-3.
563 This option is only effective when the online help system is installed."
568 "Non-nil means, treat inheritance with completion, online help etc.
569 When nil, IDLWAVE only knows about the native methods and tags of a class,
570 not about inherited ones."
575 "List of regular expressions for class-driven keyword inheritance.
577 up the class tree. While it cannot be assumed that the presence of an
578 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
579 certain methods this assumption is almost always true. The methods
580 for which to assume this can be set here."
586 "*Number of classes to show when completing object methods and keywords.
587 When completing methods or keywords for an object with unknown class,
588 the *Completions* buffer will show the valid classes for each completion
589 like this:
591 MyMethod <Class1,Class2,Class3>
593 The value of this variable may be nil to inhibit display, or an integer to
594 indicate the maximum number of classes to display.
596 On XEmacs, a full list of classes will also be placed into a `help-echo'
597 property on the competion items, so that the list of classes for the current
598 item is displayed in the echo area. If the value of this variable is a
599 negative integer, the `help-echo' property will be suppressed."
605 "*Non-nil means, fontify the classes in completions buffer.
606 This makes it easier to distinguish the completion items from the extra
607 class info listed. See `idlwave-completion-show-classes'."
613 "Association list governing specification of object classes for completion.
615 When IDLWAVE tries to complete object-oriented methods, it usually
616 cannot determine the class of a given object from context. In order
617 to provide the user with a correct list of methods or keywords, it
618 needs to determine the appropriate class. IDLWAVE has two ways of
619 doing this (well, three ways if you count the shell... see
620 `idlwave-shell-query-for-class'):
622 1. Combine the items of all available classes which contain this
623 method for the purpose of completion. So when completing a method,
624 all methods of all known classes are available, and when completing
625 a keyword, all keywords allowed for this method in any class are
626 shown. This behavior is very much like normal completion and is
627 therefore the default. It works much better than one might think -
628 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
629 become uncomfortably long. See also
630 `idlwave-completion-show-classes'.
632 2. The second possibility is to ask the user on each occasion. To
633 make this less interruptive, IDLWAVE can store the class as a text
634 property on the object operator `->'. For a given object in the
635 source code, class selection will then be needed only once
636 - for example to complete the method. Keywords to the method can
637 then be completed directly, because the class is already known.
638 You will have to turn on the storage of the selected class
639 explicitly with the variable `idlwave-store-inquired-class'.
641 This variable allows you to configure IDLWAVE's method and
642 method-keyword completion behavior. Its value is an alist, which
643 should contain at least two elements: (method-default . VALUE) and
644 \(keyword-default . VALUE), where VALUE is either t or nil. These
645 specify if the class should be found during method and keyword
646 completion, respectively.
648 The alist may have additional entries specifying exceptions from the
649 keyword completion rule for specific methods, like INIT or
650 GETPROPERTY. In order to turn on class specification for the INIT
660 :inline t
665 "*Non-nil means, store class of a method call as text property on `->'.
666 IDLWAVE sometimes has to ask the user for the class associated with a
667 particular object method call. This happens during the commands
668 `idlwave-routine-info' and `idlwave-complete', depending upon the
669 value of the variable `idlwave-query-class'.
671 When you specify a class, this information can be stored as a text
672 property on the `->' arrow in the source code, so that during the same
673 editing session, IDLWAVE will not have to ask again. When this
674 variable is non-nil, IDLWAVE will store and reuse the class information.
676 on the arrow.
678 The default of this variable is nil, since the result of commands then
679 is more predictable. However, if you know what you are doing, it can
680 be nice to turn this on.
682 An arrow which knows the class will be highlighted with
684 displays (with prefix arg: deletes) the class stored on the arrow
685 at point."
690 "*Face to highlight object operator arrows `->' which carry a class property.
691 When IDLWAVE stores a class name as text property on an object arrow
692 \(see variable `idlwave-store-inquired-class', it highlights the arrow
693 with this font in order to remind the user that this arrow is special."
698 "*Non-nil means, resize the Routine-info *Help* window to fit the content."
703 "*Non-nil means, completion automatically adds `=' after completed keywords."
708 "*Non-nil means, completion automatically adds `(' after completed function.
709 nil means, don't add anything.
710 A value of `2' means, also add the closing parenthesis and position cursor
711 between the two."
718 "*Non-nil means, try to restore the window configuration after completion.
719 When completion is not unique, Emacs displays a list of completions.
720 This messes up your window configuration. With this variable set, IDLWAVE
721 restores the old configuration after successful completion."
725 ;;; Variables for abbrev and action behavior -----------------------------
728 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
729 The variables in this group govern this."
733 "*Non-nil means performs actions when indenting.
734 The actions that can be performed are listed in `idlwave-indent-action-table'."
739 "*A single character string used to start abbreviations in abbrev mode.
740 Possible characters to chose from: ~`\%
741 or even '?'. '.' is not a good choice because it can make structure
742 field names act like abbrevs in certain circumstances.
744 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
745 must set it directly using `setq' in the .emacs file before idlwave.el
746 is loaded."
751 "*Non-nil means, enable `idlwave-surround'.
752 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
753 `idlwave-surround'.
754 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
756 Also see the default key bindings for keys using `idlwave-surround'.
757 Keys are bound and made into actions calling `idlwave-surround' with
758 `idlwave-action-and-binding'.
759 See help for `idlwave-action-and-binding' for examples.
761 Also see help for `idlwave-surround'."
766 "*Non-nil means pad '=' in keywords (routine calls or defs) like assignment.
767 Whenever `idlwave-surround' is non-nil then this affects how '=' is
768 padded for keywords and for variables. If t, pad the same as for
769 assignments. If nil then spaces are removed. With any other value,
770 spaces are left unchanged."
778 "*Non-nil means point blinks to block beginning for `idlwave-show-begin'."
783 "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
788 "*Non-nil means re-indent line after END was typed."
793 "*Non-nil means the abbrev hook can move point.
794 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
795 definitions, use the command `list-abbrevs', for abbrevs that move
796 point. Moving point is useful, for example, to place point between
797 parentheses of expanded functions.
799 See `idlwave-check-abbrev'."
804 "*Non-nil means all abbrevs will be forced to either upper or lower case.
805 If the value t, all expanded abbrevs will be upper case.
806 If the value is 'down then abbrevs will be forced to lower case.
807 If nil, the case will not change.
808 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
809 upper case, regardless of this variable."
814 "*Non-nil means, reserved words will be made upper case via abbrev expansion.
815 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
816 Has effect only if in abbrev-mode."
820 ;;; Action/Expand Tables.
821 ;;
822 ;; The average user may have difficulty modifying this directly. It
823 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
824 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
825 ;; examples of how to add an action.
826 ;;
827 ;; The action table is used by `idlwave-indent-line' whereas both the
828 ;; action and expand tables are used by `idlwave-indent-and-action'. In
829 ;; general, the expand table is only used when a line is explicitly
830 ;; indented. Whereas, in addition to being used when the expand table
831 ;; is used, the action table is used when a line is indirectly
832 ;; indented via line splitting, auto-filling or a new line creation.
833 ;;
834 ;; Example actions:
835 ;;
836 ;; Capitalize system vars
837 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
838 ;;
839 ;; Capitalize procedure name
840 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
841 ;; '(capitalize-word 1) t)
842 ;;
843 ;; Capitalize common block name
844 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
845 ;; '(capitalize-word 1) t)
846 ;; Capitalize label
847 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
848 ;; '(capitalize-word -1) t)
851 "*Associated array containing action lists of search string (car),
852 and function as a cdr. This table is used by `idlwave-indent-line'.
853 See documentation for `idlwave-do-action' for a complete description of
854 the action lists.
856 Additions to the table are made with `idlwave-action-and-binding' when a
857 binding is not requested.
861 "*Associated array containing action lists of search string (car),
862 and function as a cdr. The table is used by the
863 `idlwave-indent-and-action' function. See documentation for
864 `idlwave-do-action' for a complete description of the action lists.
866 Additions to the table are made with `idlwave-action-and-binding' when a
867 binding is requested.
870 ;;; Documentation header and history keyword ---------------------------------
873 "Options for documenting IDLWAVE files."
876 ;; FIXME: make defcustom?
879 ";+
880 ; NAME:
881 ;
882 ;
883 ;
884 ; PURPOSE:
885 ;
886 ;
887 ;
888 ; CATEGORY:
889 ;
890 ;
891 ;
892 ; CALLING SEQUENCE:
893 ;
894 ;
895 ;
896 ; INPUTS:
897 ;
898 ;
899 ;
900 ; OPTIONAL INPUTS:
901 ;
902 ;
903 ;
904 ; KEYWORD PARAMETERS:
905 ;
906 ;
907 ;
908 ; OUTPUTS:
909 ;
910 ;
911 ;
912 ; OPTIONAL OUTPUTS:
913 ;
914 ;
915 ;
916 ; COMMON BLOCKS:
917 ;
918 ;
919 ;
920 ; SIDE EFFECTS:
921 ;
922 ;
923 ;
924 ; RESTRICTIONS:
925 ;
926 ;
927 ;
928 ; PROCEDURE:
929 ;
930 ;
931 ;
932 ; EXAMPLE:
933 ;
934 ;
935 ;
936 ; MODIFICATION HISTORY:
937 ;
938 ;-
940 "*A list (PATHNAME STRING) specifying the doc-header template to use for
941 summarizing a file. If PATHNAME is non-nil then this file will be included.
942 Otherwise STRING is used. If nil, the file summary will be omitted.
943 For example you might set PATHNAME to the path for the
947 "*Non-nil means, the documentation header will always be at start of file.
948 When nil, the header is positioned between the PRO/FUNCTION line of
949 the current routine and the code, allowing several routine headers in
950 a file."
955 "*The hook function used to update the timestamp of a function."
960 "*The modifications keyword to use with the log documentation commands.
961 A ':' is added to the keyword end.
962 Inserted by doc-header and used to position logs by doc-modification.
963 If nil it will not be inserted."
968 "*Regexp matching the start of a document library header."
973 "*Regexp matching the end of a document library header."
977 ;;; External Programs -------------------------------------------------------
980 "Path locations of external commands used by IDLWAVE."
983 ;; WARNING: The following variable has recently been moved from
984 ;; idlw-shell.el to this file. I hope this does not break
985 ;; anything.
988 "*If non-nil, this is the command to run IDL.
989 Should be an absolute file path or path relative to the current environment
990 execution search path. If you want to specify command line switches
991 for the idl program, use `idlwave-shell-command-line-options'.
993 I know the name of this variable is badly chosen, but I cannot change
994 it without compromizing backwards-compatibility."
999 "*A list of command line options for calling the IDL program.
1000 Since IDL is executed directly without going through a shell like /bin/sh,
1002 string for each argument. But you may also give a single string which
1003 contains the options whitespace-separated. Emacs will be kind enough to
1004 split it for you."
1006 string
1011 "*The external application providing reference help for programming."
1015 ;;; Some Shell variables which must be defined here.-----------------------
1018 "List of modifiers to be used for the debugging commands.
1019 Will be used to bind debugging commands in the shell buffer and in all
1020 source buffers. These are additional convenience bindings, the debugging
1021 commands are always available with the `C-c C-d' prefix.
1022 If you set this to '(control shift), this means setting a breakpoint will
1023 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1024 are `control', `meta', `super', `hyper', `alt', and `shift'."
1035 "*If non-nil attempt invoke idlwave-shell if not already running.
1036 This is checked when an attempt to send a command to an
1037 IDL process is made."
1041 ;;; Miscellaneous variables -------------------------------------------------
1044 "Miscellaneous options for IDLWAVE mode."
1048 "*Non-nil displays a startup message when `idlwave-mode' is first called."
1054 common-blocks class-arrows)
1055 "Items which should be fontified on the default fontification level 2.
1056 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1057 is everything and level 2 is specified by this list.
1058 This variable must be set before IDLWAVE gets loaded. It is
1059 a list of symbols, the following symbols are allowed.
1061 pros-and-functions Procedure and Function definitions
1062 batch-files Batch Files
1063 idlwave-idl-keywords IDL Keywords
1064 label Statement Labels
1065 goto Goto Statements
1066 common-blocks Common Blocks
1067 keyword-parameters Keyword Parameters in routine definitions and calls
1068 system-variables System Variables
1069 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1070 class-arrows Object Arrows with class property"
1088 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1093 "Normal hook. Executed when idlwave.el is loaded."
1098 "Non-nil means turn on a few experimental features.
1099 This variable is only for the maintainer, to test difficult stuff,
1100 while still distributing stable releases.
1103 ;;;
1104 ;;; End customization variables section
1105 ;;;
1107 ;;; Non customization variables
1109 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1110 ;;; Simon Marshall <simon_at_gnu.ai.mit.edu>
1111 ;;; and Carsten Dominik...
1113 ;; The following are the reserved words in IDL. Maybe we should
1114 ;; highlight some more stuff as well?
1115 ;; Procedure declarations. Fontify keyword plus procedure name.
1117 ;; To update this regexp, update the list of keywords and
1118 ;; evaluate the form.
1119 ;; (insert
1120 ;; (prin1-to-string
1121 ;; (concat
1122 ;; "\\<\\("
1123 ;; (regexp-opt
1124 ;; '("||" "&&" "and" "or" "xor" "not"
1125 ;; "eq" "ge" "gt" "le" "lt" "ne"
1126 ;; "for" "do" "endfor"
1127 ;; "if" "then" "endif" "else" "endelse"
1128 ;; "case" "of" "endcase"
1129 ;; "switch" "break" "continue" "endswitch"
1130 ;; "begin" "end"
1131 ;; "repeat" "until" "endrep"
1132 ;; "while" "endwhile"
1133 ;; "goto" "return"
1134 ;; "inherits" "mod"
1135 ;; "compile_opt" "forward_function"
1136 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1137 ;; "\\)\\>")))
1138 "\\<\\(&&\\|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\\|||\\)\\>")
1142 ;; Function declarations. Fontify keyword plus function name.
1148 ;; Common blocks
1154 ;; Start with point after block name and comma
1156 nil
1158 )))
1160 ;; Batch files
1164 ;; FIXME warning.
1168 ;; Labels
1172 ;; The goto statement and its label
1178 ;; Tags in structure definitions. Note that this definition
1179 ;; actually collides with labels, so we have to use the same
1180 ;; face. It also matches named subscript ranges,
1181 ;; e.g. vec{bottom:top]. No good way around this.
1185 ;; Structure names
1190 ;; Keyword parameters, like /xlog or ,xrange=[]
1191 ;; This is anchored to the comma preceeding the keyword.
1192 ;; Treats continuation lines, works only during whole buffer
1193 ;; fontification. Slow, use it only in fancy fontification.
1195 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\\(\n[ \t]*;.*\\)*\n[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1198 ;; System variables start with a bang.
1203 ;; Special and unusual operators (not used because too noisy)
1207 ;; All operators (not used because too noisy)
1211 ;; Arrows with text property `idlwave-class'
1225 batch-files
1226 idlwave-idl-keywords
1227 label goto
1228 structtag
1229 structname
1230 common-blocks
1231 keyword-parameters
1232 system-variables
1233 class-arrows)
1237 ;; Match an object arrow with class property
1247 idlwave-font-lock-keywords-1
1248 idlwave-font-lock-keywords-2
1249 idlwave-font-lock-keywords-3)
1250 nil t
1252 beginning-of-line))
1258 "Regexp to match the start of a full-line comment.
1259 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1264 "Regular expression to find the beginning of a block. The case does
1268 "Regular expression to find the beginning of a unit. The case does
1272 "Regular expression to find the line that indicates the end of unit.
1273 This line is the end of buffer or the start of another unit. The case does
1281 "Regular expression to find the end of a block. The case does
1294 "Matches between statements and the corresponding END variant.
1295 The cars are the reserved words starting a block. If the block really
1296 begins with BEGIN, the cars are the reserved words before the begin
1297 which can be used to identify the block type.
1298 This is used to check for the correct END type, to close blocks and
1303 "Regular expression matching reserved words which can stand before
1304 blocks starting with a BEGIN statement. The matches must have associations
1321 ))
1325 ;; "endif else" is the only possible "end" that can be
1326 ;; followed by a statement on the same line.
1328 ;; all other "end"s can not be followed by a statement.
1341 idlwave-identifier
1345 idlwave-identifier
1350 "Associated list of statement matching regular expressions.
1351 Each regular expression matches the start of an IDL statement. The
1352 first element of each association is a symbol giving the statement
1353 type. The associated value is a list. The first element of this list
1354 is a regular expression matching the start of an IDL statement for
1355 identifying the statement type. The second element of this list is a
1356 regular expression for finding a substatement for the type. The
1357 substatement starts after the end of the found match modulo
1358 whitespace. If it is nil then the statement has no substatement. The
1359 list order matters since matching an assignment statement exactly is
1360 not possible without parsing. Thus assignment statement become just
1369 ;; Note that this is documented in the v18 manuals as being a string
1370 ;; of length one rather than a single character.
1371 ;; The code in this file accepts either format for compatibility.
1373 "Character to be inserted for IDL comment indentation.
1377 "Character which is inserted as a last character on previous line by
1383 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1387 ;; If I take the time I can replace idlwave-keyword-abbrev with
1388 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1389 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1390 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1391 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1394 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1395 Specifically, if the abbrev is in a comment or string it is unexpanded.
1396 Otherwise ARGS forms a list that is evaluated."
1441 "Execute BODY with a different syntax table."
1449 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1450 ; "Execute BODY with a different syntax table."
1451 ; `(let ((saved-syntax (syntax-table)))
1452 ; (unwind-protect
1453 ; (progn
1454 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1455 ; ,@body)
1456 ; (set-syntax-table saved-syntax))))
1459 "KEY and CMD are made into a key binding and an indent action.
1460 KEY is a string - same as for the `define-key' function. CMD is a
1461 function of no arguments or a list to be evaluated. CMD is bound to
1462 KEY in `idlwave-mode-map' by defining an anonymous function calling
1463 `self-insert-command' followed by CMD. If KEY contains more than one
1464 character a binding will only be set if SELECT is 'both.
1466 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1467 replacing any previous value for KEY. If a binding is not set then it
1468 will instead be placed in `idlwave-indent-action-table'.
1470 If the optional argument SELECT is nil then an action and binding are
1471 created. If SELECT is 'noaction, then a binding is always set and no
1472 action is created. If SELECT is 'both then an action and binding
1473 will both be created even if KEY contains more than one character.
1474 Otherwise, if SELECT is non-nil then only an action is created.
1476 Some examples:
1477 No spaces before and 1 after a comma
1479 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1481 Capitalize system variables - action only
1482 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1484 ;; Add action
1489 ;; Replace action command
1491 ;; New action
1493 ;; Make key binding for action
1502 cmd
1509 ;(define-key idlwave-mode-map "\C-c\C- " 'idlwave-hard-tab)
1528 ;; (define-key idlwave-mode-map "\r" 'idlwave-newline)
1529 ;; (define-key idlwave-mode-map "\t" 'idlwave-indent-line)
1541 ;; Bind the debug commands also with the special modifiers.
1558 ;; (define-key idlwave-mode-map "\C-c\C-f" 'idlwave-function)
1559 ;; (define-key idlwave-mode-map "\C-c\C-p" 'idlwave-procedure)
1581 ;; Pickup both forms of Esc/Meta binding
1591 ;; Set action and key bindings.
1592 ;; See description of the function `idlwave-action-and-binding'.
1593 ;; Automatically add spaces for the following characters
1594 ;(idlwave-action-and-binding "&" '(idlwave-surround -1 -1 '(?&) 1
1595 ; (lambda (char) 0)))
1597 ;; Binding works for both > and ->, by changing the length of the token.
1603 ;; Automatically add spaces to equal sign if not keyword
1606 ;;;
1607 ;;; Abbrev Section
1608 ;;;
1609 ;;; When expanding abbrevs and the abbrev hook moves backward, an extra
1610 ;;; space is inserted (this is the space typed by the user to expanded
1611 ;;; the abbrev).
1612 ;;;
1618 "Define-abbrev with backward compatibility.
1620 If NOPREFIX is non-nil, don't prepend prefix character. Installs into
1621 idlwave-mode-abbrev-table unless TABLE is non-nil."
1625 expansion
1626 hook)))
1636 ;;
1637 ;; Templates
1638 ;;
1648 ;;
1649 ;; Keywords, system functions, conversion routines
1650 ;;
1706 ;; This section is reserved words only. (From IDL user manual)
1707 ;;
1753 ;; defined later - so just make the compiler hush
1757 ;;;###autoload
1759 "Major mode for editing IDL source files (version 5.5).
1761 The main features of this mode are
1763 1. Indentation and Formatting
1764 --------------------------
1765 Like other Emacs programming modes, C-j inserts a newline and indents.
1766 TAB is used for explicit indentation of the current line.
1769 function can also be used in the middle of a line to split the line
1770 at that point. When used inside a long constant string, the string
1771 is split at that point with the `+' concatenation operator.
1773 Comments are indented as follows:
1775 `;;;' Indentation remains unchanged.
1776 `;;' Indent like the surrounding code
1777 `;' Indent to a minimum column.
1779 The indentation of comments starting in column 0 is never changed.
1782 comment. The indentation of the second line of the paragraph
1783 relative to the first will be retained. Use
1785 comments. When the variable `idlwave-fill-comment-line-only' is
1786 nil, code can also be auto-filled and auto-indented.
1788 To convert pre-existing IDL code to your formatting style, mark the
1793 2. Routine Info
1794 ------------
1795 IDLWAVE displays information about the calling sequence and the
1796 accepted keyword parameters of a procedure or function with
1798 source file of a module. These commands know about system
1799 routines, all routines in idlwave-mode buffers and (when the
1800 idlwave-shell is active) about all modules currently compiled under
1801 this shell. It also makes use of pre-compiled or custom-scanned
1802 user and library catalogs many popular libraries ship with by
1804 information, which is also used for completion (see item 4).
1806 3. Online IDL Help
1807 ---------------
1809 for the system variable, keyword, or routine at point. A single
1810 key stroke gets you directly to the right place in the docs. The
1811 HTML help files package must be installed for this to work -- check
1812 the IDLWAVE webpage for the correct package for your version. See
1813 the manual to configure where and how the HTML help is displayed.
1815 4. Completion
1816 ----------
1818 class names, keyword parameters, system variables and tags, class
1819 tags, structure tags, filenames and much more. It is context
1820 sensitive and figures out what is expected at point. Lower case
1821 strings are completed in lower case, other strings in mixed or
1822 upper case.
1824 5. Code Templates and Abbreviations
1825 --------------------------------
1826 Many Abbreviations are predefined to expand to code fragments and templates.
1841 have direct keybindings - see the list of keybindings below.
1844 beginning of the current program unit (pro, function or main).
1845 Change log entries can be added to the current program unit with
1848 6. Automatic Case Conversion
1849 -------------------------
1850 The case of reserved words and some abbrevs is controlled by
1851 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1853 7. Automatic END completion
1854 ------------------------
1855 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1856 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1858 8. Hooks
1859 -----
1860 Loading idlwave.el runs `idlwave-load-hook'.
1861 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1863 9. Documentation and Customization
1864 -------------------------------
1865 Info documentation for this package is available. Use
1867 not work). For Postscript, PDF, and HTML versions of the
1868 documentation, check IDLWAVE's homepage at `http://idlwave.org'.
1869 IDLWAVE has customize support - see the group `idlwave'.
1871 10.Keybindings
1872 -----------
1873 Here is a list of all keybindings of this mode.
1875 followed by the key sequence to see what the key sequence does.
1920 ;; Set tag table list to use IDLTAGS as file name.
1924 ;; Font-lock additions - originally Phil Williams, then Ulrik Dickow
1925 ;; Following line is for Emacs - XEmacs uses the corresponding property
1926 ;; on the `idlwave-mode' symbol.
1929 ;; Imenu setup
1937 ;; Make a local post-command-hook and add our hook to it
1938 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1942 ;; Make local hooks for buffer updates
1943 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1950 ;; Setup directories and file, if necessary
1953 ;; Update the routine info with info about current buffer?
1956 ;; Run the mode hook
1965 idlwave-user-catalog-file
1966 idlwave-config-directory)
1968 idlwave-path-file
1969 idlwave-config-directory))
1973 ;;
1974 ;; Code Formatting ----------------------------------------------------
1975 ;;
1978 "Push mark for compatibility with Emacs 18/19."
1984 "Inserts TAB in buffer in current position."
1988 ;;; This stuff is experimental
1991 "If non-nil, a list that can be evaluated using `eval'.
1992 It is evaluated in the lisp function `idlwave-command-hook' which is
1996 "Command run after every command.
1997 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
1998 sets the variable to zero afterwards."
2006 ;;; End experiment
2008 ;; It would be better to use expand.el for better abbrev handling and
2009 ;; versatility.
2012 "Reverses abbrev expansion if in comment or string.
2013 Argument ARG is the number of characters to move point
2014 backward if `idlwave-abbrev-move' is non-nil.
2015 If optional argument RESERVED is non-nil then the expansion
2016 consists of reserved words, which will be capitalized if
2017 `idlwave-reserved-word-upcase' is non-nil.
2018 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2019 is non-nil, unless its value is \`down in which case the abbrev will be
2020 made into all lowercase.
2021 Returns non-nil if abbrev is left expanded."
2024 nil)
2036 t))
2039 "Returns t if point is inside a comment, nil otherwise."
2045 "Move to start of comment delimiter on current line.
2046 Moves to end of line if there is no comment delimiter.
2047 Ignores comment delimiters in strings.
2048 Returns point if comment found and nil otherwise."
2051 found)
2052 ;; Look for first comment delimiter not in a string
2067 "Is transient-mark-mode on and the region active?
2068 Works on both Emacs and XEmacs."
2074 "Insert quote and show matching quote if this is end of a string."
2085 ;; Not the end of a string
2089 "Ensure that the previous word was a token before `idlwave-show-begin'.
2090 An END token must be preceded by whitespace."
2100 "Finds the start of current block and blinks to it for a second.
2101 Also checks if the correct end statement has been used."
2102 ;; All end statements are reserved words
2103 ;; Re-indent end line
2104 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2105 ;;(backward-char 1)
2109 begin-pos end-pos end end1 )
2113 idlwave-show-block)
2115 ;; Move inside current block
2128 end-pos))
2136 ;; A generic end
2147 end1 end)
2149 ;;(delete-char 1))
2163 ;; seems to be a case thing
2167 idlwave-block-matches))
2169 ;; Just a normal block
2174 "Terminate the current block with the correct END statement."
2177 ;; Start new line if we are not in a new line
2188 "Let the > symbol expand around -> if present. The new token length
2189 is returned."
2193 "Surround the LENGTH characters before point with blanks.
2194 LENGTH defaults to 1.
2195 Optional arguments BEFORE and AFTER affect the behavior before and
2196 after the characters (see also description of `idlwave-make-space'):
2198 nil do nothing
2199 0 force no spaces
2200 integer > 0 force exactly n spaces
2201 integer < 0 at least |n| spaces
2203 The function does nothing if any of the following conditions is true:
2204 - `idlwave-surround-by-blank' is nil
2205 - the character before point is inside a string or comment
2206 - the char preceeding the string to be surrounded is a member of ESCAPE-CHARS.
2207 This hack is used to avoid padding of `>' when it is part of
2208 the '->' operator. In this case, ESCAPE-CHARS would be '(?-).
2210 If a function is passed in EC-HOOK, and an ESCAPE-CHARS match occurs,
2211 the named function will be called with a single argument of the
2212 preceeding character. Then idlwave-surround will run as usual if
2213 EC-HOOK returns non-nil, and a new length will be taken from the
2214 return value."
2227 ;; avoid clobbering indent
2237 ;; Check to see if the line should auto wrap
2243 "Make space at point.
2244 The space affected is all the spaces and tabs around point.
2245 If n is non-nil then point is left abs(n) spaces from the beginning of
2246 the contiguous space.
2247 The amount of space at point is determined by N.
2248 If the value of N is:
2249 nil - do nothing.
2250 > 0 - exactly N spaces.
2251 < 0 - a minimum of -N spaces, i.e., do not change if there are
2252 already -N spaces.
2253 0 - no spaces (i.e. remove any existing space)."
2267 ;; n = 0, done
2268 ))))
2271 "Inserts a newline and indents the current and previous line."
2273 ;;
2274 ;; Handle unterminated single and double quotes
2275 ;; If not in a comment and in a string then insertion of a newline
2276 ;; will mean unbalanced quotes.
2277 ;;
2282 ;;
2283 ;; The current line is being split, the cursor should be at the
2284 ;; beginning of the new line skipping the leading indentation.
2285 ;;
2286 ;; The reason we insert the new line before indenting is that the
2287 ;; indenting could be confused by keywords (e.g. END) on the line
2288 ;; after the split point. This prevents us from just using
2289 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2290 ;;
2296 ;;
2297 ;; Use global variable 'comment-column' to set parallel comment
2298 ;;
2299 ;; Modeled on lisp.el
2300 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2302 "Compute indent for the beginning of the IDL comment delimiter."
2310 ;; On line by itself, indent as code
2313 ;; after code - do not change
2317 comment-column))))
2320 "Continue line by breaking line at point and indent the lines.
2321 For a code line insert continuation marker. If the line is a line comment
2322 then the new line will contain a comment with the same indentation.
2323 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2324 non-nil."
2326 ;; Expand abbreviation, just like normal RET would.
2330 ;; For code line add continuation.
2331 ;; Check if splitting a string.
2335 ;; Split the string.
2337 idlwave-continuation-char beg)
2341 ;; Do not split the string.
2345 ;; Not splitting a string.
2351 ;; Indent previous line
2356 ;; Reindent new line
2360 "Moves point to the beginning of the current program unit."
2365 "Moves point to the start of the next program unit."
2371 "Mark current IDL statement."
2379 "Mark containing block."
2391 "Put mark at beginning of program, point at end.
2392 The marks are pushed."
2402 "Move to beginning of enclosing block if prefix ARG >= 0.
2403 If prefix ARG < 0 then move forward to enclosing block end."
2408 "Go to the beginning of the current block."
2414 "Go to the beginning of the current block."
2420 "Move across next nested block."
2426 "Move backward across previous nested block."
2432 "Go down a block.
2433 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2434 Returns non-nil if successfull."
2438 ;; Backward
2446 ;; Forward
2454 status))
2457 "Put point at beginning of doc library header, mark at end.
2458 The marks are pushed."
2476 "Return (NAME TYPE CLASS) of current routine."
2480 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2489 "Move to beginning of the current statement.
2490 Skips back past statement continuations.
2491 Point is placed at the beginning of the line whether or not this is an
2492 actual statement."
2504 "Moves point to beginning of the previous statement.
2505 Returns t if the current line before moving is the beginning of
2506 the first non-comment statement in the file, and nil otherwise."
2510 ;; first line in file
2511 t
2512 ;; skip blank lines, label lines, include lines and line comments
2514 ;; The current statement is the first statement until we
2515 ;; reach another statement.
2523 ;; skip continuation lines
2529 first-statement)))
2532 "Moves point to the end of the current IDL statement.
2533 If not in a statement just moves to end of line. Returns position."
2543 "Moves point to the end of the current IDL statement.
2544 If not in a statement just moves to end of line. Returns position."
2552 "Moves point to beginning of the next IDL statement.
2553 Returns t if that statement is the last
2554 non-comment IDL statement in the file, and nil otherwise."
2558 ;; skip blank lines, label lines, include lines and line comments
2560 ;; The current statement is the last statement until
2561 ;; we reach a new statement.
2568 last-statement))
2571 "Skip past multiple commands on a line (with `&')."
2581 "Skip label or case statement element.
2582 Returns position after label.
2583 If there is no label point is not moved and nil is returned."
2584 ;; Case expressions and labels are terminated by a colon.
2585 ;; So we find the first colon in the line and make sure
2586 ;; - no `?' is before it (might be a ? b : c)
2587 ;; - it is not in a comment
2588 ;; - not in a string constant
2589 ;; - not in parenthesis (like a[0:3])
2590 ;; - not followed by another ":" in explicit class, ala a->b::c
2591 ;; As many in this mode, this function is heuristic and not an exact
2592 ;; parser.
2604 nil)))
2607 "Move to start of next IDL substatement after point.
2608 Uses the type of the current IDL statement to determine if the next
2609 statement is on a new line or is a subpart of the current statement.
2610 Returns point at start of substatement modulo whitespace.
2611 If optional argument is non-nil move to beginning of current
2612 substatement."
2616 st nst last)
2622 ;; Continue looking for substatements until we are past orig
2636 ;; If a continuation line starts here, move to next line
2642 "Return the type of the current IDL statement.
2643 Uses `idlwave-statement-match' to return a cons of (type . point) with
2644 point the ending position where the type was determined. Type is the
2645 association from `idlwave-statement-match', i.e. the cons cell from the
2646 list not just the type symbol. Returns nil if not an identifiable
2647 statement."
2649 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2650 ;; and possibly comments
2662 "Pad '=' with spaces. Two cases: Assignment statement, and keyword
2663 assignment. Which case is determined using
2664 `idlwave-start-of-substatement' and `idlwave-statement-type'. The
2665 equal sign will be surrounded by BEFORE and AFTER blanks. If
2666 `idlwave-pad-keyword' is t then keyword assignment is treated just
2667 like assignment statements. When nil, spaces are removed for keyword
2668 assignment. Any other value keeps the current space around the `='.
2669 Limits in for loops are treated as keyword assignment.
2671 Starting with IDL 6.0, a number of op= assignments are available.
2672 Since ambiguities of the form:
2674 r and= b
2675 rand= b
2677 can occur, alphanumeric operator assignment will never be pre-padded,
2678 only post-padded. You must use a space before these to disambiguate
2679 \(not just for padding, but for proper parsing by IDL too!). Other
2680 operators, such as ##=, ^=, etc., will be pre-padded.
2682 See `idlwave-surround'."
2695 ;; Why doesn't ##? work for both?
2703 ;; Everything gets padded equally
2705 ;; Treating keywords/for variables specially...
2723 "Call `idlwave-indent-line' and do expand actions.
2724 With prefix ARG non-nil, indent the entire sub-statement."
2732 ;;Expand the END abbreviation, just as RET or Space would have.
2743 "Indents current IDL line as code or as a comment.
2744 The actions in `idlwave-indent-action-table' are performed.
2745 If the optional argument EXPAND is non-nil then the actions in
2746 `idlwave-indent-expand-table' are performed."
2748 ;; Move point out of left margin.
2757 ;; Indentation for a line comment
2761 ;;
2762 ;; Code Line
2763 ;;
2764 ;; Before indenting, run action routines.
2765 ;;
2768 ;;
2771 ;;
2772 ;; No longer expand abbrevs on the line. The user can do this
2773 ;; manually using expand-region-abbrevs.
2774 ;;
2775 ;; Indent for code line
2776 ;;
2779 ;; a label line
2781 ;; a batch command
2783 ;; leave flush left
2784 nil
2785 ;; indent the line
2787 ;; Adjust parallel comment
2790 ;; Emacs 21 is too smart with fill-column on comment indent
2793 fill-column)))
2796 ;; Get rid of marker
2800 "Perform an action repeatedly on a line.
2801 ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is
2802 either a function name to be called with `funcall' or a list to be
2803 evaluated with `eval'. The action performed by FUNC should leave point
2804 after the match for REG - otherwise an infinite loop may be entered."
2814 "Indent from point with spaces until column COL.
2815 Inserts space before markers at point."
2821 "Indent the current line to column COL.
2822 Indents such that first non-whitespace character is at column COL
2823 Inserts spaces before markers at point."
2830 "Indents program unit which contains point."
2842 "Indent current statement, including all continuation lines."
2851 "Return appropriate indentation for current line as IDL code."
2855 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2856 ;; function
2859 ;; Check for continuation line
2864 ;; calculate indent based on previous and current statements
2867 ;; calculate indent based on previous statement
2870 ;; Beginning of file
2875 ;; Main block
2878 idlwave-main-block-indent))
2879 ;; Begin block
2882 idlwave-block-indent))
2883 ;; End Block
2886 ;; Match to the *beginning* of the block opener
2890 ;; idlwave-end-offset
2891 ;; idlwave-block-indent))
2893 ;; Default to current indent
2895 ;; adjust the indentation based on the current statement
2897 ;; End block
2902 ;;
2903 ;; Parentheses indent
2904 ;;
2907 "Calculate the continuation indent inside a paren group.
2908 Returns a cons-cell with (open . indent), where open is the
2909 location of the open paren"
2911 ;; Found an innermost open paren.
2914 ;; Line up with next word unless this is a closing paren.
2917 ;; Plain Kernighan-style nested indent
2921 ;; This is a closed paren - line up under open paren.
2925 ;; Empty (or just comment) follows -- revert to basic indent
2927 ;; Skip paren
2930 nil)
2932 ;; Line up with first word after any blank space
2938 "Calculates the IDL continuation indent column from the previous
2939 statement. Note that here previous statement usually means the
2940 beginning of the current statement if this statement is a continuation
2941 of the previous line. Various special types of continuations,
2942 including assignments, routine definitions, and parenthetical
2943 groupings, are treated separately."
2954 idlwave-continuation-indent))
2955 fancy-nonparen-indent fancy-paren-indent)
2957 ;; Align then with its matching if, etc.
2964 match cont-re)
2979 ;; Indent in from the previous line for continuing statements
2984 match)
2996 ;; Parenthetical indent, either traditional or Kernighan style
3003 indent-cons)
3006 beg-reg end-reg close-exp))
3007 ;; First permitted containing paren
3009 idlwave-indent-to-open-paren
3010 idlwave-indent-parens-nested
3013 idlwave-max-extra-continuation-indent))
3016 fancy-paren-indent)
3018 ;; A continued assignment, or procedure call/definition
3026 ;; A continued Procedure call or definition
3029 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3031 ;; Comment only, or blank line with "$"? Basic indent.
3033 nil
3036 ;; Continued assignment (with =):
3050 idlwave-max-extra-continuation-indent))
3053 fancy-nonparen-indent))
3055 ;; Basic indent, by default
3061 "Move to next match of the regular expression KEY-RE.
3062 Matches inside comments or string constants will be ignored.
3063 If DIR is negative, the search will be backwards.
3064 At a successful match, the mark is pushed unless NOMARK is non-nil.
3065 Searches are limited to LIMIT.
3066 Searches are case-insensitive and use a special syntax table which
3067 treats `$' and `_' as word characters.
3068 Return value is the beginning of the match or (in case of failure) nil."
3072 found)
3086 found)
3087 nil)))
3090 "When optional argument DIR is non-negative, move forward to end of
3091 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3092 regular expressions. When DIR is negative, move backwards to block beginning.
3093 Recursively calls itself to skip over nested blocks. DIR defaults to
3094 forward. Calls `push-mark' unless the optional argument NOMARK is
3095 non-nil. Movement is limited by the start of program units because of
3096 possibility of unbalanced blocks."
3103 idlwave-begin-block-reg
3104 idlwave-end-block-reg))
3105 found
3107 idlwave-end-block-reg))
3111 idlwave-begin-unit-reg dir t limit)
3114 idlwave-end-unit-reg dir t limit)))
3115 limit)))
3127 "The minimum indent in the current statement."
3138 min
3142 "Return indentation of the current statement.
3143 If in a statement, moves to beginning of statement before finding indent."
3150 "Return the column of the indentation of the current line.
3151 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3155 ;; if we are at the end of blank line return 0
3160 "Tests if current line is continuation line.
3161 Blank or comment-only lines following regular continuation lines (with
3162 `$') count as continuations too."
3172 "Tests if the current line is a comment line."
3178 "Tests if the current line is a comment line."
3184 "Searches current line from current point for REGEXP.
3185 If optional argument CONT is non-nil, searches to the end of
3186 the current statement.
3187 If optional arg BEG is non-nil, search starts from the beginning of the
3188 current statement.
3189 Ignores matches that end in a comment or inside a string expression.
3190 Returns point if successful, nil otherwise.
3191 This function produces unexpected results if REGEXP contains quotes or
3192 a comment delimiter. The search is case insensitive.
3193 If successful leaves point after the match, otherwise, does not move point."
3199 found)
3205 found))
3208 "Fills paragraphs in comments.
3209 A paragraph is made up of all contiguous lines having the same comment
3210 leader (the leading whitespace before the comment delimiter and the
3211 comment delimiter). In addition, paragraphs are separated by blank
3212 line comments. The indentation is given by the hanging indent of the
3213 first line, otherwise by the minimum indentation of the lines after
3214 the first line. The indentation of the first line does not change.
3215 Does not effect code lines. Does not fill comments on the same line
3216 with code. The hanging indent is given by the end of the first match
3217 matching `idlwave-hang-indent-regexp' on the paragraph's first line . If the
3218 optional argument NOHANG is non-nil then the hanging indent is
3219 ignored."
3221 ;; check if this is a line comment
3228 pre here diff fill-prefix-reg bcl first-indent
3229 hang start end)
3230 ;; Change tabs to spaces in the surrounding paragraph.
3231 ;; The surrounding paragraph will be the largest containing block of
3232 ;; contiguous line comments. Thus, we may be changing tabs in
3233 ;; a much larger area than is needed, but this is the easiest
3234 ;; brute force way to do it.
3235 ;;
3236 ;; This has the undesirable side effect of replacing the tabs
3237 ;; permanently without the user's request or knowledge.
3245 ;;
3252 t)
3253 ;; Get the comment leader on the line and its length
3255 ;; the comment leader is the indentation plus exactly the
3256 ;; number of consecutive ";".
3266 ;; Mark the beginning and end of the paragraph
3272 ;; Move to first line of paragraph
3286 ;; if at end of buffer add a newline (need this because
3287 ;; fill-region needs END to be at the beginning of line after
3288 ;; the paragraph or it will add a line).
3291 ;; Set END to the beginning of line after the paragraph
3292 ;; END is calculated as distance from end of buffer
3294 ;;
3295 ;; Calculate the indentation for the paragraph.
3296 ;;
3297 ;; In the following while statements, after one iteration
3298 ;; point will be at the beginning of a line in which case
3299 ;; the while will not be executed for the
3300 ;; the first paragraph line and thus will not affect the
3301 ;; indentation.
3302 ;;
3303 ;; First check to see if indentation is based on hanging indent.
3309 ;; Adjust lines of paragraph by inserting spaces so that
3310 ;; each line's indent is at least as great as the hanging
3311 ;; indent. This is needed for fill-paragraph to work with
3312 ;; a fill-prefix.
3319 t)
3323 ;; adjust the original location for the
3324 ;; inserted text.
3328 )
3330 ;; No hang. Instead find minimum indentation of paragraph
3331 ;; after first line.
3332 ;; For the following while statement, since START is at the
3333 ;; beginning of line and END is at the end of line
3334 ;; point is greater than START at least once (which would
3335 ;; be the case for a single line paragraph).
3342 comment-start-skip
3344 t)
3347 )
3350 ?\ )))
3351 ;; first-line indent
3356 comment-start-skip
3358 t)
3360 indent))
3362 ;; try to keep point at its original place
3365 ;; In place of the more modern fill-region-as-paragraph, a hack
3366 ;; to keep whitespace untouched on the first line within the
3367 ;; indent length and to preserve any indent on the first line
3368 ;; (first indent).
3374 start
3377 nil)
3381 ;; When we want the point at the beginning of the comment
3382 ;; body fill-region will put it at the beginning of the line.
3387 "Calculate the position of the hanging indent for the comment
3388 paragraph. The hanging indent position is given by the first match
3389 with the `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3390 non-nil then use last occurrence matching `idlwave-hang-indent-regexp' on
3391 the line.
3392 If not found returns nil."
3397 idlwave-hang-indent-regexp
3399 t)
3404 idlwave-hang-indent-regexp
3406 t)
3410 "Called to break lines in auto fill mode.
3411 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3412 non-nil. Places a continuation character at the end of the line if
3413 not in a comment. Splits strings with IDL concatenation operator `+'
3414 if `idlwave-auto-fill-split-string' is non-nil."
3416 nil ; do not to fill
3419 ;; Check for comment line
3424 ;; Prevent actions do-auto-fill which calls indent-line-function.
3430 idlwave-auto-fill-split-string)
3433 ))))
3437 ;; Indent the split line
3439 )
3443 ;; A continued line comment
3444 ;; We treat continued line comments as part of a comment
3445 ;; paragraph. So we check for a hanging indent.
3454 ;; Remove whitespace between comment delimiter and
3455 ;; text, insert spaces for appropriate indentation.
3458 comment-start-skip
3463 )))
3464 ;; Split code or comment?
3468 ;; Splitting a non-full-line comment.
3469 ;; Insert the comment delimiter from split line
3474 ;; Insert blank to keep off beginning of line
3483 ;; Split code line - add continuation character
3486 ;; Check to see if we split a string
3488 idlwave-auto-fill-split-string)
3489 ;; Split the string and concatenate.
3490 ;; The first extra space is for the space
3491 ;; the line was split. That space was removed.
3496 ;; Make the second part of continued string
3501 ;; Warning
3504 ;; Although do-auto-fill (via indent-new-comment-line) calls
3505 ;; idlwave-indent-line for the new line, re-indent again
3506 ;; because of the addition of the continuation character.
3508 )))))
3511 "Toggle auto-fill mode for IDL mode.
3512 With arg, turn auto-fill mode on if arg is positive.
3513 In auto-fill mode, inserting a space at a column beyond `fill-column'
3514 automatically breaks the line at a previous space."
3520 'idlwave-auto-fill
3521 nil))
3522 ;; update mode-line
3525 ;(defun idlwave-fill-routine-call ()
3526 ; "Fill a routine definition or statement, indenting appropriately."
3527 ; (let ((where (idlwave-where)))))
3531 "Insert a documentation header at the beginning of the unit.
3532 Inserts the value of the variable idlwave-file-header. Sets mark before
3533 moving to do insertion unless the optional prefix argument NOMARK
3534 is non-nil."
3537 ;; make sure we catch the current line if it begins the unit
3543 ;; skip function or procedure line
3557 "Default timestamp insertion function"
3563 ;; Remove extra spaces from line
3565 ;; Insert a blank line comment to separate from the date entry -
3566 ;; will keep the entry from flowing onto date line if re-filled.
3570 "Insert a brief modification log at the beginning of the current program.
3571 Looks for an occurrence of the value of user variable
3572 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user name
3573 and places the point for the user to add a log. Before moving, saves
3574 location on mark ring so that the user can return to previous point."
3589 end t)
3599 ;;; CJC 3/16/93
3600 ;;; Interface to expand-region-abbrevs which did not work when the
3601 ;;; abbrev hook associated with an abbrev moves point backwards
3602 ;;; after abbrev expansion, e.g., as with the abbrev '.n'.
3603 ;;; The original would enter an infinite loop in attempting to expand
3604 ;;; .n (it would continually expand and unexpand the abbrev without expanding
3605 ;;; because the point would keep going back to the beginning of the
3606 ;;; abbrev instead of to the end of the abbrev). We now keep the
3607 ;;; abbrev hook from moving backwards.
3608 ;;;
3610 "Expand each abbrev occurrence in the region.
3611 Calling from a program, arguments are START END."
3620 "Returns t if point is in a comment or quoted string.
3621 nil otherwise."
3625 "Returns location of the opening quote
3626 if point is in a IDL string constant, nil otherwise.
3627 Ignores comment delimiters on the current line.
3628 Properly handles nested quotation marks and octal
3629 constants - a double quote followed by an octal digit."
3630 ;;; Treat an octal inside an apostrophe to be a normal string. Treat a
3631 ;;; double quote followed by an octal digit to be an octal constant
3632 ;;; rather than a string. Therefore, there is no terminating double
3633 ;;; quote.
3635 ;; Because single and double quotes can quote each other we must
3636 ;; search for the string start from the beginning of line.
3642 delim
3643 found)
3645 ;; Find string start
3646 ;; Don't find an octal constant beginning with a double quote
3648 ;; Find the string end.
3649 ;; In IDL, two consecutive delimiters after the start of a
3650 ;; string act as an
3651 ;; escape for the delimiter in the string.
3652 ;; Two consecutive delimiters alone (i.e., not after the
3653 ;; start of a string) is the null string.
3655 ;; Move to position after quote
3658 ;; Get the string delimiter
3660 ;; Check for null string
3663 ;; Look for next unpaired delimiter
3671 ))
3674 ;; return string beginning position or nil
3678 "Determines if the character after point is a pointer dereference *."
3689 ;; Statement templates
3691 ;; Replace these with a general template function, something like
3692 ;; expand.el (I think there was also something with a name similar to
3693 ;; dmacro.el)
3696 "Build a template with optional prompt expression.
3698 Opens a line if point is not followed by a newline modulo intervening
3699 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3700 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3701 adjusted according to `idlwave-abbrev-change-case'. If optional argument
3702 PROMPT is a string then it is displayed as a message in the
3703 minibuffer. The PROMPT serves as a reminder to the user of an
3704 expression to enter.
3706 The lines containing S1 and S2 are reindented using `indent-region'
3707 unless the optional second argument NOINDENT is non-nil."
3709 ;; This is a gross hack to avoit template abbrev expansion
3710 ;; in the shell. FIXME: This is a dirty hack.
3720 end)
3733 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3736 string))
3739 "Build skeleton IDL if-else block."
3747 "Build skeleton IDL case statement."
3755 "Build skeleton IDL switch statement."
3763 "Build skeleton for loop statment."
3771 "Build skeleton for loop statment."
3807 "Return a list of substrings of STRING which are separated by PATTERN.
3821 end)
3829 ;; Return the buffer currently visiting FILE
3839 "List of buffer pulled up by idlwave for special reasons.
3843 ;; Return a buffer visiting file.
3847 buf)))
3850 "Kill buffers created automatically by IDLWAVE.
3851 Function prompts for a letter to identify the buffers to kill.
3852 Possible letters are:
3855 clicks in the routine info window.
3856 s Buffers created by the IDLWAVE Shell to display where execution
3857 stopped or an error was found.
3858 a Both of the above.
3860 Buffer containing unsaved changes require confirmation before they are killed."
3864 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3878 "How many outlawed buffers have tag TAG?"
3882 idlwave-outlawed-buffers))))
3885 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3888 entry)
3902 "Remove BUFFER from the buffers which may be killed.
3903 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3904 Intended for `after-save-hook'."
3907 ;; Revoke license
3911 ;; Remove this function from the hook.
3916 ;; Find FILE on the scanned lib path and return a buffer visiting it
3918 dir efile)
3926 ;; Find FILE on the scanned lib path and return a buffer visiting it
3927 ;; This is for, e.g., finding source with no user catalog
3934 "Creates the IDL tags file IDLTAGS in the current directory from
3935 the list of directories specified in the minibuffer. Directories may be
3936 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
3937 specified top directories are searched if the directory name is prefixed
3938 by @. Specify @ directories with care, it may take a long, long time if
3939 you specify /."
3942 buffer save_buffer files numfiles item errbuf)
3944 ;;
3945 ;; Read list of directories
3948 ;;
3949 ;; Set etags command, vars
3955 ;;
3956 ;; For each directory
3960 ;;
3961 ;; Find the subdirectories
3983 ;;
3984 ;; For each subdirectory
3988 ;;
3989 ;; Call etags
3998 0
4000 ;;
4001 ;; Append additional tags
4008 )))
4020 ))
4023 "Comment the lines in the region if the first non-blank line is
4024 commented, and conversely, uncomment region. If optional prefix arg
4025 N is non-nil, then for N positive, add N comment delimiters or for N
4026 negative, remove N comment delimiters.
4027 Uses `comment-region' which does not place comment delimiters on
4028 blank lines."
4035 ;; skip blank lines
4047 ;; ----------------------------------------------------------------------------
4048 ;; ----------------------------------------------------------------------------
4049 ;; ----------------------------------------------------------------------------
4050 ;; ----------------------------------------------------------------------------
4051 ;;
4052 ;; Completion and Routine Info
4053 ;;
4055 ;; String "intern" functions
4057 ;; For the completion and routine info function, we want to normalize
4058 ;; the case of procedure names etc. We do this by "interning" these
4059 ;; string is a hand-crafted way. Hashes are used to map the downcase
4060 ;; version of the strings to the cased versions. Most *-sint-*
4061 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4062 ;; system hash. The former is re-scanned, and the latter takes case
4063 ;; precedence.
4064 ;;
4065 ;; Since these cased versions are really lisp objects, we can use `eq'
4066 ;; to search, which is a large performance boost. All new strings
4067 ;; need to be "sinterned". We do this as early as possible after
4068 ;; getting these strings from completion or buffer substrings. So
4069 ;; most of the code can simply assume to deal with "sinterned"
4070 ;; strings. The only exception is that the functions which scan whole
4071 ;; buffers for routine information do not intern the grabbed strings.
4072 ;; This is only done afterwards. Therefore in these functions it is
4073 ;; *not* safe to assume the strings can be compared with `eq' and be
4074 ;; fed into the routine assq functions.
4076 ;; Here we define the hashing functions.
4078 ;; The variables which hold the hashes.
4087 "Reset all sintern hashes."
4088 ;; Make sure the hash functions are accessible.
4100 ;; Make sure these are lists
4107 ;; Reset the system & library hash
4113 idlwave-sint-libnames nil))
4117 ;; Reset the buffer & shell hash
4131 ;;(defmacro idlwave-sintern (type var)
4132 ;; `(cond ((not (stringp name)) name)
4133 ;; ((gethash (downcase name) (cdr ,var)))
4134 ;; ((gethash (downcase name) (car ,var)))
4135 ;; (set (idlwave-sintern-set name ,type ,var set))
4136 ;; (name)))
4176 iname))
4179 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4183 kwd-list)
4186 "Sintern all strings in the rinfo LIST. With optional parameter
4187 SET: also set new patterns. Probably this will always have to be t.
4188 If DEFAULT-DIR is passed, it is used as the base of the directory"
4200 ;; The class and name
4208 ;; The source
4221 ;; The keywords
4224 kwds))
4226 ;; Build a canonicalized list
4231 ;; Creating new sintern tables
4234 "Define a variable and a function to sintern the new type TAG.
4235 This defines the function `idlwave-sintern-TAG' and the variable
4236 `idlwave-sint-TAGs'."
4248 name)
4252 "Reset the sintern variable associated with TAG."
4255 ;;---------------------------------------------------------------------------
4258 ;; The variables which hold the information
4272 "Alist with !PATH directories and zero or more flags if the dir has
4273 been scanned in a user catalog ('user) or discovered in a library
4289 ;;
4290 ;; The code to get routine info from different sources.
4297 "Provide a list of IDL routines.
4298 This routine loads the builtin routines on the first call. Later it
4299 only returns the value of the variable."
4309 ;; Keep it running...
4310 )
4312 ;; Something is wrong, get rid of the process
4321 ;; return the current value
4322 idlwave-routines)))
4325 "List of functions which should run after a global rinfo update.
4329 "Rescan the previously selected directories. For batch processing."
4333 "Dispatch another emacs instance to update the idlwave catalog.
4334 After the process finishes normally, the first access to routine info
4335 will re-read the catalog."
4359 nil emacs args)))
4362 process
4366 idlwave-system-routines nil
4367 idlwave-catalog-process nil)
4373 ;; Format for all routine info user catalog, library catalogs, etc.:
4374 ;;
4375 ;; ("ROUTINE" type class
4376 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4377 ;; (buffer pro_file dir) | (compiled pro_file dir)
4378 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...)))
4379 ;;
4380 ;; DIR will be supplied dynamically while loading library catalogs,
4381 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4382 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4383 ;; be nil, as can LINK1, etc., if no HTML help is available.
4388 "Update the internal routine-info lists.
4391 about individual routines.
4393 The information can come from 4 sources:
4394 1. IDL programs in the current editing session
4395 2. Compiled modules in an IDL shell running as Emacs subprocess
4396 3. A list which covers the IDL system routines.
4397 4. A list which covers the prescanned library files.
4399 Scans all IDLWAVE-mode buffers of the current editing session (see
4400 `idlwave-scan-all-buffers-for-routine-info').
4401 When an IDL shell is running, this command also queries the IDL program
4402 for currently compiled routines.
4404 With prefix ARG, also reload the system and library lists.
4405 With two prefix ARG's, also rescans the chosen user catalog tree.
4406 With three prefix args, dispatch asynchronous process to do the update.
4408 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4409 lists, but instead wait for the shell query to complete and
4410 asynchronously finish updating routine info. This is set
4411 automatically when called interactively. When you need routine
4412 information updated immediately, leave NO-CONCATENATE nil."
4414 ;; Stop any idle processing
4422 ;; Start a background process which updates the catalog.
4425 ;; Update the user catalog now, and wait for them.
4429 idlwave-buffer-case-takes-precedence
4431 ;; The override-idle means, even if the idle timer has done some
4432 ;; preparing work, load and renormalize everything anyway.
4436 idlwave-compiled-routines nil
4437 idlwave-unresolved-routines nil)
4438 ;; Reset the appropriate hashes
4440 ;; reset was already done in idle time, so skip this step now once
4447 ;; We can safely scan the buffer stuff first
4451 ;; We first do the system info, and then the buffers
4455 ;; Let's see if there is a shell
4459 idlwave-query-shell-for-routine-info)))
4461 ;; Load the library catalogs again, first re-scanning the path
4473 ;; 1. If we are not going to ask the shell, we need to do the
4474 ;; concatenation now.
4475 ;; 2. When this function is called non-interactively, it
4476 ;; means that someone needs routine info *now*. The
4477 ;; shell update causes the concatenation to be
4478 ;; *delayed*, so not in time for the current command.
4479 ;; Therefore, we do a concatenation now, even though
4480 ;; the shell might do it again.
4484 ;; Ask the shell about the routines it knows of.
4507 idlwave-init-rinfo-when-idle-after
4537 ;; Check for the old style catalog and warn
4540 idlwave-library-routines)
4545 idlwave-user-catalog-file))
4569 ;; restart the timer
4574 idlwave-init-rinfo-when-idle-after
4578 ;; Load and case-treat the system and catalog files.
4615 ;; Scan all buffers, current buffer last
4620 ;; Don't scan any buffers
4623 ;; Just scan this buffer
4629 ;; Put the result into the correct variable
4634 "Put the different sources for routine information together."
4635 ;; The sequence here is important because earlier definitions shadow
4636 ;; later ones. We assume that if things in the buffers are newer
4637 ;; then in the shell of the system, they are meant to be different.
4640 idlwave-compiled-routines
4641 idlwave-library-catalog-routines
4642 idlwave-user-catalog-routines))
4645 ;; Give a message with information about the number of routines we have.
4648 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
4658 "Return the class alist - make it if necessary."
4665 idlwave-class-alist)))
4667 ;; Three functions for the hooks
4676 "Update idlwave-routines for current buffer. Can run from after-save-hook."
4680 idlwave-scan-all-buffers-for-routine-info
4681 idlwave-routines)
4687 nil
4693 routines)
4697 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
4699 found)
4701 ;; The following test uses eq to make sure it works correctly
4702 ;; when two buffers visit the same file. Then the file names
4703 ;; will be equal, but not eq.
4709 ;; End of that section reached. Jump.
4715 ;;----- Scanning buffers -------------------
4718 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
4724 buffer-file-name)
4725 ;; yes, this buffer has the right mode.
4730 ;; Concatenate the individual lists and return the result
4734 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
4736 routine-list string entry)
4750 routine-list))
4754 "Parse a module definition."
4756 start name args type keywords class)
4757 ;; Remove comments
4760 ;; Remove the continuation line stuff
4765 ;; Match the name and type.
4773 ;; Match normal args and keyword args
4776 string start)
4781 ;; Normalize and sort.
4785 ;; Make and return the entry
4786 ;; We don't know which argument are optional, so this information
4787 ;; will not be contained in the calling sequence.
4790 class
4793 ; ((string= (downcase
4794 ; (file-name-sans-extension
4795 ; (file-name-nondirectory (buffer-file-name))))
4796 ; (downcase name))
4797 ; (list 'lib))
4798 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
4804 "%s"
4812 nil))))
4815 ;;----- Scanning the user catalog -------------------
4818 "Return the syslib directory, or a dummy that never matches."
4820 "@@@@@@@@"
4821 idlwave-system-directory))
4826 "Scan all files on selected dirs of IDL search path for routine information.
4828 A widget checklist will allow you to choose the directories. Write
4829 the result as a file `idlwave-user-catalog-file'. When this file
4830 exists, will be automatically loaded to give routine information about
4831 library routines. With ARG, just rescan the same directories as last
4832 time - so no widget will pop up."
4834 ;; Make sure the file is loaded if it exists.
4840 ;; Make sure the file name makes sense
4846 idlwave-user-catalog-file))))
4850 ;; Rescan the known directories
4855 ;; Expand the directories from library-path and run the widget
4859 ;; Propagate any flags on the existing path-alist
4862 idlwave-true-path-alist)))
4869 ;; Ask the shell for the path and then run the widget
4878 ;; Parse shell path information and select among it.
4880 ;; Command hook used by `idlwave-create-user-catalog-file'.
4882 ;; Scan immediately
4884 ;; Set the path and display the widget
4890 "This is the front-end to the creation of the IDLWAVE user catalog.
4891 Please select the directories on IDL's search path from which you
4892 would like to extract routine information, to be stored in the file:
4894 %s
4896 If this is not the correct file, first set variable
4897 `idlwave-user-catalog-file', and call this command again.
4899 N.B. Many libraries include pre-scanned catalog files
4901 not be scanned. You can scan your own libraries off-line using the
4902 perl script `idlwave_catalog'.
4904 After selecting the directories, choose [Scan & Save] to scan the library
4905 directories and save the routine info.
4911 "Create the widget to select IDL search path directories for scanning."
4923 idlwave-user-catalog-file))
4934 :notify
4940 path-list)
4945 :notify
4950 path-list)
4964 'checklist
4968 dirs-list))
4969 :greedy t
4991 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
4996 dir-entry)
5002 selected-dirs)
5009 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5013 dirs-alist dir files file)
5015 idlwave-path-alist path-alist ; for library-path instead
5016 idlwave-true-path-alist nil)
5038 idlwave-user-catalog-routines)))))))))
5046 font-lock-mode)
5052 ;; Define the routine info list
5059 idlwave-user-catalog-routines))
5063 ;; Save the buffer
5069 idlwave-user-catalog-file)
5087 font-lock-mode)
5092 ;; Define the variable which knows the value of "!DIR"
5094 idlwave-system-directory))
5096 ;; Define the variable which contains a list of all scanned directories
5103 idlwave-path-alist))
5110 ;; Expand parts of path starting with '+' recursively into directory list.
5111 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5121 ;; Expand recursively
5123 ;; Keep unchanged
5129 ;; Return a list of all directories below DIR, including DIR itself
5138 path1))
5141 ;;----- Scanning the library catalogs ------------------
5144 "Scan for library catalog files (.idlwave_catalog) and ingest.
5146 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5147 instead, if present) are searched. Print MESSAGE-BASE along with the
5148 libraries being loaded, if passed, and skip loading/normalizing if
5149 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5150 be set to nil to disable library catalog scanning."
5157 dir-entry dir flags catalog all-routines)
5165 ;; Load the catalog file
5170 message-base
5172 old-libname)))
5174 idlwave-library-catalog-libname))
5181 all-routines))))
5183 ;; Add a 'lib flag if on path-alist
5190 ;;----- Communicating with the Shell -------------------
5192 ;; First, here is the idl program which can be used to query IDL for
5193 ;; defined routines.
5195 "
5196 ;; START OF IDLWAVE SUPPORT ROUTINES
5197 pro idlwave_print_info_entry,name,func=func,separator=sep
5198 ;; See if it's an object method
5199 if name eq '' then return
5200 func = keyword_set(func)
5201 methsep = strpos(name,'::')
5202 meth = methsep ne -1
5204 ;; Get routine info
5205 pars = routine_info(name,/parameters,functions=func)
5206 source = routine_info(name,/source,functions=func)
5207 nargs = pars.num_args
5208 nkw = pars.num_kw_args
5209 if nargs gt 0 then args = pars.args
5210 if nkw gt 0 then kwargs = pars.kw_args
5212 ;; Trim the class, and make the name
5213 if meth then begin
5214 class = strmid(name,0,methsep)
5215 name = strmid(name,methsep+2,strlen(name)-1)
5216 if nargs gt 0 then begin
5217 ;; remove the self argument
5218 wh = where(args ne 'SELF',nargs)
5219 if nargs gt 0 then args = args[wh]
5220 endif
5221 endif else begin
5222 ;; No class, just a normal routine.
5224 endelse
5226 ;; Calling sequence
5228 if func then cs = 'Result = '
5229 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5230 cs = cs + '%s'
5231 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5232 if nargs gt 0 then begin
5233 for j=0,nargs-1 do begin
5234 cs = cs + args[j]
5235 if j lt nargs-1 then cs = cs + ', '
5236 endfor
5237 end
5238 if func then cs = cs + ')'
5239 ;; Keyword arguments
5240 kwstring = ''
5241 if nkw gt 0 then begin
5242 for j=0,nkw-1 do begin
5243 kwstring = kwstring + ' ' + kwargs[j]
5244 endfor
5245 endif
5247 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5249 print,ret + ': ' + name + sep + class + sep + source[0].path $
5250 + sep + cs + sep + kwstring
5251 end
5253 pro idlwave_routine_info
5254 on_error,1
5255 sep = '<@>'
5257 all = routine_info()
5258 for i=0,n_elements(all)-1 do $
5259 idlwave_print_info_entry,all[i],separator=sep
5260 all = routine_info(/functions)
5261 for i=0,n_elements(all)-1 do $
5262 idlwave_print_info_entry,all[i],/func,separator=sep
5263 print,'>>>END OF IDLWAVE ROUTINE INFO'
5264 end
5266 pro idlwave_get_sysvars
5267 on_error,1
5268 catch,error_status
5269 if error_status ne 0 then begin
5270 print, 'Cannot get info about system variables'
5271 endif else begin
5272 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5273 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5274 v = strsplit(s,' +',/regex,/extract) ; get variables
5275 for i=0,n_elements(v)-1 do begin
5276 t = [''] ; get tag list
5277 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5278 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5279 endfor
5280 endelse
5281 end
5283 pro idlwave_get_class_tags, class
5284 res = execute('tags=tag_names({'+class+'})')
5285 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5286 end
5287 ;; END OF IDLWAVE SUPPORT ROUTINES
5288 "
5297 "Query the shell for routine_info of compiled modules and update the lists."
5298 ;; Save and compile the procedure. The compiled procedure is then
5299 ;; saved into an IDL SAVE file, to allow for fast RESTORE.
5300 ;; We need to RESTORE the procedure each time we use it, since
5301 ;; the user may have killed or redefined it. In particular,
5302 ;; .RESET_SESSION will kill all user procedures.
5314 ; (message "SENDING SAVE") ; ????????????????????????
5316 (format "save,'idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5320 ;; Restore and execute the procedure, analyze the output
5321 ; (message "SENDING RESTORE & EXECUTE") ; ????????????????????????
5324 idlwave-shell-temp-rinfo-save-file)
5330 ;; ---------------------------------------------------------------------------
5331 ;;
5332 ;; Completion and displaying routine calling sequences
5340 "Complete a function, procedure or keyword name at point.
5341 This function is smart and figures out what can be completed
5342 at this point.
5343 - At the beginning of a statement it completes procedure names.
5344 - In the middle of a statement it completes function names.
5345 - after a `(' or `,' in the argument list of a function or procedure,
5346 it completes a keyword of the relevant function or procedure.
5347 - In the first arg of `OBJ_NEW', it completes a class name.
5349 When several completions are possible, a list will be displayed in the
5350 *Completions* buffer. If this list is too long to fit into the
5351 window, scrolling can be achieved by repeatedly pressing
5354 The function also knows about object methods. When it needs a class
5355 name, the action depends upon `idlwave-query-class', which see. You
5356 can force IDLWAVE to ask you for a class name with a
5359 See also the variables `idlwave-keyword-completion-adds-equal' and
5360 `idlwave-function-completion-adds-paren'.
5362 The optional ARG can be used to specify the completion type in order
5363 to override IDLWAVE's idea of what should be completed at point.
5364 Possible values are:
5366 0 <=> query for the completion type
5367 1 <=> 'procedure
5368 2 <=> 'procedure-keyword
5369 3 <=> 'function
5370 4 <=> 'function-keyword
5371 5 <=> 'procedure-method
5372 6 <=> 'procedure-method-keyword
5373 7 <=> 'function-method
5374 8 <=> 'function-method-keyword
5375 9 <=> 'class
5377 As a special case, the universal argument C-u forces completion of
5378 function names in places where the default would be a keyword.
5380 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5381 completion.
5383 For Lisp programmers only:
5384 When we force a keyword, optional argument MODULE can contain the module name.
5385 When we force a method or a method keyword, CLASS can specify the class."
5412 ;; Complete a filename in quotes
5417 ;; Check for any special completion functions
5424 ;; Complete a class
5430 ;; Complete a procedure name
5443 isa
5449 isa
5453 ;; Complete a function name
5466 isa
5472 isa
5480 ;; Complete a procedure keyword
5507 isa
5511 ;; Complete a function keyword
5523 msg-name)
5528 ;; OBJ_NEW: Messages mention the proper Init method
5535 msg-name)))
5544 isa
5550 "List of special completion functions.
5551 These functions are called for each completion. Each function must
5552 check if its own special completion context is present. If yes, it
5553 should use `idlwave-complete-in-buffer' to do some completion and
5554 return t. If such a function returns t, *no further* attempts to
5555 complete other contexts will be done. If the function returns nil,
5560 fun ret)
5565 nil)))
5568 ;; Return an artificial WHERE specification to force the completion
5569 ;; routine to complete a specific item independent of context.
5570 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
5571 ;; MODULE and CLASS can be used to specify the routine name and class.
5572 ;; The class name will also be found in MODULE if that is like "class::mod".
5590 what)
5663 ;; Completing read, case insensitive
5673 "Use the comint stuff to complete a file name."
5681 idlwave-shell-default-directory
5682 default-directory)))
5686 ;; Make a fully qualified module name including the class name
5690 "Like `idlwave-rinfo-assq', but sintern strings first."
5696 ;; Works like assq, but also checks type and class
5707 ;; Return the first matching method on the inheritance list
5709 class rtn)
5713 rtn))
5716 keep-system)
5717 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
5718 If WITH-FILE is passed, find the best rinfo entry with a file
5719 included. If KEEP-SYSTEM is set, don't prune system for compiled
5720 syslib files."
5723 list))
5724 syslibp)
5731 ;; Its a compiled syslib, so we need to remove the system entry
5737 twins)))))
5741 keep-system)
5742 "Like `idlwave-best-rinfo-assq', but sintern strings first."
5748 "Does the entry list ENTRIES contain a syslib entry?
5749 If yes, return the index (>=1)."
5758 nil)))
5761 "Return a list of all associations of Key in LIST."
5769 "Return all classes which have a method METHOD. TYPE is 'fun or 'pro.
5770 When TYPE is not specified, both procedures and functions will be considered."
5783 "Return all classes which have a method METHOD with keyword KEYWORD.
5784 TYPE is 'fun or 'pro.
5785 When TYPE is not specified, both procedures and functions will be considered."
5788 nil
5800 "Return list of all elements in LIST which are also in CLUB."
5809 "Return list of all elements in LIST which are not in CLUB."
5813 nil
5819 "Return whether or not the class is listed explicitly, ala a->b::c.
5820 INFO is as returned by idlwave-what-function or -procedure."
5827 "List of special functions for determining class.
5831 ;; Determine the class of a routine call.
5832 ;; INFO is the `cw-list' structure as returned by idlwave-where.
5833 ;; The second element in this structure is the class. When nil, we
5834 ;; return nil. When t, try to get the class from text properties at
5835 ;; the arrow. When the object is "self", we use the class of the
5836 ;; current routine. otherwise prompt the user for a class name.
5837 ;; Also stores the selected class as a text property at the arrow.
5838 ;; TYPE is 'fun or 'pro.
5844 idlwave-query-class))
5846 idlwave-query-class))
5858 store special-class class-alist)
5862 ;; There is an object which would like to know its class
5864 idlwave-store-inquired-class
5871 ;; Before prompting, try any special class determination routines
5873 idlwave-determine-class-special
5879 store idlwave-store-inquired-class)))
5881 ;; Prompt for a class, if we need to
5902 ;; Store it, if requested
5904 ;; We have a real class here
5910 rear-nonsticky t))
5913 ;; Return the class
5914 class)
5915 ;; Default as fallback
5929 ;; Record a file link, if any, for the tested names during selection.
5933 sel))
5937 "Find out where we are.
5938 The return value is a list with the following stuff:
5939 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
5941 PRO-LIST (PRO POINT CLASS ARROW)
5942 FUNC-LIST (FUNC POINT CLASS ARROW)
5943 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
5944 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
5945 be completed here.
5946 LAST-CHAR last relevant character before point (non-white non-comment,
5947 not part of current identifier or leading slash).
5949 In the lists, we have these meanings:
5950 PRO: Procedure name
5951 FUNC: Function name
5952 POINT: Where is this
5953 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
5954 ARROW: Location of the arrow"
5972 cw cw-mod cw-arrow cw-class cw-point)
5976 match-string)
5982 match-string))
5984 cw-arrow pro-arrow))
5986 match-string)
5987 nil)
5989 match-string)
5992 match-string)
5999 cw-class func-class cw-arrow func-arrow))
6002 cw-class pro-class cw-arrow pro-arrow))
6003 ; ((member last-char '(?\' ?\) ?\] ?!))
6004 ; ;; after these chars, a function makes no sense
6005 ; ;; FIXME: I am sure there can be more in this list
6006 ; ;; FIXME: Do we want to do this at all?
6007 ; nil)
6008 ;; Everywhere else we try a function.
6012 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t)
6016 t))))))
6019 cw
6021 last-char)))
6024 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6032 ;; Find out if point is within the argument list of a function.
6033 ;; The return value is ("function-name" class arrow-start (point) level).
6034 ;; Level is 1 on the top level parentheses, higher further down.
6036 ;; If the optional BOUND is an integer, bound backwards directed
6037 ;; searches to this point.
6041 func-point
6043 func arrow-start class)
6048 ;; move back out of the current parenthesis
6057 bound t))
6060 pos func-point)
6066 'exit
6070 arrow-start func-point cnt)))
6075 ;; Find out if point is within the argument list of a procedure.
6076 ;; The return value is ("procedure-name" class arrow-pos (point)).
6078 ;; If the optional BOUND is an integer, bound backwards directed
6079 ;; searches to this point.
6081 pro class arrow-start string)
6083 ;;(idlwave-beginning-of-statement)
6093 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6094 string))
6099 pos)
6104 arrow-start
6105 pro-point)))
6108 ;; If there is an object at point, move over it and return t.
6118 nil)
6136 nil)))
6139 "Return the last character before point which is not white or a comment
6140 and also not part of the current identifier. Since we do this in
6141 order to identify places where keywords are, we consider the initial
6142 `/' of a keyword as part of the identifier.
6143 This function is not general, can only be used for completion stuff."
6146 ;; skip the current identifier
6148 ;; also skip a leading slash which might be belong to the keyword
6151 ;; FIXME: does not check if this is a valid identifier
6159 ;; continuation line
6172 &optional prepare-display-function
6173 special-selector)
6174 "Perform TYPE completion of word before point against LIST.
6175 SELECTOR is the PREDICATE argument for the completion function. Show
6176 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6177 'procedure, 'class-tag, 'keyword, 'sysvar, etc.. SPECIAL-SELECTOR is
6178 used only once, for `all-completions', and can be used to, e.g.,
6179 accumulate information on matching completions."
6182 dpart dcompletion)
6187 ;; What is already in the buffer?
6192 idlwave-complete-after-success-form
6195 idlwave-complete-after-success-form-force
6199 ;; Try a completion
6205 idlwave-completion-help-links nil)
6208 ;; nothing available.
6212 ;; We can add something
6216 idlwave-complete-empty-string-as-lower-case)
6221 ;; Now this is a unique match
6223 t)
6229 selector))))))
6231 ;; This is already complete
6234 nil)
6236 ;; We cannot add something - offer a list.
6244 idlwave-completion-help-links))))
6245 list))
6247 ;; "complete" means, this is already a valid completion
6250 ; (completion-fixup-function ; Emacs
6251 ; (lambda () (and (eq (preceding-char) ?>)
6252 ; (re-search-backward " <" beg t)))))
6260 idlwave-complete-empty-string-as-lower-case)
6266 x)
6267 list)))
6269 t))))
6272 "Complete a class at point."
6274 ;; Call `idlwave-routines' to make sure the class list will be available
6276 ;; Check for the special case of completing empty string after pro/function
6285 ;; Yank the full class specification
6287 ;; Do the completion, using list gathered from `idlwave-routines'
6296 idlwave-completion-help-links))
6297 x))
6298 list)))))
6301 ;; Attach the proper class list to a LIST of completion items.
6302 ;; TYPE, when 'kwd, shows classes for method keywords, when
6303 ;; 'class-tag, for class tags, and otherwise for methods.
6304 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6310 ;; In these cases, we do not have to do anything
6311 list
6315 ;; (do-dots (featurep 'xemacs))
6321 classes nclasses class-info space)
6324 ;; get the classes
6326 ;; Just one class for tags
6330 ;; Multiple classes for method or method-keyword
6334 method-selector x type-selector)
6340 classes)))))
6342 ;; Make the separator between item and class-info
6347 ;; We do want info in the buffer
6350 space
6355 ;; We do want properties
6359 x))
6362 x))
6363 list))))
6366 ;; Call idlwave-attach-classes with method parameters
6369 ;; Call idlwave-attach-classes with keyword parameters
6372 ;; Call idlwave-attach-classes with class structure tags
6376 ;;----------------------------------------------------------------------
6377 ;;----------------------------------------------------------------------
6378 ;;----------------------------------------------------------------------
6379 ;;----------------------------------------------------------------------
6380 ;;----------------------------------------------------------------------
6386 "Select an item in LIST with a popup menu.
6387 TITLE is the title to put atop the popup. If SORT is non-nil,
6388 sort the list before displaying"
6390 rtn menu resp)
6400 x)))
6401 list)))
6414 rtn))
6417 "Split the MENU into submenus of maximum length N."
6419 ;; No splitting needed
6420 menu
6435 nextmenu))
6437 nextmenu nil
6442 "Split the MENU into submenus of maximum length N."
6444 ;; No splitting needed
6445 menu
6461 nextmenu))
6463 nextmenu nil
6467 menu)))
6472 "Scroll the completion window on this frame."
6490 "Display the completions in LIST in the completions buffer and echo MESSAGE."
6498 list)
6501 ;; Store a special value in `this-command'. When `idlwave-complete'
6502 ;; finds this in `last-command', it will scroll the *Completions* buffer.
6505 ;; Mark the completions buffer as created by cib
6508 ;; Fontify the classes
6513 ;; Run the hook
6516 ;; Display the message
6520 "Call FUNCTION as a completion chooser and pass ARGS to it."
6526 ;; For the shell, remove the fontification of the word before point
6541 "Restore the old (before completion) window configuration."
6543 idlwave-before-completion-wconf
6547 "Make the user select an element from the alist in the variable SYM.
6548 The keys of the alist are expected to be strings. The function returns the
6549 car of the selected association.
6550 To do this, PROMPT is displayed and and the user must hit a letter key to
6551 select an entry. If the user does not reply within DELAY seconds, a help
6552 window with the options is displayed automatically.
6553 The key which is associated with each option is generated automatically.
6555 If these don't exist, a letter in the string is automatically selected."
6559 keys-alist char)
6560 ;; First check the cache
6563 ;; Need to make new list
6567 ;; Display prompt and wait for quick reply
6572 ;; No quick reply: Show help
6578 keys-alist))
6582 ;; Return the selected result
6585 ;; Used for, e.g., electric debug super-examine.
6587 "Make an alist for single key selection."
6595 ;; First check if the configuration predetermined a key
6602 ;; Then check for capital letters
6612 t t name))
6615 ;; Now check for lowercase letters
6625 t t name))
6628 ;; Bummer, nothing found! Use a stupid number
6635 "Set the buffer-local value of VAR in BUFFER to VALUE."
6641 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
6647 ;; In XEmacs, we can use :activate-callback directly to advice the
6648 ;; choose functions. We use the private keymap only for the online
6649 ;; help feature.
6658 cl-args))
6668 "Execute `default-choose-completion' and then restore the win-conf."
6672 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
6675 (define-key new-map [button3] (lambda ()
6676 (interactive)
6677 (setq this-command last-command)))
6678 new-map))
6680 ;; In Emacs we also replace keybindings in the completion
6681 ;; map in order to install our wrappers.
6683 (defun idlwave-display-completion-list-emacs (list)
6684 "Display completion list and install the choose wrappers."
6685 (with-output-to-temp-buffer "*Completions*"
6686 (display-completion-list list))
6687 (save-excursion
6688 (set-buffer "*Completions*")
6689 (use-local-map
6690 (or idlwave-completion-map
6691 (setq idlwave-completion-map
6692 (idlwave-make-modified-completion-map-emacs
6693 (current-local-map)))))))
6695 (defun idlwave-make-modified-completion-map-emacs (old-map)
6696 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
6697 (let ((new-map (copy-keymap old-map)))
6698 (substitute-key-definition
6699 'choose-completion 'idlwave-choose-completion new-map)
6700 (substitute-key-definition
6701 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
6702 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
6703 new-map))
6705 (defun idlwave-choose-completion (&rest args)
6706 "Choose the completion that point is in or next to."
6707 (interactive)
6708 (apply 'idlwave-choose 'choose-completion args))
6710 (defun idlwave-mouse-choose-completion (&rest args)
6711 "Click on an alternative in the `*Completions*' buffer to choose it."
6712 (interactive "e")
6713 (apply 'idlwave-choose 'mouse-choose-completion args))
6715 ;;----------------------------------------------------------------------
6716 ;;----------------------------------------------------------------------
6718 ;;; ------------------------------------------------------------------------
6719 ;;; Stucture parsing code, and code to manage class info
6721 ;;
6722 ;; - Go again over the documentation how to write a completion
6723 ;; plugin. It is in self.el, but currently still very bad.
6724 ;; This could be in a separate file in the distribution, or
6725 ;; in an appendix for the manual.
6727 (defvar idlwave-struct-skip
6729 "Regexp for skipping continued blank or comment-only lines in
6730 structures")
6732 (defvar idlwave-struct-tag-regexp
6733 (concat "[{,]" ;leading comma/brace
6734 idlwave-struct-skip ; 4 groups
6737 "Regexp for structure tags.")
6739 (defun idlwave-struct-tags ()
6740 "Return a list of all tags in the structure defined at point.
6741 Point is expected just before the opening `{' of the struct definition."
6742 (save-excursion
6743 (let* ((borders (idlwave-struct-borders))
6744 (beg (car borders))
6745 (end (cdr borders))
6746 tags)
6747 (goto-char beg)
6748 (save-restriction
6749 (narrow-to-region beg end)
6750 (while (re-search-forward idlwave-struct-tag-regexp end t)
6751 ;; Check if we are still on the top level of the structure.
6752 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
6753 (= (point) beg))
6754 (push (match-string-no-properties 5) tags))
6755 (goto-char (match-end 0))))
6756 (nreverse tags))))
6758 (defun idlwave-find-struct-tag (tag)
6759 "Find a given TAG in the structure defined at point."
6760 (let* ((borders (idlwave-struct-borders))
6761 (beg (car borders))
6762 (end (cdr borders))
6763 (case-fold-search t))
6765 end t)))
6767 (defun idlwave-struct-inherits ()
6768 "Return a list of all `inherits' names in the struct at point.
6769 Point is expected just before the opening `{' of the struct definition."
6770 (save-excursion
6771 (let* ((borders (idlwave-struct-borders))
6772 (beg (car borders))
6773 (end (cdr borders))
6774 (case-fold-search t)
6775 names)
6776 (goto-char beg)
6777 (save-restriction
6778 (narrow-to-region beg end)
6779 (while (re-search-forward
6780 (concat "[{,]" ;leading comma/brace
6781 idlwave-struct-skip ; 4 groups
6782 "inherits" ; The INHERITS tag
6783 idlwave-struct-skip ; 4 more
6785 end t)
6786 ;; Check if we are still on the top level of the structure.
6787 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
6788 (= (point) beg))
6789 (push (match-string-no-properties 9) names))
6790 (goto-char (match-end 0))))
6791 (nreverse names))))
6793 (defun idlwave-in-structure ()
6794 "Return t if point is inside an IDL structure definition."
6795 (let ((beg (point)))
6796 (save-excursion
6797 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
6798 (if (idlwave-find-structure-definition nil nil 'back)
6799 (let ((borders (idlwave-struct-borders)))
6800 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
6801 (and (> beg (car borders)) (< beg (cdr borders))))))))))
6803 (defun idlwave-struct-borders ()
6804 "Return the borders of the {...} after point as a cons cell."
6805 (let (beg)
6806 (save-excursion
6807 (skip-chars-forward "^{")
6808 (setq beg (point))
6809 (condition-case nil (forward-list 1)
6810 (error (goto-char beg)))
6811 (cons beg (point)))))
6813 (defun idlwave-find-structure-definition (&optional var name bound)
6814 "Search forward for a structure definition. If VAR is non-nil,
6815 search for a structure assigned to variable VAR. If NAME is non-nil,
6816 search for a named structure NAME, if a string, or a generic named
6817 structure otherwise. If BOUND is an integer, limit the search. If
6818 BOUND is the symbol `all', we search first back and then forward
6819 through the entire file. If BOUND is the symbol `back' we search only
6820 backward."
6822 (case-fold-search t)
6823 (lim (if (integerp bound) bound nil))
6824 (re (concat
6825 (if var
6829 (if name
6830 (if (stringp name)
6832 ;; Just a generic name
6834 ""))))
6835 (if (or (and (or (eq bound 'all) (eq bound 'back))
6836 (re-search-backward re nil t))
6837 (and (not (eq bound 'back)) (re-search-forward re lim t)))
6838 (progn
6839 (goto-char (match-beginning 3))
6840 (match-string-no-properties 5)))))
6842 (defvar idlwave-class-info nil)
6843 (defvar idlwave-system-class-info nil) ; Gathered from idlw-rinfo
6844 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
6846 (add-hook 'idlwave-update-rinfo-hook
6847 (lambda () (setq idlwave-class-reset t)))
6848 (add-hook 'idlwave-after-load-rinfo-hook
6849 (lambda () (setq idlwave-class-info nil)))
6851 (defun idlwave-class-info (class)
6852 (let (list entry)
6853 (if idlwave-class-info
6854 (if idlwave-class-reset
6855 (setq
6856 idlwave-class-reset nil
6857 idlwave-class-info ; Remove any visited in a buffer
6858 (delq nil (mapcar
6859 (lambda (x)
6860 (let ((filebuf
6861 (idlwave-class-file-or-buffer
6862 (or (cdr (assq 'found-in x)) (car x)))))
6863 (if (cdr filebuf)
6864 nil
6865 x)))
6866 idlwave-class-info))))
6867 ;; Info is nil, put in the system stuff to start.
6868 (setq idlwave-class-info idlwave-system-class-info)
6869 (setq list idlwave-class-info)
6870 (while (setq entry (pop list))
6871 (idlwave-sintern-class-info entry)))
6872 (setq class (idlwave-sintern-class class))
6873 (or (assq class idlwave-class-info)
6874 (progn (idlwave-scan-class-info class)
6875 (assq class idlwave-class-info)))))
6877 (defun idlwave-sintern-class-info (entry)
6878 "Sintern the class names in a class-info entry."
6879 (let ((taglist (assq 'tags entry))
6880 (inherits (assq 'inherits entry)))
6881 (setcar entry (idlwave-sintern-class (car entry) 'set))
6882 (if inherits
6883 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
6884 (cdr inherits))))))
6886 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
6887 "Find class structure definition(s)
6888 If ALL-HOOK is set, find all named structure definitions in a given
6889 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
6890 set, look for the name__define pro, and inside of it, for the ALT-CLASS
6891 class/struct definition"
6892 (let ((case-fold-search t) end-lim list name)
6893 (when (re-search-forward
6895 (if all-hook
6896 (progn
6897 ;; For everything there
6898 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
6899 (while (setq name
6900 (idlwave-find-structure-definition nil t end-lim))
6901 (funcall all-hook name)))
6902 (idlwave-find-structure-definition nil (or alt-class class))))))
6905 (defun idlwave-class-file-or-buffer (class)
6906 "Find buffer visiting CLASS definition"
6907 (let* ((pro (concat (downcase class) "__define"))
6908 (file (idlwave-routine-source-file
6909 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
6910 (idlwave-routines))))))
6911 (cons file (if file (idlwave-get-buffer-visiting file)))))
6914 (defun idlwave-scan-class-info (class)
6915 "Scan all class and named structure info in the class__define pro"
6916 (let* ((idlwave-auto-routine-info-updates nil)
6917 (filebuf (idlwave-class-file-or-buffer class))
6918 (file (car filebuf))
6919 (buf (cdr filebuf))
6920 (class (idlwave-sintern-class class)))
6921 (if (or
6922 (not file)
6923 (and ;; neither a regular file nor a visited buffer
6924 (not buf)
6925 (not (file-regular-p file))))
6926 nil ; Cannot find the file/buffer to get any info
6927 (save-excursion
6928 (if buf (set-buffer buf)
6929 ;; Read the file in temporarily
6930 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
6931 (erase-buffer)
6932 (unless (eq major-mode 'idlwave-mode)
6933 (idlwave-mode))
6934 (insert-file-contents file))
6935 (save-excursion
6936 (goto-char 1)
6937 (idlwave-find-class-definition class
6938 ;; Scan all of the structures found there
6939 (lambda (name)
6940 (let* ((this-class (idlwave-sintern-class name))
6941 (entry
6942 (list this-class
6943 (cons 'tags (idlwave-struct-tags))
6944 (cons 'inherits (idlwave-struct-inherits)))))
6945 (if (not (eq this-class class))
6946 (setq entry (nconc entry (list (cons 'found-in class)))))
6947 (idlwave-sintern-class-info entry)
6948 (push entry idlwave-class-info)))))))))
6950 (defun idlwave-class-found-in (class)
6951 "Return the FOUND-IN property of the class."
6952 (cdr (assq 'found-in (idlwave-class-info class))))
6953 (defun idlwave-class-tags (class)
6954 "Return the native tags in CLASS."
6955 (cdr (assq 'tags (idlwave-class-info class))))
6956 (defun idlwave-class-inherits (class)
6957 "Return the direct superclasses of CLASS."
6958 (cdr (assq 'inherits (idlwave-class-info class))))
6961 (defun idlwave-all-class-tags (class)
6962 "Return a list of native and inherited tags in CLASS."
6963 (condition-case err
6964 (apply 'append (mapcar 'idlwave-class-tags
6965 (cons class (idlwave-all-class-inherits class))))
6966 (error
6967 (idlwave-class-tag-reset)
6968 (error "%s" (error-message-string err)))))
6971 (defun idlwave-all-class-inherits (class)
6972 "Return a list of all superclasses of CLASS (recursively expanded).
6973 The list is cached in `idlwave-class-info' for faster access."
6974 (cond
6975 ((not idlwave-support-inheritance) nil)
6976 ((eq class nil) nil)
6977 ((eq class t) nil)
6978 (t
6979 (let ((info (idlwave-class-info class))
6980 entry)
6981 (if (setq entry (assq 'all-inherits info))
6982 (cdr entry)
6983 ;; Save the depth of inheritance scan to check for circular references
6984 (let ((inherits (mapcar (lambda (x) (cons x 0))
6985 (idlwave-class-inherits class)))
6986 rtn all-inherits cl)
6987 (while inherits
6988 (setq cl (pop inherits)
6989 rtn (cons (car cl) rtn)
6990 inherits (append (mapcar (lambda (x)
6991 (cons x (1+ (cdr cl))))
6992 (idlwave-class-inherits (car cl)))
6993 inherits))
6994 (if (> (cdr cl) 999)
6995 (error
6996 "Class scan: inheritance depth exceeded. Circular inheritance?")
6997 ))
6998 (setq all-inherits (nreverse rtn))
6999 (nconc info (list (cons 'all-inherits all-inherits)))
7000 all-inherits))))))
7002 (defun idlwave-entry-keywords (entry &optional record-link)
7003 "Return the flat entry keywords alist from routine-info entry.
7004 If RECORD-LINK is non-nil, the keyword text is copied and a text
7005 property indicating the link is added."
7006 (let (kwds)
7007 (mapcar
7008 (lambda (key-list)
7009 (let ((file (car key-list)))
7010 (mapcar (lambda (key-cons)
7011 (let ((key (car key-cons))
7012 (link (cdr key-cons)))
7013 (when (and record-link file)
7014 (setq key (copy-sequence key))
7015 (put-text-property
7016 0 (length key)
7017 'link
7018 (concat
7019 file
7020 (if link
7021 (concat idlwave-html-link-sep
7022 (number-to-string link))))
7023 key))
7024 (push (list key) kwds)))
7025 (cdr key-list))))
7026 (nthcdr 5 entry))
7027 (nreverse kwds)))
7029 (defun idlwave-entry-find-keyword (entry keyword)
7030 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set"
7031 (catch 'exit
7032 (mapc
7033 (lambda (key-list)
7034 (let ((file (car key-list))
7035 (kwd (assoc keyword (cdr key-list))))
7036 (when kwd
7037 (setq kwd (cons (car kwd)
7038 (if (and file (cdr kwd))
7039 (concat file
7040 idlwave-html-link-sep
7041 (number-to-string (cdr kwd)))
7042 (cdr kwd))))
7043 (throw 'exit kwd))))
7044 (nthcdr 5 entry))))
7046 ;;==========================================================================
7047 ;;
7048 ;; Completing class structure tags. This is a completion plugin.
7049 ;; The necessary taglist is constructed dynamically
7051 (defvar idlwave-current-tags-class nil)
7052 (defvar idlwave-current-class-tags nil)
7053 (defvar idlwave-current-native-class-tags nil)
7054 (defvar idlwave-sint-class-tags nil)
7055 (idlwave-new-sintern-type 'class-tag)
7056 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7057 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7059 (defun idlwave-complete-class-structure-tag ()
7060 "Complete a structure tag on a `self' argument in an object method."
7061 (interactive)
7062 (let ((pos (point))
7063 (case-fold-search t))
7064 (if (save-excursion
7065 ;; Check if the context is right
7066 (skip-chars-backward "a-zA-Z0-9._$")
7067 (and (< (point) (- pos 4))
7069 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7070 (super-classes (idlwave-all-class-inherits class-selector)))
7071 ;; Check if we are in a class routine
7072 (unless class-selector
7073 (error "Not in a method procedure or function"))
7074 ;; Check if we need to update the "current" class
7075 (if (not (equal class-selector idlwave-current-tags-class))
7076 (idlwave-prepare-class-tag-completion class-selector))
7077 (setq idlwave-completion-help-info
7078 (list 'idlwave-complete-class-structure-tag-help
7079 (idlwave-sintern-routine
7080 (concat class-selector "__define"))
7081 nil))
7082 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7083 (idlwave-complete-in-buffer
7084 'class-tag 'class-tag
7085 idlwave-current-class-tags nil
7086 (format "Select a tag of class %s" class-selector)
7087 "class tag"
7088 'idlwave-attach-class-tag-classes))
7089 t) ; return t to skip other completions
7090 nil)))
7092 (defun idlwave-class-tag-reset ()
7093 (setq idlwave-current-tags-class nil))
7095 (defun idlwave-prepare-class-tag-completion (class)
7096 "Find and parse the necessary class definitions for class structure tags."
7097 (setq idlwave-sint-class-tags nil)
7098 (setq idlwave-current-tags-class class)
7099 (setq idlwave-current-class-tags
7100 (mapcar (lambda (x)
7101 (list (idlwave-sintern-class-tag x 'set)))
7102 (idlwave-all-class-tags class)))
7103 (setq idlwave-current-native-class-tags
7104 (mapcar 'downcase (idlwave-class-tags class))))
7106 ;===========================================================================
7107 ;;
7108 ;; Completing system variables and their structure fields
7109 ;; This is also a plugin.
7111 (defvar idlwave-sint-sysvars nil)
7112 (defvar idlwave-sint-sysvartags nil)
7113 (idlwave-new-sintern-type 'sysvar)
7114 (idlwave-new-sintern-type 'sysvartag)
7115 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7116 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7117 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7119 (defvar idlwave-executive-commands-alist nil
7120 "Alist of system variables and their help files.")
7122 (defvar idlwave-system-variables-alist nil
7123 "Alist of system variables and the associated structure tags.
7124 Gets set in `idlw-rinfo.el'.")
7126 (defun idlwave-complete-sysvar-or-tag ()
7127 "Complete a system variable."
7128 (interactive)
7129 (let ((pos (point))
7130 (case-fold-search t))
7131 (cond ((save-excursion
7132 ;; Check if the context is right for system variable
7133 (skip-chars-backward "[a-zA-Z0-9_$]")
7134 (equal (char-before) ?!))
7135 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7136 (idlwave-complete-in-buffer 'sysvar 'sysvar
7137 idlwave-system-variables-alist nil
7138 "Select a system variable"
7139 "system variable")
7140 t) ; return t to skip other completions
7141 ((save-excursion
7142 ;; Check if the context is right for sysvar tag
7143 (skip-chars-backward "a-zA-Z0-9_$.")
7144 (and (equal (char-before) ?!)
7146 (<= (match-end 0) pos)))
7147 ;; Complete a system variable tag
7148 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7149 (entry (assq var idlwave-system-variables-alist))
7150 (tags (cdr (assq 'tags entry))))
7151 (or entry (error "!%s is not a known system variable" var))
7152 (or tags (error "System variable !%s is not a structure" var))
7153 (setq idlwave-completion-help-info
7154 (list 'idlwave-complete-sysvar-tag-help var))
7155 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7156 tags nil
7157 "Select a system variable tag"
7158 "system variable tag")
7159 t)) ; return t to skip other completions
7160 (t nil))))
7162 (defun idlwave-complete-sysvar-help (mode word)
7163 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7164 (entry (assoc word idlwave-system-variables-alist)))
7165 (cond
7166 ((eq mode 'test)
7167 (and (stringp word) entry (nth 1 (assq 'link entry))))
7168 ((eq mode 'set)
7169 (if entry (setq link (nth 1 (assq 'link entry))))) ;; setting dynamic!!!
7170 (t (error "This should not happen")))))
7172 (defun idlwave-complete-sysvar-tag-help (mode word)
7173 (let* ((var (nth 1 idlwave-completion-help-info))
7174 (entry (assoc var idlwave-system-variables-alist))
7175 (tags (cdr (assq 'tags entry)))
7176 (main (nth 1 (assq 'link entry)))
7177 target main-base)
7178 (cond
7179 ((eq mode 'test) ; we can at least link the main
7180 (and (stringp word) entry main))
7181 ((eq mode 'set)
7182 (if entry
7183 (setq link
7184 (if (setq target (cdr (assoc word tags)))
7185 (idlwave-substitute-link-target main target)
7186 main)))) ;; setting dynamic!!!
7187 (t (error "This should not happen")))))
7189 (defun idlwave-substitute-link-target (link target)
7190 "Substitute the target anchor for the given link."
7191 (let (main-base)
7192 (setq main-base (if (string-match "#" link)
7193 (substring link 0 (match-beginning 0))
7194 link))
7195 (if target
7196 (concat main-base idlwave-html-link-sep (number-to-string target))
7197 link)))
7199 ;; Fake help in the source buffer for class structure tags.
7200 ;; KWD AND NAME ARE GLOBAL-VARIABLES HERE.
7201 (defvar name)
7202 (defvar kwd)
7203 (defvar idlwave-help-do-class-struct-tag nil)
7204 (defun idlwave-complete-class-structure-tag-help (mode word)
7205 (cond
7206 ((eq mode 'test) ; nothing gets fontified for class tags
7207 nil)
7208 ((eq mode 'set)
7209 (let (class-with found-in)
7210 (when (setq class-with
7211 (idlwave-class-or-superclass-with-tag
7212 idlwave-current-tags-class
7213 word))
7214 (if (assq (idlwave-sintern-class class-with)
7215 idlwave-system-class-info)
7216 (error "No help available for system class tags."))
7217 (if (setq found-in (idlwave-class-found-in class-with))
7218 (setq name (cons (concat found-in "__define") class-with))
7219 (setq name (concat class-with "__define")))))
7220 (setq kwd word
7221 idlwave-help-do-class-struct-tag t))
7222 (t (error "This should not happen"))))
7224 (defun idlwave-class-or-superclass-with-tag (class tag)
7225 "Find and return the CLASS or one of its superclass with the
7226 associated TAG, if any."
7227 (let ((sclasses (cons class (cdr (assq 'all-inherits
7228 (idlwave-class-info class)))))
7229 cl)
7230 (catch 'exit
7231 (while sclasses
7232 (setq cl (pop sclasses))
7233 (let ((tags (idlwave-class-tags cl)))
7234 (while tags
7235 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7236 (throw 'exit cl))
7237 (setq tags (cdr tags))))))))
7240 (defun idlwave-sysvars-reset ()
7241 (if (and (fboundp 'idlwave-shell-is-running)
7242 (idlwave-shell-is-running)
7243 idlwave-idlwave_routine_info-compiled)
7244 (idlwave-shell-send-command "idlwave_get_sysvars"
7245 'idlwave-process-sysvars 'hide)))
7247 (defun idlwave-process-sysvars ()
7248 (idlwave-shell-filter-sysvars)
7249 (setq idlwave-sint-sysvars nil
7250 idlwave-sint-sysvartags nil)
7251 (idlwave-sintern-sysvar-alist))
7253 (defun idlwave-sintern-sysvar-alist ()
7254 (let ((list idlwave-system-variables-alist) entry tags)
7255 (while (setq entry (pop list))
7256 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7257 (setq tags (assq 'tags entry))
7258 (if tags
7259 (setcdr tags
7260 (mapcar (lambda (x)
7261 (cons (idlwave-sintern-sysvartag (car x) 'set)
7262 (cdr x)))
7263 (cdr tags)))))))
7265 (defvar idlwave-shell-command-output)
7266 (defun idlwave-shell-filter-sysvars ()
7267 "Get any new system variables and tags."
7268 (let ((text idlwave-shell-command-output)
7269 (start 0)
7270 (old idlwave-system-variables-alist)
7271 var tags type name class link old-entry)
7272 (setq idlwave-system-variables-alist nil)
7274 text start)
7275 (setq start (match-end 0)
7276 var (match-string 1 text)
7277 tags (if (match-end 3)
7278 (idlwave-split-string (match-string 3 text))))
7279 ;; Maintain old links, if present
7280 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7281 (setq link (assq 'link old-entry))
7282 (setq idlwave-system-variables-alist
7283 (cons (list var
7284 (cons
7285 'tags
7286 (mapcar (lambda (x)
7287 (cons x
7288 (cdr (assq
7289 (idlwave-sintern-sysvartag x)
7290 (cdr (assq 'tags old-entry))))))
7291 tags)) link)
7292 idlwave-system-variables-alist)))
7293 ;; Keep the old value if query was not successful
7294 (setq idlwave-system-variables-alist
7295 (or idlwave-system-variables-alist old))))
7297 (defun idlwave-completion-fontify-classes ()
7298 "Goto the *Completions* buffer and fontify the class info."
7299 (when (featurep 'font-lock)
7300 (save-excursion
7301 (set-buffer "*Completions*")
7302 (save-excursion
7303 (goto-char (point-min))
7304 (let ((buffer-read-only nil))
7306 (put-text-property (match-beginning 0) (match-end 0)
7307 'face 'font-lock-string-face)))))))
7309 (defun idlwave-uniquify (list)
7310 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7311 (delq nil
7312 (mapcar (lambda (x)
7313 (unless (gethash x ht)
7314 (puthash x t ht)
7315 x))
7316 list))))
7318 (defun idlwave-after-successful-completion (type slash &optional verify)
7319 "Add `=' or `(' after successful completion of keyword and function.
7320 Restore the pre-completion window configuration if possible."
7321 (cond
7322 ((eq type 'procedure)
7323 nil)
7324 ((eq type 'function)
7325 (cond
7326 ((equal idlwave-function-completion-adds-paren nil) nil)
7327 ((or (equal idlwave-function-completion-adds-paren t)
7328 (equal idlwave-function-completion-adds-paren 1))
7329 (insert "("))
7330 ((equal idlwave-function-completion-adds-paren 2)
7331 (insert "()")
7332 (backward-char 1))
7333 (t nil)))
7334 ((eq type 'keyword)
7335 (if (and idlwave-keyword-completion-adds-equal
7336 (not slash))
7337 (progn (insert "=") t)
7338 nil)))
7340 ;; Restore the pre-completion window configuration if this is safe.
7342 (if (or (eq verify 'force) ; force
7343 (and
7344 (get-buffer-window "*Completions*") ; visible
7345 (idlwave-local-value 'idlwave-completion-p
7346 "*Completions*") ; cib-buffer
7347 (eq (marker-buffer idlwave-completion-mark)
7348 (current-buffer)) ; buffer OK
7349 (equal (marker-position idlwave-completion-mark)
7350 verify))) ; pos OK
7351 (idlwave-restore-wconf-after-completion))
7352 (move-marker idlwave-completion-mark nil)
7353 (setq idlwave-before-completion-wconf nil))
7355 (defun idlwave-mouse-context-help (ev &optional arg)
7356 "Call `idlwave-context-help' on the clicked location."
7357 (interactive "eP")
7358 (mouse-set-point ev)
7359 (idlwave-context-help arg))
7361 (defvar idlwave-last-context-help-pos nil)
7362 (defun idlwave-context-help (&optional arg)
7363 "Display IDL Online Help on context.
7364 If point is on a keyword, help for that keyword will be shown. If
7365 point is on a routine name or in the argument list of a routine, help
7366 for that routine will be displayed. Works for system routines and
7367 keywords, it pulls up text help. For other routies and keywords,
7368 visits the source file, finding help in the header (if
7369 `idlwave-help-source-try-header' is non-nil) or the routine definition
7370 itself."
7371 (interactive "P")
7372 (idlwave-do-context-help arg))
7374 (defun idlwave-mouse-completion-help (ev)
7375 "Display online help about the completion at point."
7376 (interactive "eP")
7377 ;; Restore last-command for next command, to make
7378 ;; scrolling/cancelling of completions work.
7379 (setq this-command last-command)
7380 (idlwave-do-mouse-completion-help ev))
7382 (defun idlwave-routine-info (&optional arg external)
7383 "Display a routines calling sequence and list of keywords. When
7384 point is on the name a function or procedure, or in the argument list
7385 of a function or procedure, this command displays a help buffer with
7386 the information. When called with prefix arg, enforce class query.
7388 When point is on an object operator `->', display the class stored in
7389 this arrow, if any (see `idlwave-store-inquired-class'). With a
7390 prefix arg, the class property is cleared out."
7392 (interactive "P")
7393 (idlwave-routines)
7394 (if (string-match "->" (buffer-substring
7395 (max (point-min) (1- (point)))
7396 (min (+ 2 (point)) (point-max))))
7397 ;; Cursor is on an arrow
7398 (if (get-text-property (point) 'idlwave-class)
7399 ;; arrow has class property
7400 (if arg
7401 ;; Remove property
7402 (save-excursion
7403 (backward-char 1)
7405 (remove-text-properties (match-beginning 1) (match-end 1)
7406 '(idlwave-class nil face nil))
7407 (message "Class property removed from arrow")))
7408 ;; Echo class property
7409 (message "Arrow has text property identifying object to be class %s"
7410 (get-text-property (point) 'idlwave-class)))
7411 ;; No property found
7412 (message "Arrow has no class text property"))
7414 ;; Not on an arrow...
7415 (let* ((idlwave-query-class nil)
7416 (idlwave-force-class-query (equal arg '(4)))
7417 (module (idlwave-what-module)))
7418 (if (car module)
7419 (apply 'idlwave-display-calling-sequence
7420 (idlwave-fix-module-if-obj_new module))
7421 (error "Don't know which calling sequence to show")))))
7423 (defun idlwave-resolve (&optional arg)
7424 "Call RESOLVE_ROUTINE on the module name at point.
7425 Like `idlwave-routine-info', this looks for a routine call at point.
7426 After confirmation in the minibuffer, it will use the shell to issue
7427 a RESOLVE call for this routine, to attempt to make it defined and its
7428 routine info available for IDLWAVE. If the routine is a method call,
7429 both `class__method' and `class__define' will be tried.
7430 With ARG, enforce query for the class of object methods."
7431 (interactive "P")
7432 (let* ((idlwave-query-class nil)
7433 (idlwave-force-class-query (equal arg '(4)))
7434 (module (idlwave-what-module))
7435 (name (idlwave-make-full-name (nth 2 module) (car module)))
7436 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7437 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7438 (kwd "")
7439 class)
7441 resolve)
7442 (setq type (match-string 1 resolve)
7443 class (if (match-beginning 2)
7444 (match-string 3 resolve)
7445 nil)
7446 name (match-string 4 resolve)))
7447 (if (string= (downcase type) "function")
7448 (setq kwd ",/is_function"))
7450 (cond
7451 ((null class)
7452 (idlwave-shell-send-command
7453 (format "resolve_routine,'%s'%s" (downcase name) kwd)
7454 'idlwave-update-routine-info
7455 nil t))
7456 (t
7457 (idlwave-shell-send-command
7458 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
7459 (list 'idlwave-shell-send-command
7460 (format "resolve_routine,'%s__%s'%s"
7461 (downcase class) (downcase name) kwd)
7462 '(idlwave-update-routine-info)
7463 nil t))))))
7465 (defun idlwave-find-module (&optional arg)
7466 "Find the source code of an IDL module.
7467 Works for modules for which IDLWAVE has routine info available. The
7468 function offers as default the module name `idlwave-routine-info'
7469 would use. With ARG limit to this buffer. With two prefix ARG's
7470 force class query for object methods."
7471 (interactive "P")
7472 (let* ((idlwave-query-class nil)
7473 (idlwave-force-class-query (equal arg '(16)))
7474 (this-buffer (equal arg '(4)))
7475 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
7476 (default (if module
7477 (concat (idlwave-make-full-name
7478 (nth 2 module) (car module))
7479 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
7480 "none"))
7481 (list
7482 (idlwave-uniquify
7483 (delq nil
7484 (mapcar (lambda (x)
7485 (if (eq 'system (car-safe (nth 3 x)))
7486 ;; Take out system routines with no source.
7487 nil
7488 (list
7489 (concat (idlwave-make-full-name
7490 (nth 2 x) (car x))
7491 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
7492 (if this-buffer
7493 (idlwave-save-buffer-update)
7494 (idlwave-routines))))))
7495 (name (idlwave-completing-read
7496 (if (or (not this-buffer)
7497 (assoc default list))
7498 (format "Module (Default %s): " default)
7499 (format "Module in this file: "))
7500 list))
7501 type class)
7503 ;; Nothing, use the default.
7504 (setq name default))
7505 (if (string-match "<[fp]>" name)
7506 (setq type (substring name -2 -1)
7507 name (substring name 0 -3)))
7509 (setq class (match-string 1 name)
7510 name (match-string 2 name)))
7511 (setq name (idlwave-sintern-routine-or-method name class)
7512 class (idlwave-sintern-class class)
7513 type (cond ((equal type "f") 'fun)
7514 ((equal type "p") 'pro)
7515 (t t)))
7516 (idlwave-do-find-module name type class nil this-buffer)))
7518 (defun idlwave-do-find-module (name type class
7519 &optional force-source this-buffer)
7520 (let ((name1 (idlwave-make-full-name class name))
7521 source buf1 entry
7522 (buf (current-buffer))
7523 (pos (point))
7524 file name2)
7525 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
7526 'WITH-FILE)
7527 source (or force-source (nth 3 entry))
7528 name2 (if (nth 2 entry)
7529 (idlwave-make-full-name (nth 2 entry) name)
7530 name1))
7531 (if source
7532 (setq file (idlwave-routine-source-file source)))
7533 (unless file ; Try to find it on the path.
7534 (setq file
7535 (idlwave-expand-lib-file-name
7536 (if class
7537 (format "%s__define.pro" (downcase class))
7538 (format "%s.pro" (downcase name))))))
7539 (cond
7540 ((or (null name) (equal name ""))
7541 (error "Abort"))
7542 ((eq (car source) 'system)
7543 (error "Source code for system routine %s is not available"
7544 name2))
7545 ((or (not file) (not (file-regular-p file)))
7546 (error "Source code for routine %s is not available"
7547 name2))
7548 (t
7549 (when (not this-buffer)
7550 (setq buf1
7551 (idlwave-find-file-noselect file 'find))
7552 (pop-to-buffer buf1 t))
7553 (goto-char (point-max))
7554 (let ((case-fold-search t))
7555 (if (re-search-backward
7557 (cond ((eq type 'fun) "function")
7558 ((eq type 'pro) "pro")
7561 (regexp-quote (downcase name2))
7562 "[^a-zA-Z0-9_$]")
7563 nil t)
7564 (goto-char (match-beginning 0))
7565 (pop-to-buffer buf)
7566 (goto-char pos)
7567 (error "Could not find routine %s" name2)))))))
7569 (defun idlwave-what-module ()
7570 "Return a default module for stuff near point.
7571 Used by `idlwave-routine-info' and `idlwave-find-module'."
7572 (idlwave-routines)
7573 (if (let ((case-fold-search t))
7574 (save-excursion
7575 (idlwave-beginning-of-statement)
7576 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
7577 ;; This is a function or procedure definition statement
7578 ;; We return the defined routine as module.
7579 (list
7580 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
7581 (match-string-no-properties 2))
7582 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
7583 (idlwave-sintern-class (match-string 3)))
7585 ;; Not a definition statement - analyze precise position.
7586 (let* ((where (idlwave-where))
7587 (cw (nth 2 where))
7588 (pro (car (nth 0 where)))
7589 (func (car (nth 1 where)))
7590 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
7591 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
7592 (following-char)))
7593 )
7594 (cond
7595 ((and (eq cw 'procedure)
7596 (not (equal this-word "")))
7597 (setq this-word (idlwave-sintern-routine-or-method
7598 this-word (nth 2 (nth 3 where))))
7599 (list this-word 'pro
7600 (idlwave-determine-class
7601 (cons this-word (cdr (nth 3 where)))
7602 'pro)))
7603 ((and (eq cw 'function)
7604 (not (equal this-word ""))
7605 (or (eq next-char ?\() ; exclude arrays, vars.
7607 (setq this-word (idlwave-sintern-routine-or-method
7608 this-word (nth 2 (nth 3 where))))
7609 (list this-word 'fun
7610 (idlwave-determine-class
7611 (cons this-word (cdr (nth 3 where)))
7612 'fun)))
7613 ((and (memq cw '(function-keyword procedure-keyword))
7614 (not (equal this-word ""))
7615 (eq next-char ?\()) ; A function!
7616 (setq this-word (idlwave-sintern-routine this-word))
7617 (list this-word 'fun nil))
7618 (func
7619 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
7620 (pro
7621 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
7622 (t nil)))))
7624 (defun idlwave-what-module-find-class ()
7625 "Call idlwave-what-module and find the inherited class if necessary."
7626 (let* ((module (idlwave-what-module))
7627 (class (nth 2 module))
7628 classes)
7629 (if (and (= (length module) 3)
7630 (stringp class))
7631 (list (car module)
7632 (nth 1 module)
7633 (apply 'idlwave-find-inherited-class module))
7634 module)))
7636 (defun idlwave-find-inherited-class (name type class)
7637 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
7638 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
7639 (if entry
7640 (nth 2 entry)
7641 class)))
7643 (defun idlwave-fix-module-if-obj_new (module)
7644 "Check if MODULE points to obj_new.
7645 If yes, and if the cursor is in the keyword region, change to the
7646 appropriate Init method."
7647 (let* ((name (car module))
7648 (pos (point))
7649 (case-fold-search t)
7650 string)
7651 (if (and (stringp name)
7652 (equal (downcase name) "obj_new")
7653 (save-excursion
7654 (idlwave-beginning-of-statement)
7655 (setq string (buffer-substring (point) pos))
7657 string)))
7658 (let ((name "Init")
7659 (class (match-string 1 string)))
7660 (setq module (list (idlwave-sintern-method "Init")
7661 'fun
7662 (idlwave-sintern-class class)))))
7663 module))
7665 (defun idlwave-fix-keywords (name type class keywords &optional super-classes)
7666 "Update a list of keywords.
7667 Translate OBJ_NEW, adding all super-class keywords, or all keywords
7668 from all classes if class equals t."
7669 (let ((case-fold-search t))
7671 ;; If this is the OBJ_NEW function, try to figure out the class and use
7672 ;; the keywords from the corresponding INIT method.
7673 (if (and (equal (upcase name) "OBJ_NEW")
7674 (or (eq major-mode 'idlwave-mode)
7675 (eq major-mode 'idlwave-shell-mode)))
7676 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
7677 (string (buffer-substring bos (point)))
7678 (case-fold-search t)
7679 class)
7681 string)
7682 (setq class (idlwave-sintern-class (match-string 1 string)))
7683 (setq idlwave-current-obj_new-class class)
7684 (setq keywords
7685 (append keywords
7686 (idlwave-entry-keywords
7687 (idlwave-rinfo-assq
7688 (idlwave-sintern-method "INIT")
7689 'fun
7690 class
7691 (idlwave-routines)) 'do-link))))))
7693 ;; If the class is `t', combine all keywords of all methods NAME
7694 (when (eq class t)
7695 (mapc (lambda (entry)
7696 (and
7697 (nth 2 entry) ; non-nil class
7698 (eq (nth 1 entry) type) ; correct type
7699 (setq keywords
7700 (append keywords
7701 (idlwave-entry-keywords entry 'do-link)))))
7702 (idlwave-all-assq name (idlwave-routines)))
7703 (setq keywords (idlwave-uniquify keywords)))
7705 ;; If we have inheritance, add all keywords from superclasses, if
7706 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
7707 (when (and
7708 super-classes
7709 idlwave-keyword-class-inheritance
7710 (stringp class)
7711 (or (assq (idlwave-sintern-keyword "_extra") keywords)
7712 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
7713 ;; Check if one of the keyword-class regexps matches the name
7714 (let ((regexps idlwave-keyword-class-inheritance) re)
7715 (catch 'exit
7716 (while (setq re (pop regexps))
7717 (if (string-match re name) (throw 'exit t))))))
7719 (loop for entry in (idlwave-routines) do
7720 (and (nth 2 entry) ; non-nil class
7721 (memq (nth 2 entry) super-classes) ; an inherited class
7722 (eq (nth 1 entry) type) ; correct type
7723 (eq (car entry) name) ; correct name
7724 (mapcar (lambda (k) (add-to-list 'keywords k))
7725 (idlwave-entry-keywords entry 'do-link))))
7726 (setq keywords (idlwave-uniquify keywords)))
7728 ;; Return the final list
7729 keywords))
7731 (defun idlwave-expand-keyword (keyword module)
7732 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
7733 KEYWORD may be an exact match or an abbreviation of a keyword.
7734 If the match is exact, KEYWORD itself is returned, even if there may be other
7735 keywords of which KEYWORD is an abbreviation. This is necessary because some
7736 system routines have keywords which are prefixes of other keywords.
7737 If KEYWORD is an abbreviation of several keywords, a list of all possible
7738 completions is returned.
7739 If the abbreviation was unique, the correct keyword is returned.
7740 If it cannot be a keyword, the function return nil.
7741 If we do not know about MODULE, just return KEYWORD literally."
7742 (let* ((name (car module))
7743 (type (nth 1 module))
7744 (class (nth 2 module))
7745 (kwd (idlwave-sintern-keyword keyword))
7746 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
7747 (kwd-alist (idlwave-entry-keywords entry))
7748 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
7749 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
7750 (completion-ignore-case t)
7751 candidates)
7752 (cond ((assq kwd kwd-alist)
7753 kwd)
7754 ((setq candidates (all-completions kwd kwd-alist))
7755 (if (= (length candidates) 1)
7756 (car candidates)
7757 candidates))
7758 ((and entry extra)
7759 ;; Inheritance may cause this keyword to be correct
7760 keyword)
7761 (entry
7762 ;; We do know the function, which does not have the keyword.
7763 nil)
7764 (t
7765 ;; We do not know the function, so this just might be a correct
7766 ;; keyword - return it as it is.
7767 keyword))))
7769 (defvar idlwave-rinfo-mouse-map (make-sparse-keymap))
7770 (defvar idlwave-rinfo-map (make-sparse-keymap))
7771 (define-key idlwave-rinfo-mouse-map
7772 (if (featurep 'xemacs) [button2] [mouse-2])
7773 'idlwave-mouse-active-rinfo)
7774 (define-key idlwave-rinfo-mouse-map
7775 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
7776 'idlwave-mouse-active-rinfo-shift)
7777 (define-key idlwave-rinfo-mouse-map
7778 (if (featurep 'xemacs) [button3] [mouse-3])
7779 'idlwave-mouse-active-rinfo-right)
7780 (define-key idlwave-rinfo-mouse-map " " 'idlwave-active-rinfo-space)
7781 (define-key idlwave-rinfo-map "q" 'idlwave-quit-help)
7782 (define-key idlwave-rinfo-mouse-map "q" 'idlwave-quit-help)
7783 (defvar idlwave-popup-source nil)
7784 (defvar idlwave-rinfo-marker (make-marker))
7786 (defun idlwave-quit-help ()
7787 (interactive)
7788 (let ((ri-window (get-buffer-window "*Help*"))
7789 (olh-window (get-buffer-window "*IDLWAVE Help*")))
7790 (when (and olh-window
7791 (fboundp 'idlwave-help-quit))
7792 (select-window olh-window)
7793 (idlwave-help-quit))
7794 (when (window-live-p ri-window)
7795 (delete-window ri-window))))
7797 (defun idlwave-display-calling-sequence (name type class
7798 &optional initial-class)
7799 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
7800 (let* ((initial-class (or initial-class class))
7801 (entry (or (idlwave-best-rinfo-assq name type class
7802 (idlwave-routines))
7803 (idlwave-rinfo-assq name type class
7804 idlwave-unresolved-routines)))
7805 (name (or (car entry) name))
7806 (class (or (nth 2 entry) class))
7807 (superclasses (idlwave-all-class-inherits initial-class))
7808 (twins (idlwave-routine-twins entry))
7809 (dtwins (idlwave-study-twins twins))
7810 (all dtwins)
7811 (system (eq (car (nth 3 entry)) 'system))
7812 (calling-seq (nth 4 entry))
7813 (keywords (idlwave-entry-keywords entry 'do-link))
7814 (html-file (car (nth 5 entry)))
7815 (help-echo-kwd
7816 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
7817 (help-echo-use
7818 "Button2/3: Online Help")
7819 (help-echo-src
7820 "Button2: Jump to source and back | Button3: Source in Help window.")
7821 (help-echo-class
7822 "Button2: Display info about same method in superclass")
7823 (col 0)
7824 (data (list name type class (current-buffer) nil initial-class))
7825 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
7826 (face 'idlwave-help-link-face)
7827 beg props win cnt total)
7828 ;; Fix keywords, but don't add chained super-classes, since these
7829 ;; are shown separately for that super-class
7830 (setq keywords (idlwave-fix-keywords name type class keywords))
7831 (cond
7832 ((null entry)
7833 (error "No %s %s known %s" type name
7834 (if initial-class (concat "in class " initial-class) "")))
7835 ((or (null name) (equal name ""))
7836 (error "No function or procedure call at point"))
7837 ((null calling-seq)
7838 (error "Calling sequence of %s %s not available" type name))
7839 (t
7840 (save-excursion
7841 (move-marker idlwave-rinfo-marker (point))
7842 (set-buffer (get-buffer-create "*Help*"))
7843 (use-local-map idlwave-rinfo-map)
7844 (setq buffer-read-only nil)
7845 (erase-buffer)
7846 (set (make-local-variable 'idlwave-popup-source) nil)
7847 (set (make-local-variable 'idlwave-current-obj_new-class)
7848 idlwave-current-obj_new-class)
7849 (when superclasses
7850 (setq props (list 'mouse-face 'highlight
7851 km-prop idlwave-rinfo-mouse-map
7852 'help-echo help-echo-class
7853 'data (cons 'class data)))
7854 (let ((classes (cons initial-class superclasses)) c)
7855 (insert "Classes: ")
7856 (while (setq c (pop classes))
7857 (insert " ")
7858 (setq beg (point))
7859 (insert c)
7860 (if (equal (downcase c) (downcase class))
7861 (add-text-properties beg (point) (list 'face 'bold))
7862 ;; If Method exists in a different class link it
7863 (if (idlwave-rinfo-assq name type c (idlwave-routines))
7864 (add-text-properties beg (point) props))))
7866 (setq props (list 'mouse-face 'highlight
7867 km-prop idlwave-rinfo-mouse-map
7868 'help-echo help-echo-use
7869 'data (cons 'usage data)))
7870 (if html-file (setq props (append (list 'face face 'link html-file)
7871 props)))
7872 (insert "Usage: ")
7873 (setq beg (point))
7874 (insert (if class
7875 (format calling-seq class name class name class name)
7876 (format calling-seq name name name name))
7878 (add-text-properties beg (point) props)
7880 (insert "Keywords:")
7881 (if (null keywords)
7882 (insert " No keywords accepted.")
7883 (setq col 9)
7884 (mapcar
7885 (lambda (x)
7886 (if (>= (+ col 1 (length (car x)))
7887 (window-width))
7888 (progn
7890 (setq col 9)))
7891 (insert " ")
7892 (setq beg (point)
7893 ;; Relevant keywords already have link property attached
7894 props (list 'mouse-face 'highlight
7895 km-prop idlwave-rinfo-mouse-map
7896 'data (cons 'keyword data)
7897 'help-echo help-echo-kwd
7898 'keyword (car x)))
7899 (if system (setq props (append (list 'face face) props)))
7900 (insert (car x))
7901 (add-text-properties beg (point) props)
7902 (setq col (+ col 1 (length (car x)))))
7903 keywords))
7905 (setq cnt 1 total (length all))
7906 ;; Here entry is (key file (list of type-conses))
7907 (while (setq entry (pop all))
7908 (setq props (list 'mouse-face 'highlight
7909 km-prop idlwave-rinfo-mouse-map
7910 'help-echo help-echo-src
7911 'source (list (car (car (nth 2 entry))) ;type
7912 (nth 1 entry)
7913 nil
7914 (cdr (car (nth 2 entry))))
7915 'data (cons 'source data)))
7916 (idlwave-insert-source-location
7918 (if (equal cnt 1)
7919 (if (> total 1) "Sources:" "Source:")
7920 "")
7921 (if (> total 1) "- " ""))
7922 entry props)
7923 (incf cnt)
7924 (when (and all (> cnt idlwave-rinfo-max-source-lines))
7925 ;; No more source lines, please
7926 (insert (format
7928 idlwave-rinfo-max-source-lines))
7929 (setq all nil)))
7930 (goto-char (point-min))
7931 (setq buffer-read-only t))
7932 (display-buffer "*Help*")
7933 (if (and (setq win (get-buffer-window "*Help*"))
7934 idlwave-resize-routine-help-window)
7935 (progn
7936 (let ((ww (selected-window)))
7937 (unwind-protect
7938 (progn
7939 (select-window win)
7940 (enlarge-window (- (/ (frame-height) 2)
7941 (window-height)))
7942 (shrink-window-if-larger-than-buffer))
7943 (select-window ww)))))))))
7945 (defun idlwave-insert-source-location (prefix entry &optional file-props)
7946 "Insert a source location into the routine info buffer.
7947 Start line with PREFIX. If a file name is inserted, add FILE-PROPS to
7948 it."
7949 (let* ((key (car entry))
7950 (file (nth 1 entry))
7951 (types (nth 2 entry))
7952 (shell-flag (assq 'compiled types))
7953 (buffer-flag (assq 'buffer types))
7954 (user-flag (assq 'user types))
7955 (lib-flag (assq 'lib types))
7956 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
7957 (and user-flag (idlwave-count-memq 'user types))
7958 (and lib-flag (idlwave-count-memq 'lib types))
7959 1))
7960 (doflags t)
7961 beg special)
7963 (insert prefix)
7965 (cond
7966 ((eq key 'system)
7967 (setq doflags nil)
7968 (insert "System "))
7970 ((eq key 'builtin)
7971 (setq doflags nil)
7972 (insert "Builtin "))
7974 ((and (not file) shell-flag)
7975 (insert "Unresolved"))
7977 ((null file)
7978 (insert "ERROR"))
7980 ((idlwave-syslib-p file)
7981 (if (string-match "obsolete" (file-name-directory file))
7982 (insert "Obsolete ")
7983 (insert "SystemLib ")))
7985 ;; New special syntax: taken directly from routine-info for
7986 ;; library catalog routines
7987 ((setq special (or (cdr lib-flag) (cdr user-flag)))
7988 (insert (format "%-10s" special)))
7990 ;; Old special syntax: a matching regexp
7991 ((setq special (idlwave-special-lib-test file))
7992 (insert (format "%-10s" special)))
7994 ;; Catch-all with file
7995 ((idlwave-lib-p file) (insert "Library "))
7997 ;; Sanity catch all
7998 (t (insert "Other ")))
8000 (when doflags
8001 (insert (concat
8002 " ["
8003 (if lib-flag "L" "-")
8004 (if user-flag "C" "-")
8005 (if shell-flag "S" "-")
8006 (if buffer-flag "B" "-")
8007 "] ")))
8008 (when (> ndupl 1)
8009 (setq beg (point))
8010 (insert (format "(%dx) " ndupl))
8011 (add-text-properties beg (point) (list 'face 'bold)))
8012 (when (and file (not (equal file "")))
8013 (setq beg (point))
8014 (insert (apply 'abbreviate-file-name
8015 (if (featurep 'xemacs) (list file t) (list file))))
8016 (if file-props
8017 (add-text-properties beg (point) file-props)))))
8019 (defun idlwave-special-lib-test (file)
8020 "Check the path of FILE against the regexps which define special libs.
8021 Return the name of the special lib if there is a match."
8022 (let ((alist idlwave-special-lib-alist)
8023 entry rtn)
8024 (cond
8025 ((stringp file)
8026 (while (setq entry (pop alist))
8027 (if (string-match (car entry) file)
8028 (setq rtn (cdr entry)
8029 alist nil)))
8030 rtn)
8031 (t nil))))
8033 (defun idlwave-mouse-active-rinfo-right (ev)
8034 (interactive "e")
8035 (idlwave-mouse-active-rinfo ev 'right))
8037 (defun idlwave-mouse-active-rinfo-shift (ev)
8038 (interactive "e")
8039 (idlwave-mouse-active-rinfo ev nil 'shift))
8041 (defun idlwave-active-rinfo-space ()
8042 (interactive)
8043 (idlwave-mouse-active-rinfo nil 'right))
8045 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8046 "Does the mouse actions in the routine info buffer.
8047 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8048 was pressed."
8049 (interactive "e")
8050 (if ev (mouse-set-point ev))
8051 (let (data id name type class buf bufwin source word initial-class)
8052 (setq data (get-text-property (point) 'data)
8053 source (get-text-property (point) 'source)
8054 keyword (get-text-property (point) 'keyword)
8055 link (get-text-property (point) 'link)
8056 id (car data)
8057 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8058 buf (nth 4 data)
8059 initial-class (nth 6 data)
8060 word (idlwave-this-word)
8061 bufwin (get-buffer-window buf t))
8063 (cond ((eq id 'class) ; Switch class being displayed
8064 (if (window-live-p bufwin) (select-window bufwin))
8065 (idlwave-display-calling-sequence
8066 (idlwave-sintern-method name)
8067 type (idlwave-sintern-class word)
8068 initial-class))
8069 ((eq id 'usage) ; Online help on this routine
8070 (idlwave-online-help link name type class))
8071 ((eq id 'source) ; Source in help or buffer
8072 (if right ; In help
8073 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8074 (idlwave-help-source-try-header nil)
8075 ;; Fake idlwave-routines so help will find the right entry
8076 (idlwave-routines
8077 (list (list name type class source ""))))
8078 (idlwave-help-get-special-help name type class nil))
8079 ;; Otherwise just pop to the source
8080 (setq idlwave-popup-source (not idlwave-popup-source))
8081 (if idlwave-popup-source
8082 (condition-case err
8083 (idlwave-do-find-module name type class source)
8084 (error
8085 (setq idlwave-popup-source nil)
8086 (if (window-live-p bufwin) (select-window bufwin))
8087 (error (nth 1 err))))
8088 (if bufwin
8089 (select-window bufwin)
8090 (pop-to-buffer buf))
8091 (goto-char (marker-position idlwave-rinfo-marker)))))
8092 ((eq id 'keyword)
8093 (if right
8094 (idlwave-online-help link name type class keyword)
8095 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8097 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8098 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8099 (let ((bwin (get-buffer-window buffer)))
8100 (if idlwave-complete-empty-string-as-lower-case
8101 (setq keyword (downcase keyword)))
8102 (if bwin
8103 (select-window bwin)
8104 (pop-to-buffer buffer)
8105 (setq bwin (get-buffer-window buffer)))
8106 (if (eq (preceding-char) ?/)
8107 (insert keyword)
8108 (unless (save-excursion
8109 (re-search-backward
8111 (min (- (point) 100) (point-min)) t))
8112 (insert ", "))
8113 (if shift (insert "/"))
8114 (insert keyword)
8115 (if (and (not shift)
8116 idlwave-keyword-completion-adds-equal)
8117 (insert "=")))))
8119 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8120 "List the load path shadows of all routines defined in current buffer."
8121 (interactive "P")
8122 (idlwave-routines)
8123 (if (eq major-mode 'idlwave-mode)
8124 (idlwave-list-load-path-shadows
8125 nil (idlwave-update-current-buffer-info 'save-buffer)
8126 "in current buffer")
8127 (error "Current buffer is not in idlwave-mode")))
8129 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8130 "List the load path shadows of all routines compiled under the shell.
8131 This is very useful for checking an IDL application. Just compile the
8132 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8133 routines and update IDLWAVE internal info. Then check for shadowing
8134 with this command."
8135 (interactive "P")
8136 (cond
8137 ((or (not (fboundp 'idlwave-shell-is-running))
8138 (not (idlwave-shell-is-running)))
8139 (error "Shell is not running"))
8140 ((null idlwave-compiled-routines)
8141 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8142 (t
8143 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8144 "in the shell"))))
8146 (defun idlwave-list-all-load-path-shadows (&optional arg)
8147 "List the load path shadows of all routines known to IDLWAVE."
8148 (interactive "P")
8149 (idlwave-list-load-path-shadows nil nil "globally"))
8151 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8152 "List the routines which are defined multiple times.
8153 Search the information IDLWAVE has about IDL routines for multiple
8154 definitions.
8155 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8157 When IDL hits a routine call which is not defined, it will search on
8158 the load path in order to find a definition. The output of this
8159 command can be used to detect possible name clashes during this process."
8160 (idlwave-routines) ; Make sure everything is loaded.
8161 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8162 (or (y-or-n-p
8163 "You don't have any user or library catalogs. Continue anyway? ")
8164 (error "Abort")))
8165 (let* ((routines (append idlwave-system-routines
8166 idlwave-compiled-routines
8167 idlwave-library-catalog-routines
8168 idlwave-user-catalog-routines
8169 idlwave-buffer-routines
8170 nil))
8171 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8172 (keymap (make-sparse-keymap))
8173 (props (list 'mouse-face 'highlight
8174 km-prop keymap
8175 'help-echo "Mouse2: Find source"))
8176 (nroutines (length (or special-routines routines)))
8177 (step (/ nroutines 99))
8178 (n 0)
8179 (next-perc 1)
8180 (cnt 0)
8181 (idlwave-sort-prefer-buffer-info nil)
8182 routine twins dtwins twin done props1 lroutines)
8184 (if special-routines
8185 ;; Just looking for shadows of a few special routines
8186 (setq lroutines routines
8187 routines special-routines))
8189 (message "Sorting routines...")
8190 (setq routines (sort routines
8191 (lambda (a b)
8192 (string< (downcase (idlwave-make-full-name
8193 (nth 2 a) (car a)))
8194 (downcase (idlwave-make-full-name
8195 (nth 2 b) (car b)))))))
8196 (message "Sorting routines...done")
8198 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8199 (lambda (ev)
8200 (interactive "e")
8201 (mouse-set-point ev)
8202 (apply 'idlwave-do-find-module
8203 (get-text-property (point) 'find-args))))
8204 (define-key keymap [(return)]
8205 (lambda ()
8206 (interactive)
8207 (apply 'idlwave-do-find-module
8208 (get-text-property (point) 'find-args))))
8209 (message "Compiling list...( 0%%)")
8210 (save-excursion
8211 (set-buffer (get-buffer-create "*Shadows*"))
8212 (setq buffer-read-only nil)
8213 (erase-buffer)
8214 (while (setq routine (pop routines))
8215 (setq n (1+ n))
8216 (if (= (* next-perc step) n)
8217 (progn
8218 (message "Compiling list...(%2d%%)" next-perc)
8219 (setq next-perc (1+ next-perc))))
8220 ;; Get a list of all twins
8221 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8222 (if (memq routine done)
8223 (setq dtwins nil)
8224 (setq dtwins (idlwave-study-twins twins)))
8225 ;; Mark all twins as dealt with
8226 (setq done (append twins done))
8227 (when (or (> (length dtwins) 1)
8228 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8229 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8230 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8231 (incf cnt)
8233 (idlwave-make-full-name (nth 2 routine)
8234 (car routine))
8235 (if (eq (nth 1 routine) 'fun) "()" "")))
8236 (while (setq twin (pop dtwins))
8237 (setq props1 (append (list 'find-args
8238 (list (nth 0 routine)
8239 (nth 1 routine)
8240 (nth 2 routine)))
8241 props))
8243 (goto-char (point-min))
8244 (setq buffer-read-only t))
8245 (setq loc (or loc ""))
8246 (if (> cnt 0)
8247 (progn
8248 (display-buffer (get-buffer "*Shadows*"))
8249 (message "%d case%s of shadowing found %s"
8250 cnt (if (= cnt 1) "" "s") loc))
8251 (message "No shadowing conflicts found %s" loc))))
8253 (defun idlwave-print-source (routine)
8254 (let* ((source (nth 3 routine))
8255 (stype (car source))
8256 (sfile (idlwave-routine-source-file source)))
8257 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8258 (if (and (eq stype 'compiled)
8259 (or (not (stringp sfile))
8261 (setq stype 'unresolved))
8263 stype
8264 (if sfile sfile "No source code available")))))
8266 (defun idlwave-routine-twins (entry &optional list)
8267 "Return all twin entries of ENTRY in LIST.
8268 LIST defaults to `idlwave-routines'.
8269 Twin entries are those which have the same name, type, and class.
8270 ENTRY will also be returned, as the first item of this list."
8271 (let* ((name (car entry))
8272 (type (nth 1 entry))
8273 (class (nth 2 entry))
8274 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8275 twins candidate)
8276 (while (setq candidate (pop candidates))
8277 (if (and (not (eq candidate entry))
8278 (eq type (nth 1 candidate))
8279 (eq class (nth 2 candidate)))
8280 (push candidate twins)))
8281 (if (setq candidate (idlwave-rinfo-assq name type class
8282 idlwave-unresolved-routines))
8283 (push candidate twins))
8284 (cons entry (nreverse twins))))
8286 (defun idlwave-study-twins (entries)
8287 "Return dangerous twins of first entry in ENTRIES.
8288 Dangerous twins are routines with same name, but in different files on
8289 the load path. If a file is in the system library and has an entry in
8290 the `idlwave-system-routines' list, we omit the latter as
8291 non-dangerous because many IDL routines are implemented as library
8292 routines, and may have been scanned."
8293 (let* ((entry (car entries))
8294 (name (car entry)) ;
8295 (type (nth 1 entry)) ; Must be bound for
8296 (class (nth 2 entry)) ; idlwave-routine-twin-compare
8297 (cnt 0)
8298 source type type-cons file alist syslibp key)
8299 (while (setq entry (pop entries))
8300 (incf cnt)
8301 (setq source (nth 3 entry)
8302 type (car source)
8303 type-cons (cons type (nth 3 source))
8304 file (idlwave-routine-source-file source))
8306 ;; Make KEY to index entry properly
8307 (setq key (cond ((eq type 'system) type)
8308 (file (file-truename file))
8309 (t 'unresolved)))
8311 ;; Check for an entry in the system library
8312 (if (and file
8313 (not syslibp)
8314 (idlwave-syslib-p file))
8315 (setq syslibp t))
8317 ;; If there's more than one matching entry for the same file, just
8318 ;; append the type-cons to the type list.
8319 (if (setq entry (assoc key alist))
8320 (push type-cons (nth 2 entry))
8321 (push (list key file (list type-cons)) alist)))
8323 (setq alist (nreverse alist))
8325 (when syslibp
8326 ;; File is in system *library* - remove any 'system entry
8327 (setq alist (delq (assq 'system alist) alist)))
8329 ;; If 'system remains and we've scanned the syslib, it's a builtin
8330 ;; (rather than a !DIR/lib/.pro file bundled as source).
8331 (when (and (idlwave-syslib-scanned-p)
8332 (setq entry (assoc 'system alist)))
8333 (setcar entry 'builtin))
8334 (sort alist 'idlwave-routine-twin-compare)))
8336 (defvar name)
8337 (defvar type)
8338 (defvar class)
8339 (defvar idlwave-sort-prefer-buffer-info t
8340 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8342 (defmacro idlwave-xor (a b)
8343 `(and (or ,a ,b)
8344 (not (and ,a ,b))))
8346 (defun idlwave-routine-entry-compare (a b)
8347 "Compare two routine info entries for sortiung. This is the general case.
8348 It first compates class, names, and type. If it turns out that A and B
8349 are twins (same name, class, and type), calls another routine which
8350 compares twins on the basis of their file names and path locations."
8351 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8352 (cond
8353 ((not (equal (idlwave-downcase-safe class)
8354 (idlwave-downcase-safe (nth 2 b))))
8355 ;; Class decides
8356 (cond ((null (nth 2 b)) nil)
8357 ((null class) t)
8358 (t (string< (downcase class) (downcase (nth 2 b))))))
8359 ((not (equal (downcase name) (downcase (car b))))
8360 ;; Name decides
8361 (string< (downcase name) (downcase (car b))))
8362 ((not (eq type (nth 1 b)))
8363 ;; Type decides
8364 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8365 (t
8366 ;; A and B are twins - so the decision is more complicated.
8367 ;; Call twin-compare with the proper arguments.
8368 (idlwave-routine-entry-compare-twins a b)))))
8370 (defun idlwave-routine-entry-compare-twins (a b)
8371 "Compare two routine entries, under the assumption that they are
8372 twins. This basically calls `idlwave-routine-twin-compare' with the
8373 correct args."
8374 (let* ((name (car a)) (type (nth 1 a)) (class (nth 2 a)) ; needed outside
8375 (asrc (nth 3 a))
8376 (atype (car asrc))
8377 (bsrc (nth 3 b))
8378 (btype (car bsrc))
8379 (afile (idlwave-routine-source-file asrc))
8380 (bfile (idlwave-routine-source-file bsrc)))
8381 (idlwave-routine-twin-compare
8382 (if (stringp afile)
8383 (list (file-truename afile) afile (list atype))
8384 (list atype afile (list atype)))
8385 (if (stringp bfile)
8386 (list (file-truename bfile) bfile (list btype))
8387 (list btype bfile (list btype))))
8388 ))
8390 (defun idlwave-routine-twin-compare (a b)
8391 "Compare two routine twin entries for sorting.
8392 In here, A and B are not normal routine info entries, but special
8393 lists (KEY FILENAME (TYPES...)).
8394 This expects NAME TYPE CLASS to be bound to the right values."
8395 (let* (;; Dis-assemble entries
8396 (akey (car a)) (bkey (car b))
8397 (afile (nth 1 a)) (bfile (nth 1 b))
8398 (atypes (nth 2 a)) (btypes (nth 2 b))
8399 ;; System routines?
8400 (asysp (memq akey '(builtin system)))
8401 (bsysp (memq bkey '(builtin system)))
8402 ;; Compiled routines?
8403 (acompp (memq 'compiled atypes))
8404 (bcompp (memq 'compiled btypes))
8405 ;; Unresolved?
8406 (aunresp (or (eq akey 'unresolved)
8407 (and acompp (not afile))))
8408 (bunresp (or (eq bkey 'unresolved)
8409 (and bcompp (not bfile))))
8410 ;; Buffer info available?
8411 (abufp (memq 'buffer atypes))
8412 (bbufp (memq 'buffer btypes))
8413 ;; On search path?
8414 (tpath-alist (idlwave-true-path-alist))
8415 (apathp (and (stringp akey)
8416 (assoc (file-name-directory akey) tpath-alist)))
8417 (bpathp (and (stringp bkey)
8418 (assoc (file-name-directory bkey) tpath-alist)))
8419 ;; How early on search path? High number means early since we
8420 ;; measure the tail of the path list
8421 (anpath (length (memq apathp tpath-alist)))
8422 (bnpath (length (memq bpathp tpath-alist)))
8423 ;; Look at file names
8424 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8425 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8427 (regexp-quote (downcase class))
8428 (regexp-quote (downcase name)))
8430 ;; Is file name derived from the routine name?
8431 ;; Method file or class definition file?
8432 (anamep (string-match fname-re aname))
8433 (adefp (and class anamep (string= "define" (match-string 1 aname))))
8434 (bnamep (string-match fname-re bname))
8435 (bdefp (and class bnamep (string= "define" (match-string 1 bname)))))
8437 ;; Now: follow JD's ideas about sorting. Looks really simple now,
8438 ;; doesn't it? The difficult stuff is hidden above...
8439 (cond
8440 ((idlwave-xor asysp bsysp) asysp) ; System entries first
8441 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
8442 ((and idlwave-sort-prefer-buffer-info
8443 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
8444 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
8445 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
8446 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
8447 ((and class anamep bnamep ; both file names match ->
8448 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
8449 ((> anpath bnpath) t) ; Who is first on path?
8450 (t nil)))) ; Default
8452 (defun idlwave-routine-source-file (source)
8453 (if (nth 2 source)
8454 (expand-file-name (nth 1 source) (nth 2 source))
8455 (nth 1 source)))
8457 (defun idlwave-downcase-safe (string)
8458 "Donwcase if string, else return unchanged."
8459 (if (stringp string)
8460 (downcase string)
8461 string))
8463 (defun idlwave-count-eq (elt list)
8464 "How often is ELT in LIST?"
8465 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
8467 (defun idlwave-count-memq (elt alist)
8468 "How often is ELT a key in ALIST?"
8469 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
8471 (defun idlwave-syslib-p (file)
8472 "Non-nil if FILE is in the system library."
8473 (let* ((true-syslib (file-name-as-directory
8474 (file-truename
8475 (expand-file-name "lib" (idlwave-sys-dir)))))
8476 (true-file (file-truename file)))
8477 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
8479 (defun idlwave-lib-p (file)
8480 "Non-nil if file is in the library"
8481 (let ((true-dir (file-name-directory (file-truename file))))
8482 (assoc true-dir (idlwave-true-path-alist))))
8484 (defun idlwave-path-alist-add-flag (list-entry flag)
8485 "Add a flag to the path list entry, if not set."
8486 (let ((flags (cdr list-entry)))
8487 (add-to-list 'flags flag)
8488 (setcdr list-entry flags)))
8490 (defun idlwave-path-alist-remove-flag (list-entry flag)
8491 "Remove a flag to the path list entry, if set."
8492 (let ((flags (delq flag (cdr list-entry))))
8493 (setcdr list-entry flags)))
8495 (defun idlwave-true-path-alist ()
8496 "Return `idlwave-path-alist' alist with true-names.
8497 Info is cached, but relies on the functions setting `idlwave-path-alist'
8498 to reset the variable `idlwave-true-path-alist' to nil."
8499 (or idlwave-true-path-alist
8500 (setq idlwave-true-path-alist
8501 (mapcar (lambda(x) (cons
8502 (file-name-as-directory
8503 (file-truename
8504 (directory-file-name
8505 (car x))))
8506 (cdr x)))
8507 idlwave-path-alist))))
8509 (defun idlwave-syslib-scanned-p ()
8510 "Non-nil if the system lib file !DIR/lib has been scanned."
8511 (let* ((true-syslib (file-name-as-directory
8512 (file-truename
8513 (expand-file-name "lib" (idlwave-sys-dir))))))
8514 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
8516 ;; ----------------------------------------------------------------------------
8517 ;;
8518 ;; Online Help display
8521 ;; ----------------------------------------------------------------------------
8522 ;;
8523 ;; Additions for use with imenu.el and func-menu.el
8524 ;; (pop-up a list of IDL units in the current file).
8525 ;;
8527 (defun idlwave-prev-index-position ()
8528 "Search for the previous procedure or function.
8529 Return nil if not found. For use with imenu.el."
8530 (save-match-data
8531 (cond
8533 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
8534 (t nil))))
8536 (defun idlwave-unit-name ()
8537 "Return the unit name.
8538 Assumes that point is at the beginning of the unit as found by
8539 `idlwave-prev-index-position'."
8540 (forward-sexp 2)
8541 (forward-sexp -1)
8542 (let ((begin (point)))
8543 (re-search-forward
8545 (if (fboundp 'buffer-substring-no-properties)
8546 (buffer-substring-no-properties begin (point))
8547 (buffer-substring begin (point)))))
8549 (defalias 'idlwave-function-menu
8550 (condition-case nil
8551 (progn
8552 (require 'func-menu)
8553 'function-menu)
8554 (error (condition-case nil
8555 (progn
8556 (require 'imenu)
8557 'imenu)
8558 (error nil)))))
8560 ;; Here we hack func-menu.el in order to support this new mode.
8561 ;; The latest versions of func-menu.el already have this stuff in, so
8562 ;; we hack only if it is not already there.
8563 (when (fboundp 'eval-after-load)
8564 (eval-after-load "func-menu"
8565 '(progn
8566 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
8567 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
8568 (setq fume-function-name-regexp-alist
8569 (cons '(idlwave-mode . fume-function-name-regexp-idl)
8570 fume-function-name-regexp-alist)))
8571 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
8572 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
8573 (setq fume-find-function-name-method-alist
8574 (cons '(idlwave-mode . fume-find-next-idl-function-name)
8575 fume-find-function-name-method-alist))))))
8577 (defun idlwave-edit-in-idlde ()
8578 "Edit the current file in IDL Development environment."
8579 (interactive)
8580 (start-process "idldeclient" nil
8581 idlwave-shell-explicit-file-name "-c" "-e"
8582 (buffer-file-name) "&"))
8584 (defun idlwave-launch-idlhelp ()
8585 "Start the IDLhelp application."
8586 (interactive)
8587 (start-process "idlhelp" nil idlwave-help-application))
8589 ;; Menus - using easymenu.el
8590 (defvar idlwave-mode-menu-def
8591 `("IDLWAVE"
8592 ["PRO/FUNC menu" idlwave-function-menu t]
8593 ("Motion"
8594 ["Subprogram Start" idlwave-beginning-of-subprogram t]
8595 ["Subprogram End" idlwave-end-of-subprogram t]
8596 ["Block Start" idlwave-beginning-of-block t]
8597 ["Block End" idlwave-end-of-block t]
8598 ["Up Block" idlwave-backward-up-block t]
8599 ["Down Block" idlwave-down-block t]
8600 ["Skip Block Backward" idlwave-backward-block t]
8601 ["Skip Block Forward" idlwave-forward-block t])
8602 ("Mark"
8603 ["Subprogram" idlwave-mark-subprogram t]
8604 ["Block" idlwave-mark-block t]
8605 ["Header" idlwave-mark-doclib t])
8606 ("Format"
8607 ["Indent Subprogram" idlwave-indent-subprogram t]
8608 ["(Un)Comment Region" idlwave-toggle-comment-region "C-c ;"]
8609 ["Continue/Split line" idlwave-split-line t]
8610 "--"
8611 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
8612 :selected (symbol-value idlwave-fill-function)])
8613 ("Templates"
8614 ["Procedure" idlwave-procedure t]
8615 ["Function" idlwave-function t]
8616 ["Doc Header" idlwave-doc-header t]
8617 ["Log" idlwave-doc-modification t]
8618 "--"
8619 ["Case" idlwave-case t]
8620 ["For" idlwave-for t]
8621 ["Repeat" idlwave-repeat t]
8622 ["While" idlwave-while t]
8623 "--"
8624 ["Close Block" idlwave-close-block t])
8625 ("Completion"
8626 ["Complete" idlwave-complete t]
8627 ("Complete Special"
8628 ["1 Procedure Name" (idlwave-complete 'procedure) t]
8629 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
8630 "--"
8631 ["3 Function Name" (idlwave-complete 'function) t]
8632 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
8633 "--"
8634 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
8635 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
8636 "--"
8637 ["7 Function Method Name" (idlwave-complete 'function-method) t]
8638 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
8639 "--"
8640 ["9 Class Name" idlwave-complete-class t]))
8641 ("Routine Info"
8642 ["Show Routine Info" idlwave-routine-info t]
8643 ["Online Context Help" idlwave-context-help t]
8644 "--"
8645 ["Find Routine Source" idlwave-find-module t]
8646 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
8647 "--"
8648 ["Update Routine Info" idlwave-update-routine-info t]
8649 "--"
8650 "IDL User Catalog"
8651 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
8652 ["Scan Directories" (idlwave-update-routine-info '(16))
8653 (and idlwave-path-alist (not idlwave-catalog-process))]
8654 ["Scan Directories &" (idlwave-update-routine-info '(64))
8655 (and idlwave-path-alist (not idlwave-catalog-process))]
8656 "--"
8657 "Routine Shadows"
8658 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
8659 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
8660 ["Check Everything" idlwave-list-all-load-path-shadows t])
8661 ("Misc"
8662 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
8663 "--"
8664 ["Insert TAB character" idlwave-hard-tab t])
8665 "--"
8666 ("External"
8667 ["Generate IDL tags" idlwave-make-tags t]
8668 ["Start IDL shell" idlwave-shell t]
8669 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
8670 ["Launch IDL Help" idlwave-launch-idlhelp t])
8671 "--"
8672 ("Customize"
8673 ["Browse IDLWAVE Group" idlwave-customize t]
8674 "--"
8675 ["Build Full Customize Menu" idlwave-create-customize-menu
8676 (fboundp 'customize-menu-create)])
8677 ("Documentation"
8678 ["Describe Mode" describe-mode t]
8679 ["Abbreviation List" idlwave-list-abbrevs t]
8680 "--"
8681 ["Commentary in idlwave.el" idlwave-show-commentary t]
8682 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
8683 "--"
8684 ["Info" idlwave-info t]
8685 "--"
8686 ["Launch IDL Help" idlwave-launch-idlhelp t])))
8688 (defvar idlwave-mode-debug-menu-def
8689 '("Debug"
8690 ["Start IDL shell" idlwave-shell t]
8691 ["Save and .RUN buffer" idlwave-shell-save-and-run
8692 (and (boundp 'idlwave-shell-automatic-start)
8693 idlwave-shell-automatic-start)]))
8695 (if (or (featurep 'easymenu) (load "easymenu" t))
8696 (progn
8697 (easy-menu-define idlwave-mode-menu idlwave-mode-map
8698 "IDL and WAVE CL editing menu"
8699 idlwave-mode-menu-def)
8700 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
8701 "IDL and WAVE CL editing menu"
8702 idlwave-mode-debug-menu-def)))
8704 (defun idlwave-customize ()
8705 "Call the customize function with idlwave as argument."
8706 (interactive)
8707 ;; Try to load the code for the shell, so that we can customize it
8708 ;; as well.
8709 (or (featurep 'idlw-shell)
8710 (load "idlw-shell" t))
8711 (customize-browse 'idlwave))
8713 (defun idlwave-create-customize-menu ()
8714 "Create a full customization menu for IDLWAVE, insert it into the menu."
8715 (interactive)
8716 (if (fboundp 'customize-menu-create)
8717 (progn
8718 ;; Try to load the code for the shell, so that we can customize it
8719 ;; as well.
8720 (or (featurep 'idlw-shell)
8721 (load "idlw-shell" t))
8722 (easy-menu-change
8723 '("IDLWAVE") "Customize"
8724 `(["Browse IDLWAVE group" idlwave-customize t]
8725 "--"
8726 ,(customize-menu-create 'idlwave)
8727 ["Set" Custom-set t]
8728 ["Save" Custom-save t]
8729 ["Reset to Current" Custom-reset-current t]
8730 ["Reset to Saved" Custom-reset-saved t]
8731 ["Reset to Standard Settings" Custom-reset-standard t]))
8733 (error "Cannot expand menu (outdated version of cus-edit.el)")))
8735 (defun idlwave-show-commentary ()
8736 "Use the finder to view the file documentation from `idlwave.el'."
8737 (interactive)
8738 (require 'finder)
8739 (finder-commentary "idlwave.el"))
8741 (defun idlwave-shell-show-commentary ()
8742 "Use the finder to view the file documentation from `idlw-shell.el'."
8743 (interactive)
8744 (require 'finder)
8745 (finder-commentary "idlw-shell.el"))
8747 (defun idlwave-info ()
8748 "Read documentation for IDLWAVE in the info system."
8749 (interactive)
8750 (require 'info)
8751 (Info-goto-node "(idlwave)"))
8753 (defun idlwave-list-abbrevs (arg)
8754 "Show the code abbreviations define in IDLWAVE mode.
8755 This lists all abbrevs where the replacement text differs from the input text.
8756 These are the ones the users want to learn to speed up their writing.
8758 The function does *not* list abbrevs which replace a word with itself
8759 to call a hook. These hooks are used to change the case of words or
8760 to blink the matching `begin', and the user does not need to know them.
8762 With arg, list all abbrevs with the corresponding hook.
8764 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
8766 (interactive "P")
8767 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
8768 abbrevs
8769 str rpl func fmt (len-str 0) (len-rpl 0))
8770 (mapatoms
8771 (lambda (sym)
8772 (if (symbol-value sym)
8773 (progn
8774 (setq str (symbol-name sym)
8775 rpl (symbol-value sym)
8776 func (symbol-function sym))
8777 (if arg
8778 (setq func (prin1-to-string func))
8779 (if (and (listp func) (stringp (nth 2 func)))
8780 (setq rpl (concat "EVAL: " (nth 2 func))
8781 func "")
8782 (setq func "")))
8783 (if (or arg (not (string= rpl str)))
8784 (progn
8785 (setq len-str (max len-str (length str)))
8786 (setq len-rpl (max len-rpl (length rpl)))
8787 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
8788 table)
8789 ;; sort the list
8790 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
8791 ;; Make the format
8793 (with-output-to-temp-buffer "*Help*"
8794 (if arg
8795 (progn
8798 (princ (format fmt "KEY" "REPLACE" "HOOK"))
8799 (princ (format fmt "---" "-------" "----")))
8802 (princ (format fmt "KEY" "ACTION" ""))
8803 (princ (format fmt "---" "------" "")))
8804 (mapcar
8805 (lambda (list)
8806 (setq str (car list)
8807 rpl (nth 1 list)
8808 func (nth 2 list))
8809 (princ (format fmt str rpl func)))
8810 abbrevs)))
8811 ;; Make sure each abbreviation uses only one display line
8812 (save-excursion
8813 (set-buffer "*Help*")
8814 (setq truncate-lines t)))
8816 ;; Add .pro files to speedbar for support, if it's loaded
8817 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
8819 ;; Set an idle timer to load the routine info.
8820 ;; Will only work on systems which support this.
8821 (or idlwave-routines (idlwave-start-load-rinfo-timer))
8825 ;; Run the hook
8826 (run-hooks 'idlwave-load-hook)
8828 (provide 'idlwave)
8830 ;; arch-tag: f77f3b0c-c37c-424f-a328-0886fd42b6fb
8831 ;;; idlwave.el ends here