| blob | d29e56ce75daffd39db2251a8fd56715624769de |
1 ;; idlwave.el --- IDL editing mode for GNU Emacs
3 ;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
4 ;; Free Software Foundation, Inc.
6 ;; Authors: J.D. Smith <jdsmith@as.arizona.edu>
7 ;; Carsten Dominik <dominik@science.uva.nl>
8 ;; Chris Chase <chase@att.com>
9 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
10 ;; Version: 6.1_em22
11 ;; Keywords: languages
13 ;; This file is part of GNU Emacs.
15 ;; GNU Emacs is free software; you can redistribute it and/or modify
16 ;; it under the terms of the GNU General Public License as published by
17 ;; the Free Software Foundation; either version 2, or (at your option)
18 ;; any later version.
20 ;; GNU Emacs is distributed in the hope that it will be useful,
21 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
22 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
23 ;; GNU General Public License for more details.
25 ;; You should have received a copy of the GNU General Public License
26 ;; along with GNU Emacs; see the file COPYING. If not, write to the
27 ;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
28 ;; Boston, MA 02110-1301, USA.
30 ;;; Commentary:
32 ;; IDLWAVE enables feature-rich development and interaction with IDL,
33 ;; the Interactive Data Language. It provides a compelling,
34 ;; full-featured alternative to the IDLDE development environment
35 ;; bundled with IDL.
37 ;; In the remotely distant past, based on pascal.el, though bears
38 ;; little resemblance to it now.
39 ;;
40 ;; Incorporates many ideas, such as abbrevs, action routines, and
41 ;; continuation line indenting, from wave.el.
42 ;; wave.el original written by Lubos Pochman, Precision Visuals, Boulder.
43 ;;
44 ;; See the mode description ("C-h m" in idlwave-mode or "C-h f idlwave-mode")
45 ;; for features, key bindings, and info.
46 ;; Also, Info format documentation is available with `M-x idlwave-info'
47 ;;
48 ;; New versions of IDLWAVE, documentation, and more information
49 ;; available from:
50 ;; http://idlwave.org
51 ;;
52 ;; INSTALLATION
53 ;; ============
54 ;;
55 ;; Follow the instructions in the INSTALL file of the distribution.
56 ;; In short, put this file on your load path and add the following
57 ;; lines to your .emacs file:
58 ;;
59 ;; (autoload 'idlwave-mode "idlwave" "IDLWAVE Mode" t)
60 ;; (autoload 'idlwave-shell "idlw-shell" "IDLWAVE Shell" t)
61 ;; (setq auto-mode-alist (cons '("\\.pro\\'" . idlwave-mode) auto-mode-alist))
62 ;;
63 ;;
64 ;; SOURCE
65 ;; ======
66 ;;
67 ;; The newest version of this file is available from the maintainer's
68 ;; Webpage:
69 ;;
70 ;; http://idlwave.org
71 ;;
72 ;; DOCUMENTATION
73 ;; =============
74 ;;
75 ;; IDLWAVE is documented online in info format. A printable version
76 ;; of the documentation is available from the maintainers webpage (see
77 ;; SOURCE).
78 ;;
79 ;;
80 ;; ACKNOWLEDGMENTS
81 ;; ===============
82 ;;
83 ;; Thanks to the following people for their contributions and comments:
84 ;;
85 ;; Ulrik Dickow <dickow_at_nbi.dk>
86 ;; Eric E. Dors <edors_at_lanl.gov>
87 ;; Stein Vidar H. Haugan <s.v.h.haugan_at_astro.uio.no>
88 ;; David Huenemoerder <dph_at_space.mit.edu>
89 ;; Kevin Ivory <Kevin.Ivory_at_linmpi.mpg.de>
90 ;; Dick Jackson <dick_at_d-jackson.com>
91 ;; Xuyong Liu <liu_at_stsci.edu>
92 ;; Simon Marshall <Simon.Marshall_at_esrin.esa.it>
93 ;; Laurent Mugnier <mugnier_at_onera.fr>
94 ;; Lubos Pochman <lubos_at_rsinc.com>
95 ;; Bob Portmann <portmann_at_al.noaa.gov>
96 ;; Patrick M. Ryan <pat_at_jaameri.gsfc.nasa.gov>
97 ;; Marty Ryba <ryba_at_ll.mit.edu>
98 ;; Paul Sorenson <aardvark62_at_msn.com>
99 ;; Phil Sterne <sterne_at_dublin.llnl.gov>
100 ;; Phil Williams <williams_at_irc.chmcc.org>
101 ;;
102 ;; CUSTOMIZATION:
103 ;; =============
104 ;;
105 ;; IDLWAVE has extensive customize support; to learn about the
106 ;; variables which control the mode's behavior, use `M-x
107 ;; idlwave-customize'.
108 ;;
109 ;; You can set your own preferred values with Customize, or with Lisp
110 ;; code in .emacs. For an example of what to put into .emacs, check
111 ;; the TexInfo documentation or see a complete .emacs available at the
112 ;; website.
113 ;;
114 ;; KNOWN PROBLEMS:
115 ;; ==============
116 ;;
117 ;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual
118 ;; Numerics, Inc. is growing less and less complete as the two
119 ;; languages grow increasingly apart. The mode probably shouldn't
120 ;; even have "WAVE" in its title, but it's catchy, and was required
121 ;; to avoid conflict with the CORBA idl.el mode. Caveat WAVEor.
122 ;;
123 ;; Moving the point backwards in conjunction with abbrev expansion
124 ;; does not work as I would like it, but this is a problem with
125 ;; emacs abbrev expansion done by the self-insert-command. It ends
126 ;; up inserting the character that expanded the abbrev after moving
127 ;; point backward, e.g., "\cl" expanded with a space becomes
128 ;; "LONG( )" with point before the close paren. This is solved by
129 ;; using a temporary function in `post-command-hook' - not pretty,
130 ;; but it works.
131 ;;
132 ;; Tabs and spaces are treated equally as whitespace when filling a
133 ;; comment paragraph. To accomplish this, tabs are permanently
134 ;; replaced by spaces in the text surrounding the paragraph, which
135 ;; may be an undesirable side-effect. Replacing tabs with spaces is
136 ;; limited to comments only and occurs only when a comment
137 ;; paragraph is filled via `idlwave-fill-paragraph'.
138 ;;
139 ;; Muti-statement lines (using "&") on block begin and end lines can
140 ;; ruin the formatting. For example, multiple end statements on a
141 ;; line: endif & endif. Using "&" outside of block begin/end lines
142 ;; should be okay.
143 ;;
144 ;; Determining the expression at point for printing and other
145 ;; examination commands is somewhat rough: currently only fairly
146 ;; simple entities are found. You can always drag-select or examine
147 ;; a pre-selected region.
148 ;;
149 ;; When forcing completion of method keywords, the initial
150 ;; query for a method has multiple entries for some methods. Would
151 ;; be too difficult to fix this hardly used case.
152 ;;
153 \f
154 ;;; Code:
160 ;; For XEmacs
176 ;; Kludge to allow `defcustom' for Emacs 19.
179 nil ;; We've got what we needed
180 ;; We have the old or no custom-library, hack around it!
186 "Major mode for editing IDL .pro files."
198 ;;; Variables for indentation behavior ---------------------------------------
201 "Indentation and formatting options for IDLWAVE mode."
205 "*Extra indentation for the main block of code.
206 That is the block between the FUNCTION/PRO statement and the END
207 statement for that program unit."
212 "*Extra indentation applied to block lines.
213 If you change this, you probably also want to change `idlwave-end-offset'."
218 "*Extra indentation applied to block END lines.
219 A value equal to negative `idlwave-block-indent' will make END lines
220 line up with the block BEGIN lines."
225 "*Extra indentation applied to continuation lines.
226 This extra offset applies to the first of a set of continuation lines.
227 The following lines receive the same indentation as the first."
232 "*Maximum additional indentation for special continuation indent.
233 Several special indentations are tried to help line up continuation
234 lines in routine calls or definitions, other statements with
235 parentheses, or assignment statements. This variable specifies a
236 maximum amount by which this special indentation can exceed the
237 standard continuation indentation, otherwise defaulting to a fixed
238 offset. Set to 0 to effectively disable all special continuation
239 indentation, or to a large number (like 100) to enable it in all
240 cases. See also `idlwave-indent-to-open-paren', which can override
241 this variable."
246 "*Non-nil means, indent continuation lines to innermost open
247 parenthesis. This indentation occurs even if otherwise disallowed by
248 `idlwave-max-extra-continuation-indent'. Matching parens and the
249 interleaving args are lined up. Example:
251 x = function_a(function_b(function_c( a, b, [1,2,3, $
252 4,5,6 $
253 ], $
254 c, d $
255 )))
257 When this variable is nil, paren alignment may still occur, based on
258 the value of `max-extra-continuation-indent', which, if zero, would
259 yield:
261 x = function_a(function_b(function_c( a, b, [1,2,3, $
262 4,5,6 $
263 ], $
264 c, d $
265 )))"
270 "*Non-nil means, indent continuation lines with parens by nesting
271 lines at consecutively deeper levels."
277 "*If set non-nil then comment paragraphs are indented under the
278 hanging indent given by `idlwave-hang-indent-regexp' match in the first line
279 of the paragraph."
284 "*Regular expression matching the position of the hanging indent
285 in the first line of a comment paragraph. The size of the indent
286 extends to the end of the match for the regular expression."
291 "*If non-nil then use last match on line for `idlwave-indent-regexp'."
296 "*If non-nil then auto fill will only operate on comment lines."
301 "*If non-nil then auto fill will split strings with the IDL `+' operator.
302 When the line end falls within a string, string concatenation with the
303 '+' operator will be used to distribute a long string over lines.
304 If nil and a string is split then a terminal beep and warning are issued.
306 This variable is ignored when `idlwave-fill-comment-line-only' is
307 non-nil, since in this case code is not auto-filled."
312 "*If non-nil then `idlwave-split-line' will split strings with `+'.
313 When the splitting point of a line falls inside a string, split the string
314 using the `+' string concatenation operator. If nil and a string is
315 split then a terminal beep and warning are issued."
320 "*The indentation of a comment that starts with this regular
321 expression will not be changed. Note that the indentation of a comment
322 at the beginning of a line is never changed."
327 "*A comment anchored at the beginning of line.
328 A comment matching this regular expression will not have its
337 "*A comment that starts with this regular expression on a line by
338 itself is indented as if it is a part of IDL code. As a result if
339 the comment is not preceded by whitespace it is unchanged."
343 ;; Comments not matching any of the above will be indented as a
344 ;; right-margin comment, i.e., to a minimum of `comment-column'.
346 ;;; Routine Info and Completion ---------------------------------------
349 "Routine Info options for IDLWAVE mode."
353 "*Non-nil means search the IDL path for library catalog files.
355 These files, named .idlwave_catalog, document routine information for
356 individual directories and libraries of IDL .pro files. Many popular
357 libraries come with catalog files by default, so leaving this on is a
358 usually a good idea.."
363 "*Seconds of idle time before routine info is automatically
364 initialized. Initializing the routine info can take a long time, in
365 particular if a large number of library catalogs are involved. When
366 Emacs is idle for more than the number of seconds specified by this
367 variable, it starts the initialization. The process is split into
368 five steps, in order to keep work interruption as short as possible.
369 If one of the steps finishes, and no user input has arrived in the
370 mean time, initialization proceeds immediately to the next step. A
371 good value for this variable is about 1/3 of the time initialization
372 take in your setup. So if you have a fast machine and no problems
373 with a slow network connection, don't hesitate to set this to 2
374 seconds. A Value of 0 means, don't initialize automatically, but
375 instead wait until routine information is needed, and initialize
376 then."
381 "*Non-nil means, scan buffers for IDL programs when updating info.
382 The scanning is done by the command `idlwave-update-routine-info'.
383 The following values are allowed:
385 nil Don't scan any buffers.
386 t Scan all idlwave-mode buffers in the current editing session.
387 current Scan only the current buffer, but no other buffers."
395 "*Non-nil means query the shell for info about compiled routines.
396 Querying the shell is useful to get information about compiled modules,
397 and it is turned on by default. However, when you have a complete library
398 scan, this is not necessary."
404 "*Controls under what circumstances routine info is updated automatically.
405 Possible values:
406 nil Never
407 t All available
408 \(...) A list of circumstances. Allowed members are:
409 find-file Add info for new IDLWAVE buffers.
410 save-buffer Update buffer info when buffer is saved
411 kill-buffer Remove buffer info when buffer gets killed
412 compile-buffer Update shell info after `idlwave-shell-save-and...'"
424 "*Maximum number of source files displayed in the Routine Info window.
425 When an integer, it is the maximum number of source files displayed.
426 t means to show all source files."
431 "Library path for Windows and MacOS (OS9). Not needed under UNIX.
432 When selecting the directories to scan for IDL user catalog routine
433 info, IDLWAVE can, under UNIX, query the shell for the exact search
434 path \(the value of !PATH). However, under Windows and MacOS
435 \(pre-OSX), the IDLWAVE shell does not work. In this case, this
436 variable can be set to specify the paths where IDLWAVE can find PRO
437 files. The shell will only be asked for a list of paths when this
438 variable is nil. The value is a list of directories. A directory
439 preceeded by a `+' will be searched recursively. If you set this
440 variable on a UNIX system, the shell will not be queried. See also
441 `idlwave-system-directory'."
446 "The IDL system directory for Windows and MacOS. Not needed under
447 UNIX. Set this to the value of the `!DIR' system variable in IDL.
448 IDLWAVE uses this to find out which of the library routines belong to
449 the official system library. All files inside the `lib' subdirectory
450 are considered system library files - so don't install private stuff
451 in this directory. On UNIX systems, IDLWAVE queries the shell for the
452 value of `!DIR'. See also `idlwave-library-path'."
456 ;; Configuration files
459 "*Directory for configuration files and user-library catalog."
471 "Alist of regular expressions matching special library directories.
472 When listing routine source locations, IDLWAVE gives a short hint where
473 the file defining the routine is located. By default it lists `SystemLib'
474 for routines in the system library `!DIR/lib' and `Library' for anything
475 else. This variable can define additional types. The car of each entry
476 is a regular expression matching the file name (they normally will match
477 on the path). The cdr is the string to be used as identifier. Max 10
478 chars are allowed."
484 "Write out path (!PATH) and system directory (!DIR) info automatically.
485 Path info is needed to locate library catalog files. If non-nil,
486 whenever the path-list changes as a result of shell-query, etc., it is
488 used to force a write."
493 "Completion options for IDLWAVE mode."
510 "Association list setting the case of completed words.
512 This variable determines the case (UPPER/lower/Capitalized...) of
513 words inserted into the buffer by completion. The preferred case can
514 be specified separately for routine names, keywords, classes and
515 methods.
516 This alist should therefore have entries for `routine' (normal
517 functions and procedures, i.e. non-methods), `keyword', `class', and
518 `method'. Plausible values are
520 upcase upcase whole word, like `BOX_CURSOR'
521 downcase downcase whole word, like `read_ppm'
522 capitalize capitalize each part, like `Widget_Control'
523 preserve preserve case as is, like `IDLgrView'
525 The value can also be any Emacs Lisp function which transforms the
526 case of characters in a string.
528 A value of `preserve' means that the case of the completed word is
529 identical to the way it was written in the definition statement of the
530 routine. This was implemented to allow for mixed-case completion, in
531 particular of object classes and methods.
532 If a completable word is defined in multiple locations, the meaning of
533 `preserve' is not unique since the different definitions might be
534 cased differently. Therefore IDLWAVE always takes the case of the
535 *first* definition it encounters during routine info collection and
536 uses the case derived from it consistently.
538 Note that a lowercase-only string in the buffer will always be completed in
539 lower case (but see the variable `idlwave-completion-force-default-case').
541 After changing this variable, you need to either restart Emacs or press
542 `C-u C-c C-i' to update the internal lists."
549 "*Non-nil means, completion will always honor `idlwave-completion-case'.
550 When nil, only the completion of a mixed case or upper case string
551 will honor the default settings in `idlwave-completion-case', while
552 the completion of lower case strings will be completed entirely in
553 lower case."
558 "*Non-nil means, the empty string is considered downcase for completion.
559 The case of what is already in the buffer determines the case of completions.
560 When this variable is non-nil, the empty string is considered to be downcase.
561 Completing on the empty string then offers downcase versions of the possible
562 completions."
567 "Obsolete variable. See `idlwave-complete-empty-string-as-lower-case' and
571 "*Non-nil means, the case of tokens in buffers dominates over system stuff.
572 To make this possible, we need to re-case everything each time we update
573 the routine info from the buffers. This is slow.
574 The default is to consider the case given in the system and library files
575 first which makes updating much faster."
580 "*Non-nil means, highlight completions for which system help is available.
581 Help can then be accessed with mouse-3.
582 This option is only effective when the online help system is installed."
587 "Non-nil means, treat inheritance with completion, online help etc.
588 When nil, IDLWAVE only knows about the native methods and tags of a class,
589 not about inherited ones."
594 "List of regular expressions for class-driven keyword inheritance.
596 up the class tree. While it cannot be assumed that the presence of an
597 _EXTRA or _REF_EXTRA symbol guarantees such chaining will occur, for
598 certain methods this assumption is almost always true. The methods
599 for which to assume this can be set here."
605 "*Number of classes to show when completing object methods and keywords.
606 When completing methods or keywords for an object with unknown class,
607 the *Completions* buffer will show the valid classes for each completion
608 like this:
610 MyMethod <Class1,Class2,Class3>
612 The value of this variable may be nil to inhibit display, or an integer to
613 indicate the maximum number of classes to display.
615 On XEmacs, a full list of classes will also be placed into a `help-echo'
616 property on the competion items, so that the list of classes for the current
617 item is displayed in the echo area. If the value of this variable is a
618 negative integer, the `help-echo' property will be suppressed."
624 "*Non-nil means, fontify the classes in completions buffer.
625 This makes it easier to distinguish the completion items from the extra
626 class info listed. See `idlwave-completion-show-classes'."
632 "Association list governing specification of object classes for completion.
634 When IDLWAVE tries to complete object-oriented methods, it usually
635 cannot determine the class of a given object from context. In order
636 to provide the user with a correct list of methods or keywords, it
637 needs to determine the appropriate class. IDLWAVE has two ways of
638 doing this (well, three ways if you count the shell... see
639 `idlwave-shell-query-for-class'):
641 1. Combine the items of all available classes which contain this
642 method for the purpose of completion. So when completing a method,
643 all methods of all known classes are available, and when completing
644 a keyword, all keywords allowed for this method in any class are
645 shown. This behavior is very much like normal completion and is
646 therefore the default. It works much better than one might think -
647 only for the INIT, GETPROPERTY and SETPROPERTY the keyword lists
648 become uncomfortably long. See also
649 `idlwave-completion-show-classes'.
651 2. The second possibility is to ask the user on each occasion. To
652 make this less interruptive, IDLWAVE can store the class as a text
653 property on the object operator `->'. For a given object in the
654 source code, class selection will then be needed only once
655 - for example to complete the method. Keywords to the method can
656 then be completed directly, because the class is already known.
657 You will have to turn on the storage of the selected class
658 explicitly with the variable `idlwave-store-inquired-class'.
660 This variable allows you to configure IDLWAVE's method and
661 method-keyword completion behavior. Its value is an alist, which
662 should contain at least two elements: (method-default . VALUE) and
663 \(keyword-default . VALUE), where VALUE is either t or nil. These
664 specify if the class should be found during method and keyword
665 completion, respectively.
667 The alist may have additional entries specifying exceptions from the
668 keyword completion rule for specific methods, like INIT or
669 GETPROPERTY. In order to turn on class specification for the INIT
679 :inline t
684 "*Non-nil means, store class of a method call as text property on `->'.
685 IDLWAVE sometimes has to ask the user for the class associated with a
686 particular object method call. This happens during the commands
687 `idlwave-routine-info' and `idlwave-complete', depending upon the
688 value of the variable `idlwave-query-class'.
690 When you specify a class, this information can be stored as a text
691 property on the `->' arrow in the source code, so that during the same
692 editing session, IDLWAVE will not have to ask again. When this
693 variable is non-nil, IDLWAVE will store and reuse the class information.
695 on the arrow.
697 The default of this variable is nil, since the result of commands then
698 is more predictable. However, if you know what you are doing, it can
699 be nice to turn this on.
701 An arrow which knows the class will be highlighted with
703 displays (with prefix arg: deletes) the class stored on the arrow
704 at point."
709 "*Face to highlight object operator arrows `->' which carry a class property.
710 When IDLWAVE stores a class name as text property on an object arrow
711 \(see variable `idlwave-store-inquired-class', it highlights the arrow
712 with this font in order to remind the user that this arrow is special."
717 "*Non-nil means, resize the Routine-info *Help* window to fit the content."
722 "*Non-nil means, completion automatically adds `=' after completed keywords."
727 "*Non-nil means, completion automatically adds `(' after completed function.
728 nil means, don't add anything.
729 A value of `2' means, also add the closing parenthesis and position cursor
730 between the two."
737 "*Non-nil means, try to restore the window configuration after completion.
738 When completion is not unique, Emacs displays a list of completions.
739 This messes up your window configuration. With this variable set, IDLWAVE
740 restores the old configuration after successful completion."
744 ;;; Variables for abbrev and action behavior -----------------------------
747 "IDLWAVE performs actions when expanding abbreviations or indenting lines.
748 The variables in this group govern this."
752 "*Non-nil means performs actions when indenting.
753 The actions that can be performed are listed in `idlwave-indent-action-table'."
758 "*A single character string used to start abbreviations in abbrev mode.
759 Possible characters to chose from: ~`\%
760 or even '?'. '.' is not a good choice because it can make structure
761 field names act like abbrevs in certain circumstances.
763 Changes to this in `idlwave-mode-hook' will have no effect. Instead a user
764 must set it directly using `setq' in the .emacs file before idlwave.el
765 is loaded."
770 "*Non-nil means, enable `idlwave-surround'.
771 If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
772 `idlwave-surround'.
773 See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
775 Also see the default key bindings for keys using `idlwave-surround'.
776 Keys are bound and made into actions calling `idlwave-surround' with
777 `idlwave-action-and-binding'.
778 See help for `idlwave-action-and-binding' for examples.
780 Also see help for `idlwave-surround'."
785 "*Non-nil means pad '=' in keywords (routine calls or defs) like assignment.
786 Whenever `idlwave-surround' is non-nil then this affects how '=' is
787 padded for keywords and for variables. If t, pad the same as for
788 assignments. If nil then spaces are removed. With any other value,
789 spaces are left unchanged."
797 "*Non-nil means point blinks to block beginning for `idlwave-show-begin'."
802 "*Non-nil means expand generic END to ENDIF/ENDELSE/ENDWHILE etc."
807 "*Non-nil means re-indent line after END was typed."
812 "*Non-nil means the abbrev hook can move point.
813 Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
814 definitions, use the command `list-abbrevs', for abbrevs that move
815 point. Moving point is useful, for example, to place point between
816 parentheses of expanded functions.
818 See `idlwave-check-abbrev'."
823 "*Non-nil means all abbrevs will be forced to either upper or lower case.
824 If the value t, all expanded abbrevs will be upper case.
825 If the value is 'down then abbrevs will be forced to lower case.
826 If nil, the case will not change.
827 If `idlwave-reserved-word-upcase' is non-nil, reserved words will always be
828 upper case, regardless of this variable."
833 "*Non-nil means, reserved words will be made upper case via abbrev expansion.
834 If nil case of reserved words is controlled by `idlwave-abbrev-change-case'.
835 Has effect only if in abbrev-mode."
839 ;;; Action/Expand Tables.
840 ;;
841 ;; The average user may have difficulty modifying this directly. It
842 ;; can be modified/set in idlwave-mode-hook, but it is easier to use
843 ;; idlwave-action-and-binding. See help for idlwave-action-and-binding for
844 ;; examples of how to add an action.
845 ;;
846 ;; The action table is used by `idlwave-indent-line' whereas both the
847 ;; action and expand tables are used by `idlwave-indent-and-action'. In
848 ;; general, the expand table is only used when a line is explicitly
849 ;; indented. Whereas, in addition to being used when the expand table
850 ;; is used, the action table is used when a line is indirectly
851 ;; indented via line splitting, auto-filling or a new line creation.
852 ;;
853 ;; Example actions:
854 ;;
855 ;; Capitalize system vars
856 ;; (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)
857 ;;
858 ;; Capitalize procedure name
859 ;; (idlwave-action-and-binding "\\<\\(pro\\|function\\)\\>[ \t]*\\<"
860 ;; '(capitalize-word 1) t)
861 ;;
862 ;; Capitalize common block name
863 ;; (idlwave-action-and-binding "\\<common\\>[ \t]+\\<"
864 ;; '(capitalize-word 1) t)
865 ;; Capitalize label
866 ;; (idlwave-action-and-binding (concat "^[ \t]*" idlwave-label)
867 ;; '(capitalize-word -1) t)
870 "*Associated array containing action lists of search string (car),
871 and function as a cdr. This table is used by `idlwave-indent-line'.
872 See documentation for `idlwave-do-action' for a complete description of
873 the action lists.
875 Additions to the table are made with `idlwave-action-and-binding' when a
876 binding is not requested.
880 "*Associated array containing action lists of search string (car),
881 and function as a cdr. The table is used by the
882 `idlwave-indent-and-action' function. See documentation for
883 `idlwave-do-action' for a complete description of the action lists.
885 Additions to the table are made with `idlwave-action-and-binding' when a
886 binding is requested.
889 ;;; Documentation header and history keyword ---------------------------------
892 "Options for documenting IDLWAVE files."
895 ;; FIXME: make defcustom?
898 ";+
899 ; NAME:
900 ;
901 ;
902 ;
903 ; PURPOSE:
904 ;
905 ;
906 ;
907 ; CATEGORY:
908 ;
909 ;
910 ;
911 ; CALLING SEQUENCE:
912 ;
913 ;
914 ;
915 ; INPUTS:
916 ;
917 ;
918 ;
919 ; OPTIONAL INPUTS:
920 ;
921 ;
922 ;
923 ; KEYWORD PARAMETERS:
924 ;
925 ;
926 ;
927 ; OUTPUTS:
928 ;
929 ;
930 ;
931 ; OPTIONAL OUTPUTS:
932 ;
933 ;
934 ;
935 ; COMMON BLOCKS:
936 ;
937 ;
938 ;
939 ; SIDE EFFECTS:
940 ;
941 ;
942 ;
943 ; RESTRICTIONS:
944 ;
945 ;
946 ;
947 ; PROCEDURE:
948 ;
949 ;
950 ;
951 ; EXAMPLE:
952 ;
953 ;
954 ;
955 ; MODIFICATION HISTORY:
956 ;
957 ;-
959 "*A list (PATHNAME STRING) specifying the doc-header template to use for
960 summarizing a file. If PATHNAME is non-nil then this file will be included.
961 Otherwise STRING is used. If nil, the file summary will be omitted.
962 For example you might set PATHNAME to the path for the
966 "*Non-nil means, the documentation header will always be at start of file.
967 When nil, the header is positioned between the PRO/FUNCTION line of
968 the current routine and the code, allowing several routine headers in
969 a file."
974 "*The hook function used to update the timestamp of a function."
979 "*The modifications keyword to use with the log documentation commands.
980 A ':' is added to the keyword end.
981 Inserted by doc-header and used to position logs by doc-modification.
982 If nil it will not be inserted."
987 "*Regexp matching the start of a document library header."
992 "*Regexp matching the end of a document library header."
996 ;;; External Programs -------------------------------------------------------
999 "Path locations of external commands used by IDLWAVE."
1003 "*If non-nil, this is the command to run IDL.
1004 Should be an absolute file path or path relative to the current environment
1005 execution search path. If you want to specify command line switches
1006 for the idl program, use `idlwave-shell-command-line-options'.
1008 I know the name of this variable is badly chosen, but I cannot change
1009 it without compromizing backwards-compatibility."
1014 "*A list of command line options for calling the IDL program.
1015 Since IDL is executed directly without going through a shell like /bin/sh,
1017 string for each argument. But you may also give a single string which
1018 contains the options whitespace-separated. Emacs will be kind enough to
1019 split it for you."
1021 string
1026 "*The external application providing reference help for programming.
1027 Obsolete, if the IDL Assistant is being used for help."
1031 ;;; Some Shell variables which must be defined here.-----------------------
1034 "List of modifiers to be used for the debugging commands.
1035 Will be used to bind debugging commands in the shell buffer and in all
1036 source buffers. These are additional convenience bindings, the debugging
1037 commands are always available with the `C-c C-d' prefix.
1038 If you set this to '(control shift), this means setting a breakpoint will
1039 be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
1040 are `control', `meta', `super', `hyper', `alt', and `shift'."
1051 "*If non-nil attempt invoke idlwave-shell if not already running.
1052 This is checked when an attempt to send a command to an
1053 IDL process is made."
1057 ;;; Miscellaneous variables -------------------------------------------------
1060 "Miscellaneous options for IDLWAVE mode."
1065 "*Non-nil displays a startup message when `idlwave-mode' is first called."
1071 common-blocks class-arrows)
1072 "Items which should be fontified on the default fontification level 2.
1073 IDLWAVE defines 3 levels of fontification. Level 1 is very little, level 3
1074 is everything and level 2 is specified by this list.
1075 This variable must be set before IDLWAVE gets loaded. It is
1076 a list of symbols, the following symbols are allowed.
1078 pros-and-functions Procedure and Function definitions
1079 batch-files Batch Files
1080 idlwave-idl-keywords IDL Keywords
1081 label Statement Labels
1082 goto Goto Statements
1083 common-blocks Common Blocks
1084 keyword-parameters Keyword Parameters in routine definitions and calls
1085 system-variables System Variables
1086 fixme FIXME: Warning in comments (on XEmacs only v. 21.0 and up)
1087 class-arrows Object Arrows with class property"
1105 "Normal hook. Executed when a buffer is put into `idlwave-mode'."
1110 "Normal hook. Executed when idlwave.el is loaded."
1115 "Non-nil means turn on a few experimental features.
1116 This variable is only for the maintainer, to test difficult stuff,
1117 while still distributing stable releases.
1120 ;;;
1121 ;;; End customization variables section
1122 ;;;
1124 ;;; Non customization variables
1126 ;;; font-lock mode - Additions by Phil Williams, Ulrik Dickow and
1127 ;;; Simon Marshall <simon_at_gnu.ai.mit.edu>
1128 ;;; and Carsten Dominik...
1130 ;; The following are the reserved words in IDL. Maybe we should
1131 ;; highlight some more stuff as well?
1132 ;; Procedure declarations. Fontify keyword plus procedure name.
1134 ;; To update this regexp, update the list of keywords and
1135 ;; evaluate the form.
1136 ;; (insert
1137 ;; (prin1-to-string
1138 ;; (concat
1139 ;; "\\<\\("
1140 ;; (regexp-opt
1141 ;; '("||" "&&" "and" "or" "xor" "not"
1142 ;; "eq" "ge" "gt" "le" "lt" "ne"
1143 ;; "for" "do" "endfor"
1144 ;; "if" "then" "endif" "else" "endelse"
1145 ;; "case" "of" "endcase"
1146 ;; "switch" "break" "continue" "endswitch"
1147 ;; "begin" "end"
1148 ;; "repeat" "until" "endrep"
1149 ;; "while" "endwhile"
1150 ;; "goto" "return"
1151 ;; "inherits" "mod"
1152 ;; "compile_opt" "forward_function"
1153 ;; "on_error" "on_ioerror")) ; on_error is not officially reserved
1154 ;; "\\)\\>")))
1155 "\\<\\(&&\\|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\\|||\\)\\>")
1159 ;; Function declarations. Fontify keyword plus function name.
1165 ;; Common blocks
1171 ;; Start with point after block name and comma
1173 nil
1175 )))
1177 ;; Batch files
1181 ;; FIXME warning.
1185 ;; Labels
1189 ;; The goto statement and its label
1195 ;; Tags in structure definitions. Note that this definition
1196 ;; actually collides with labels, so we have to use the same
1197 ;; face. It also matches named subscript ranges,
1198 ;; e.g. vec{bottom:top]. No good way around this.
1202 ;; Structure names
1207 ;; Keyword parameters, like /xlog or ,xrange=[]
1208 ;; This is anchored to the comma preceeding the keyword.
1209 ;; Treats continuation lines, works only during whole buffer
1210 ;; fontification. Slow, use it only in fancy fontification.
1212 '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\([ \t]*\\(;.*\\)?\n\\)*[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
1215 ;; System variables start with a bang.
1220 ;; Special and unusual operators (not used because too noisy)
1224 ;; All operators (not used because too noisy)
1228 ;; Arrows with text property `idlwave-class'
1242 batch-files
1243 idlwave-idl-keywords
1244 label goto
1245 structtag
1246 structname
1247 common-blocks
1248 keyword-parameters
1249 system-variables
1250 class-arrows)
1254 ;; Match an object arrow with class property
1264 idlwave-font-lock-keywords-1
1265 idlwave-font-lock-keywords-2
1266 idlwave-font-lock-keywords-3)
1267 nil t
1269 beginning-of-line))
1275 "Regexp to match the start of a full-line comment.
1276 That is the _beginning_ of a line containing a comment delimiter `;' preceded
1281 "Regular expression to find the beginning of a block. The case does
1285 "Regular expression to find the beginning of a unit. The case does
1289 "Regular expression to find the line that indicates the end of unit.
1290 This line is the end of buffer or the start of another unit. The case does
1298 "Regular expression to find the end of a block. The case does
1311 "Matches between statements and the corresponding END variant.
1312 The cars are the reserved words starting a block. If the block really
1313 begins with BEGIN, the cars are the reserved words before the begin
1314 which can be used to identify the block type.
1315 This is used to check for the correct END type, to close blocks and
1320 "Regular expression matching reserved words which can stand before
1321 blocks starting with a BEGIN statement. The matches must have associations
1338 ))
1342 ;; "endif else" is the only possible "end" that can be
1343 ;; followed by a statement on the same line.
1345 ;; all other "end"s can not be followed by a statement.
1358 idlwave-identifier
1362 idlwave-identifier
1367 "Associated list of statement matching regular expressions.
1368 Each regular expression matches the start of an IDL statement. The
1369 first element of each association is a symbol giving the statement
1370 type. The associated value is a list. The first element of this list
1371 is a regular expression matching the start of an IDL statement for
1372 identifying the statement type. The second element of this list is a
1373 regular expression for finding a substatement for the type. The
1374 substatement starts after the end of the found match modulo
1375 whitespace. If it is nil then the statement has no substatement. The
1376 list order matters since matching an assignment statement exactly is
1377 not possible without parsing. Thus assignment statement become just
1386 ;; Note that this is documented in the v18 manuals as being a string
1387 ;; of length one rather than a single character.
1388 ;; The code in this file accepts either format for compatibility.
1390 "Character to be inserted for IDL comment indentation.
1394 "Character which is inserted as a last character on previous line by
1400 "Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
1404 ;; If I take the time I can replace idlwave-keyword-abbrev with
1405 ;; idlwave-code-abbrev and remove the quoted abbrev check from
1406 ;; idlwave-check-abbrev. Then, e.g, (idlwave-keyword-abbrev 0 t) becomes
1407 ;; (idlwave-code-abbrev idlwave-check-abbrev 0 t). In fact I should change
1408 ;; the name of idlwave-check-abbrev to something like idlwave-modify-abbrev.
1411 "Creates a function for abbrev hooks that ensures abbrevs are not quoted.
1412 Specifically, if the abbrev is in a comment or string it is unexpanded.
1413 Otherwise ARGS forms a list that is evaluated."
1458 "Execute BODY with a different syntax table."
1466 ;(defmacro idlwave-with-special-syntax1 (&rest body)
1467 ; "Execute BODY with a different syntax table."
1468 ; `(let ((saved-syntax (syntax-table)))
1469 ; (unwind-protect
1470 ; (progn
1471 ; (set-syntax-table idlwave-find-symbol-syntax-table)
1472 ; ,@body)
1473 ; (set-syntax-table saved-syntax))))
1476 "KEY and CMD are made into a key binding and an indent action.
1477 KEY is a string - same as for the `define-key' function. CMD is a
1478 function of no arguments or a list to be evaluated. CMD is bound to
1479 KEY in `idlwave-mode-map' by defining an anonymous function calling
1480 `self-insert-command' followed by CMD. If KEY contains more than one
1481 character a binding will only be set if SELECT is 'both.
1483 \(KEY . CMD\) is also placed in the `idlwave-indent-expand-table',
1484 replacing any previous value for KEY. If a binding is not set then it
1485 will instead be placed in `idlwave-indent-action-table'.
1487 If the optional argument SELECT is nil then an action and binding are
1488 created. If SELECT is 'noaction, then a binding is always set and no
1489 action is created. If SELECT is 'both then an action and binding
1490 will both be created even if KEY contains more than one character.
1491 Otherwise, if SELECT is non-nil then only an action is created.
1493 Some examples:
1494 No spaces before and 1 after a comma
1496 A minimum of 1 space before and after `=' (see `idlwave-expand-equal').
1498 Capitalize system variables - action only
1499 (idlwave-action-and-binding idlwave-sysvar '(capitalize-word 1) t)"
1501 ;; Add action
1507 ;; Replace action command
1509 ;; New action
1511 ;; Make key binding for action
1520 cmd
1527 ;(define-key idlwave-mode-map "\C-c\C- " 'idlwave-hard-tab)
1546 ;; (define-key idlwave-mode-map "\r" 'idlwave-newline)
1547 ;; (define-key idlwave-mode-map "\t" 'idlwave-indent-line)
1559 ;; Bind the debug commands also with the special modifiers.
1576 ;; (define-key idlwave-mode-map "\C-c\C-f" 'idlwave-function)
1577 ;; (define-key idlwave-mode-map "\C-c\C-p" 'idlwave-procedure)
1601 ;; Pickup both forms of Esc/Meta binding
1611 ;; Set action and key bindings.
1612 ;; See description of the function `idlwave-action-and-binding'.
1613 ;; Automatically add spaces for the following characters
1615 ;; Actions for & are complicated by &&
1618 ;; Automatically add spaces to equal sign if not keyword. This needs
1619 ;; to go ahead of > and <, so >= and <= will be treated correctly
1622 ;; Actions for > and < are complicated by >=, <=, and ->...
1629 ;;;
1630 ;;; Abbrev Section
1631 ;;;
1632 ;;; When expanding abbrevs and the abbrev hook moves backward, an extra
1633 ;;; space is inserted (this is the space typed by the user to expanded
1634 ;;; the abbrev).
1635 ;;;
1641 "Define-abbrev with backward compatibility.
1643 If NOPREFIX is non-nil, don't prepend prefix character. Installs into
1644 idlwave-mode-abbrev-table unless TABLE is non-nil."
1648 expansion
1649 hook)))
1659 ;;
1660 ;; Templates
1661 ;;
1671 ;;
1672 ;; Keywords, system functions, conversion routines
1673 ;;
1731 ;; This section is reserved words only. (From IDL user manual)
1732 ;;
1778 ;; defined later - so just make the compiler hush
1782 ;;;###autoload
1784 "Major mode for editing IDL source files (version 6.1_em22).
1786 The main features of this mode are
1788 1. Indentation and Formatting
1789 --------------------------
1790 Like other Emacs programming modes, C-j inserts a newline and indents.
1791 TAB is used for explicit indentation of the current line.
1794 function can also be used in the middle of a line to split the line
1795 at that point. When used inside a long constant string, the string
1796 is split at that point with the `+' concatenation operator.
1798 Comments are indented as follows:
1800 `;;;' Indentation remains unchanged.
1801 `;;' Indent like the surrounding code
1802 `;' Indent to a minimum column.
1804 The indentation of comments starting in column 0 is never changed.
1807 comment. The indentation of the second line of the paragraph
1808 relative to the first will be retained. Use
1810 comments. When the variable `idlwave-fill-comment-line-only' is
1811 nil, code can also be auto-filled and auto-indented.
1813 To convert pre-existing IDL code to your formatting style, mark the
1818 2. Routine Info
1819 ------------
1820 IDLWAVE displays information about the calling sequence and the
1821 accepted keyword parameters of a procedure or function with
1823 source file of a module. These commands know about system
1824 routines, all routines in idlwave-mode buffers and (when the
1825 idlwave-shell is active) about all modules currently compiled under
1826 this shell. It also makes use of pre-compiled or custom-scanned
1827 user and library catalogs many popular libraries ship with by
1829 information, which is also used for completion (see item 4).
1831 3. Online IDL Help
1832 ---------------
1835 for the system variable, keyword, or routines at point. A single
1836 key stroke gets you directly to the right place in the docs. See
1837 the manual to configure where and how the HTML help is displayed.
1839 4. Completion
1840 ----------
1842 class names, keyword parameters, system variables and tags, class
1843 tags, structure tags, filenames and much more. It is context
1844 sensitive and figures out what is expected at point. Lower case
1845 strings are completed in lower case, other strings in mixed or
1846 upper case.
1848 5. Code Templates and Abbreviations
1849 --------------------------------
1850 Many Abbreviations are predefined to expand to code fragments and templates.
1865 have direct keybindings - see the list of keybindings below.
1868 beginning of the current program unit (pro, function or main).
1869 Change log entries can be added to the current program unit with
1872 6. Automatic Case Conversion
1873 -------------------------
1874 The case of reserved words and some abbrevs is controlled by
1875 `idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
1877 7. Automatic END completion
1878 ------------------------
1879 If the variable `idlwave-expand-generic-end' is non-nil, each END typed
1880 will be converted to the specific version, like ENDIF, ENDFOR, etc.
1882 8. Hooks
1883 -----
1884 Loading idlwave.el runs `idlwave-load-hook'.
1885 Turning on `idlwave-mode' runs `idlwave-mode-hook'.
1887 9. Documentation and Customization
1888 -------------------------------
1889 Info documentation for this package is available. Use
1891 not work). For Postscript, PDF, and HTML versions of the
1892 documentation, check IDLWAVE's homepage at `http://idlwave.org'.
1893 IDLWAVE has customize support - see the group `idlwave'.
1895 10.Keybindings
1896 -----------
1897 Here is a list of all keybindings of this mode.
1899 followed by the key sequence to see what the key sequence does.
1945 ;; ChangeLog
1949 ;; Set tag table list to use IDLTAGS as file name.
1953 ;; Font-lock additions
1954 ;; Following line is for Emacs - XEmacs uses the corresponding property
1955 ;; on the `idlwave-mode' symbol.
1962 ;; Imenu setup
1970 ;; HideShow setup
1973 idlwave-begin-block-reg
1974 idlwave-end-block-reg
1975 ";"
1978 ;; Make a local post-command-hook and add our hook to it
1979 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1980 ;; (make-local-hook 'post-command-hook)
1983 ;; Make local hooks for buffer updates
1984 ;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
1985 ;; (make-local-hook 'kill-buffer-hook)
1987 ;; (make-local-hook 'after-save-hook)
1991 ;; Setup directories and file, if necessary
1994 ;; Update the routine info with info about current buffer?
1997 ;; Check help location
2000 ;; Run the mode hook
2010 idlwave-user-catalog-file
2011 idlwave-config-directory)
2012 idlwave-xml-system-rinfo-converted-file
2014 idlwave-xml-system-rinfo-converted-file
2015 idlwave-config-directory)
2017 idlwave-path-file
2018 idlwave-config-directory))
2023 "Fontify continuation lines correctly."
2034 ;;
2035 ;; Code Formatting ----------------------------------------------------
2036 ;;
2039 "Inserts TAB in buffer in current position."
2043 ;;; This stuff is experimental
2046 "If non-nil, a list that can be evaluated using `eval'.
2047 It is evaluated in the lisp function `idlwave-command-hook' which is
2051 "Command run after every command.
2052 Evaluates a non-nil value of the *variable* `idlwave-command-hook' and
2053 sets the variable to zero afterwards."
2061 ;;; End experiment
2063 ;; It would be better to use expand.el for better abbrev handling and
2064 ;; versatility.
2067 "Reverses abbrev expansion if in comment or string.
2068 Argument ARG is the number of characters to move point
2069 backward if `idlwave-abbrev-move' is non-nil.
2070 If optional argument RESERVED is non-nil then the expansion
2071 consists of reserved words, which will be capitalized if
2072 `idlwave-reserved-word-upcase' is non-nil.
2073 Otherwise, the abbrev will be capitalized if `idlwave-abbrev-change-case'
2074 is non-nil, unless its value is \`down in which case the abbrev will be
2075 made into all lowercase.
2076 Returns non-nil if abbrev is left expanded."
2079 nil)
2091 t))
2094 "Returns t if point is inside a comment, nil otherwise."
2100 "Move to start of comment delimiter on current line.
2101 Moves to end of line if there is no comment delimiter.
2102 Ignores comment delimiters in strings.
2103 Returns point if comment found and nil otherwise."
2106 found)
2107 ;; Look for first comment delimiter not in a string
2122 "Is transient-mark-mode on and the region active?
2123 Works on both Emacs and XEmacs."
2129 "Insert quote and show matching quote if this is end of a string."
2140 ;; Not the end of a string
2144 "Ensure that the previous word was a token before `idlwave-show-begin'.
2145 An END token must be preceded by whitespace."
2155 "Finds the start of current block and blinks to it for a second.
2156 Also checks if the correct end statement has been used."
2157 ;; All end statements are reserved words
2158 ;; Re-indent end line
2159 ;;(insert-char ?\ 1) ;; So indent, etc. work well
2160 ;;(backward-char 1)
2164 begin-pos end-pos end end1 )
2168 idlwave-show-block)
2170 ;; Move inside current block
2183 end-pos))
2191 ;; A generic end
2202 end1 end)
2204 ;;(delete-char 1))
2218 ;; seems to be a case thing
2222 idlwave-block-matches))
2224 ;; Just a normal block
2229 "Terminate the current block with the correct END statement."
2231 ;; Start new line if we are not in a new line
2242 "Surround &, leaving room for && (which surrround as well)."
2252 "Surround > and < by blanks, leaving room for >= and <=, and considering ->."
2258 ;; Key binding: pad only on left, to save for possible >=/<=
2262 "Surround the LENGTH characters before point with blanks.
2263 LENGTH defaults to 1.
2264 Optional arguments BEFORE and AFTER affect the behavior before and
2265 after the characters (see also description of `idlwave-make-space'):
2267 nil do nothing
2268 0 force no spaces
2269 integer > 0 force exactly n spaces
2270 integer < 0 at least |n| spaces
2272 The function does nothing if any of the following conditions is true:
2273 - `idlwave-surround-by-blank' is nil
2274 - the character before point is inside a string or comment"
2282 ;; avoid clobbering indent
2292 ;; Check to see if the line should auto wrap
2298 "Make space at point.
2299 The space affected is all the spaces and tabs around point.
2300 If n is non-nil then point is left abs(n) spaces from the beginning of
2301 the contiguous space.
2302 The amount of space at point is determined by N.
2303 If the value of N is:
2304 nil - do nothing.
2305 > 0 - exactly N spaces.
2306 < 0 - a minimum of -N spaces, i.e., do not change if there are
2307 already -N spaces.
2308 0 - no spaces (i.e. remove any existing space)."
2322 ;; n = 0, done
2323 ))))
2326 "Inserts a newline and indents the current and previous line."
2328 ;;
2329 ;; Handle unterminated single and double quotes
2330 ;; If not in a comment and in a string then insertion of a newline
2331 ;; will mean unbalanced quotes.
2332 ;;
2337 ;;
2338 ;; The current line is being split, the cursor should be at the
2339 ;; beginning of the new line skipping the leading indentation.
2340 ;;
2341 ;; The reason we insert the new line before indenting is that the
2342 ;; indenting could be confused by keywords (e.g. END) on the line
2343 ;; after the split point. This prevents us from just using
2344 ;; `indent-for-tab-command' followed by `newline-and-indent'.
2345 ;;
2351 ;;
2352 ;; Use global variable 'comment-column' to set parallel comment
2353 ;;
2354 ;; Modeled on lisp.el
2355 ;; Emacs Lisp and IDL (Wave CL) have identical comment syntax
2357 "Compute indent for the beginning of the IDL comment delimiter."
2365 ;; On line by itself, indent as code
2368 ;; after code - do not change
2372 comment-column))))
2375 "Continue line by breaking line at point and indent the lines.
2376 For a code line insert continuation marker. If the line is a line comment
2377 then the new line will contain a comment with the same indentation.
2378 Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
2379 non-nil."
2381 ;; Expand abbreviation, just like normal RET would.
2385 ;; For code line add continuation.
2386 ;; Check if splitting a string.
2390 ;; Split the string.
2392 idlwave-continuation-char beg)
2396 ;; Do not split the string.
2400 ;; Not splitting a string.
2406 ;; Indent previous line
2411 ;; Reindent new line
2415 "Moves point to the beginning of the current program unit."
2420 "Moves point to the start of the next program unit."
2426 "Mark current IDL statement."
2434 "Mark containing block."
2446 "Put mark at beginning of program, point at end.
2447 The marks are pushed."
2457 "Move to beginning of enclosing block if prefix ARG >= 0.
2458 If prefix ARG < 0 then move forward to enclosing block end."
2463 "Go to the beginning of the current block."
2469 "Go to the beginning of the current block."
2475 "Move across next nested block."
2482 "Move backward across previous nested block."
2488 "Go down a block.
2489 With ARG: ARG >= 0 go forwards, ARG < 0 go backwards.
2490 Returns non-nil if successfull."
2494 ;; Backward
2502 ;; Forward
2510 status))
2513 "Put point at beginning of doc library header, mark at end.
2514 The marks are pushed."
2535 "Return (NAME TYPE CLASS) of current routine."
2539 (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
2548 "Move to beginning of the current statement.
2549 Skips back past statement continuations.
2550 Point is placed at the beginning of the line whether or not this is an
2551 actual statement."
2563 "Moves point to beginning of the previous statement.
2564 Returns t if the current line before moving is the beginning of
2565 the first non-comment statement in the file, and nil otherwise."
2569 ;; first line in file
2570 t
2571 ;; skip blank lines, label lines, include lines and line comments
2573 ;; The current statement is the first statement until we
2574 ;; reach another statement.
2582 ;; skip continuation lines
2588 first-statement)))
2591 "Moves point to the end of the current IDL statement.
2592 If not in a statement just moves to end of line. Returns position."
2602 "Moves point to the end of the current IDL statement.
2603 If not in a statement just moves to end of line. Returns position."
2611 "Moves point to beginning of the next IDL statement.
2612 Returns t if that statement is the last
2613 non-comment IDL statement in the file, and nil otherwise."
2617 ;; skip blank lines, label lines, include lines and line comments
2619 ;; The current statement is the last statement until
2620 ;; we reach a new statement.
2627 last-statement))
2630 "Skip past multiple commands on a line (with `&')."
2640 "Skip label or case statement element.
2641 Returns position after label.
2642 If there is no label point is not moved and nil is returned."
2643 ;; Case expressions and labels are terminated by a colon.
2644 ;; So we find the first colon in the line and make sure
2645 ;; - no `?' is before it (might be a ? b : c)
2646 ;; - it is not in a comment
2647 ;; - not in a string constant
2648 ;; - not in parenthesis (like a[0:3])
2649 ;; - not followed by another ":" in explicit class, ala a->b::c
2650 ;; As many in this mode, this function is heuristic and not an exact
2651 ;; parser.
2663 nil)))
2666 "Move to start of next IDL substatement after point.
2667 Uses the type of the current IDL statement to determine if the next
2668 statement is on a new line or is a subpart of the current statement.
2669 Returns point at start of substatement modulo whitespace.
2670 If optional argument is non-nil move to beginning of current
2671 substatement."
2675 st nst last)
2681 ;; Continue looking for substatements until we are past orig
2695 ;; If a continuation line starts here, move to next line
2701 "Return the type of the current IDL statement.
2702 Uses `idlwave-statement-match' to return a cons of (type . point) with
2703 point the ending position where the type was determined. Type is the
2704 association from `idlwave-statement-match', i.e. the cons cell from the
2705 list not just the type symbol. Returns nil if not an identifiable
2706 statement."
2708 ;; Skip whitespace within a statement which is spaces, tabs, continuations
2709 ;; and possibly comments
2721 "Pad '=' with spaces. Two cases: Assignment statement, and keyword
2722 assignment. Which case is determined using
2723 `idlwave-start-of-substatement' and `idlwave-statement-type'. The
2724 equal sign will be surrounded by BEFORE and AFTER blanks. If
2725 `idlwave-pad-keyword' is t then keyword assignment is treated just
2726 like assignment statements. When nil, spaces are removed for keyword
2727 assignment. Any other value keeps the current space around the `='.
2728 Limits in for loops are treated as keyword assignment.
2730 Starting with IDL 6.0, a number of op= assignments are available.
2731 Since ambiguities of the form:
2733 r and= b
2734 rand= b
2736 can occur, alphanumeric operator assignment will never be pre-padded,
2737 only post-padded. You must use a space before these to disambiguate
2738 \(not just for padding, but for proper parsing by IDL too!). Other
2739 operators, such as ##=, ^=, etc., will be pre-padded.
2741 IS-ACTION is ignored.
2743 See `idlwave-surround'."
2756 ;; Why doesn't ##? work for both?
2760 ;(setq begin nil) ; won't modify begin
2764 ;; Everything gets padded equally
2766 ;; Treating keywords/for variables specially...
2784 "Call `idlwave-indent-line' and do expand actions.
2785 With prefix ARG non-nil, indent the entire sub-statement."
2793 ;;Expand the END abbreviation, just as RET or Space would have.
2804 "Indents current IDL line as code or as a comment.
2805 The actions in `idlwave-indent-action-table' are performed.
2806 If the optional argument EXPAND is non-nil then the actions in
2807 `idlwave-indent-expand-table' are performed."
2809 ;; Move point out of left margin.
2818 ;; Indentation for a line comment
2822 ;;
2823 ;; Code Line
2824 ;;
2825 ;; Before indenting, run action routines.
2826 ;;
2829 ;;
2832 ;;
2833 ;; No longer expand abbrevs on the line. The user can do this
2834 ;; manually using expand-region-abbrevs.
2835 ;;
2836 ;; Indent for code line
2837 ;;
2840 ;; a label line
2842 ;; a batch command
2844 ;; leave flush left
2845 nil
2846 ;; indent the line
2848 ;; Adjust parallel comment
2851 ;; Emacs 21 is too smart with fill-column on comment indent
2854 fill-column)))
2857 ;; Get rid of marker
2861 "Perform an action repeatedly on a line. ACTION is a list (REG
2862 . FUNC). REG is a regular expression. FUNC is either a function name
2863 to be called with `funcall' or a list to be evaluated with `eval'.
2864 The action performed by FUNC should leave point after the match for
2865 REG - otherwise an infinite loop may be entered. FUNC is always
2866 passed a final argument of 'is-action, so it can discriminate between
2867 being run as an action, or a key binding"
2877 "Indent from point with spaces until column COL.
2878 Inserts space before markers at point."
2884 "Indent the current line to column COL.
2885 Indents such that first non-whitespace character is at column COL
2886 Inserts spaces before markers at point."
2893 "Indents program unit which contains point."
2905 "Indent current statement, including all continuation lines."
2914 "Return appropriate indentation for current line as IDL code."
2918 ;; Check for beginning of unit - main (beginning of buffer), pro, or
2919 ;; function
2922 ;; Check for continuation line
2927 ;; calculate indent based on previous and current statements
2930 ;; calculate indent based on previous statement
2933 ;; Beginning of file
2938 ;; Main block
2941 idlwave-main-block-indent))
2942 ;; Begin block
2945 idlwave-block-indent))
2946 ;; End Block
2949 ;; Match to the *beginning* of the block opener
2953 ;; idlwave-end-offset
2954 ;; idlwave-block-indent))
2956 ;; Default to current indent
2958 ;; adjust the indentation based on the current statement
2960 ;; End block
2965 ;;
2966 ;; Parentheses indent
2967 ;;
2970 "Calculate the continuation indent inside a paren group.
2971 Returns a cons-cell with (open . indent), where open is the
2972 location of the open paren"
2974 ;; Found an innermost open paren.
2977 ;; Line up with next word unless this is a closing paren.
2980 ;; Plain Kernighan-style nested indent
2984 ;; This is a closed paren - line up under open paren.
2988 ;; Empty (or just comment) follows -- revert to basic indent
2990 ;; Skip paren
2993 nil)
2995 ;; Line up with first word after any blank space
3001 "Calculates the IDL continuation indent column from the previous
3002 statement. Note that here previous statement usually means the
3003 beginning of the current statement if this statement is a continuation
3004 of the previous line. Various special types of continuations,
3005 including assignments, routine definitions, and parenthetical
3006 groupings, are treated separately."
3017 idlwave-continuation-indent))
3018 fancy-nonparen-indent fancy-paren-indent)
3020 ;; Align then with its matching if, etc.
3027 match cont-re)
3042 ;; Indent in from the previous line for continuing statements
3047 match)
3059 ;; Parenthetical indent, either traditional or Kernighan style
3066 indent-cons)
3069 beg-reg end-reg close-exp))
3070 ;; First permitted containing paren
3072 idlwave-indent-to-open-paren
3073 idlwave-indent-parens-nested
3076 idlwave-max-extra-continuation-indent))
3079 fancy-paren-indent)
3081 ;; A continued assignment, or procedure call/definition
3089 ;; A continued Procedure call or definition
3092 (looking-at "[ \t]*\\([a-zA-Z0-9.$_]+[ \t]*->[ \t]*\\)?[a-zA-Z][:a-zA-Z0-9$_]*[ \t]*\\(,\\)[ \t]*"))
3094 ;; Comment only, or blank line with "$"? Basic indent.
3096 nil
3099 ;; Continued assignment (with =):
3113 idlwave-max-extra-continuation-indent))
3116 fancy-nonparen-indent))
3118 ;; Basic indent, by default
3124 "Move to next match of the regular expression KEY-RE.
3125 Matches inside comments or string constants will be ignored.
3126 If DIR is negative, the search will be backwards.
3127 At a successful match, the mark is pushed unless NOMARK is non-nil.
3128 Searches are limited to LIMIT.
3129 Searches are case-insensitive and use a special syntax table which
3130 treats `$' and `_' as word characters.
3131 Return value is the beginning of the match or (in case of failure) nil."
3135 found)
3149 found)
3150 nil)))
3153 "When optional argument DIR is non-negative, move forward to end of
3154 current block using the `idlwave-begin-block-reg' and `idlwave-end-block-reg'
3155 regular expressions. When DIR is negative, move backwards to block beginning.
3156 Recursively calls itself to skip over nested blocks. DIR defaults to
3157 forward. Calls `push-mark' unless the optional argument NOMARK is
3158 non-nil. Movement is limited by the start of program units because of
3159 possibility of unbalanced blocks."
3166 idlwave-begin-block-reg
3167 idlwave-end-block-reg))
3168 found
3170 idlwave-end-block-reg))
3174 idlwave-begin-unit-reg dir t limit)
3177 idlwave-end-unit-reg dir t limit)))
3178 limit)))
3190 "The minimum indent in the current statement."
3201 min
3205 "Return indentation of the current statement.
3206 If in a statement, moves to beginning of statement before finding indent."
3213 "Return the column of the indentation of the current line.
3214 Skips any whitespace. Returns 0 if the end-of-line follows the whitespace."
3218 ;; if we are at the end of blank line return 0
3223 "Tests if current line is continuation line.
3224 Blank or comment-only lines following regular continuation lines (with
3225 `$') count as continuations too."
3236 "Tests if the current line is a comment line."
3242 "Tests if the current line is a comment line."
3248 "Searches current line from current point for REGEXP.
3249 If optional argument CONT is non-nil, searches to the end of
3250 the current statement.
3251 If optional arg BEG is non-nil, search starts from the beginning of the
3252 current statement.
3253 Ignores matches that end in a comment or inside a string expression.
3254 Returns point if successful, nil otherwise.
3255 This function produces unexpected results if REGEXP contains quotes or
3256 a comment delimiter. The search is case insensitive.
3257 If successful leaves point after the match, otherwise, does not move point."
3263 found)
3269 found))
3272 "Fills paragraphs in comments.
3273 A paragraph is made up of all contiguous lines having the same comment
3274 leader (the leading whitespace before the comment delimiter and the
3275 comment delimiter). In addition, paragraphs are separated by blank
3276 line comments. The indentation is given by the hanging indent of the
3277 first line, otherwise by the minimum indentation of the lines after
3278 the first line. The indentation of the first line does not change.
3279 Does not effect code lines. Does not fill comments on the same line
3280 with code. The hanging indent is given by the end of the first match
3281 matching `idlwave-hang-indent-regexp' on the paragraph's first line . If the
3282 optional argument NOHANG is non-nil then the hanging indent is
3283 ignored."
3285 ;; check if this is a line comment
3292 pre here diff fill-prefix-reg bcl first-indent
3293 hang start end)
3294 ;; Change tabs to spaces in the surrounding paragraph.
3295 ;; The surrounding paragraph will be the largest containing block of
3296 ;; contiguous line comments. Thus, we may be changing tabs in
3297 ;; a much larger area than is needed, but this is the easiest
3298 ;; brute force way to do it.
3299 ;;
3300 ;; This has the undesirable side effect of replacing the tabs
3301 ;; permanently without the user's request or knowledge.
3309 ;;
3316 t)
3317 ;; Get the comment leader on the line and its length
3319 ;; the comment leader is the indentation plus exactly the
3320 ;; number of consecutive ";".
3330 ;; Mark the beginning and end of the paragraph
3336 ;; Move to first line of paragraph
3350 ;; if at end of buffer add a newline (need this because
3351 ;; fill-region needs END to be at the beginning of line after
3352 ;; the paragraph or it will add a line).
3355 ;; Set END to the beginning of line after the paragraph
3356 ;; END is calculated as distance from end of buffer
3358 ;;
3359 ;; Calculate the indentation for the paragraph.
3360 ;;
3361 ;; In the following while statements, after one iteration
3362 ;; point will be at the beginning of a line in which case
3363 ;; the while will not be executed for the
3364 ;; the first paragraph line and thus will not affect the
3365 ;; indentation.
3366 ;;
3367 ;; First check to see if indentation is based on hanging indent.
3373 ;; Adjust lines of paragraph by inserting spaces so that
3374 ;; each line's indent is at least as great as the hanging
3375 ;; indent. This is needed for fill-paragraph to work with
3376 ;; a fill-prefix.
3383 t)
3387 ;; adjust the original location for the
3388 ;; inserted text.
3392 )
3394 ;; No hang. Instead find minimum indentation of paragraph
3395 ;; after first line.
3396 ;; For the following while statement, since START is at the
3397 ;; beginning of line and END is at the end of line
3398 ;; point is greater than START at least once (which would
3399 ;; be the case for a single line paragraph).
3406 comment-start-skip
3408 t)
3411 )
3414 ?\ )))
3415 ;; first-line indent
3420 comment-start-skip
3422 t)
3424 indent))
3426 ;; try to keep point at its original place
3429 ;; In place of the more modern fill-region-as-paragraph, a hack
3430 ;; to keep whitespace untouched on the first line within the
3431 ;; indent length and to preserve any indent on the first line
3432 ;; (first indent).
3438 start
3441 nil)
3445 ;; When we want the point at the beginning of the comment
3446 ;; body fill-region will put it at the beginning of the line.
3451 "Calculate the position of the hanging indent for the comment
3452 paragraph. The hanging indent position is given by the first match
3453 with the `idlwave-hang-indent-regexp'. If `idlwave-use-last-hang-indent' is
3454 non-nil then use last occurrence matching `idlwave-hang-indent-regexp' on
3455 the line.
3456 If not found returns nil."
3461 idlwave-hang-indent-regexp
3463 t)
3468 idlwave-hang-indent-regexp
3470 t)
3474 "Called to break lines in auto fill mode.
3475 Only fills non-comment lines if `idlwave-fill-comment-line-only' is
3476 non-nil. Places a continuation character at the end of the line if
3477 not in a comment. Splits strings with IDL concatenation operator `+'
3478 if `idlwave-auto-fill-split-string' is non-nil."
3480 nil ; do not to fill
3483 ;; Check for comment line
3488 ;; Prevent actions do-auto-fill which calls indent-line-function.
3493 idlwave-auto-fill-split-string)
3496 ))))
3500 ;; Indent the split line
3505 ;; A continued line comment
3506 ;; We treat continued line comments as part of a comment
3507 ;; paragraph. So we check for a hanging indent.
3516 ;; Remove whitespace between comment delimiter and
3517 ;; text, insert spaces for appropriate indentation.
3520 comment-start-skip
3525 )))
3526 ;; Split code or comment?
3530 ;; Splitting a non-full-line comment.
3531 ;; Insert the comment delimiter from split line
3536 ;; Insert blank to keep off beginning of line
3545 ;; Split code line - add continuation character
3548 ;; Check to see if we split a string
3550 idlwave-auto-fill-split-string)
3551 ;; Split the string and concatenate.
3552 ;; The first extra space is for the space
3553 ;; the line was split. That space was removed.
3558 ;; Make the second part of continued string
3563 ;; Warning
3566 ;; Although do-auto-fill (via indent-new-comment-line) calls
3567 ;; idlwave-indent-line for the new line, re-indent again
3568 ;; because of the addition of the continuation character.
3570 )))))
3573 "Toggle auto-fill mode for IDL mode.
3574 With arg, turn auto-fill mode on if arg is positive.
3575 In auto-fill mode, inserting a space at a column beyond `fill-column'
3576 automatically breaks the line at a previous space."
3582 'idlwave-auto-fill
3583 nil))
3584 ;; update mode-line
3587 ;(defun idlwave-fill-routine-call ()
3588 ; "Fill a routine definition or statement, indenting appropriately."
3589 ; (let ((where (idlwave-where)))))
3593 "Insert a documentation header at the beginning of the unit.
3594 Inserts the value of the variable idlwave-file-header. Sets mark before
3595 moving to do insertion unless the optional prefix argument NOMARK
3596 is non-nil."
3599 ;; make sure we catch the current line if it begins the unit
3605 ;; skip function or procedure line
3619 "Default timestamp insertion function"
3625 ;; Remove extra spaces from line
3627 ;; Insert a blank line comment to separate from the date entry -
3628 ;; will keep the entry from flowing onto date line if re-filled.
3632 "Insert a brief modification log at the beginning of the current program.
3633 Looks for an occurrence of the value of user variable
3634 `idlwave-doc-modifications-keyword' if non-nil. Inserts time and user name
3635 and places the point for the user to add a log. Before moving, saves
3636 location on mark ring so that the user can return to previous point."
3651 end t)
3662 ;;; CJC 3/16/93
3663 ;;; Interface to expand-region-abbrevs which did not work when the
3664 ;;; abbrev hook associated with an abbrev moves point backwards
3665 ;;; after abbrev expansion, e.g., as with the abbrev '.n'.
3666 ;;; The original would enter an infinite loop in attempting to expand
3667 ;;; .n (it would continually expand and unexpand the abbrev without expanding
3668 ;;; because the point would keep going back to the beginning of the
3669 ;;; abbrev instead of to the end of the abbrev). We now keep the
3670 ;;; abbrev hook from moving backwards.
3671 ;;;
3673 "Expand each abbrev occurrence in the region.
3674 Calling from a program, arguments are START END."
3683 "Returns t if point is in a comment or quoted string.
3684 nil otherwise."
3688 "Returns location of the opening quote
3689 if point is in a IDL string constant, nil otherwise.
3690 Ignores comment delimiters on the current line.
3691 Properly handles nested quotation marks and octal
3692 constants - a double quote followed by an octal digit."
3693 ;;; Treat an octal inside an apostrophe to be a normal string. Treat a
3694 ;;; double quote followed by an octal digit to be an octal constant
3695 ;;; rather than a string. Therefore, there is no terminating double
3696 ;;; quote.
3698 ;; Because single and double quotes can quote each other we must
3699 ;; search for the string start from the beginning of line.
3705 delim
3706 found)
3708 ;; Find string start
3709 ;; Don't find an octal constant beginning with a double quote
3711 ;; Find the string end.
3712 ;; In IDL, two consecutive delimiters after the start of a
3713 ;; string act as an
3714 ;; escape for the delimiter in the string.
3715 ;; Two consecutive delimiters alone (i.e., not after the
3716 ;; start of a string) is the null string.
3718 ;; Move to position after quote
3721 ;; Get the string delimiter
3723 ;; Check for null string
3726 ;; Look for next unpaired delimiter
3734 ))
3737 ;; return string beginning position or nil
3741 "Determines if the character after point is a pointer dereference *."
3752 ;; Statement templates
3754 ;; Replace these with a general template function, something like
3755 ;; expand.el (I think there was also something with a name similar to
3756 ;; dmacro.el)
3759 "Build a template with optional prompt expression.
3761 Opens a line if point is not followed by a newline modulo intervening
3762 whitespace. S1 and S2 are strings. S1 is inserted at point followed
3763 by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
3764 adjusted according to `idlwave-abbrev-change-case'. If optional argument
3765 PROMPT is a string then it is displayed as a message in the
3766 minibuffer. The PROMPT serves as a reminder to the user of an
3767 expression to enter.
3769 The lines containing S1 and S2 are reindented using `indent-region'
3770 unless the optional second argument NOINDENT is non-nil."
3772 ;; This is a gross hack to avoit template abbrev expansion
3773 ;; in the shell. FIXME: This is a dirty hack.
3783 end)
3796 "Make STRING have the case required by `idlwave-reserved-word-upcase'."
3799 string))
3802 "Build skeleton IDL if-else block."
3810 "Build skeleton IDL case statement."
3818 "Build skeleton IDL switch statement."
3826 "Build skeleton for loop statment."
3834 "Build skeleton for loop statment."
3870 "Return a list of substrings of STRING which are separated by PATTERN.
3884 end)
3892 ;; Return the buffer currently visiting FILE
3902 "List of buffer pulled up by idlwave for special reasons.
3906 ;; Return a buffer visiting file.
3910 buf)))
3913 "Kill buffers created automatically by IDLWAVE.
3914 Function prompts for a letter to identify the buffers to kill.
3915 Possible letters are:
3918 clicks in the routine info window.
3919 s Buffers created by the IDLWAVE Shell to display where execution
3920 stopped or an error was found.
3921 a Both of the above.
3923 Buffer containing unsaved changes require confirmation before they are killed."
3927 (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
3941 "How many outlawed buffers have tag TAG?"
3945 idlwave-outlawed-buffers))))
3948 "Kill all buffers pulled up by IDLWAVE matching REASONS."
3951 entry)
3965 "Remove BUFFER from the buffers which may be killed.
3966 Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
3967 Intended for `after-save-hook'."
3970 ;; Revoke license
3974 ;; Remove this function from the hook.
3979 ;; Find FILE on the scanned lib path and return a buffer visiting it
3981 dir efile)
3989 ;; Find FILE on the scanned lib path and return a buffer visiting it
3990 ;; This is for, e.g., finding source with no user catalog
3997 "Creates the IDL tags file IDLTAGS in the current directory from
3998 the list of directories specified in the minibuffer. Directories may be
3999 for example: . /usr/local/rsi/idl/lib. All the subdirectories of the
4000 specified top directories are searched if the directory name is prefixed
4001 by @. Specify @ directories with care, it may take a long, long time if
4002 you specify /."
4005 buffer save_buffer files numfiles item errbuf)
4007 ;;
4008 ;; Read list of directories
4011 ;;
4012 ;; Set etags command, vars
4018 ;;
4019 ;; For each directory
4023 ;;
4024 ;; Find the subdirectories
4046 ;;
4047 ;; For each subdirectory
4051 ;;
4052 ;; Call etags
4061 0
4063 ;;
4064 ;; Append additional tags
4071 )))
4083 ))
4086 "Comment the lines in the region if the first non-blank line is
4087 commented, and conversely, uncomment region. If optional prefix arg
4088 N is non-nil, then for N positive, add N comment delimiters or for N
4089 negative, remove N comment delimiters.
4090 Uses `comment-region' which does not place comment delimiters on
4091 blank lines."
4098 ;; skip blank lines
4110 ;; ----------------------------------------------------------------------------
4111 ;; ----------------------------------------------------------------------------
4112 ;; ----------------------------------------------------------------------------
4113 ;; ----------------------------------------------------------------------------
4114 ;;
4115 ;; Completion and Routine Info
4116 ;;
4118 ;; String "intern" functions
4120 ;; For the completion and routine info function, we want to normalize
4121 ;; the case of procedure names etc. We do this by "interning" these
4122 ;; string is a hand-crafted way. Hashes are used to map the downcase
4123 ;; version of the strings to the cased versions. Most *-sint-*
4124 ;; variables consist of *two* hashes, a buffer+shell, followed by a
4125 ;; system hash. The former is re-scanned, and the latter takes case
4126 ;; precedence.
4127 ;;
4128 ;; Since these cased versions are really lisp objects, we can use `eq'
4129 ;; to search, which is a large performance boost. All new strings
4130 ;; need to be "sinterned". We do this as early as possible after
4131 ;; getting these strings from completion or buffer substrings. So
4132 ;; most of the code can simply assume to deal with "sinterned"
4133 ;; strings. The only exception is that the functions which scan whole
4134 ;; buffers for routine information do not intern the grabbed strings.
4135 ;; This is only done afterwards. Therefore in these functions it is
4136 ;; *not* safe to assume the strings can be compared with `eq' and be
4137 ;; fed into the routine assq functions.
4139 ;; Here we define the hashing functions.
4141 ;; The variables which hold the hashes.
4150 "Reset all sintern hashes."
4151 ;; Make sure the hash functions are accessible.
4163 ;; Make sure these are lists
4168 ;; Reset the system & library hash
4176 idlwave-sint-libnames nil))
4178 ;; Reset the buffer & shell hash
4194 ;;(defmacro idlwave-sintern (type var)
4195 ;; `(cond ((not (stringp name)) name)
4196 ;; ((gethash (downcase name) (cdr ,var)))
4197 ;; ((gethash (downcase name) (car ,var)))
4198 ;; (set (idlwave-sintern-set name ,type ,var set))
4199 ;; (name)))
4239 iname))
4242 "Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
4246 kwd-list)
4249 "Sintern all strings in the rinfo LIST. With optional parameter
4250 SET: also set new patterns. Probably this will always have to be t.
4251 If DEFAULT-DIR is passed, it is used as the base of the directory"
4263 ;; The class and name
4271 ;; The source
4284 ;; The keywords
4287 kwds))
4289 ;; Build a canonicalized list
4294 ;; Creating new sintern tables
4297 "Define a variable and a function to sintern the new type TAG.
4298 This defines the function `idlwave-sintern-TAG' and the variable
4299 `idlwave-sint-TAGs'."
4311 name)
4315 "Reset the sintern variable associated with TAG."
4318 ;;---------------------------------------------------------------------------
4321 ;; The variables which hold the information
4337 "Alist with !PATH directories and zero or more flags if the dir has
4338 been scanned in a user catalog ('user) or discovered in a library
4354 ;;
4355 ;; The code to get routine info from different sources.
4362 "Provide a list of IDL routines.
4363 This routine loads the builtin routines on the first call. Later it
4364 only returns the value of the variable."
4374 ;; Keep it running...
4375 )
4377 ;; Something is wrong, get rid of the process
4386 ;; return the current value
4387 idlwave-routines)))
4390 "List of functions which should run after a global rinfo update.
4394 "Rescan the previously selected directories. For batch processing."
4398 "Dispatch another Emacs instance to update the idlwave catalog.
4399 After the process finishes normally, the first access to routine info
4400 will re-read the catalog."
4424 nil emacs args)))
4427 process
4431 idlwave-system-routines nil
4432 idlwave-catalog-process nil)
4438 ;; Format for all routine info user catalog, library catalogs, etc.:
4439 ;;
4440 ;; ("ROUTINE" type class
4441 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4442 ;; (buffer pro_file dir) | (compiled pro_file dir)
4443 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4444 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
4445 ;;
4446 ;; DIR will be supplied dynamically while loading library catalogs,
4447 ;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
4448 ;; complete filepath, in which case DIR is unnecessary. HELPFILE can
4449 ;; be nil, as can LINK1, etc., if no HTML help is available.
4456 "Update the internal routine-info lists.
4459 about individual routines.
4461 The information can come from 4 sources:
4462 1. IDL programs in the current editing session
4463 2. Compiled modules in an IDL shell running as Emacs subprocess
4464 3. A list which covers the IDL system routines.
4465 4. A list which covers the prescanned library files.
4467 Scans all IDLWAVE-mode buffers of the current editing session (see
4468 `idlwave-scan-all-buffers-for-routine-info').
4469 When an IDL shell is running, this command also queries the IDL program
4470 for currently compiled routines.
4472 With prefix ARG, also reload the system and library lists.
4473 With two prefix ARG's, also rescans the chosen user catalog tree.
4474 With three prefix args, dispatch asynchronous process to do the update.
4476 If NO-CONCATENATE is non-nil, don't pre-concatenate the routine info
4477 lists, but instead wait for the shell query to complete and
4478 asynchronously finish updating routine info. This is set
4479 automatically when called interactively. When you need routine
4480 information updated immediately, leave NO-CONCATENATE nil."
4482 ;; Stop any idle processing
4490 ;; Start a background process which updates the catalog.
4493 ;; Update the user catalog now, and wait for them.
4497 idlwave-buffer-case-takes-precedence
4499 ;; The override-idle means, even if the idle timer has done some
4500 ;; preparing work, load and renormalize everything anyway.
4504 idlwave-compiled-routines nil
4505 idlwave-unresolved-routines nil)
4506 ;; Reset the appropriate hashes
4508 ;; reset was already done in idle time, so skip this step now once
4515 ;; We can safely scan the buffer stuff first
4519 ;; We first do the system info, and then the buffers
4523 ;; Let's see if there is a shell
4527 idlwave-query-shell-for-routine-info)))
4529 ;; Load the library catalogs again, first re-scanning the path
4541 ;; 1. If we are not going to ask the shell, we need to do the
4542 ;; concatenation now.
4543 ;; 2. When this function is called non-interactively, it
4544 ;; means that someone needs routine info *now*. The
4545 ;; shell update causes the concatenation to be
4546 ;; *delayed*, so not in time for the current command.
4547 ;; Therefore, we do a concatenation now, even though
4548 ;; the shell might do it again.
4552 ;; Ask the shell about the routines it knows of.
4575 idlwave-init-rinfo-when-idle-after
4581 ;;------ XML Help routine info system
4583 ;; Load the system routine info from the cached routine info file,
4584 ;; which, if necessary, will be re-created from the XML file on
4585 ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo
4586 ;; file distributed with older IDLWAVE versions (<6.0)
4590 ;; See if we can create it from XML source
4610 idlwave-xml-system-rinfo-converted-file
4611 catalog-file)))
4615 "Alist of system variables and the associated structure tags.
4623 ;; From a list of syntax statments, shorten with %s and group with "or"
4632 x)
4637 ;; Create a class list entry from the xml parsed list., returning a
4638 ;; cons of form (class-entry method-entries).
4644 class-entry
4645 method methods-entry extra-kwds
4646 props get-props set-props init-props inherits
4647 pelem ptype)
4677 init-props)
4680 get-props)
4683 set-props)
4687 methods-entry)))
4690 ;(unless (get 'init-props 'matched)
4691 ; (message "Failed to match Init in class %s" class))
4692 ;(unless (get 'get-props 'matched)
4693 ; (message "Failed to match GetProperty in class %s" class))
4694 ;(unless (get 'set-props 'matched)
4695 ; (message "Failed to match SetProperty in class %s" class))
4703 ;; Create correctly structured list elements from ROUTINE or METHOD
4704 ;; XML list structures. Return a list of list elements, with more
4705 ;; than one sub-list possible if a routine can serve as both
4706 ;; procedure and function (e.g. call_method).
4713 syntax kwd klink pref-list kwds pelem ptype entry props result type)
4748 ;; Debug
4749 ; (if (and (null (aref syntax-vec 0))
4750 ; (null (aref syntax-vec 1))
4751 ; (null (aref syntax-vec 2)))
4752 ; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints")
4753 ; (if class
4754 ; (insert (format "Missing SYNTAX entry for %s::%s\n" class name))
4755 ; (insert (message "Missing SYNTAX entry for %s\n" name)))))
4757 ;; Executive commands are treated specially
4769 result)))
4773 ;; Group keywords by link file, as a list with elements
4774 ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2))
4786 ;; Ensure the master link is there
4789 linkfiles
4794 ;; Clean up the syntax of routines which are actually aliases by
4795 ;; removing the "OR" from the statements
4804 ;; Duplicate and trim original routine aliases from rinfo list
4805 ;; This if for, e.g. OPENR/OPENW/OPENU
4815 ;; Add any missing aliases (separate by slashes)
4830 ;; Duplicate and trim original routine aliases from rinfo list
4831 ;; This if for, e.g. !X, !Y, !Z.
4844 ;; Create a sysvar list entry from the xml parsed list.
4852 pelem ptype props fields tags)
4863 tags))))
4877 ;; Automatically generated from source file:
4882 idlwave-xml-routine-info-file))
4900 "Convert XML supplied IDL routine info into internal form.
4901 Cache to disk for quick recovery."
4907 props rinfo msg-cnt elem type nelem class-result alias
4908 routines routine-aliases statement-aliases sysvar-aliases
4909 version-string)
4920 ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff.
4931 idlwave-system-variables-alist nil
4932 idlwave-system-class-info nil
4933 idlwave-executive-commands-alist nil
4934 idlwave-help-special-topic-words nil)
4950 routine-aliases)
4955 ;; a cons cell is an executive commands
4967 idlwave-help-special-topic-words)
4968 ;; Save the links to those which are statement aliases (not routines)
4977 sysvar-aliases)
4979 idlwave-system-variables-alist)))
4990 ;; ("ROUTINE" type class
4991 ;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
4992 ;; (buffer pro_file dir) | (compiled pro_file dir)
4993 ;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
4994 ;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
5004 ;;(load "idlw-rinfo" 'noerror 'nomessage)
5026 ;; Check for the old style catalog and warn
5029 idlwave-library-routines)
5034 idlwave-user-catalog-file))
5061 ;; restart the timer
5066 idlwave-init-rinfo-when-idle-after
5070 ;; Load and case-treat the system, user catalog, and library routine
5071 ;; info files.
5073 ;; System
5075 ;;(load "idlw-rinfo" 'noerror 'nomessage))
5087 ;; User catalog
5096 idlwave-library-routines)
5099 idlwave-user-catalog-file))
5108 ;; Library catalog
5119 ;; Scan all buffers, current buffer last
5124 ;; Don't scan any buffers
5127 ;; Just scan this buffer
5133 ;; Put the result into the correct variable
5138 "Put the different sources for routine information together."
5139 ;; The sequence here is important because earlier definitions shadow
5140 ;; later ones. We assume that if things in the buffers are newer
5141 ;; then in the shell of the system, they are meant to be different.
5144 idlwave-compiled-routines
5145 idlwave-library-catalog-routines
5146 idlwave-user-catalog-routines))
5149 ;; Give a message with information about the number of routines we have.
5152 "Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
5162 "Return the class alist - make it if necessary."
5169 idlwave-class-alist)))
5171 ;; Three functions for the hooks
5180 "Update idlwave-routines for current buffer. Can run from after-save-hook."
5184 idlwave-scan-all-buffers-for-routine-info
5185 idlwave-routines)
5191 nil
5197 routines)
5201 "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
5203 found)
5205 ;; The following test uses eq to make sure it works correctly
5206 ;; when two buffers visit the same file. Then the file names
5207 ;; will be equal, but not eq.
5213 ;; End of that section reached. Jump.
5219 ;;----- Scanning buffers -------------------
5222 "Call `idlwave-get-buffer-routine-info' on idlwave-mode buffers in BUFFERS."
5228 buffer-file-name)
5229 ;; yes, this buffer has the right mode.
5234 ;; Concatenate the individual lists and return the result
5238 "Scan the current buffer for routine info. Return (PRO-LIST FUNC-LIST)."
5240 routine-list string entry)
5254 routine-list))
5258 "Parse a module definition."
5260 start name args type keywords class)
5261 ;; Remove comments
5264 ;; Remove the continuation line stuff
5269 ;; Match the name and type.
5277 ;; Match normal args and keyword args
5280 string start)
5285 ;; Normalize and sort.
5289 ;; Make and return the entry
5290 ;; We don't know which argument are optional, so this information
5291 ;; will not be contained in the calling sequence.
5294 class
5297 ; ((string= (downcase
5298 ; (file-name-sans-extension
5299 ; (file-name-nondirectory (buffer-file-name))))
5300 ; (downcase name))
5301 ; (list 'lib))
5302 ; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
5308 "%s"
5316 nil))))
5319 ;;----- Scanning the user catalog -------------------
5322 "Return the syslib directory, or a dummy that never matches."
5326 idlwave-system-directory)
5332 "Scan all files on selected dirs of IDL search path for routine information.
5334 A widget checklist will allow you to choose the directories. Write
5335 the result as a file `idlwave-user-catalog-file'. When this file
5336 exists, will be automatically loaded to give routine information about
5337 library routines. With ARG, just rescan the same directories as last
5338 time - so no widget will pop up."
5340 ;; Make sure the file is loaded if it exists.
5346 ;; Make sure the file name makes sense
5352 idlwave-user-catalog-file))))
5356 ;; Rescan the known directories
5361 ;; Expand the directories from library-path and run the widget
5365 ;; Propagate any flags on the existing path-alist
5368 idlwave-true-path-alist)))
5375 ;; Ask the shell for the path and then run the widget
5384 ;; Parse shell path information and select among it.
5386 ;; Command hook used by `idlwave-create-user-catalog-file'.
5388 ;; Scan immediately
5390 ;; Set the path and display the widget
5396 "This is the front-end to the creation of the IDLWAVE user catalog.
5397 Please select the directories on IDL's search path from which you
5398 would like to extract routine information, to be stored in the file:
5400 %s
5402 If this is not the correct file, first set variable
5403 `idlwave-user-catalog-file', and call this command again.
5405 N.B. Many libraries include pre-scanned catalog files
5407 not be scanned. You can scan your own libraries off-line using the
5408 perl script `idlwave_catalog'.
5410 After selecting the directories, choose [Scan & Save] to scan the library
5411 directories and save the routine info.
5417 "Create the widget to select IDL search path directories for scanning."
5429 idlwave-user-catalog-file))
5440 :notify
5446 path-list)
5451 :notify
5456 path-list)
5470 'checklist
5474 dirs-list))
5475 :greedy t
5497 ;; Call `idlwave-scan-user-lib-files' with data taken from the widget.
5502 dir-entry)
5508 selected-dirs)
5515 ;; Scan the PRO files in PATH-ALIST and store the info in the user catalog
5519 dirs-alist dir files file)
5521 idlwave-path-alist path-alist ; for library-path instead
5522 idlwave-true-path-alist nil)
5544 idlwave-user-catalog-routines)))))))))
5552 font-lock-mode)
5558 ;; Define the routine info list
5565 idlwave-user-catalog-routines))
5569 ;; Save the buffer
5575 idlwave-user-catalog-file)
5593 font-lock-mode)
5598 ;; Define the variable which knows the value of "!DIR"
5600 idlwave-system-directory))
5602 ;; Define the variable which contains a list of all scanned directories
5609 idlwave-path-alist))
5616 ;; Expand parts of path starting with '+' recursively into directory list.
5617 ;; Relative recursive path elements are expanded relative to DEFAULT-DIR.
5627 ;; Expand recursively
5629 ;; Keep unchanged
5635 ;; Return a list of all directories below DIR, including DIR itself
5644 path1))
5647 ;;----- Scanning the library catalogs ------------------
5653 "Scan for library catalog files (.idlwave_catalog) and ingest.
5655 All directories on `idlwave-path-alist' (or `idlwave-library-path'
5656 instead, if present) are searched. Print MESSAGE-BASE along with the
5657 libraries being loaded, if passed, and skip loading/normalizing if
5658 NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
5659 be set to nil to disable library catalog scanning."
5666 dir-entry dir flags catalog all-routines)
5674 ;; Load the catalog file
5679 message-base
5681 old-libname)))
5683 idlwave-library-catalog-libname))
5690 all-routines))))
5692 ;; Add a 'lib flag if on path-alist
5699 ;;----- Communicating with the Shell -------------------
5701 ;; First, here is the idl program which can be used to query IDL for
5702 ;; defined routines.
5704 "
5705 ;; START OF IDLWAVE SUPPORT ROUTINES
5706 pro idlwave_print_safe,item,limit
5707 catch,err
5708 if err ne 0 then begin
5709 print,'Could not print item.'
5710 return
5711 endif
5712 if n_elements(item) gt limit then $
5713 print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $
5714 else print,item
5715 end
5717 pro idlwave_print_info_entry,name,func=func,separator=sep
5718 ;; See if it's an object method
5719 if name eq '' then return
5720 func = keyword_set(func)
5721 methsep = strpos(name,'::')
5722 meth = methsep ne -1
5724 ;; Get routine info
5725 pars = routine_info(name,/parameters,functions=func)
5726 source = routine_info(name,/source,functions=func)
5727 nargs = pars.num_args
5728 nkw = pars.num_kw_args
5729 if nargs gt 0 then args = pars.args
5730 if nkw gt 0 then kwargs = pars.kw_args
5732 ;; Trim the class, and make the name
5733 if meth then begin
5734 class = strmid(name,0,methsep)
5735 name = strmid(name,methsep+2,strlen(name)-1)
5736 if nargs gt 0 then begin
5737 ;; remove the self argument
5738 wh = where(args ne 'SELF',nargs)
5739 if nargs gt 0 then args = args[wh]
5740 endif
5741 endif else begin
5742 ;; No class, just a normal routine.
5744 endelse
5746 ;; Calling sequence
5748 if func then cs = 'Result = '
5749 if meth then cs = cs + 'Obj -> [' + '%s' + '::]'
5750 cs = cs + '%s'
5751 if func then cs = cs + '(' else if nargs gt 0 then cs = cs + ', '
5752 if nargs gt 0 then begin
5753 for j=0,nargs-1 do begin
5754 cs = cs + args[j]
5755 if j lt nargs-1 then cs = cs + ', '
5756 endfor
5757 end
5758 if func then cs = cs + ')'
5759 ;; Keyword arguments
5760 kwstring = ''
5761 if nkw gt 0 then begin
5762 for j=0,nkw-1 do begin
5763 kwstring = kwstring + ' ' + kwargs[j]
5764 endfor
5765 endif
5767 ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
5769 print,ret + ': ' + name + sep + class + sep + source[0].path $
5770 + sep + cs + sep + kwstring
5771 end
5773 pro idlwave_routine_info,file
5774 on_error,1
5775 sep = '<@>'
5777 all = routine_info()
5778 fileQ=n_elements(file) ne 0
5779 if fileQ then file=strtrim(file,2)
5780 for i=0L,n_elements(all)-1L do begin
5781 if fileQ then begin
5782 if (routine_info(all[i],/SOURCE)).path eq file then $
5783 idlwave_print_info_entry,all[i],separator=sep
5784 endif else idlwave_print_info_entry,all[i],separator=sep
5785 endfor
5786 all = routine_info(/functions)
5787 for i=0L,n_elements(all)-1L do begin
5788 if fileQ then begin
5789 if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $
5790 idlwave_print_info_entry,all[i],separator=sep,/FUNC
5791 endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC
5792 endfor
5793 print,'>>>END OF IDLWAVE ROUTINE INFO'
5794 end
5796 pro idlwave_get_sysvars
5797 on_error,1
5798 catch,error_status
5799 if error_status ne 0 then begin
5800 print, 'Cannot get info about system variables'
5801 endif else begin
5802 help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
5803 s = strtrim(strjoin(s,' ',/single),2) ; make one line
5804 v = strsplit(s,' +',/regex,/extract) ; get variables
5805 for i=0L,n_elements(v)-1 do begin
5806 t = [''] ; get tag list
5807 a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
5808 print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
5809 endfor
5810 endelse
5811 end
5813 pro idlwave_get_class_tags, class
5814 res = execute('tags=tag_names({'+class+'})')
5815 if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
5816 end
5817 ;; END OF IDLWAVE SUPPORT ROUTINES
5818 "
5840 (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
5845 ;; Restore if necessary. Must use execute to hide lame routine_info
5846 ;; errors on undefinded routine
5848 (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'"
5849 idlwave-shell-temp-rinfo-save-file
5850 idlwave-shell-temp-rinfo-save-file)
5855 "Query the shell for routine_info of compiled modules and update the lists."
5856 ;; Save and compile the procedure. The compiled procedure is then
5857 ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may
5858 ;; need to test for and possibly RESTORE the procedure each time we
5859 ;; use it, since the user may have killed or redefined it. In
5860 ;; particular, .RESET_SESSION will kill all user procedures. If
5861 ;; FILE is set, only update routine info for routines in that file.
5864 ; execute the routine_info procedure, and analyze the output
5872 ;; ---------------------------------------------------------------------------
5873 ;;
5874 ;; Completion and displaying routine calling sequences
5882 "Complete a function, procedure or keyword name at point.
5883 This function is smart and figures out what can be completed
5884 at this point.
5885 - At the beginning of a statement it completes procedure names.
5886 - In the middle of a statement it completes function names.
5887 - after a `(' or `,' in the argument list of a function or procedure,
5888 it completes a keyword of the relevant function or procedure.
5889 - In the first arg of `OBJ_NEW', it completes a class name.
5891 When several completions are possible, a list will be displayed in the
5892 *Completions* buffer. If this list is too long to fit into the
5893 window, scrolling can be achieved by repeatedly pressing
5896 The function also knows about object methods. When it needs a class
5897 name, the action depends upon `idlwave-query-class', which see. You
5898 can force IDLWAVE to ask you for a class name with a
5901 See also the variables `idlwave-keyword-completion-adds-equal' and
5902 `idlwave-function-completion-adds-paren'.
5904 The optional ARG can be used to specify the completion type in order
5905 to override IDLWAVE's idea of what should be completed at point.
5906 Possible values are:
5908 0 <=> query for the completion type
5909 1 <=> 'procedure
5910 2 <=> 'procedure-keyword
5911 3 <=> 'function
5912 4 <=> 'function-keyword
5913 5 <=> 'procedure-method
5914 6 <=> 'procedure-method-keyword
5915 7 <=> 'function-method
5916 8 <=> 'function-method-keyword
5917 9 <=> 'class
5919 As a special case, the universal argument C-u forces completion of
5920 function names in places where the default would be a keyword.
5922 Two prefix argument, C-u C-u, prompts for a regexp by which to limit
5923 completion.
5925 For Lisp programmers only:
5926 When we force a keyword, optional argument MODULE can contain the module name.
5927 When we force a method or a method keyword, CLASS can specify the class."
5954 ;; Complete a filename in quotes
5959 ;; Check for any special completion functions
5966 ;; Complete a class
5972 ;; Complete a procedure name
5985 isa
5991 isa
5995 ;; Complete a function name
6008 isa
6014 isa
6022 ;; Complete a procedure keyword
6039 super-classes system))
6051 isa
6055 ;; Complete a function keyword
6068 msg-name)
6073 super-classes system))
6074 ;; OBJ_NEW: Messages mention the proper Init method
6081 msg-name))
6090 isa
6096 "List of special completion functions.
6097 These functions are called for each completion. Each function must
6098 check if its own special completion context is present. If yes, it
6099 should use `idlwave-complete-in-buffer' to do some completion and
6100 return t. If such a function returns t, *no further* attempts to
6101 complete other contexts will be done. If the function returns nil,
6106 fun ret)
6111 nil)))
6114 ;; Return an artificial WHERE specification to force the completion
6115 ;; routine to complete a specific item independent of context.
6116 ;; WHAT is the prefix arg of `idlwave-complete', see there for details.
6117 ;; MODULE and CLASS can be used to specify the routine name and class.
6118 ;; The class name will also be found in MODULE if that is like "class::mod".
6136 what)
6209 ;; Completing read, case insensitive
6219 "Use the comint stuff to complete a file name."
6227 idlwave-shell-default-directory
6228 default-directory)))
6232 ;; Make a fully qualified module name including the class name
6236 "Like `idlwave-rinfo-assq', but sintern strings first."
6242 ;; Works like assq, but also checks type and class
6253 ;; Return the first matching method on the inheritance list
6255 class rtn)
6259 rtn))
6262 keep-system)
6263 "Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
6264 If WITH-FILE is passed, find the best rinfo entry with a file
6265 included. If KEEP-SYSTEM is set, don't prune system for compiled
6266 syslib files."
6269 list))
6270 syslibp)
6277 ;; Its a compiled syslib, so we need to remove the system entry
6283 twins)))))
6287 keep-system)
6288 "Like `idlwave-best-rinfo-assq', but sintern strings first."
6294 "Does the entry list ENTRIES contain a syslib entry?
6295 If yes, return the index (>=1)."
6304 nil)))
6307 "Return a list of all associations of Key in LIST."
6315 "Return all classes which have a method METHOD. TYPE is 'fun or 'pro.
6316 When TYPE is not specified, both procedures and functions will be considered."
6329 "Return all classes which have a method METHOD with keyword KEYWORD.
6330 TYPE is 'fun or 'pro.
6331 When TYPE is not specified, both procedures and functions will be considered."
6334 nil
6346 "Return list of all elements in LIST which are also in CLUB."
6355 "Return list of all elements in LIST which are not in CLUB."
6359 nil
6365 "Return whether or not the class is listed explicitly, ala a->b::c.
6366 INFO is as returned by idlwave-what-function or -procedure."
6373 "List of special functions for determining class.
6377 ;; Determine the class of a routine call.
6378 ;; INFO is the `cw-list' structure as returned by idlwave-where.
6379 ;; The second element in this structure is the class. When nil, we
6380 ;; return nil. When t, try to get the class from text properties at
6381 ;; the arrow. When the object is "self", we use the class of the
6382 ;; current routine. otherwise prompt the user for a class name.
6383 ;; Also stores the selected class as a text property at the arrow.
6384 ;; TYPE is 'fun or 'pro.
6390 idlwave-query-class))
6392 idlwave-query-class))
6404 store special-class class-alist)
6408 ;; There is an object which would like to know its class
6410 idlwave-store-inquired-class
6417 ;; Before prompting, try any special class determination routines
6419 idlwave-determine-class-special
6425 store idlwave-store-inquired-class)))
6427 ;; Prompt for a class, if we need to
6448 ;; Store it, if requested
6450 ;; We have a real class here
6456 rear-nonsticky t))
6459 ;; Return the class
6460 class)
6461 ;; Default as fallback
6475 ;; Record a file link, if any, for the tested names during selection.
6479 sel))
6483 "Find out where we are.
6484 The return value is a list with the following stuff:
6485 \(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
6487 PRO-LIST (PRO POINT CLASS ARROW)
6488 FUNC-LIST (FUNC POINT CLASS ARROW)
6489 COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
6490 CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
6491 be completed here.
6492 LAST-CHAR last relevant character before point (non-white non-comment,
6493 not part of current identifier or leading slash).
6495 In the lists, we have these meanings:
6496 PRO: Procedure name
6497 FUNC: Function name
6498 POINT: Where is this
6499 CLASS: What class has the routine (nil=no, t=is method, but class unknown)
6500 ARROW: Location of the arrow"
6518 cw cw-mod cw-arrow cw-class cw-point)
6522 match-string)
6528 match-string))
6530 cw-arrow pro-arrow))
6532 match-string)
6533 nil)
6535 match-string)
6538 match-string)
6545 cw-class func-class cw-arrow func-arrow))
6548 cw-class pro-class cw-arrow pro-arrow))
6549 ; ((member last-char '(?\' ?\) ?\] ?!))
6550 ; ;; after these chars, a function makes no sense
6551 ; ;; FIXME: I am sure there can be more in this list
6552 ; ;; FIXME: Do we want to do this at all?
6553 ; nil)
6554 ;; Everywhere else we try a function.
6558 (if (re-search-backward "->[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\s-*\\)?\\(\\([$a-zA-Z0-9_]+\\)::\\)?[$a-zA-Z0-9_]*\\=" bos t)
6562 t))))))
6565 cw
6567 last-char)))
6570 ;; Grab the word around point. CLASS is for the `skip-chars=...' functions
6578 ;; Find out if point is within the argument list of a function.
6579 ;; The return value is ("function-name" class arrow-start (point) level).
6580 ;; Level is 1 on the top level parentheses, higher further down.
6582 ;; If the optional BOUND is an integer, bound backwards directed
6583 ;; searches to this point.
6587 func-point
6589 func arrow-start class)
6594 ;; move back out of the current parenthesis
6603 bound t))
6606 pos func-point)
6612 'exit
6616 arrow-start func-point cnt)))
6621 ;; Find out if point is within the argument list of a procedure.
6622 ;; The return value is ("procedure-name" class arrow-pos (point)).
6624 ;; If the optional BOUND is an integer, bound backwards directed
6625 ;; searches to this point.
6627 pro class arrow-start string)
6629 ;;(idlwave-beginning-of-statement)
6639 "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
6640 string))
6645 pos)
6650 arrow-start
6651 pro-point)))
6654 ;; If there is an object at point, move over it and return t.
6664 nil)
6682 nil)))
6685 "Return the last character before point which is not white or a comment
6686 and also not part of the current identifier. Since we do this in
6687 order to identify places where keywords are, we consider the initial
6688 `/' of a keyword as part of the identifier.
6689 This function is not general, can only be used for completion stuff."
6692 ;; skip the current identifier
6694 ;; also skip a leading slash which might be belong to the keyword
6697 ;; FIXME: does not check if this is a valid identifier
6705 ;; continuation line
6718 &optional prepare-display-function
6719 special-selector)
6720 "Perform TYPE completion of word before point against LIST.
6721 SELECTOR is the PREDICATE argument for the completion function. Show
6722 PROMPT in echo area. TYPE is one of the intern types, e.g. 'function,
6723 'procedure, 'class-tag, 'keyword, 'sysvar, etc.. SPECIAL-SELECTOR is
6724 used only once, for `all-completions', and can be used to, e.g.,
6725 accumulate information on matching completions."
6728 dpart dcompletion)
6733 ;; What is already in the buffer?
6738 idlwave-complete-after-success-form
6741 idlwave-complete-after-success-form-force
6745 ;; Try a completion
6751 idlwave-completion-help-links nil)
6754 ;; nothing available.
6758 ;; We can add something
6762 idlwave-complete-empty-string-as-lower-case)
6767 ;; Now this is a unique match
6769 t)
6775 selector))))))
6777 ;; This is already complete
6780 nil)
6782 ;; We cannot add something - offer a list.
6790 idlwave-completion-help-links))))
6791 list))
6793 ;; "complete" means, this is already a valid completion
6796 ; (completion-fixup-function ; Emacs
6797 ; (lambda () (and (eq (preceding-char) ?>)
6798 ; (re-search-backward " <" beg t)))))
6806 idlwave-complete-empty-string-as-lower-case)
6812 x)
6813 list)))
6815 t))))
6818 "Complete a class at point."
6820 ;; Call `idlwave-routines' to make sure the class list will be available
6822 ;; Check for the special case of completing empty string after pro/function
6831 ;; Yank the full class specification
6833 ;; Do the completion, using list gathered from `idlwave-routines'
6842 idlwave-completion-help-links))
6843 x))
6844 list)))))
6847 ;; Attach the proper class list to a LIST of completion items.
6848 ;; TYPE, when 'kwd, shows classes for method keywords, when
6849 ;; 'class-tag, for class tags, and otherwise for methods.
6850 ;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
6856 ;; In these cases, we do not have to do anything
6857 list
6861 ;; (do-dots (featurep 'xemacs))
6867 classes nclasses class-info space)
6870 ;; get the classes
6872 ;; Just one class for tags
6876 ;; Multiple classes for method or method-keyword
6880 method-selector x type-selector)
6886 classes)))))
6888 ;; Make the separator between item and class-info
6893 ;; We do want info in the buffer
6896 space
6901 ;; We do want properties
6905 x))
6908 x))
6909 list))))
6912 ;; Call idlwave-attach-classes with method parameters
6915 ;; Call idlwave-attach-classes with keyword parameters
6918 ;; Call idlwave-attach-classes with class structure tags
6922 ;;----------------------------------------------------------------------
6923 ;;----------------------------------------------------------------------
6924 ;;----------------------------------------------------------------------
6925 ;;----------------------------------------------------------------------
6926 ;;----------------------------------------------------------------------
6932 "Select an item in LIST with a popup menu.
6933 TITLE is the title to put atop the popup. If SORT is non-nil,
6934 sort the list before displaying"
6936 rtn menu resp)
6946 x)))
6947 list)))
6960 rtn))
6963 "Split the MENU into submenus of maximum length N."
6965 ;; No splitting needed
6966 menu
6981 nextmenu))
6983 nextmenu nil
6988 "Split the MENU into submenus of maximum length N."
6990 ;; No splitting needed
6991 menu
7007 nextmenu))
7009 nextmenu nil
7013 menu)))
7018 "Scroll the completion window on this frame."
7036 "Display the completions in LIST in the completions buffer and echo MESSAGE."
7044 list)
7047 ;; Store a special value in `this-command'. When `idlwave-complete'
7048 ;; finds this in `last-command', it will scroll the *Completions* buffer.
7051 ;; Mark the completions buffer as created by cib
7054 ;; Fontify the classes
7059 ;; Run the hook
7062 ;; Display the message
7066 "Call FUNCTION as a completion chooser and pass ARGS to it."
7072 ;; For the shell, remove the fontification of the word before point
7087 "Restore the old (before completion) window configuration."
7089 idlwave-before-completion-wconf
7093 "Make the user select an element from the alist in the variable SYM.
7094 The keys of the alist are expected to be strings. The function returns the
7095 car of the selected association.
7096 To do this, PROMPT is displayed and and the user must hit a letter key to
7097 select an entry. If the user does not reply within DELAY seconds, a help
7098 window with the options is displayed automatically.
7099 The key which is associated with each option is generated automatically.
7101 If these don't exist, a letter in the string is automatically selected."
7105 keys-alist char)
7106 ;; First check the cache
7109 ;; Need to make new list
7113 ;; Display prompt and wait for quick reply
7118 ;; No quick reply: Show help
7124 keys-alist))
7128 ;; Return the selected result
7131 ;; Used for, e.g., electric debug super-examine.
7133 "Make an alist for single key selection."
7141 ;; First check if the configuration predetermined a key
7148 ;; Then check for capital letters
7158 t t name))
7161 ;; Now check for lowercase letters
7171 t t name))
7174 ;; Bummer, nothing found! Use a stupid number
7181 "Set the buffer-local value of VAR in BUFFER to VALUE."
7187 "Return the value of VAR in BUFFER, but only if VAR is local to BUFFER."
7193 ;; In XEmacs, we can use :activate-callback directly to advice the
7194 ;; choose functions. We use the private keymap only for the online
7195 ;; help feature.
7204 cl-args))
7214 "Execute `default-choose-completion' and then restore the win-conf."
7218 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7221 (define-key new-map [button3] (lambda ()
7222 (interactive)
7223 (setq this-command last-command)))
7224 new-map))
7226 ;; In Emacs we also replace keybindings in the completion
7227 ;; map in order to install our wrappers.
7229 (defun idlwave-display-completion-list-emacs (list)
7230 "Display completion list and install the choose wrappers."
7231 (with-output-to-temp-buffer "*Completions*"
7232 (display-completion-list list))
7233 (save-excursion
7234 (set-buffer "*Completions*")
7235 (use-local-map
7236 (or idlwave-completion-map
7237 (setq idlwave-completion-map
7238 (idlwave-make-modified-completion-map-emacs
7239 (current-local-map)))))))
7241 (defun idlwave-make-modified-completion-map-emacs (old-map)
7242 "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
7243 (let ((new-map (copy-keymap old-map)))
7244 (substitute-key-definition
7245 'choose-completion 'idlwave-choose-completion new-map)
7246 (substitute-key-definition
7247 'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
7248 (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
7249 new-map))
7251 (defun idlwave-choose-completion (&rest args)
7252 "Choose the completion that point is in or next to."
7253 (interactive)
7254 (apply 'idlwave-choose 'choose-completion args))
7256 (defun idlwave-mouse-choose-completion (&rest args)
7257 "Click on an alternative in the `*Completions*' buffer to choose it."
7258 (interactive "e")
7259 (apply 'idlwave-choose 'mouse-choose-completion args))
7261 ;;----------------------------------------------------------------------
7262 ;;----------------------------------------------------------------------
7264 ;;; ------------------------------------------------------------------------
7265 ;;; Stucture parsing code, and code to manage class info
7267 ;;
7268 ;; - Go again over the documentation how to write a completion
7269 ;; plugin. It is in self.el, but currently still very bad.
7270 ;; This could be in a separate file in the distribution, or
7271 ;; in an appendix for the manual.
7273 (defvar idlwave-struct-skip
7275 "Regexp for skipping continued blank or comment-only lines in
7276 structures")
7278 (defvar idlwave-struct-tag-regexp
7279 (concat "[{,]" ;leading comma/brace
7280 idlwave-struct-skip ; 4 groups
7283 "Regexp for structure tags.")
7285 (defun idlwave-struct-tags ()
7286 "Return a list of all tags in the structure defined at point.
7287 Point is expected just before the opening `{' of the struct definition."
7288 (save-excursion
7289 (let* ((borders (idlwave-struct-borders))
7290 (beg (car borders))
7291 (end (cdr borders))
7292 tags)
7293 (goto-char beg)
7294 (save-restriction
7295 (narrow-to-region beg end)
7296 (while (re-search-forward idlwave-struct-tag-regexp end t)
7297 ;; Check if we are still on the top level of the structure.
7298 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7299 (= (point) beg))
7300 (push (match-string-no-properties 5) tags))
7301 (goto-char (match-end 0))))
7302 (nreverse tags))))
7304 (defun idlwave-find-struct-tag (tag)
7305 "Find a given TAG in the structure defined at point."
7306 (let* ((borders (idlwave-struct-borders))
7307 (beg (car borders))
7308 (end (cdr borders))
7309 (case-fold-search t))
7311 end t)))
7313 (defun idlwave-struct-inherits ()
7314 "Return a list of all `inherits' names in the struct at point.
7315 Point is expected just before the opening `{' of the struct definition."
7316 (save-excursion
7317 (let* ((borders (idlwave-struct-borders))
7318 (beg (car borders))
7319 (end (cdr borders))
7320 (case-fold-search t)
7321 names)
7322 (goto-char beg)
7323 (save-restriction
7324 (narrow-to-region beg end)
7325 (while (re-search-forward
7326 (concat "[{,]" ;leading comma/brace
7327 idlwave-struct-skip ; 4 groups
7328 "inherits" ; The INHERITS tag
7329 idlwave-struct-skip ; 4 more
7331 end t)
7332 ;; Check if we are still on the top level of the structure.
7333 (if (and (condition-case nil (progn (up-list -1) t) (error nil))
7334 (= (point) beg))
7335 (push (match-string-no-properties 9) names))
7336 (goto-char (match-end 0))))
7337 (nreverse names))))
7339 (defun idlwave-in-structure ()
7340 "Return t if point is inside an IDL structure definition."
7341 (let ((beg (point)))
7342 (save-excursion
7343 (if (not (or (idlwave-in-comment) (idlwave-in-quote)))
7344 (if (idlwave-find-structure-definition nil nil 'back)
7345 (let ((borders (idlwave-struct-borders)))
7346 (or (= (car borders) (cdr borders)) ;; struct not yet closed...
7347 (and (> beg (car borders)) (< beg (cdr borders))))))))))
7349 (defun idlwave-struct-borders ()
7350 "Return the borders of the {...} after point as a cons cell."
7351 (let (beg)
7352 (save-excursion
7353 (skip-chars-forward "^{")
7354 (setq beg (point))
7355 (condition-case nil (forward-list 1)
7356 (error (goto-char beg)))
7357 (cons beg (point)))))
7359 (defun idlwave-find-structure-definition (&optional var name bound)
7360 "Search forward for a structure definition. If VAR is non-nil,
7361 search for a structure assigned to variable VAR. If NAME is non-nil,
7362 search for a named structure NAME, if a string, or a generic named
7363 structure otherwise. If BOUND is an integer, limit the search. If
7364 BOUND is the symbol `all', we search first back and then forward
7365 through the entire file. If BOUND is the symbol `back' we search only
7366 backward."
7368 (case-fold-search t)
7369 (lim (if (integerp bound) bound nil))
7370 (re (concat
7371 (if var
7375 (if name
7376 (if (stringp name)
7378 ;; Just a generic name
7380 ""))))
7381 (if (or (and (or (eq bound 'all) (eq bound 'back))
7382 (re-search-backward re nil t))
7383 (and (not (eq bound 'back)) (re-search-forward re lim t)))
7384 (progn
7385 (goto-char (match-beginning 3))
7386 (match-string-no-properties 5)))))
7388 (defvar idlwave-class-info nil)
7389 (defvar idlwave-class-reset nil) ; to reset buffer-local classes
7391 (add-hook 'idlwave-update-rinfo-hook
7392 (lambda () (setq idlwave-class-reset t)))
7393 (add-hook 'idlwave-after-load-rinfo-hook
7394 (lambda () (setq idlwave-class-info nil)))
7396 (defun idlwave-class-info (class)
7397 (let (list entry)
7398 (if idlwave-class-info
7399 (if idlwave-class-reset
7400 (setq
7401 idlwave-class-reset nil
7402 idlwave-class-info ; Remove any visited in a buffer
7403 (delq nil (mapcar
7404 (lambda (x)
7405 (let ((filebuf
7406 (idlwave-class-file-or-buffer
7407 (or (cdr (assq 'found-in x)) (car x)))))
7408 (if (cdr filebuf)
7409 nil
7410 x)))
7411 idlwave-class-info))))
7412 ;; Info is nil, put in the system stuff to start.
7413 (setq idlwave-class-info idlwave-system-class-info)
7414 (setq list idlwave-class-info)
7415 (while (setq entry (pop list))
7416 (idlwave-sintern-class-info entry)))
7417 (setq class (idlwave-sintern-class class))
7418 (or (assq class idlwave-class-info)
7419 (progn (idlwave-scan-class-info class)
7420 (assq class idlwave-class-info)))))
7422 (defun idlwave-sintern-class-info (entry)
7423 "Sintern the class names in a class-info entry."
7424 (let ((taglist (assq 'tags entry))
7425 (inherits (assq 'inherits entry)))
7426 (setcar entry (idlwave-sintern-class (car entry) 'set))
7427 (if inherits
7428 (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
7429 (cdr inherits))))))
7431 (defun idlwave-find-class-definition (class &optional all-hook alt-class)
7432 "Find class structure definition(s)
7433 If ALL-HOOK is set, find all named structure definitions in a given
7434 class__define routine, on which ALL-HOOK will be run. If ALT-CLASS is
7435 set, look for the name__define pro, and inside of it, for the ALT-CLASS
7436 class/struct definition"
7437 (let ((case-fold-search t) end-lim list name)
7438 (when (re-search-forward
7440 (if all-hook
7441 (progn
7442 ;; For everything there
7443 (setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
7444 (while (setq name
7445 (idlwave-find-structure-definition nil t end-lim))
7446 (funcall all-hook name)))
7447 (idlwave-find-structure-definition nil (or alt-class class))))))
7450 (defun idlwave-class-file-or-buffer (class)
7451 "Find buffer visiting CLASS definition"
7452 (let* ((pro (concat (downcase class) "__define"))
7453 (file (idlwave-routine-source-file
7454 (nth 3 (idlwave-rinfo-assoc pro 'pro nil
7455 (idlwave-routines))))))
7456 (cons file (if file (idlwave-get-buffer-visiting file)))))
7459 (defun idlwave-scan-class-info (class)
7460 "Scan all class and named structure info in the class__define pro"
7461 (let* ((idlwave-auto-routine-info-updates nil)
7462 (filebuf (idlwave-class-file-or-buffer class))
7463 (file (car filebuf))
7464 (buf (cdr filebuf))
7465 (class (idlwave-sintern-class class)))
7466 (if (or
7467 (not file)
7468 (and ;; neither a regular file nor a visited buffer
7469 (not buf)
7470 (not (file-regular-p file))))
7471 nil ; Cannot find the file/buffer to get any info
7472 (save-excursion
7473 (if buf (set-buffer buf)
7474 ;; Read the file in temporarily
7475 (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
7476 (erase-buffer)
7477 (unless (eq major-mode 'idlwave-mode)
7478 (idlwave-mode))
7479 (insert-file-contents file))
7480 (save-excursion
7481 (goto-char 1)
7482 (idlwave-find-class-definition class
7483 ;; Scan all of the structures found there
7484 (lambda (name)
7485 (let* ((this-class (idlwave-sintern-class name))
7486 (entry
7487 (list this-class
7488 (cons 'tags (idlwave-struct-tags))
7489 (cons 'inherits (idlwave-struct-inherits)))))
7490 (if (not (eq this-class class))
7491 (setq entry (nconc entry (list (cons 'found-in class)))))
7492 (idlwave-sintern-class-info entry)
7493 (push entry idlwave-class-info)))))))))
7495 (defun idlwave-class-found-in (class)
7496 "Return the FOUND-IN property of the class."
7497 (cdr (assq 'found-in (idlwave-class-info class))))
7498 (defun idlwave-class-tags (class)
7499 "Return the native tags in CLASS."
7500 (cdr (assq 'tags (idlwave-class-info class))))
7501 (defun idlwave-class-inherits (class)
7502 "Return the direct superclasses of CLASS."
7503 (cdr (assq 'inherits (idlwave-class-info class))))
7506 (defun idlwave-all-class-tags (class)
7507 "Return a list of native and inherited tags in CLASS."
7508 (condition-case err
7509 (apply 'append (mapcar 'idlwave-class-tags
7510 (cons class (idlwave-all-class-inherits class))))
7511 (error
7512 (idlwave-class-tag-reset)
7513 (error "%s" (error-message-string err)))))
7516 (defun idlwave-all-class-inherits (class)
7517 "Return a list of all superclasses of CLASS (recursively expanded).
7518 The list is cached in `idlwave-class-info' for faster access."
7519 (cond
7520 ((not idlwave-support-inheritance) nil)
7521 ((eq class nil) nil)
7522 ((eq class t) nil)
7523 (t
7524 (let ((info (idlwave-class-info class))
7525 entry)
7526 (if (setq entry (assq 'all-inherits info))
7527 (cdr entry)
7528 ;; Save the depth of inheritance scan to check for circular references
7529 (let ((inherits (mapcar (lambda (x) (cons x 0))
7530 (idlwave-class-inherits class)))
7531 rtn all-inherits cl)
7532 (while inherits
7533 (setq cl (pop inherits)
7534 rtn (cons (car cl) rtn)
7535 inherits (append (mapcar (lambda (x)
7536 (cons x (1+ (cdr cl))))
7537 (idlwave-class-inherits (car cl)))
7538 inherits))
7539 (if (> (cdr cl) 999)
7540 (error
7541 "Class scan: inheritance depth exceeded. Circular inheritance?")
7542 ))
7543 (setq all-inherits (nreverse rtn))
7544 (nconc info (list (cons 'all-inherits all-inherits)))
7545 all-inherits))))))
7547 (defun idlwave-entry-keywords (entry &optional record-link)
7548 "Return the flat entry keywords alist from routine-info entry.
7549 If RECORD-LINK is non-nil, the keyword text is copied and a text
7550 property indicating the link is added."
7551 (let (kwds)
7552 (mapcar
7553 (lambda (key-list)
7554 (let ((file (car key-list)))
7555 (mapcar (lambda (key-cons)
7556 (let ((key (car key-cons))
7557 (link (cdr key-cons)))
7558 (when (and record-link file)
7559 (setq key (copy-sequence key))
7560 (put-text-property
7561 0 (length key)
7562 'link
7563 (concat
7564 file
7565 (if link
7566 (concat idlwave-html-link-sep
7567 (number-to-string link))))
7568 key))
7569 (push (list key) kwds)))
7570 (cdr key-list))))
7571 (nthcdr 5 entry))
7572 (nreverse kwds)))
7574 (defun idlwave-entry-find-keyword (entry keyword)
7575 "Find keyword KEYWORD in entry ENTRY, and return (with link) if set"
7576 (catch 'exit
7577 (mapc
7578 (lambda (key-list)
7579 (let ((file (car key-list))
7580 (kwd (assoc keyword (cdr key-list))))
7581 (when kwd
7582 (setq kwd (cons (car kwd)
7583 (if (and file (cdr kwd))
7584 (concat file
7585 idlwave-html-link-sep
7586 (number-to-string (cdr kwd)))
7587 (cdr kwd))))
7588 (throw 'exit kwd))))
7589 (nthcdr 5 entry))))
7591 ;;==========================================================================
7592 ;;
7593 ;; Completing class structure tags. This is a completion plugin.
7594 ;; The necessary taglist is constructed dynamically
7596 (defvar idlwave-current-tags-class nil)
7597 (defvar idlwave-current-class-tags nil)
7598 (defvar idlwave-current-native-class-tags nil)
7599 (defvar idlwave-sint-class-tags nil)
7600 (idlwave-new-sintern-type 'class-tag)
7601 (add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
7602 (add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
7604 (defun idlwave-complete-class-structure-tag ()
7605 "Complete a structure tag on a `self' argument in an object method."
7606 (interactive)
7607 (let ((pos (point))
7608 (case-fold-search t))
7609 (if (save-excursion
7610 ;; Check if the context is right
7611 (skip-chars-backward "a-zA-Z0-9._$")
7612 (and (< (point) (- pos 4))
7614 (let* ((class-selector (nth 2 (idlwave-current-routine)))
7615 (super-classes (idlwave-all-class-inherits class-selector)))
7616 ;; Check if we are in a class routine
7617 (unless class-selector
7618 (error "Not in a method procedure or function"))
7619 ;; Check if we need to update the "current" class
7620 (if (not (equal class-selector idlwave-current-tags-class))
7621 (idlwave-prepare-class-tag-completion class-selector))
7622 (setq idlwave-completion-help-info
7623 (list 'idlwave-complete-class-structure-tag-help
7624 (idlwave-sintern-routine
7625 (concat class-selector "__define"))
7626 nil))
7627 (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
7628 (idlwave-complete-in-buffer
7629 'class-tag 'class-tag
7630 idlwave-current-class-tags nil
7631 (format "Select a tag of class %s" class-selector)
7632 "class tag"
7633 'idlwave-attach-class-tag-classes))
7634 t) ; return t to skip other completions
7635 nil)))
7637 (defun idlwave-class-tag-reset ()
7638 (setq idlwave-current-tags-class nil))
7640 (defun idlwave-prepare-class-tag-completion (class)
7641 "Find and parse the necessary class definitions for class structure tags."
7642 (setq idlwave-sint-class-tags nil)
7643 (setq idlwave-current-tags-class class)
7644 (setq idlwave-current-class-tags
7645 (mapcar (lambda (x)
7646 (list (idlwave-sintern-class-tag x 'set)))
7647 (idlwave-all-class-tags class)))
7648 (setq idlwave-current-native-class-tags
7649 (mapcar 'downcase (idlwave-class-tags class))))
7651 ;===========================================================================
7652 ;;
7653 ;; Completing system variables and their structure fields
7654 ;; This is also a plugin.
7656 (defvar idlwave-sint-sysvars nil)
7657 (defvar idlwave-sint-sysvartags nil)
7658 (idlwave-new-sintern-type 'sysvar)
7659 (idlwave-new-sintern-type 'sysvartag)
7660 (add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
7661 (add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
7662 (add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
7665 (defun idlwave-complete-sysvar-or-tag ()
7666 "Complete a system variable."
7667 (interactive)
7668 (let ((pos (point))
7669 (case-fold-search t))
7670 (cond ((save-excursion
7671 ;; Check if the context is right for system variable
7672 (skip-chars-backward "[a-zA-Z0-9_$]")
7673 (equal (char-before) ?!))
7674 (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
7675 (idlwave-complete-in-buffer 'sysvar 'sysvar
7676 idlwave-system-variables-alist nil
7677 "Select a system variable"
7678 "system variable")
7679 t) ; return t to skip other completions
7680 ((save-excursion
7681 ;; Check if the context is right for sysvar tag
7682 (skip-chars-backward "a-zA-Z0-9_$.")
7683 (and (equal (char-before) ?!)
7685 (<= (match-end 0) pos)))
7686 ;; Complete a system variable tag
7687 (let* ((var (idlwave-sintern-sysvar (match-string 1)))
7688 (entry (assq var idlwave-system-variables-alist))
7689 (tags (cdr (assq 'tags entry))))
7690 (or entry (error "!%s is not a known system variable" var))
7691 (or tags (error "System variable !%s is not a structure" var))
7692 (setq idlwave-completion-help-info
7693 (list 'idlwave-complete-sysvar-tag-help var))
7694 (idlwave-complete-in-buffer 'sysvartag 'sysvartag
7695 tags nil
7696 "Select a system variable tag"
7697 "system variable tag")
7698 t)) ; return t to skip other completions
7699 (t nil))))
7701 (defvar link) ;dynamic variables set by help callback
7702 (defvar props)
7703 (defun idlwave-complete-sysvar-help (mode word)
7704 (let ((word (or (nth 1 idlwave-completion-help-info) word))
7705 (entry (assoc word idlwave-system-variables-alist)))
7706 (cond
7707 ((eq mode 'test)
7708 (and (stringp word) entry (nth 1 (assq 'link entry))))
7709 ((eq mode 'set)
7710 (if entry (setq link (nth 1 (assq 'link entry))))) ;; setting dynamic!!!
7711 (t (error "This should not happen")))))
7713 (defun idlwave-complete-sysvar-tag-help (mode word)
7714 (let* ((var (nth 1 idlwave-completion-help-info))
7715 (entry (assoc var idlwave-system-variables-alist))
7716 (tags (cdr (assq 'tags entry)))
7717 (main (nth 1 (assq 'link entry)))
7718 target main-base)
7719 (cond
7720 ((eq mode 'test) ; we can at least link the main
7721 (and (stringp word) entry main))
7722 ((eq mode 'set)
7723 (if entry
7724 (setq link
7725 (if (setq target (cdr (assoc-string word tags t)))
7726 (idlwave-substitute-link-target main target)
7727 main)))) ;; setting dynamic!!!
7728 (t (error "This should not happen")))))
7730 (defun idlwave-split-link-target (link)
7731 "Split a given link into link file and anchor."
7732 (if (string-match idlwave-html-link-sep link)
7733 (cons (substring link 0 (match-beginning 0))
7734 (string-to-number (substring link (match-end 0))))))
7736 (defun idlwave-substitute-link-target (link target)
7737 "Substitute the target anchor for the given link."
7738 (let (main-base)
7739 (setq main-base (if (string-match "#" link)
7740 (substring link 0 (match-beginning 0))
7741 link))
7742 (if target
7743 (concat main-base idlwave-html-link-sep (number-to-string target))
7744 link)))
7746 ;; Fake help in the source buffer for class structure tags.
7747 ;; KWD AND NAME ARE GLOBAL-VARIABLES HERE.
7748 (defvar name)
7749 (defvar kwd)
7750 (defvar idlwave-help-do-class-struct-tag nil)
7751 (defun idlwave-complete-class-structure-tag-help (mode word)
7752 (cond
7753 ((eq mode 'test) ; nothing gets fontified for class tags
7754 nil)
7755 ((eq mode 'set)
7756 (let (class-with found-in)
7757 (when (setq class-with
7758 (idlwave-class-or-superclass-with-tag
7759 idlwave-current-tags-class
7760 word))
7761 (if (assq (idlwave-sintern-class class-with)
7762 idlwave-system-class-info)
7763 (error "No help available for system class tags"))
7764 (if (setq found-in (idlwave-class-found-in class-with))
7765 (setq name (cons (concat found-in "__define") class-with))
7766 (setq name (concat class-with "__define")))))
7767 (setq kwd word
7768 idlwave-help-do-class-struct-tag t))
7769 (t (error "This should not happen"))))
7771 (defun idlwave-class-or-superclass-with-tag (class tag)
7772 "Find and return the CLASS or one of its superclass with the
7773 associated TAG, if any."
7774 (let ((sclasses (cons class (idlwave-all-class-inherits class)))
7775 cl)
7776 (catch 'exit
7777 (while sclasses
7778 (setq cl (pop sclasses))
7779 (let ((tags (idlwave-class-tags cl)))
7780 (while tags
7781 (if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
7782 (throw 'exit cl))
7783 (setq tags (cdr tags))))))))
7786 (defun idlwave-sysvars-reset ()
7787 (if (and (fboundp 'idlwave-shell-is-running)
7788 (idlwave-shell-is-running)
7789 idlwave-idlwave_routine_info-compiled)
7790 (idlwave-shell-send-command "idlwave_get_sysvars"
7791 'idlwave-process-sysvars 'hide)))
7793 (defun idlwave-process-sysvars ()
7794 (idlwave-shell-filter-sysvars)
7795 (setq idlwave-sint-sysvars nil
7796 idlwave-sint-sysvartags nil)
7797 (idlwave-sintern-sysvar-alist))
7799 (defun idlwave-sintern-sysvar-alist ()
7800 (let ((list idlwave-system-variables-alist) entry tags)
7801 (while (setq entry (pop list))
7802 (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
7803 (setq tags (assq 'tags entry))
7804 (if tags
7805 (setcdr tags
7806 (mapcar (lambda (x)
7807 (cons (idlwave-sintern-sysvartag (car x) 'set)
7808 (cdr x)))
7809 (cdr tags)))))))
7811 (defvar idlwave-shell-command-output)
7812 (defun idlwave-shell-filter-sysvars ()
7813 "Get any new system variables and tags."
7814 (let ((text idlwave-shell-command-output)
7815 (start 0)
7816 (old idlwave-system-variables-alist)
7817 var tags type name class link old-entry)
7818 (setq idlwave-system-variables-alist nil)
7820 text start)
7821 (setq start (match-end 0)
7822 var (match-string 1 text)
7823 tags (if (match-end 3)
7824 (idlwave-split-string (match-string 3 text))))
7825 ;; Maintain old links, if present
7826 (setq old-entry (assq (idlwave-sintern-sysvar var) old))
7827 (setq link (assq 'link old-entry))
7828 (setq idlwave-system-variables-alist
7829 (cons (list var
7830 (cons
7831 'tags
7832 (mapcar (lambda (x)
7833 (cons x
7834 (cdr (assq
7835 (idlwave-sintern-sysvartag x)
7836 (cdr (assq 'tags old-entry))))))
7837 tags)) link)
7838 idlwave-system-variables-alist)))
7839 ;; Keep the old value if query was not successful
7840 (setq idlwave-system-variables-alist
7841 (or idlwave-system-variables-alist old))))
7843 (defun idlwave-completion-fontify-classes ()
7844 "Goto the *Completions* buffer and fontify the class info."
7845 (when (featurep 'font-lock)
7846 (save-excursion
7847 (set-buffer "*Completions*")
7848 (save-excursion
7849 (goto-char (point-min))
7850 (let ((buffer-read-only nil))
7852 (put-text-property (match-beginning 0) (match-end 0)
7853 'face 'font-lock-string-face)))))))
7855 (defun idlwave-uniquify (list)
7856 (let ((ht (make-hash-table :size (length list) :test 'equal)))
7857 (delq nil
7858 (mapcar (lambda (x)
7859 (unless (gethash x ht)
7860 (puthash x t ht)
7861 x))
7862 list))))
7864 (defun idlwave-after-successful-completion (type slash &optional verify)
7865 "Add `=' or `(' after successful completion of keyword and function.
7866 Restore the pre-completion window configuration if possible."
7867 (cond
7868 ((eq type 'procedure)
7869 nil)
7870 ((eq type 'function)
7871 (cond
7872 ((equal idlwave-function-completion-adds-paren nil) nil)
7873 ((or (equal idlwave-function-completion-adds-paren t)
7874 (equal idlwave-function-completion-adds-paren 1))
7875 (insert "("))
7876 ((equal idlwave-function-completion-adds-paren 2)
7877 (insert "()")
7878 (backward-char 1))
7879 (t nil)))
7880 ((eq type 'keyword)
7881 (if (and idlwave-keyword-completion-adds-equal
7882 (not slash))
7883 (progn (insert "=") t)
7884 nil)))
7886 ;; Restore the pre-completion window configuration if this is safe.
7888 (if (or (eq verify 'force) ; force
7889 (and
7890 (get-buffer-window "*Completions*") ; visible
7891 (idlwave-local-value 'idlwave-completion-p
7892 "*Completions*") ; cib-buffer
7893 (eq (marker-buffer idlwave-completion-mark)
7894 (current-buffer)) ; buffer OK
7895 (equal (marker-position idlwave-completion-mark)
7896 verify))) ; pos OK
7897 (idlwave-restore-wconf-after-completion))
7898 (move-marker idlwave-completion-mark nil)
7899 (setq idlwave-before-completion-wconf nil))
7901 (defun idlwave-mouse-context-help (ev &optional arg)
7902 "Call `idlwave-context-help' on the clicked location."
7903 (interactive "eP")
7904 (mouse-set-point ev)
7905 (idlwave-context-help arg))
7907 (defvar idlwave-last-context-help-pos nil)
7908 (defun idlwave-context-help (&optional arg)
7909 "Display IDL Online Help on context.
7910 If point is on a keyword, help for that keyword will be shown. If
7911 point is on a routine name or in the argument list of a routine, help
7912 for that routine will be displayed. Works for system routines and
7913 keywords, it pulls up text help. For other routies and keywords,
7914 visits the source file, finding help in the header (if
7915 `idlwave-help-source-try-header' is non-nil) or the routine definition
7916 itself."
7917 (interactive "P")
7918 (idlwave-do-context-help arg))
7920 (defun idlwave-mouse-completion-help (ev)
7921 "Display online help about the completion at point."
7922 (interactive "eP")
7923 ;; Restore last-command for next command, to make
7924 ;; scrolling/cancelling of completions work.
7925 (setq this-command last-command)
7926 (idlwave-do-mouse-completion-help ev))
7928 (defun idlwave-routine-info (&optional arg external)
7929 "Display a routines calling sequence and list of keywords. When
7930 point is on the name a function or procedure, or in the argument list
7931 of a function or procedure, this command displays a help buffer with
7932 the information. When called with prefix arg, enforce class query.
7934 When point is on an object operator `->', display the class stored in
7935 this arrow, if any (see `idlwave-store-inquired-class'). With a
7936 prefix arg, the class property is cleared out."
7938 (interactive "P")
7939 (idlwave-routines)
7940 (if (string-match "->" (buffer-substring
7941 (max (point-min) (1- (point)))
7942 (min (+ 2 (point)) (point-max))))
7943 ;; Cursor is on an arrow
7944 (if (get-text-property (point) 'idlwave-class)
7945 ;; arrow has class property
7946 (if arg
7947 ;; Remove property
7948 (save-excursion
7949 (backward-char 1)
7951 (remove-text-properties (match-beginning 1) (match-end 1)
7952 '(idlwave-class nil face nil))
7953 (message "Class property removed from arrow")))
7954 ;; Echo class property
7955 (message "Arrow has text property identifying object to be class %s"
7956 (get-text-property (point) 'idlwave-class)))
7957 ;; No property found
7958 (message "Arrow has no class text property"))
7960 ;; Not on an arrow...
7961 (let* ((idlwave-query-class nil)
7962 (idlwave-force-class-query (equal arg '(4)))
7963 (module (idlwave-what-module)))
7964 (if (car module)
7965 (apply 'idlwave-display-calling-sequence
7966 (idlwave-fix-module-if-obj_new module))
7967 (error "Don't know which calling sequence to show")))))
7969 (defun idlwave-resolve (&optional arg)
7970 "Call RESOLVE_ROUTINE on the module name at point.
7971 Like `idlwave-routine-info', this looks for a routine call at point.
7972 After confirmation in the minibuffer, it will use the shell to issue
7973 a RESOLVE call for this routine, to attempt to make it defined and its
7974 routine info available for IDLWAVE. If the routine is a method call,
7975 both `class__method' and `class__define' will be tried.
7976 With ARG, enforce query for the class of object methods."
7977 (interactive "P")
7978 (let* ((idlwave-query-class nil)
7979 (idlwave-force-class-query (equal arg '(4)))
7980 (module (idlwave-what-module))
7981 (name (idlwave-make-full-name (nth 2 module) (car module)))
7982 (type (if (eq (nth 1 module) 'pro) "pro" "function"))
7983 (resolve (read-string "Resolve: " (format "%s %s" type name)))
7984 (kwd "")
7985 class)
7987 resolve)
7988 (setq type (match-string 1 resolve)
7989 class (if (match-beginning 2)
7990 (match-string 3 resolve)
7991 nil)
7992 name (match-string 4 resolve)))
7993 (if (string= (downcase type) "function")
7994 (setq kwd ",/is_function"))
7996 (cond
7997 ((null class)
7998 (idlwave-shell-send-command
7999 (format "resolve_routine,'%s'%s" (downcase name) kwd)
8000 'idlwave-update-routine-info
8001 nil t))
8002 (t
8003 (idlwave-shell-send-command
8004 (format "resolve_routine,'%s__define'%s" (downcase class) kwd)
8005 (list 'idlwave-shell-send-command
8006 (format "resolve_routine,'%s__%s'%s"
8007 (downcase class) (downcase name) kwd)
8008 '(idlwave-update-routine-info)
8009 nil t))))))
8011 (defun idlwave-find-module-this-file ()
8012 (interactive)
8013 (idlwave-find-module '(4)))
8015 (defun idlwave-find-module (&optional arg)
8016 "Find the source code of an IDL module.
8017 Works for modules for which IDLWAVE has routine info available. The
8018 function offers as default the module name `idlwave-routine-info'
8019 would use. With ARG limit to this buffer. With two prefix ARG's
8020 force class query for object methods."
8021 (interactive "P")
8022 (let* ((idlwave-query-class nil)
8023 (idlwave-force-class-query (equal arg '(16)))
8024 (this-buffer (equal arg '(4)))
8025 (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
8026 (default (if module
8027 (concat (idlwave-make-full-name
8028 (nth 2 module) (car module))
8029 (if (eq (nth 1 module) 'pro) "<p>" "<f>"))
8030 "none"))
8031 (list
8032 (idlwave-uniquify
8033 (delq nil
8034 (mapcar (lambda (x)
8035 (if (eq 'system (car-safe (nth 3 x)))
8036 ;; Take out system routines with no source.
8037 nil
8038 (list
8039 (concat (idlwave-make-full-name
8040 (nth 2 x) (car x))
8041 (if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
8042 (if this-buffer
8043 (idlwave-save-buffer-update)
8044 (idlwave-routines))))))
8045 (name (idlwave-completing-read
8046 (if (or (not this-buffer)
8047 (assoc default list))
8048 (format "Module (Default %s): " default)
8049 (format "Module in this file: "))
8050 list))
8051 type class)
8053 ;; Nothing, use the default.
8054 (setq name default))
8055 (if (string-match "<[fp]>" name)
8056 (setq type (substring name -2 -1)
8057 name (substring name 0 -3)))
8059 (setq class (match-string 1 name)
8060 name (match-string 2 name)))
8061 (setq name (idlwave-sintern-routine-or-method name class)
8062 class (idlwave-sintern-class class)
8063 type (cond ((equal type "f") 'fun)
8064 ((equal type "p") 'pro)
8065 (t t)))
8066 (idlwave-do-find-module name type class nil this-buffer)))
8068 (defun idlwave-do-find-module (name type class
8069 &optional force-source this-buffer)
8070 (let ((name1 (idlwave-make-full-name class name))
8071 source buf1 entry
8072 (buf (current-buffer))
8073 (pos (point))
8074 file name2)
8075 (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines)
8076 'WITH-FILE)
8077 source (or force-source (nth 3 entry))
8078 name2 (if (nth 2 entry)
8079 (idlwave-make-full-name (nth 2 entry) name)
8080 name1))
8081 (if source
8082 (setq file (idlwave-routine-source-file source)))
8083 (unless file ; Try to find it on the path.
8084 (setq file
8085 (idlwave-expand-lib-file-name
8086 (if class
8087 (format "%s__define.pro" (downcase class))
8088 (format "%s.pro" (downcase name))))))
8089 (cond
8090 ((or (null name) (equal name ""))
8091 (error "Abort"))
8092 ((eq (car source) 'system)
8093 (error "Source code for system routine %s is not available"
8094 name2))
8095 ((or (not file) (not (file-regular-p file)))
8096 (error "Source code for routine %s is not available"
8097 name2))
8098 (t
8099 (when (not this-buffer)
8100 (setq buf1
8101 (idlwave-find-file-noselect file 'find))
8102 (pop-to-buffer buf1 t))
8103 (goto-char (point-max))
8104 (let ((case-fold-search t))
8105 (if (re-search-backward
8107 (cond ((eq type 'fun) "function")
8108 ((eq type 'pro) "pro")
8111 (regexp-quote (downcase name2))
8112 "[^a-zA-Z0-9_$]")
8113 nil t)
8114 (goto-char (match-beginning 0))
8115 (pop-to-buffer buf)
8116 (goto-char pos)
8117 (error "Could not find routine %s" name2)))))))
8119 (defun idlwave-what-module ()
8120 "Return a default module for stuff near point.
8121 Used by `idlwave-routine-info' and `idlwave-find-module'."
8122 (idlwave-routines)
8123 (if (let ((case-fold-search t))
8124 (save-excursion
8125 (idlwave-beginning-of-statement)
8126 (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
8127 ;; This is a function or procedure definition statement
8128 ;; We return the defined routine as module.
8129 (list
8130 (idlwave-sintern-routine-or-method (match-string-no-properties 4)
8131 (match-string-no-properties 2))
8132 (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
8133 (idlwave-sintern-class (match-string 3)))
8135 ;; Not a definition statement - analyze precise position.
8136 (let* ((where (idlwave-where))
8137 (cw (nth 2 where))
8138 (pro (car (nth 0 where)))
8139 (func (car (nth 1 where)))
8140 (this-word (idlwave-this-word "a-zA-Z0-9$_"))
8141 (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
8142 (following-char)))
8143 )
8144 (cond
8145 ((and (eq cw 'procedure)
8146 (not (equal this-word "")))
8147 (setq this-word (idlwave-sintern-routine-or-method
8148 this-word (nth 2 (nth 3 where))))
8149 (list this-word 'pro
8150 (idlwave-determine-class
8151 (cons this-word (cdr (nth 3 where)))
8152 'pro)))
8153 ((and (eq cw 'function)
8154 (not (equal this-word ""))
8155 (or (eq next-char ?\() ; exclude arrays, vars.
8157 (setq this-word (idlwave-sintern-routine-or-method
8158 this-word (nth 2 (nth 3 where))))
8159 (list this-word 'fun
8160 (idlwave-determine-class
8161 (cons this-word (cdr (nth 3 where)))
8162 'fun)))
8163 ((and (memq cw '(function-keyword procedure-keyword))
8164 (not (equal this-word ""))
8165 (eq next-char ?\()) ; A function!
8166 (setq this-word (idlwave-sintern-routine this-word))
8167 (list this-word 'fun nil))
8168 (func
8169 (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
8170 (pro
8171 (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
8172 (t nil)))))
8174 (defun idlwave-what-module-find-class ()
8175 "Call idlwave-what-module and find the inherited class if necessary."
8176 (let* ((module (idlwave-what-module))
8177 (class (nth 2 module))
8178 classes)
8179 (if (and (= (length module) 3)
8180 (stringp class))
8181 (list (car module)
8182 (nth 1 module)
8183 (apply 'idlwave-find-inherited-class module))
8184 module)))
8186 (defun idlwave-find-inherited-class (name type class)
8187 "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
8188 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
8189 (if entry
8190 (nth 2 entry)
8191 class)))
8193 (defun idlwave-fix-module-if-obj_new (module)
8194 "Check if MODULE points to obj_new.
8195 If yes, and if the cursor is in the keyword region, change to the
8196 appropriate Init method."
8197 (let* ((name (car module))
8198 (pos (point))
8199 (case-fold-search t)
8200 string)
8201 (if (and (stringp name)
8202 (equal (downcase name) "obj_new")
8203 (save-excursion
8204 (idlwave-beginning-of-statement)
8205 (setq string (buffer-substring (point) pos))
8207 string)))
8208 (let ((name "Init")
8209 (class (match-string 1 string)))
8210 (setq module (list (idlwave-sintern-method "Init")
8211 'fun
8212 (idlwave-sintern-class class)))))
8213 module))
8215 (defun idlwave-fix-keywords (name type class keywords
8216 &optional super-classes system)
8217 "Update a list of keywords.
8218 Translate OBJ_NEW, adding all super-class keywords, or all keywords
8219 from all classes if class equals t. If SYSTEM is non-nil, don't
8220 demand _EXTRA in the keyword list."
8221 (let ((case-fold-search t))
8223 ;; If this is the OBJ_NEW function, try to figure out the class and use
8224 ;; the keywords from the corresponding INIT method.
8225 (if (and (equal (upcase name) "OBJ_NEW")
8226 (or (eq major-mode 'idlwave-mode)
8227 (eq major-mode 'idlwave-shell-mode)))
8228 (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
8229 (string (buffer-substring bos (point)))
8230 (case-fold-search t)
8231 class)
8233 string)
8234 (setq class (idlwave-sintern-class (match-string 1 string)))
8235 (setq idlwave-current-obj_new-class class)
8236 (setq keywords
8237 (append keywords
8238 (idlwave-entry-keywords
8239 (idlwave-rinfo-assq
8240 (idlwave-sintern-method "INIT")
8241 'fun
8242 class
8243 (idlwave-routines)) 'do-link))))))
8245 ;; If the class is `t', combine all keywords of all methods NAME
8246 (when (eq class t)
8247 (mapc (lambda (entry)
8248 (and
8249 (nth 2 entry) ; non-nil class
8250 (eq (nth 1 entry) type) ; correct type
8251 (setq keywords
8252 (append keywords
8253 (idlwave-entry-keywords entry 'do-link)))))
8254 (idlwave-all-assq name (idlwave-routines)))
8255 (setq keywords (idlwave-uniquify keywords)))
8257 ;; If we have inheritance, add all keywords from superclasses, if
8258 ;; the user indicated that method in `idlwave-keyword-class-inheritance'
8259 (when (and
8260 super-classes
8261 idlwave-keyword-class-inheritance
8262 (stringp class)
8263 (or
8264 system
8265 (assq (idlwave-sintern-keyword "_extra") keywords)
8266 (assq (idlwave-sintern-keyword "_ref_extra") keywords))
8267 ;; Check if one of the keyword-class regexps matches the name
8268 (let ((regexps idlwave-keyword-class-inheritance) re)
8269 (catch 'exit
8270 (while (setq re (pop regexps))
8271 (if (string-match re name) (throw 'exit t))))))
8273 (loop for entry in (idlwave-routines) do
8274 (and (nth 2 entry) ; non-nil class
8275 (memq (nth 2 entry) super-classes) ; an inherited class
8276 (eq (nth 1 entry) type) ; correct type
8277 (eq (car entry) name) ; correct name
8278 (mapcar (lambda (k) (add-to-list 'keywords k))
8279 (idlwave-entry-keywords entry 'do-link))))
8280 (setq keywords (idlwave-uniquify keywords)))
8282 ;; Return the final list
8283 keywords))
8285 (defun idlwave-expand-keyword (keyword module)
8286 "Expand KEYWORD to one of the valid keyword parameters of MODULE.
8287 KEYWORD may be an exact match or an abbreviation of a keyword.
8288 If the match is exact, KEYWORD itself is returned, even if there may be other
8289 keywords of which KEYWORD is an abbreviation. This is necessary because some
8290 system routines have keywords which are prefixes of other keywords.
8291 If KEYWORD is an abbreviation of several keywords, a list of all possible
8292 completions is returned.
8293 If the abbreviation was unique, the correct keyword is returned.
8294 If it cannot be a keyword, the function return nil.
8295 If we do not know about MODULE, just return KEYWORD literally."
8296 (let* ((name (car module))
8297 (type (nth 1 module))
8298 (class (nth 2 module))
8299 (kwd (idlwave-sintern-keyword keyword))
8300 (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
8301 (kwd-alist (idlwave-entry-keywords entry))
8302 (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
8303 (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
8304 (completion-ignore-case t)
8305 candidates)
8306 (cond ((assq kwd kwd-alist)
8307 kwd)
8308 ((setq candidates (all-completions kwd kwd-alist))
8309 (if (= (length candidates) 1)
8310 (car candidates)
8311 candidates))
8312 ((and entry extra)
8313 ;; Inheritance may cause this keyword to be correct
8314 keyword)
8315 (entry
8316 ;; We do know the function, which does not have the keyword.
8317 nil)
8318 (t
8319 ;; We do not know the function, so this just might be a correct
8320 ;; keyword - return it as it is.
8321 keyword))))
8323 (defvar idlwave-rinfo-mouse-map (make-sparse-keymap))
8324 (defvar idlwave-rinfo-map (make-sparse-keymap))
8325 (define-key idlwave-rinfo-mouse-map
8326 (if (featurep 'xemacs) [button2] [mouse-2])
8327 'idlwave-mouse-active-rinfo)
8328 (define-key idlwave-rinfo-mouse-map
8329 (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
8330 'idlwave-mouse-active-rinfo-shift)
8331 (define-key idlwave-rinfo-mouse-map
8332 (if (featurep 'xemacs) [button3] [mouse-3])
8333 'idlwave-mouse-active-rinfo-right)
8334 (define-key idlwave-rinfo-mouse-map " " 'idlwave-active-rinfo-space)
8335 (define-key idlwave-rinfo-map "q" 'idlwave-quit-help)
8336 (define-key idlwave-rinfo-mouse-map "q" 'idlwave-quit-help)
8337 (defvar idlwave-popup-source nil)
8338 (defvar idlwave-rinfo-marker (make-marker))
8340 (defun idlwave-quit-help ()
8341 (interactive)
8342 (let ((ri-window (get-buffer-window "*Help*"))
8343 (olh-window (get-buffer-window "*IDLWAVE Help*")))
8344 (when (and olh-window
8345 (fboundp 'idlwave-help-quit))
8346 (select-window olh-window)
8347 (idlwave-help-quit))
8348 (when (window-live-p ri-window)
8349 (delete-window ri-window))))
8351 (defun idlwave-display-calling-sequence (name type class
8352 &optional initial-class)
8353 ;; Display the calling sequence of module NAME, type TYPE in class CLASS.
8354 (let* ((initial-class (or initial-class class))
8355 (entry (or (idlwave-best-rinfo-assq name type class
8356 (idlwave-routines))
8357 (idlwave-rinfo-assq name type class
8358 idlwave-unresolved-routines)))
8359 (name (or (car entry) name))
8360 (class (or (nth 2 entry) class))
8361 (superclasses (idlwave-all-class-inherits initial-class))
8362 (twins (idlwave-routine-twins entry))
8363 (dtwins (idlwave-study-twins twins))
8364 (all dtwins)
8365 (system (eq (car (nth 3 entry)) 'system))
8366 (calling-seq (nth 4 entry))
8367 (keywords (idlwave-entry-keywords entry 'do-link))
8368 (html-file (car (nth 5 entry)))
8369 (help-echo-kwd
8370 "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') | Button3: Online Help ")
8371 (help-echo-use
8372 "Button2/3: Online Help")
8373 (help-echo-src
8374 "Button2: Jump to source and back | Button3: Source in Help window.")
8375 (help-echo-class
8376 "Button2: Display info about same method in superclass")
8377 (col 0)
8378 (data (list name type class (current-buffer) nil initial-class))
8379 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8380 (face 'idlwave-help-link)
8381 beg props win cnt total)
8382 ;; Fix keywords, but don't add chained super-classes, since these
8383 ;; are shown separately for that super-class
8384 (setq keywords (idlwave-fix-keywords name type class keywords))
8385 (cond
8386 ((null entry)
8387 (error "No %s %s known %s" type name
8388 (if initial-class (concat "in class " initial-class) "")))
8389 ((or (null name) (equal name ""))
8390 (error "No function or procedure call at point"))
8391 ((null calling-seq)
8392 (error "Calling sequence of %s %s not available" type name))
8393 (t
8394 (save-excursion
8395 (move-marker idlwave-rinfo-marker (point))
8396 (set-buffer (get-buffer-create "*Help*"))
8397 (use-local-map idlwave-rinfo-map)
8398 (setq buffer-read-only nil)
8399 (erase-buffer)
8400 (set (make-local-variable 'idlwave-popup-source) nil)
8401 (set (make-local-variable 'idlwave-current-obj_new-class)
8402 idlwave-current-obj_new-class)
8403 (when superclasses
8404 (setq props (list 'mouse-face 'highlight
8405 km-prop idlwave-rinfo-mouse-map
8406 'help-echo help-echo-class
8407 'data (cons 'class data)))
8408 (let ((classes (cons initial-class superclasses)) c)
8409 (insert "Classes: ")
8410 (while (setq c (pop classes))
8411 (insert " ")
8412 (setq beg (point))
8413 (insert c)
8414 (if (equal (downcase c) (downcase class))
8415 (add-text-properties beg (point) (list 'face 'bold))
8416 ;; If Method exists in a different class link it
8417 (if (idlwave-rinfo-assq name type c (idlwave-routines))
8418 (add-text-properties beg (point) props))))
8420 (setq props (list 'mouse-face 'highlight
8421 km-prop idlwave-rinfo-mouse-map
8422 'help-echo help-echo-use
8423 'data (cons 'usage data)))
8424 (if html-file (setq props (append (list 'face face 'link html-file)
8425 props)))
8426 (insert "Usage: ")
8427 (setq beg (point))
8428 (insert (if class
8429 (format calling-seq class name class name class name)
8430 (format calling-seq name name name name))
8432 (add-text-properties beg (point) props)
8434 (insert "Keywords:")
8435 (if (null keywords)
8436 (insert " No keywords accepted.")
8437 (setq col 9)
8438 (mapcar
8439 (lambda (x)
8440 (if (>= (+ col 1 (length (car x)))
8441 (window-width))
8442 (progn
8444 (setq col 9)))
8445 (insert " ")
8446 (setq beg (point)
8447 ;; Relevant keywords already have link property attached
8448 props (list 'mouse-face 'highlight
8449 km-prop idlwave-rinfo-mouse-map
8450 'data (cons 'keyword data)
8451 'help-echo help-echo-kwd
8452 'keyword (car x)))
8453 (if system (setq props (append (list 'face face) props)))
8454 (insert (car x))
8455 (add-text-properties beg (point) props)
8456 (setq col (+ col 1 (length (car x)))))
8457 keywords))
8459 (setq cnt 1 total (length all))
8460 ;; Here entry is (key file (list of type-conses))
8461 (while (setq entry (pop all))
8462 (setq props (list 'mouse-face 'highlight
8463 km-prop idlwave-rinfo-mouse-map
8464 'help-echo help-echo-src
8465 'source (list (car (car (nth 2 entry))) ;type
8466 (nth 1 entry)
8467 nil
8468 (cdr (car (nth 2 entry))))
8469 'data (cons 'source data)))
8470 (idlwave-insert-source-location
8472 (if (equal cnt 1)
8473 (if (> total 1) "Sources:" "Source:")
8474 "")
8475 (if (> total 1) "- " ""))
8476 entry props)
8477 (incf cnt)
8478 (when (and all (> cnt idlwave-rinfo-max-source-lines))
8479 ;; No more source lines, please
8480 (insert (format
8482 idlwave-rinfo-max-source-lines))
8483 (setq all nil)))
8484 (goto-char (point-min))
8485 (setq buffer-read-only t))
8486 (display-buffer "*Help*")
8487 (if (and (setq win (get-buffer-window "*Help*"))
8488 idlwave-resize-routine-help-window)
8489 (progn
8490 (let ((ww (selected-window)))
8491 (unwind-protect
8492 (progn
8493 (select-window win)
8494 (enlarge-window (- (/ (frame-height) 2)
8495 (window-height)))
8496 (shrink-window-if-larger-than-buffer))
8497 (select-window ww)))))))))
8499 (defun idlwave-insert-source-location (prefix entry &optional file-props)
8500 "Insert a source location into the routine info buffer.
8501 Start line with PREFIX. If a file name is inserted, add FILE-PROPS to
8502 it."
8503 (let* ((key (car entry))
8504 (file (nth 1 entry))
8505 (types (nth 2 entry))
8506 (shell-flag (assq 'compiled types))
8507 (buffer-flag (assq 'buffer types))
8508 (user-flag (assq 'user types))
8509 (lib-flag (assq 'lib types))
8510 (ndupl (or (and buffer-flag (idlwave-count-memq 'buffer types))
8511 (and user-flag (idlwave-count-memq 'user types))
8512 (and lib-flag (idlwave-count-memq 'lib types))
8513 1))
8514 (doflags t)
8515 beg special)
8517 (insert prefix)
8519 (cond
8520 ((eq key 'system)
8521 (setq doflags nil)
8522 (insert "System "))
8524 ((eq key 'builtin)
8525 (setq doflags nil)
8526 (insert "Builtin "))
8528 ((and (not file) shell-flag)
8529 (insert "Unresolved"))
8531 ((null file)
8532 (insert "ERROR"))
8534 ((idlwave-syslib-p file)
8535 (if (string-match "obsolete" (file-name-directory file))
8536 (insert "Obsolete ")
8537 (insert "SystemLib ")))
8539 ;; New special syntax: taken directly from routine-info for
8540 ;; library catalog routines
8541 ((setq special (or (cdr lib-flag) (cdr user-flag)))
8542 (insert (format "%-10s" special)))
8544 ;; Old special syntax: a matching regexp
8545 ((setq special (idlwave-special-lib-test file))
8546 (insert (format "%-10s" special)))
8548 ;; Catch-all with file
8549 ((idlwave-lib-p file) (insert "Library "))
8551 ;; Sanity catch all
8552 (t (insert "Other ")))
8554 (when doflags
8555 (insert (concat
8556 " ["
8557 (if lib-flag "L" "-")
8558 (if user-flag "C" "-")
8559 (if shell-flag "S" "-")
8560 (if buffer-flag "B" "-")
8561 "] ")))
8562 (when (> ndupl 1)
8563 (setq beg (point))
8564 (insert (format "(%dx) " ndupl))
8565 (add-text-properties beg (point) (list 'face 'bold)))
8566 (when (and file (not (equal file "")))
8567 (setq beg (point))
8568 (insert (apply 'abbreviate-file-name
8569 (if (featurep 'xemacs) (list file t) (list file))))
8570 (if file-props
8571 (add-text-properties beg (point) file-props)))))
8573 (defun idlwave-special-lib-test (file)
8574 "Check the path of FILE against the regexps which define special libs.
8575 Return the name of the special lib if there is a match."
8576 (let ((alist idlwave-special-lib-alist)
8577 entry rtn)
8578 (cond
8579 ((stringp file)
8580 (while (setq entry (pop alist))
8581 (if (string-match (car entry) file)
8582 (setq rtn (cdr entry)
8583 alist nil)))
8584 rtn)
8585 (t nil))))
8587 (defun idlwave-mouse-active-rinfo-right (ev)
8588 (interactive "e")
8589 (idlwave-mouse-active-rinfo ev 'right))
8591 (defun idlwave-mouse-active-rinfo-shift (ev)
8592 (interactive "e")
8593 (idlwave-mouse-active-rinfo ev nil 'shift))
8595 (defun idlwave-active-rinfo-space ()
8596 (interactive)
8597 (idlwave-mouse-active-rinfo nil 'right))
8599 (defun idlwave-mouse-active-rinfo (ev &optional right shift)
8600 "Does the mouse actions in the routine info buffer.
8601 Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
8602 was pressed."
8603 (interactive "e")
8604 (if ev (mouse-set-point ev))
8605 (let (data id name type class buf bufwin source link keyword
8606 word initial-class)
8607 (setq data (get-text-property (point) 'data)
8608 source (get-text-property (point) 'source)
8609 keyword (get-text-property (point) 'keyword)
8610 link (get-text-property (point) 'link)
8611 id (car data)
8612 name (nth 1 data) type (nth 2 data) class (nth 3 data)
8613 buf (nth 4 data)
8614 initial-class (nth 6 data)
8615 word (idlwave-this-word)
8616 bufwin (get-buffer-window buf t))
8618 (cond ((eq id 'class) ; Switch class being displayed
8619 (if (window-live-p bufwin) (select-window bufwin))
8620 (idlwave-display-calling-sequence
8621 (idlwave-sintern-method name)
8622 type (idlwave-sintern-class word)
8623 initial-class))
8624 ((eq id 'usage) ; Online help on this routine
8625 (idlwave-online-help link name type class))
8626 ((eq id 'source) ; Source in help or buffer
8627 (if right ; In help
8628 (let ((idlwave-extra-help-function 'idlwave-help-with-source)
8629 (idlwave-help-source-try-header nil)
8630 ;; Fake idlwave-routines so help will find the right entry
8631 (idlwave-routines
8632 (list (list name type class source ""))))
8633 (idlwave-help-get-special-help name type class nil))
8634 ;; Otherwise just pop to the source
8635 (setq idlwave-popup-source (not idlwave-popup-source))
8636 (if idlwave-popup-source
8637 (condition-case err
8638 (idlwave-do-find-module name type class source)
8639 (error
8640 (setq idlwave-popup-source nil)
8641 (if (window-live-p bufwin) (select-window bufwin))
8642 (error (nth 1 err))))
8643 (if bufwin
8644 (select-window bufwin)
8645 (pop-to-buffer buf))
8646 (goto-char (marker-position idlwave-rinfo-marker)))))
8647 ((eq id 'keyword)
8648 (if right
8649 (idlwave-online-help link name type class keyword)
8650 (idlwave-rinfo-insert-keyword keyword buf shift))))))
8652 (defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
8653 "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
8654 (let ((bwin (get-buffer-window buffer)))
8655 (if idlwave-complete-empty-string-as-lower-case
8656 (setq keyword (downcase keyword)))
8657 (if bwin
8658 (select-window bwin)
8659 (pop-to-buffer buffer)
8660 (setq bwin (get-buffer-window buffer)))
8661 (if (eq (preceding-char) ?/)
8662 (insert keyword)
8663 (unless (save-excursion
8664 (re-search-backward
8666 (min (- (point) 100) (point-min)) t))
8667 (insert ", "))
8668 (if shift (insert "/"))
8669 (insert keyword)
8670 (if (and (not shift)
8671 idlwave-keyword-completion-adds-equal)
8672 (insert "=")))))
8674 (defun idlwave-list-buffer-load-path-shadows (&optional arg)
8675 "List the load path shadows of all routines defined in current buffer."
8676 (interactive "P")
8677 (idlwave-routines)
8678 (if (eq major-mode 'idlwave-mode)
8679 (idlwave-list-load-path-shadows
8680 nil (idlwave-update-current-buffer-info 'save-buffer)
8681 "in current buffer")
8682 (error "Current buffer is not in idlwave-mode")))
8684 (defun idlwave-list-shell-load-path-shadows (&optional arg)
8685 "List the load path shadows of all routines compiled under the shell.
8686 This is very useful for checking an IDL application. Just compile the
8687 application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
8688 routines and update IDLWAVE internal info. Then check for shadowing
8689 with this command."
8690 (interactive "P")
8691 (cond
8692 ((or (not (fboundp 'idlwave-shell-is-running))
8693 (not (idlwave-shell-is-running)))
8694 (error "Shell is not running"))
8695 ((null idlwave-compiled-routines)
8696 (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
8697 (t
8698 (idlwave-list-load-path-shadows nil idlwave-compiled-routines
8699 "in the shell"))))
8701 (defun idlwave-list-all-load-path-shadows (&optional arg)
8702 "List the load path shadows of all routines known to IDLWAVE."
8703 (interactive "P")
8704 (idlwave-list-load-path-shadows nil nil "globally"))
8706 (defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
8707 "List the routines which are defined multiple times.
8708 Search the information IDLWAVE has about IDL routines for multiple
8709 definitions.
8710 When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
8712 When IDL hits a routine call which is not defined, it will search on
8713 the load path in order to find a definition. The output of this
8714 command can be used to detect possible name clashes during this process."
8715 (idlwave-routines) ; Make sure everything is loaded.
8716 (unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
8717 (or (y-or-n-p
8718 "You don't have any user or library catalogs. Continue anyway? ")
8719 (error "Abort")))
8720 (let* ((routines (append idlwave-system-routines
8721 idlwave-compiled-routines
8722 idlwave-library-catalog-routines
8723 idlwave-user-catalog-routines
8724 idlwave-buffer-routines
8725 nil))
8726 (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
8727 (keymap (make-sparse-keymap))
8728 (props (list 'mouse-face 'highlight
8729 km-prop keymap
8730 'help-echo "Mouse2: Find source"))
8731 (nroutines (length (or special-routines routines)))
8732 (step (/ nroutines 100))
8733 (n 0)
8734 (cnt 0)
8735 (idlwave-sort-prefer-buffer-info nil)
8736 routine twins dtwins twin done props1 lroutines)
8738 (if special-routines
8739 ;; Just looking for shadows of a few special routines
8740 (setq lroutines routines
8741 routines special-routines))
8743 (message "Sorting routines...")
8744 (setq routines (sort routines
8745 (lambda (a b)
8746 (string< (downcase (idlwave-make-full-name
8747 (nth 2 a) (car a)))
8748 (downcase (idlwave-make-full-name
8749 (nth 2 b) (car b)))))))
8750 (message "Sorting routines...done")
8752 (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
8753 (lambda (ev)
8754 (interactive "e")
8755 (mouse-set-point ev)
8756 (apply 'idlwave-do-find-module
8757 (get-text-property (point) 'find-args))))
8758 (define-key keymap [(return)]
8759 (lambda ()
8760 (interactive)
8761 (apply 'idlwave-do-find-module
8762 (get-text-property (point) 'find-args))))
8763 (message "Compiling list...( 0%%)")
8764 (save-excursion
8765 (set-buffer (get-buffer-create "*Shadows*"))
8766 (setq buffer-read-only nil)
8767 (erase-buffer)
8768 (while (setq routine (pop routines))
8769 (if (= (mod (setq n (1+ n)) step) 0)
8770 (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines)))
8772 ;; Get a list of all twins
8773 (setq twins (idlwave-routine-twins routine (or lroutines routines)))
8774 (if (memq routine done)
8775 (setq dtwins nil)
8776 (setq dtwins (idlwave-study-twins twins)))
8777 ;; Mark all twins as dealt with
8778 (setq done (append twins done))
8779 (when (or (> (length dtwins) 1)
8780 (> (idlwave-count-memq 'lib (nth 2 (car dtwins))) 1)
8781 (> (idlwave-count-memq 'user (nth 2 (car dtwins))) 1)
8782 (> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
8783 (incf cnt)
8785 (idlwave-make-full-name (nth 2 routine)
8786 (car routine))
8787 (if (eq (nth 1 routine) 'fun) "()" "")))
8788 (while (setq twin (pop dtwins))
8789 (setq props1 (append (list 'find-args
8790 (list (nth 0 routine)
8791 (nth 1 routine)
8792 (nth 2 routine)))
8793 props))
8795 (goto-char (point-min))
8796 (setq buffer-read-only t))
8797 (setq loc (or loc ""))
8798 (if (> cnt 0)
8799 (progn
8800 (display-buffer (get-buffer "*Shadows*"))
8801 (message "%d case%s of shadowing found %s"
8802 cnt (if (= cnt 1) "" "s") loc))
8803 (message "No shadowing conflicts found %s" loc))))
8805 (defun idlwave-print-source (routine)
8806 (let* ((source (nth 3 routine))
8807 (stype (car source))
8808 (sfile (idlwave-routine-source-file source)))
8809 (if (idlwave-syslib-p sfile) (setq stype 'syslib))
8810 (if (and (eq stype 'compiled)
8811 (or (not (stringp sfile))
8813 (setq stype 'unresolved))
8815 stype
8816 (if sfile sfile "No source code available")))))
8818 (defun idlwave-routine-twins (entry &optional list)
8819 "Return all twin entries of ENTRY in LIST.
8820 LIST defaults to `idlwave-routines'.
8821 Twin entries are those which have the same name, type, and class.
8822 ENTRY will also be returned, as the first item of this list."
8823 (let* ((name (car entry))
8824 (type (nth 1 entry))
8825 (class (nth 2 entry))
8826 (candidates (idlwave-all-assq name (or list (idlwave-routines))))
8827 twins candidate)
8828 (while (setq candidate (pop candidates))
8829 (if (and (not (eq candidate entry))
8830 (eq type (nth 1 candidate))
8831 (eq class (nth 2 candidate)))
8832 (push candidate twins)))
8833 (if (setq candidate (idlwave-rinfo-assq name type class
8834 idlwave-unresolved-routines))
8835 (push candidate twins))
8836 (cons entry (nreverse twins))))
8838 (defun idlwave-study-twins (entries)
8839 "Return dangerous twins of first entry in ENTRIES.
8840 Dangerous twins are routines with same name, but in different files on
8841 the load path. If a file is in the system library and has an entry in
8842 the `idlwave-system-routines' list, we omit the latter as
8843 non-dangerous because many IDL routines are implemented as library
8844 routines, and may have been scanned."
8845 (let* ((entry (car entries))
8846 (name (car entry)) ;
8847 (type (nth 1 entry)) ; Must be bound for
8848 (class (nth 2 entry)) ; idlwave-routine-twin-compare
8849 (cnt 0)
8850 source type type-cons file alist syslibp key)
8851 (while (setq entry (pop entries))
8852 (incf cnt)
8853 (setq source (nth 3 entry)
8854 type (car source)
8855 type-cons (cons type (nth 3 source))
8856 file (idlwave-routine-source-file source))
8858 ;; Make KEY to index entry properly
8859 (setq key (cond ((eq type 'system) type)
8860 (file (file-truename file))
8861 (t 'unresolved)))
8863 ;; Check for an entry in the system library
8864 (if (and file
8865 (not syslibp)
8866 (idlwave-syslib-p file))
8867 (setq syslibp t))
8869 ;; If there's more than one matching entry for the same file, just
8870 ;; append the type-cons to the type list.
8871 (if (setq entry (assoc key alist))
8872 (push type-cons (nth 2 entry))
8873 (push (list key file (list type-cons)) alist)))
8875 (setq alist (nreverse alist))
8877 (when syslibp
8878 ;; File is in system *library* - remove any 'system entry
8879 (setq alist (delq (assq 'system alist) alist)))
8881 ;; If 'system remains and we've scanned the syslib, it's a builtin
8882 ;; (rather than a !DIR/lib/.pro file bundled as source).
8883 (when (and (idlwave-syslib-scanned-p)
8884 (setq entry (assoc 'system alist)))
8885 (setcar entry 'builtin))
8886 (sort alist 'idlwave-routine-twin-compare)))
8888 (defvar type)
8889 (defvar class)
8890 (defvar idlwave-sort-prefer-buffer-info t
8891 "Internal variable used to influence `idlwave-routine-twin-compare'.")
8893 (defmacro idlwave-xor (a b)
8894 `(and (or ,a ,b)
8895 (not (and ,a ,b))))
8897 (defun idlwave-routine-entry-compare (a b)
8898 "Compare two routine info entries for sortiung. This is the general case.
8899 It first compates class, names, and type. If it turns out that A and B
8900 are twins (same name, class, and type), calls another routine which
8901 compares twins on the basis of their file names and path locations."
8902 (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
8903 (cond
8904 ((not (equal (idlwave-downcase-safe class)
8905 (idlwave-downcase-safe (nth 2 b))))
8906 ;; Class decides
8907 (cond ((null (nth 2 b)) nil)
8908 ((null class) t)
8909 (t (string< (downcase class) (downcase (nth 2 b))))))
8910 ((not (equal (downcase name) (downcase (car b))))
8911 ;; Name decides
8912 (string< (downcase name) (downcase (car b))))
8913 ((not (eq type (nth 1 b)))
8914 ;; Type decides
8915 (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
8916 (t
8917 ;; A and B are twins - so the decision is more complicated.
8918 ;; Call twin-compare with the proper arguments.
8919 (idlwave-routine-entry-compare-twins a b)))))
8921 (defun idlwave-routine-entry-compare-twins (a b)
8922 "Compare two routine entries, under the assumption that they are
8923 twins. This basically calls `idlwave-routine-twin-compare' with the
8924 correct args."
8925 (let* ((name (car a)) (type (nth 1 a)) (class (nth 2 a)) ; needed outside
8926 (asrc (nth 3 a))
8927 (atype (car asrc))
8928 (bsrc (nth 3 b))
8929 (btype (car bsrc))
8930 (afile (idlwave-routine-source-file asrc))
8931 (bfile (idlwave-routine-source-file bsrc)))
8932 (idlwave-routine-twin-compare
8933 (if (stringp afile)
8934 (list (file-truename afile) afile (list atype))
8935 (list atype afile (list atype)))
8936 (if (stringp bfile)
8937 (list (file-truename bfile) bfile (list btype))
8938 (list btype bfile (list btype))))
8939 ))
8941 (defun idlwave-routine-twin-compare (a b)
8942 "Compare two routine twin entries for sorting.
8943 In here, A and B are not normal routine info entries, but special
8944 lists (KEY FILENAME (TYPES...)).
8945 This expects NAME TYPE CLASS to be bound to the right values."
8946 (let* (;; Dis-assemble entries
8947 (akey (car a)) (bkey (car b))
8948 (afile (nth 1 a)) (bfile (nth 1 b))
8949 (atypes (nth 2 a)) (btypes (nth 2 b))
8950 ;; System routines?
8951 (asysp (memq akey '(builtin system)))
8952 (bsysp (memq bkey '(builtin system)))
8953 ;; Compiled routines?
8954 (acompp (memq 'compiled atypes))
8955 (bcompp (memq 'compiled btypes))
8956 ;; Unresolved?
8957 (aunresp (or (eq akey 'unresolved)
8958 (and acompp (not afile))))
8959 (bunresp (or (eq bkey 'unresolved)
8960 (and bcompp (not bfile))))
8961 ;; Buffer info available?
8962 (abufp (memq 'buffer atypes))
8963 (bbufp (memq 'buffer btypes))
8964 ;; On search path?
8965 (tpath-alist (idlwave-true-path-alist))
8966 (apathp (and (stringp akey)
8967 (assoc (file-name-directory akey) tpath-alist)))
8968 (bpathp (and (stringp bkey)
8969 (assoc (file-name-directory bkey) tpath-alist)))
8970 ;; How early on search path? High number means early since we
8971 ;; measure the tail of the path list
8972 (anpath (length (memq apathp tpath-alist)))
8973 (bnpath (length (memq bpathp tpath-alist)))
8974 ;; Look at file names
8975 (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
8976 (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
8978 (regexp-quote (downcase class))
8979 (regexp-quote (downcase name)))
8981 ;; Is file name derived from the routine name?
8982 ;; Method file or class definition file?
8983 (anamep (string-match fname-re aname))
8984 (adefp (and class anamep (string= "define" (match-string 1 aname))))
8985 (bnamep (string-match fname-re bname))
8986 (bdefp (and class bnamep (string= "define" (match-string 1 bname)))))
8988 ;; Now: follow JD's ideas about sorting. Looks really simple now,
8989 ;; doesn't it? The difficult stuff is hidden above...
8990 (cond
8991 ((idlwave-xor asysp bsysp) asysp) ; System entries first
8992 ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
8993 ((and idlwave-sort-prefer-buffer-info
8994 (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
8995 ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
8996 ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
8997 ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
8998 ((and class anamep bnamep ; both file names match ->
8999 (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
9000 ((> anpath bnpath) t) ; Who is first on path?
9001 (t nil)))) ; Default
9003 (defun idlwave-routine-source-file (source)
9004 (if (nth 2 source)
9005 (expand-file-name (nth 1 source) (nth 2 source))
9006 (nth 1 source)))
9008 (defun idlwave-downcase-safe (string)
9009 "Donwcase if string, else return unchanged."
9010 (if (stringp string)
9011 (downcase string)
9012 string))
9014 (defun idlwave-count-eq (elt list)
9015 "How often is ELT in LIST?"
9016 (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
9018 (defun idlwave-count-memq (elt alist)
9019 "How often is ELT a key in ALIST?"
9020 (length (delq nil (mapcar (lambda (x) (eq (car x) elt)) alist))))
9022 (defun idlwave-syslib-p (file)
9023 "Non-nil if FILE is in the system library."
9024 (let* ((true-syslib (file-name-as-directory
9025 (file-truename
9026 (expand-file-name "lib" (idlwave-sys-dir)))))
9027 (true-file (file-truename file)))
9028 (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
9030 (defun idlwave-lib-p (file)
9031 "Non-nil if file is in the library"
9032 (let ((true-dir (file-name-directory (file-truename file))))
9033 (assoc true-dir (idlwave-true-path-alist))))
9035 (defun idlwave-path-alist-add-flag (list-entry flag)
9036 "Add a flag to the path list entry, if not set."
9037 (let ((flags (cdr list-entry)))
9038 (add-to-list 'flags flag)
9039 (setcdr list-entry flags)))
9041 (defun idlwave-path-alist-remove-flag (list-entry flag)
9042 "Remove a flag to the path list entry, if set."
9043 (let ((flags (delq flag (cdr list-entry))))
9044 (setcdr list-entry flags)))
9046 (defun idlwave-true-path-alist ()
9047 "Return `idlwave-path-alist' alist with true-names.
9048 Info is cached, but relies on the functions setting `idlwave-path-alist'
9049 to reset the variable `idlwave-true-path-alist' to nil."
9050 (or idlwave-true-path-alist
9051 (setq idlwave-true-path-alist
9052 (mapcar (lambda(x) (cons
9053 (file-name-as-directory
9054 (file-truename
9055 (directory-file-name
9056 (car x))))
9057 (cdr x)))
9058 idlwave-path-alist))))
9060 (defun idlwave-syslib-scanned-p ()
9061 "Non-nil if the system lib file !DIR/lib has been scanned."
9062 (let* ((true-syslib (file-name-as-directory
9063 (file-truename
9064 (expand-file-name "lib" (idlwave-sys-dir))))))
9065 (cdr (assoc true-syslib (idlwave-true-path-alist)))))
9067 ;; ----------------------------------------------------------------------------
9068 ;;
9069 ;; Online Help display
9072 ;; ----------------------------------------------------------------------------
9073 ;;
9074 ;; Additions for use with imenu.el and func-menu.el
9075 ;; (pop-up a list of IDL units in the current file).
9076 ;;
9078 (defun idlwave-prev-index-position ()
9079 "Search for the previous procedure or function.
9080 Return nil if not found. For use with imenu.el."
9081 (save-match-data
9082 (cond
9084 ;; ((idlwave-find-key idlwave-begin-unit-reg 1 'nomark)
9085 (t nil))))
9087 (defun idlwave-unit-name ()
9088 "Return the unit name.
9089 Assumes that point is at the beginning of the unit as found by
9090 `idlwave-prev-index-position'."
9091 (forward-sexp 2)
9092 (forward-sexp -1)
9093 (let ((begin (point)))
9094 (re-search-forward
9096 (if (fboundp 'buffer-substring-no-properties)
9097 (buffer-substring-no-properties begin (point))
9098 (buffer-substring begin (point)))))
9100 (defalias 'idlwave-function-menu
9101 (condition-case nil
9102 (progn
9103 (require 'func-menu)
9104 'function-menu)
9105 (error (condition-case nil
9106 (progn
9107 (require 'imenu)
9108 'imenu)
9109 (error nil)))))
9111 ;; Here we hack func-menu.el in order to support this new mode.
9112 ;; The latest versions of func-menu.el already have this stuff in, so
9113 ;; we hack only if it is not already there.
9114 (when (fboundp 'eval-after-load)
9115 (eval-after-load "func-menu"
9116 '(progn
9117 (or (assq 'idlwave-mode fume-function-name-regexp-alist)
9118 (not (boundp 'fume-function-name-regexp-idl)) ; avoid problems
9119 (setq fume-function-name-regexp-alist
9120 (cons '(idlwave-mode . fume-function-name-regexp-idl)
9121 fume-function-name-regexp-alist)))
9122 (or (assq 'idlwave-mode fume-find-function-name-method-alist)
9123 (not (fboundp 'fume-find-next-idl-function-name)) ; avoid problems
9124 (setq fume-find-function-name-method-alist
9125 (cons '(idlwave-mode . fume-find-next-idl-function-name)
9126 fume-find-function-name-method-alist))))))
9128 (defun idlwave-edit-in-idlde ()
9129 "Edit the current file in IDL Development environment."
9130 (interactive)
9131 (start-process "idldeclient" nil
9132 idlwave-shell-explicit-file-name "-c" "-e"
9133 (buffer-file-name)))
9135 (defvar idlwave-help-use-assistant)
9136 (defun idlwave-launch-idlhelp ()
9137 "Start the IDLhelp application."
9138 (interactive)
9139 (if idlwave-help-use-assistant
9140 (idlwave-help-assistant-raise)
9141 (start-process "idlhelp" nil idlwave-help-application)))
9143 ;; Menus - using easymenu.el
9144 (defvar idlwave-mode-menu-def
9145 `("IDLWAVE"
9146 ["PRO/FUNC menu" idlwave-function-menu t]
9147 ("Motion"
9148 ["Subprogram Start" idlwave-beginning-of-subprogram t]
9149 ["Subprogram End" idlwave-end-of-subprogram t]
9150 ["Block Start" idlwave-beginning-of-block t]
9151 ["Block End" idlwave-end-of-block t]
9152 ["Up Block" idlwave-backward-up-block t]
9153 ["Down Block" idlwave-down-block t]
9154 ["Skip Block Backward" idlwave-backward-block t]
9155 ["Skip Block Forward" idlwave-forward-block t])
9156 ("Mark"
9157 ["Subprogram" idlwave-mark-subprogram t]
9158 ["Block" idlwave-mark-block t]
9159 ["Header" idlwave-mark-doclib t])
9160 ("Format"
9161 ["Indent Entire Statement" idlwave-indent-statement
9163 ["Indent Subprogram" idlwave-indent-subprogram t]
9164 ["(Un)Comment Region" idlwave-toggle-comment-region t]
9165 ["Continue/Split line" idlwave-split-line t]
9166 "--"
9167 ["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
9168 :selected (symbol-value idlwave-fill-function)])
9169 ("Templates"
9170 ["Procedure" idlwave-procedure t]
9171 ["Function" idlwave-function t]
9172 ["Doc Header" idlwave-doc-header t]
9173 ["Log" idlwave-doc-modification t]
9174 "--"
9175 ["Case" idlwave-case t]
9176 ["For" idlwave-for t]
9177 ["Repeat" idlwave-repeat t]
9178 ["While" idlwave-while t]
9179 "--"
9180 ["Close Block" idlwave-close-block t])
9181 ("Completion"
9182 ["Complete" idlwave-complete t]
9183 ("Complete Specific"
9184 ["1 Procedure Name" (idlwave-complete 'procedure) t]
9185 ["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
9186 "--"
9187 ["3 Function Name" (idlwave-complete 'function) t]
9188 ["4 Function Keyword" (idlwave-complete 'function-keyword) t]
9189 "--"
9190 ["5 Procedure Method Name" (idlwave-complete 'procedure-method) t]
9191 ["6 Procedure Method Keyword" (idlwave-complete 'procedure-method-keyword) t]
9192 "--"
9193 ["7 Function Method Name" (idlwave-complete 'function-method) t]
9194 ["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
9195 "--"
9196 ["9 Class Name" idlwave-complete-class t]))
9197 ("Routine Info"
9198 ["Show Routine Info" idlwave-routine-info t]
9199 ["Online Context Help" idlwave-context-help t]
9200 "--"
9201 ["Find Routine Source" idlwave-find-module t]
9202 ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
9203 "--"
9204 ["Update Routine Info" idlwave-update-routine-info t]
9205 ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t]
9206 "--"
9207 "IDL User Catalog"
9208 ["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
9209 ["Scan Directories" (idlwave-update-routine-info '(16))
9210 (and idlwave-path-alist (not idlwave-catalog-process))]
9211 ["Scan Directories &" (idlwave-update-routine-info '(64))
9212 (and idlwave-path-alist (not idlwave-catalog-process))]
9213 "--"
9214 "Routine Shadows"
9215 ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
9216 ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
9217 ["Check Everything" idlwave-list-all-load-path-shadows t])
9218 ("Misc"
9219 ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
9220 "--"
9221 ["Insert TAB character" idlwave-hard-tab t])
9222 "--"
9223 ("External"
9224 ["Start IDL shell" idlwave-shell t]
9225 ["Edit file in IDLDE" idlwave-edit-in-idlde t]
9226 ["Launch IDL Help" idlwave-launch-idlhelp t])
9227 "--"
9228 ("Customize"
9229 ["Browse IDLWAVE Group" idlwave-customize t]
9230 "--"
9231 ["Build Full Customize Menu" idlwave-create-customize-menu
9232 (fboundp 'customize-menu-create)])
9233 ("Documentation"
9234 ["Describe Mode" describe-mode t]
9235 ["Abbreviation List" idlwave-list-abbrevs t]
9236 "--"
9237 ["Commentary in idlwave.el" idlwave-show-commentary t]
9238 ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
9239 "--"
9240 ["Info" idlwave-info t]
9241 "--"
9242 ["Help with Topic" idlwave-help-assistant-help-with-topic
9243 idlwave-help-use-assistant]
9244 ["Launch IDL Help" idlwave-launch-idlhelp t])))
9246 (defvar idlwave-mode-debug-menu-def
9247 '("Debug"
9248 ["Start IDL shell" idlwave-shell t]
9249 ["Save and .RUN buffer" idlwave-shell-save-and-run
9250 (and (boundp 'idlwave-shell-automatic-start)
9251 idlwave-shell-automatic-start)]))
9253 (if (or (featurep 'easymenu) (load "easymenu" t))
9254 (progn
9255 (easy-menu-define idlwave-mode-menu idlwave-mode-map
9256 "IDL and WAVE CL editing menu"
9257 idlwave-mode-menu-def)
9258 (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
9259 "IDL and WAVE CL editing menu"
9260 idlwave-mode-debug-menu-def)))
9262 (defun idlwave-customize ()
9263 "Call the customize function with idlwave as argument."
9264 (interactive)
9265 ;; Try to load the code for the shell, so that we can customize it
9266 ;; as well.
9267 (or (featurep 'idlw-shell)
9268 (load "idlw-shell" t))
9269 (customize-browse 'idlwave))
9271 (defun idlwave-create-customize-menu ()
9272 "Create a full customization menu for IDLWAVE, insert it into the menu."
9273 (interactive)
9274 (if (fboundp 'customize-menu-create)
9275 (progn
9276 ;; Try to load the code for the shell, so that we can customize it
9277 ;; as well.
9278 (or (featurep 'idlw-shell)
9279 (load "idlw-shell" t))
9280 (easy-menu-change
9281 '("IDLWAVE") "Customize"
9282 `(["Browse IDLWAVE group" idlwave-customize t]
9283 "--"
9284 ,(customize-menu-create 'idlwave)
9285 ["Set" Custom-set t]
9286 ["Save" Custom-save t]
9287 ["Reset to Current" Custom-reset-current t]
9288 ["Reset to Saved" Custom-reset-saved t]
9289 ["Reset to Standard Settings" Custom-reset-standard t]))
9291 (error "Cannot expand menu (outdated version of cus-edit.el)")))
9293 (defun idlwave-show-commentary ()
9294 "Use the finder to view the file documentation from `idlwave.el'."
9295 (interactive)
9296 (require 'finder)
9297 (finder-commentary "idlwave.el"))
9299 (defun idlwave-shell-show-commentary ()
9300 "Use the finder to view the file documentation from `idlw-shell.el'."
9301 (interactive)
9302 (require 'finder)
9303 (finder-commentary "idlw-shell.el"))
9305 (defun idlwave-info ()
9306 "Read documentation for IDLWAVE in the info system."
9307 (interactive)
9308 (require 'info)
9309 (Info-goto-node "(idlwave)"))
9311 (defun idlwave-list-abbrevs (arg)
9312 "Show the code abbreviations define in IDLWAVE mode.
9313 This lists all abbrevs where the replacement text differs from the input text.
9314 These are the ones the users want to learn to speed up their writing.
9316 The function does *not* list abbrevs which replace a word with itself
9317 to call a hook. These hooks are used to change the case of words or
9318 to blink the matching `begin', and the user does not need to know them.
9320 With arg, list all abbrevs with the corresponding hook.
9322 This function was written since `list-abbrevs' looks terrible for IDLWAVE mode."
9324 (interactive "P")
9325 (let ((table (symbol-value 'idlwave-mode-abbrev-table))
9326 abbrevs
9327 str rpl func fmt (len-str 0) (len-rpl 0))
9328 (mapatoms
9329 (lambda (sym)
9330 (if (symbol-value sym)
9331 (progn
9332 (setq str (symbol-name sym)
9333 rpl (symbol-value sym)
9334 func (symbol-function sym))
9335 (if arg
9336 (setq func (prin1-to-string func))
9337 (if (and (listp func) (stringp (nth 2 func)))
9338 (setq rpl (concat "EVAL: " (nth 2 func))
9339 func "")
9340 (setq func "")))
9341 (if (or arg (not (string= rpl str)))
9342 (progn
9343 (setq len-str (max len-str (length str)))
9344 (setq len-rpl (max len-rpl (length rpl)))
9345 (setq abbrevs (cons (list str rpl func) abbrevs)))))))
9346 table)
9347 ;; sort the list
9348 (setq abbrevs (sort abbrevs (lambda (a b) (string< (car a) (car b)))))
9349 ;; Make the format
9351 (with-output-to-temp-buffer "*Help*"
9352 (if arg
9353 (progn
9356 (princ (format fmt "KEY" "REPLACE" "HOOK"))
9357 (princ (format fmt "---" "-------" "----")))
9360 (princ (format fmt "KEY" "ACTION" ""))
9361 (princ (format fmt "---" "------" "")))
9362 (mapcar
9363 (lambda (list)
9364 (setq str (car list)
9365 rpl (nth 1 list)
9366 func (nth 2 list))
9367 (princ (format fmt str rpl func)))
9368 abbrevs)))
9369 ;; Make sure each abbreviation uses only one display line
9370 (save-excursion
9371 (set-buffer "*Help*")
9372 (setq truncate-lines t)))
9374 ;; Add .pro files to speedbar for support, if it's loaded
9375 (eval-after-load "speedbar" '(speedbar-add-supported-extension ".pro"))
9377 ;; Set an idle timer to load the routine info.
9378 ;; Will only work on systems which support this.
9379 (or idlwave-routines (idlwave-start-load-rinfo-timer))
9383 ;; Run the hook
9384 (run-hooks 'idlwave-load-hook)
9386 (provide 'idlwave)
9388 ;; arch-tag: f77f3b0c-c37c-424f-a328-0886fd42b6fb
9389 ;;; idlwave.el ends here