;;; idlwave.el --- IDL and WAVE CL editing mode for GNU Emacs
-;; Copyright (c) 1994-1997 Chris Chase
-;; Copyright (c) 1999 Carsten Dominik
-;; Copyright (c) 1999 Free Software Foundation
+;; Copyright (c) 1999, 2000 Free Software Foundation
;; Author: Chris Chase <chase@att.com>
-;; Maintainer: Carsten Dominik <dominik@strw.leidenuniv.nl>
-;; Version: 3.11
-;; Date: $Date: 1999/12/20 11:10:02 $
+;; Maintainer: John-David Smith <jdsmith@astro.cornell.edu>
+;; Version: 4.7
+;; Date: $Date: 2001/12/30 22:18:30 $
;; Keywords: languages
-;; This file is part of the GNU Emacs.
+;; This file is part of GNU Emacs.
;; GNU Emacs is free software; you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; point backward, e.g., "\cl" expanded with a space becomes
;; "LONG( )" with point before the close paren. This is solved by
;; using a temporary function in `post-command-hook' - not pretty,
-;; but it works.<
+;; but it works.
;;
;; Tabs and spaces are treated equally as whitespace when filling a
;; comment paragraph. To accomplish this, tabs are permanently
;; problems with pointer dereferencing statements. I don't use
;; pointers often enough to find out - please report any problems.
;;
-;; Completion of keywords for SETPROPERTY and GETPROPERTY assumes that
-;; all INIT keywords are allowed in these methods as well. In some
-;; cases, there are exceptions to this rule and IDLWAVE will offer
-;; a few illegal keyword parameters.
-;;
;; Completion and Routine Info do not know about inheritance. Thus,
;; Keywords inherited from superclasses are not displayed and cannot
;; completed.
;;
;; When forcing completion of method keywords, the initial
;; query for a method has multiple entries for some methods. Would
-;; be too difficult to fix this hardly used problem.
+;; be too difficult to fix this hardly used case.
;;
\f
;;; Code:
(eval-when-compile (require 'cl))
(eval-and-compile
- ;; Kludge to allow `defcustom' for Emacs 19.
- (condition-case () (require 'custom) (error nil))
- (if (and (featurep 'custom) (fboundp 'custom-declare-variable))
- nil ;; We've got what we needed
- ;; We have the old or no custom-library, hack around it!
- (defmacro defgroup (&rest args) nil)
- (defmacro defcustom (var value doc &rest args)
- (` (defvar (, var) (, value) (, doc))))))
+ ;; Kludge to allow `defcustom' for Emacs 19.
+ (condition-case () (require 'custom) (error nil))
+ (if (and (featurep 'custom) (fboundp 'custom-declare-variable))
+ nil ;; We've got what we needed
+ ;; We have the old or no custom-library, hack around it!
+ (defmacro defgroup (&rest args) nil)
+ (defmacro defcustom (var value doc &rest args)
+ `(defvar ,var ,value ,doc))))
(defgroup idlwave nil
"Major mode for editing IDL/WAVE CL .pro files"
:tag "IDLWAVE"
:link '(url-link :tag "Home Page"
"http://strw.leidenuniv.nl/~dominik/Tools/idlwave")
- :link '(emacs-commentary-link :tag "Commentary in idlwave-shell.el"
- "idlwave-shell.el")
+ :link '(emacs-commentary-link :tag "Commentary in idlw-shell.el"
+ "idlw-shell.el")
:link '(emacs-commentary-link :tag "Commentary in idlwave.el" "idlwave.el")
:link '(custom-manual "(idlwave)Top")
:prefix "idlwave"
;;; Routine Info and Completion ---------------------------------------
-(defgroup idlwave-routine-info-and-completion nil
- "Routine info and name/keyword completion options for IDLWAVE mode."
+(defgroup idlwave-routine-info nil
+ "Routine Info options for IDLWAVE mode."
:group 'idlwave)
(defcustom idlwave-scan-all-buffers-for-routine-info t
- "*Non-nil means, scan all buffers for IDL programs when updating info.
-`idlwave-update-routine-info' scans buffers of the current Emacs session
-for routine definitions. When this variable is nil, it only parses the
-current buffer. When non-nil, all buffers are searched.
-A prefix to \\[idlwave-update-routine-info] toggles the meaning of this
-variable for the duration of the command."
- :group 'idlwave-routine-info-and-completion
- :type 'boolean)
+ "*Non-nil means, scan buffers for IDL programs when updating info.
+The scanning is done by the command `idlwave-update-routine-info'.
+The following values are allowed:
+
+nil Don't scan any buffers.
+t Scan all idlwave-mode buffers in the current editing session.
+current Scan only the current buffer, but no other buffers."
+ :group 'idlwave-routine-info
+ :type '(choice
+ (const :tag "No buffer" nil)
+ (const :tag "All buffers" t)
+ (const :tag "Current buffer only" 'current)))
(defcustom idlwave-query-shell-for-routine-info t
"*Non-nil means query the shell for info about compiled routines.
Querying the shell is useful to get information about compiled modules,
and it is turned on by default. However, when you have a complete library
scan, this is not necessary."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-routine-info
:type 'boolean)
+(defcustom idlwave-auto-routine-info-updates
+ '(find-file save-buffer kill-buffer compile-buffer)
+ "*Controls under what circumstances routine info is updated automatically.
+Possible values:
+nil Never
+t All available
+(...) A list of circumstances. Allowed members are:
+ find-file Add info for new IDLWAVE buffers.
+ save-buffer Update buffer info when buffer is saved
+ kill-buffer Remove buffer info when buffer gets killed
+ compile-buffer Update shell info after `idlwave-shell-save-and...'"
+ :group 'idlwave-routine-info
+ :type '(choice
+ (const :tag "Never" nil)
+ (const :tag "As often as possible" t)
+ (set :tag "Checklist" :greedy t
+ (const :tag "When visiting a file" find-file)
+ (const :tag "When saving a buffer" save-buffer)
+ (const :tag "After a buffer was killed" kill-buffer)
+ (const :tag "After a buffer was compiled successfully, update shell info" compile-buffer))))
+
+(defcustom idlwave-rinfo-max-source-lines 5
+ "*Maximum number of source files displayed in the Routine Info window.
+When an integer, it is the maximum number of source files displayed.
+t means to show all source files."
+ :group 'idlwave-routine-info
+ :type 'integer)
+
(defcustom idlwave-library-path nil
"Library path for Windows and MacOS. Not needed under Unix.
When selecting the directories to scan for IDL library routine info,
case, this variable specifies the path where IDLWAVE can find library files.
The shell will only be asked when this variable is nil.
The value is a list of directories. A directory preceeded by a `+' will
-be search recursively."
- :group 'idlwave-routine-info-and-completion
+be searched recursively. If you set this variable on a UNIX system, the shell
+will not be asked.
+See also `idlwave-system-directory'."
+ :group 'idlwave-routine-info
:type '(repeat (directory)))
-(defcustom idlwave-libinfo-file nil
+(defcustom idlwave-system-directory ""
+ "The IDL system directory for Windows and MacOS. Not needed under UNIX.
+Set this to the value of the `!DIR' system variable in IDL. IDLWAVE uses
+this to find out which of the library routines belong to the official system
+library. All files inside the `lib' subdirectory are considered system
+library files - so don't install private stuff in this directory.
+On UNIX systems, IDLWAVE queries the shell for the value of `!DIR'.
+See also `idlwave-library-path'."
+ :group 'idlwave-routine-info
+ :type 'directory)
+
+(defcustom idlwave-libinfo-file "~/.idlcat.el"
"*File for routine information of the IDL library.
When this points to a file, the file will be loaded when IDLWAVE first
accesses routine info (or does completion).
When you scan the library with `idlwave-create-libinfo-file', this file
will be used to store the result."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-routine-info
+ :type 'file)
+
+(defcustom idlwave-special-lib-alist nil
+ "Alist of regular expressions matching special library directories.
+When listing routine source locations, IDLWAVE gives a short hint where
+the file defining the routine is located. By default it lists `SystemLib'
+for routines in the system library `!DIR/lib' and `Library' for anything
+else. This variable can define additional types. The car of each entry
+is a regular expression matching the file name (they normally will match
+on the path). The cdr is the string to be used as identifier. Max 10
+chars are allowed."
+ :group 'idlwave-routine-info
+ :type '(repeat
+ (cons regexp string)))
+
+(defgroup idlwave-online-help nil
+ "Online Help options for IDLWAVE mode."
+ :group 'idlwave)
+
+(defcustom idlwave-help-directory ""
+ "The directory where idlw-help.txt and idlw-help.el are stored."
+ :group 'idlwave-online-help
:type 'file)
+(defcustom idlwave-help-use-dedicated-frame t
+ "*Non-nil means, use a separate frame for Online Help if possible."
+ :group 'idlwave-online-help
+ :type 'boolean)
+
+(defcustom idlwave-help-frame-parameters
+ '((height . 20) (unsplittable . t))
+ "The frame parameters for the special Online Help frame.
+See also `idlwave-help-use-dedicated-frame'.
+If you do not set the frame width here, the value specified in
+`idlw-help.el' will be used."
+ :group 'idlwave-online-help
+ :type '(repeat
+ (cons symbol sexp)))
+
+(defcustom idlwave-max-popup-menu-items 20
+ "Maximum number of items per pane in popup menus.
+Currently only used for class selection during completion help."
+ :group 'idlwave-online-help
+ :type 'integer)
+
+(defcustom idlwave-extra-help-function 'idlwave-help-with-source
+ "The function to call for online help if the normal help fails.
+Online help works only for system routines which are described in the
+IDL manuals. A function may be specified to access help from other sources.
+
+The function must accept four arguments: NAME, TYPE, CLASS, KEYWORD.
+The Help buffer is current when this function is called, and the help
+text should be loaded into this buffer. If help is found, the function
+should return the buffer position which should be used as `window-start'
+in the help window. Also, the variable `idlwave-help-mode-line-indicator'
+should be set to a useful string, which will be displayed in the mode line
+of the help window. If should also set the variable `idlwave-min-frame-width'
+to a positive integer. IDLWAVE will ensure that the help frame is at
+least that many columns wide.
+Failure to find help should be indicated by throwing an error.
+
+When this variable is non-nil, IDLWAVE will allow the mouse-3 help click
+for every routine and keyword, even though the item may not be highlighted
+in blue (indicating the availability of system documentation).
+
+The default value for this function is `idlwave-help-with-source' which
+loads the routine source file into the help buffer. If you try to write
+a different function which accesses a special help file or so, it is
+probably a good idea to still call this function as a fallback."
+ :group 'idlwave-online-help
+ :type 'symbol)
+
+(defcustom idlwave-help-fontify-source-code nil
+ "*Non-nil means, fontify source code displayed as help like normal code."
+ :group 'idlwave-online-help
+ :type 'boolean)
+
+(defcustom idlwave-help-source-try-header t
+ "*Non-nil means, try to find help in routine header when displaying source.
+Routines which are not documented in the system manual use their source as
+help text. When this variable is non-nil, we try to find a description of
+the help item in the first routine doclib header above the routine definition.
+If the variable is nil, or if we cannot find/parse the header, the routine
+definition is displayed instead."
+ :group 'idlwave-online-help
+ :type 'boolean)
+
+(defface idlwave-help-link-face
+ '((((class color)) (:foreground "Blue"))
+ (t (:weight bold)))
+ "Face for highlighting links into IDLWAVE online help."
+ :group 'idlwave-online-help)
+
+(defcustom idlwave-help-activate-links-agressively t
+ "*Non-nil means, make all possible links in help active.
+This just activates all words which are also a help topic - some links may
+be misleading."
+ :group 'idlwave-online-help
+ :type 'boolean)
+
+
+(defgroup idlwave-completion nil
+ "Completion options for IDLWAVE mode."
+ :prefix "idlwave"
+ :group 'idlwave)
+
(eval-and-compile
(defconst idlwave-tmp
'(choice :tag "by applying the function"
(const preserve)
(symbol :tag "Other"))))
-
(defcustom idlwave-completion-case '((routine . upcase)
(keyword . upcase)
(class . preserve)
After changing this variable, you need to either restart Emacs or press
`C-u C-c C-i' to update the internal lists."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
:type `(repeat
(cons (symbol :tag "Derive completion case for")
,idlwave-tmp)))
will honor the default settings in `idlwave-completion-case', while
the completion of lower case strings will be completed entirely in
lower case."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
:type 'boolean)
(defcustom idlwave-complete-empty-string-as-lower-case nil
When this variable is non-nil, the empty string is considered to be downcase.
Completing on the empty string then offers downcase versions of the possible
completions."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
:type 'boolean)
(defvar idlwave-default-completion-case-is-down nil
the routine info from the buffers. This is slow.
The default is to consider the case given in the system and library files
first which makes updating much faster."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
+ :type 'boolean)
+
+(defcustom idlwave-highlight-help-links-in-completion t
+ "*Non-nil means, highlight completions for which system help is available.
+Help can then be accessed with mouse-3.
+This option is only effective when the online help system is installed."
+ :group 'idlwave-completion
+ :type 'boolean)
+
+(defcustom idlwave-support-inheritance t
+ "Non-nil means, treat inheritance with completion, online help etc.
+When nil, IDLWAVE only knows about the native methods and tags of a class,
+not about inherited ones."
+ :group 'idlwave-routine-info
:type 'boolean)
(defcustom idlwave-completion-show-classes 1
property on the competion items, so that the list of classes for the current
item is displayed in the echo area. If the value of this variable is a
negative integer, the `help-echo' property will be suppressed."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
:type '(choice (const :tag "Don't show" nil)
(integer :tag "Number of classes shown" 1)))
"*Non-nil means, fontify the classes in completions buffer.
This makes it easier to distinguish the completion items from the extra
class info listed. See `idlwave-completion-show-classes'."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
:type 'boolean)
(defcustom idlwave-query-class '((method-default . nil)
keyword completion rule for specific methods, like INIT or
GETPROPERTY. In order to turn on class specification for the INIT
method, add an entry (\"INIT\" . t). The method name must be ALL-CAPS."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
:type '(list
(cons (const method-default)
(boolean :tag "Determine class when completing METHODS "))
`idlwave-class-arrow-face'. The command \\[idlwave-routine-info]
displays (with prefix arg: deletes) the class stored on the arrow
at point."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
:type 'boolean)
(defcustom idlwave-class-arrow-face 'bold
When IDLWAVE stores a class name as text property on an object arrow
(see variable `idlwave-store-inquired-class', it highlights the arrow
with this font in order to remind the user that this arrow is special."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
:type 'symbol)
(defcustom idlwave-resize-routine-help-window t
"*Non-nil means, resize the Routine-info *Help* window to fit the content."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
:type 'boolean)
(defcustom idlwave-keyword-completion-adds-equal t
"*Non-nil means, completion automatically adds `=' after completed keywords."
- :group 'idlwave-routine-info
+ :group 'idlwave-completion
:type 'boolean)
(defcustom idlwave-function-completion-adds-paren t
"*Non-nil means, completion automatically adds `(' after completed function.
-Nil means, don't add anything.
+nil means, don't add anything.
A value of `2' means, also add the closing parenthesis and position cursor
between the two."
- :group 'idlwave-routine-info
+ :group 'idlwave-completion
:type '(choice (const :tag "Nothing" nil)
(const :tag "(" t)
(const :tag "()" 2)))
When completion is not unique, Emacs displays a list of completions.
This messes up your window configuration. With this variable set, IDLWAVE
restores the old configuration after successful completion."
- :group 'idlwave-routine-info-and-completion
+ :group 'idlwave-completion
:type 'boolean)
;;; Variables for abbrev and action behavior -----------------------------
(defcustom idlwave-surround-by-blank nil
"*Non-nil means, enable `idlwave-surround'.
-If non-nil, `=',`<',`>',`&',`,' are surrounded with spaces by
+If non-nil, `=',`<',`>',`&',`,', `->' are surrounded with spaces by
`idlwave-surround'.
See help for `idlwave-indent-action-table' for symbols using `idlwave-surround'.
(defcustom idlwave-pad-keyword t
"*Non-nil means pad '=' for keywords like assignments.
Whenever `idlwave-surround' is non-nil then this affects how '=' is padded
-for keywords. If non-nil it is padded the same as for assignments.
-If nil then spaces are removed."
+for keywords. If t, it is padded the same as for assignments.
+If nil then spaces are removed. With any other value, spaces are left
+unchanged."
:group 'idlwave-abbrev-and-indent-action
- :type 'boolean)
+ :type '(choice
+ (const :tag "Pad like assignments" t)
+ (const :tag "Remove space near `='" nil)
+ (const :tag "Keep space near `='" 'keep)))
(defcustom idlwave-show-block t
"*Non-nil means point blinks to block beginning for `idlwave-show-begin'."
:group 'idlwave-abbrev-and-indent-action
:type 'boolean)
+(defcustom idlwave-reindent-end t
+ "*Non-nil means re-indent line after END was typed."
+ :group 'idlwave-abbrev-and-indent-action
+ :type 'boolean)
+
(defcustom idlwave-abbrev-move t
"*Non-nil means the abbrev hook can move point.
Set to nil by `idlwave-expand-region-abbrevs'. To see the abbrev
")
"*A list (PATHNAME STRING) specifying the doc-header template to use for
summarizing a file. If PATHNAME is non-nil then this file will be included.
-Otherwise STRING is used. If NIL, the file summary will be omitted.
+Otherwise STRING is used. If nil, the file summary will be omitted.
For example you might set PATHNAME to the path for the
lib_template.pro file included in the IDL distribution.")
;;; External Programs -------------------------------------------------------
(defgroup idlwave-external-programs nil
- "Miscellaneous options for IDLWAVE mode."
+ "Path locations of external commands used by IDLWAVE."
:group 'idlwave)
;; WARNING: The following variable has recently been moved from
-;; idlwave-shell.el to this file. I hope this does not break
+;; idlw-shell.el to this file. I hope this does not break
;; anything.
(defcustom idlwave-shell-explicit-file-name "idl"
:group 'idlwave-external-programs
:type 'string)
+;;; Some Shell variables which must be defined here.-----------------------
+
+(defcustom idlwave-shell-debug-modifiers '()
+ "List of modifiers to be used for the debugging commands.
+Will be used to bind debugging commands in the shell buffer and in all
+source buffers. These are additional convenience bindings, the debugging
+commands are always available with the `C-c C-d' prefix.
+If you set this to '(control shift), this means setting a breakpoint will
+be on `C-S-b', compiling a source file on `C-S-c' etc. Possible modifiers
+are `control', `meta', `super', `hyper', `alt', and `shift'."
+ :group 'idlwave-shell-general-setup
+ :type '(set :tag "Specify modifiers"
+ (const control)
+ (const meta)
+ (const super)
+ (const hyper)
+ (const alt)
+ (const shift)))
+
+(defcustom idlwave-shell-automatic-start nil
+ "*If non-nil attempt invoke idlwave-shell if not already running.
+This is checked when an attempt to send a command to an
+IDL process is made."
+ :group 'idlwave-shell-general-setup
+ :type 'boolean)
+
;;; Miscellaneous variables -------------------------------------------------
(defgroup idlwave-misc nil
(const :tag "IDL Keywords (reserved words)" idl-keywords)
(const :tag "Statement Labels" label)
(const :tag "Goto Statements" goto)
+ (const :tag "Tags in Structure Definition" structtag)
+ (const :tag "Structure Name" structname)
(const :tag "Common Blocks" common-blocks)
(const :tag "Keyword Parameters" keyword-parameters)
(const :tag "System Variables" system-variables)
:group 'idlwave-misc
:type 'hook)
+(defvar idlwave-experimental nil
+ "Non-nil means turn on a few experimental features.
+This variable is only for the maintainer, to test difficult stuff,
+while still distributing stable releases.
+As a user, you should not set this to t.")
+
;;;
;;; End customization variables section
;;;
;; The following are the reserved words in IDL. Maybe we should
;; highlight some more stuff as well?
(idl-keywords
-; '("and" "or" "xor" "not"
-; "eq" "ge" "gt" "le" "lt" "ne"
-; "for" "do" "endfor"
-; "if" "then" "endif" "else" "endelse"
-; "case" "of" "endcase"
-; "begin" "end"
-; "repeat" "until" "endrep"
-; "while" "endwhile"
-; "goto" "return"
-; "inherits" "mod" "on_error" "on_ioerror") ;; on_error is not reserved
- (concat "\\<\\("
- "and\\|begin\\|case\\|do\\|e\\(lse\\|nd\\(case\\|else\\|"
- "for\\|if\\|rep\\|while\\)?\\|q\\)\\|for\\|g\\(oto\\|[et]\\)"
- "\\|i\\(f\\|nherits\\)\\|l[et]\\|mod\\|n\\(e\\|ot\\)\\|"
- "o\\(n_ioerror\\|[fr]\\)\\|re\\(peat\\|turn\\)\\|then\\|"
- "until\\|while\\|xor"
- "\\)\\>"))
+ ;; To update this regexp, update the list of keywords and
+ ;; evaluate the form.
+; (insert
+; (prin1-to-string
+; (concat
+; "\\<\\("
+; (regexp-opt
+; '("and" "or" "xor" "not"
+; "eq" "ge" "gt" "le" "lt" "ne"
+; "for" "do" "endfor"
+; "if" "then" "endif" "else" "endelse"
+; "case" "of" "endcase"
+; "switch" "break" "continue" "endswitch"
+; "begin" "end"
+; "repeat" "until" "endrep"
+; "while" "endwhile"
+; "goto" "return"
+; "inherits" "mod"
+; "compile_opt" "forward_function"
+; "on_error" "on_ioerror")) ; on_error is not officially reserved
+; "\\)\\>")))
+
+ "\\<\\(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\\)\\>")
;; Procedure declarations. Fontify keyword plus procedure name.
;; Function declarations. Fontify keyword plus function name.
(1 font-lock-keyword-face)
(2 font-lock-reference-face)))
+ ;; Tags in structure definitions. Note that this definition actually
+ ;; collides with labels, so we have to use the same face.
+ (structtag
+ '("\\<\\([a-zA-Z][a-zA-Z0-9_]*:\\)[^:]" (1 font-lock-reference-face)))
+
+ ;; Structure names
+ (structname
+ '("\\({\\|\\<inherits\\s-\\)\\s-*\\([a-zA-Z][a-zA-Z0-9_]*\\)[},\t \n]"
+ (2 font-lock-function-name-face)))
+
;; Named parameters, like /xlog or ,xrange=[]
;; This is anchored to the comma preceeding the keyword.
- ;; With continuation lines, works only during whole buffer fontification.
+ ;; Treats continuation lines, works only during whole buffer
+ ;; fontification. Slow, use it only in fancy fontification.
(keyword-parameters
- '("[(,][ \t]*\\(\\$[ \t]*\n[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
- (2 font-lock-reference-face)))
+ '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\\(\n[ \t]*;.*\\)*\n[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
+ (5 font-lock-reference-face)))
- ;; System variables stars with a bang.
+ ;; System variables start with a bang.
(system-variables
- '("\\(![a-zA-Z_]+\\(\\.\\sw+\\)?\\)"
+ '("\\(![a-zA-Z_0-9]+\\(\\.\\sw+\\)?\\)"
(1 font-lock-variable-name-face)))
;; Special and unusual operators (not used because too noisy)
fixme fixme
label label
goto goto
+ structtag structtag
+ structname structname
keyword-parameters keyword-parameters
system-variables system-variables
special-operators special-operators
batch-files
idl-keywords
label goto
+ structtag
+ structname
common-blocks
keyword-parameters
system-variables
That is the _beginning_ of a line containing a comment delimiter `;' preceded
only by whitespace.")
-(defconst idlwave-begin-block-reg "\\<\\(pro\\|function\\|begin\\|case\\)\\>"
+(defconst idlwave-begin-block-reg
+ "\\<\\(pro\\|function\\|begin\\|case\\|switch\\)\\>"
"Regular expression to find the beginning of a block. The case does
not matter. The search skips matches in comments.")
"Regular expression to match a continued line.")
(defconst idlwave-end-block-reg
- "\\<end\\(\\|case\\|else\\|for\\|if\\|rep\\|while\\)\\>"
+ "\\<end\\(\\|case\\|switch\\|else\\|for\\|if\\|rep\\|while\\)\\>"
"Regular expression to find the end of a block. The case does
not matter. The search skips matches found in comments.")
("for" . "endfor")
("then" . "endif")
("repeat" . "endrep")
+ ("switch" . "endswitch")
("while" . "endwhile"))
"Matches between statements and the corresponding END variant.
The cars are the reserved words starting a block. If the block really
'(repeat . ("repeat\\>" "repeat"))
'(goto . ("goto\\>" nil))
'(case . ("case\\>" nil))
+ '(switch . ("switch\\>" nil))
(cons 'call (list (concat idlwave-identifier "\\(\\s *$\\|\\s *,\\)") nil))
- '(assign . ("[^=\n]*=" nil)))
+ '(assign . ("[^=>\n]*=" nil)))
"Associated list of statement matching regular expressions.
Each regular expression matches the start of an IDL statement. The
whitespace. If it is nil then the statement has no substatement. The
list order matters since matching an assignment statement exactly is
not possible without parsing. Thus assignment statement become just
-the leftover unidentified statements containing and equal sign. " )
+the leftover unidentified statements containing an equal sign." )
(defvar idlwave-fill-function 'auto-fill-function
"IDL mode auto fill function.")
"Character which is inserted as a last character on previous line by
\\[idlwave-split-line] to begin a continuation line. Normally $.")
-(defconst idlwave-mode-version " 3.11")
+(defconst idlwave-mode-version " 4.7")
(defmacro idlwave-keyword-abbrev (&rest args)
"Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
- (` (quote (lambda ()
- (, (append '(idlwave-check-abbrev) args))))))
+ `(quote (lambda ()
+ ,(append '(idlwave-check-abbrev) args))))
;; If I take the time I can replace idlwave-keyword-abbrev with
;; idlwave-code-abbrev and remove the quoted abbrev check from
"Creates a function for abbrev hooks that ensures abbrevs are not quoted.
Specifically, if the abbrev is in a comment or string it is unexpanded.
Otherwise ARGS forms a list that is evaluated."
- (` (quote (lambda ()
- (, (prin1-to-string args)) ;; Puts the code in the doc string
- (if (idlwave-quoted) (progn (unexpand-abbrev) nil)
- (, (append args)))))))
+ `(quote (lambda ()
+ ,(prin1-to-string args) ;; Puts the code in the doc string
+ (if (idlwave-quoted)
+ (progn (unexpand-abbrev) nil)
+ ,(append args)))))
(defvar idlwave-mode-map (make-sparse-keymap)
"Keymap used in IDL mode.")
(modify-syntax-entry ?$ "w" idlwave-find-symbol-syntax-table)
(modify-syntax-entry ?_ "w" idlwave-find-symbol-syntax-table)
+(defmacro idlwave-with-special-syntax (&rest body)
+ "Execute BODY with a different systax table."
+ `(let ((saved-syntax (syntax-table)))
+ (unwind-protect
+ (progn
+ (set-syntax-table idlwave-find-symbol-syntax-table)
+ ,@body)
+ (set-syntax-table saved-syntax))))
+
+(defvar idlwave-print-symbol-syntax-table
+ (copy-syntax-table idlwave-mode-syntax-table)
+ "Syntax table that treats symbol characters as word characters.")
+
+(modify-syntax-entry ?$ "w" idlwave-find-symbol-syntax-table)
+(modify-syntax-entry ?_ "w" idlwave-find-symbol-syntax-table)
+(modify-syntax-entry ?! "w" idlwave-find-symbol-syntax-table)
+(modify-syntax-entry ?. "w" idlwave-find-symbol-syntax-table)
+
+(defmacro idlwave-with-special-syntax1 (&rest body)
+ "Execute BODY with a different systax table."
+ `(let ((saved-syntax (syntax-table)))
+ (unwind-protect
+ (progn
+ (set-syntax-table idlwave-find-symbol-syntax-table)
+ ,@body)
+ (set-syntax-table saved-syntax))))
+
(defun idlwave-action-and-binding (key cmd &optional select)
"KEY and CMD are made into a key binding and an indent action.
KEY is a string - same as for the `define-key' function. CMD is a
(fset 'idlwave-debug-map (make-sparse-keymap))
+(define-key idlwave-mode-map "\C-c " 'idlwave-hard-tab)
+(define-key idlwave-mode-map [(control tab)] 'idlwave-hard-tab)
+;(define-key idlwave-mode-map "\C-c\C- " 'idlwave-hard-tab)
(define-key idlwave-mode-map "'" 'idlwave-show-matching-quote)
(define-key idlwave-mode-map "\"" 'idlwave-show-matching-quote)
(define-key idlwave-mode-map "\C-c;" 'idlwave-toggle-comment-region)
(define-key idlwave-mode-map "\C-c\C-c" 'idlwave-case)
(define-key idlwave-mode-map "\C-c\C-d" 'idlwave-debug-map)
(define-key idlwave-mode-map "\C-c\C-d\C-c" 'idlwave-shell-save-and-run)
+(define-key idlwave-mode-map "\C-c\C-d\C-b" 'idlwave-shell-break-here)
+(when (and (boundp 'idlwave-shell-debug-modifiers)
+ (listp idlwave-shell-debug-modifiers)
+ (not (equal idlwave-shell-debug-modifiers '())))
+ ;; Bind the debug commands also with the special modifiers.
+ (let ((shift (memq 'shift idlwave-shell-debug-modifiers))
+ (mods-noshift (delq 'shift
+ (copy-sequence idlwave-shell-debug-modifiers))))
+ (define-key idlwave-mode-map
+ (vector (append mods-noshift (list (if shift ?C ?c))))
+ 'idlwave-shell-save-and-run)
+ (define-key idlwave-mode-map
+ (vector (append mods-noshift (list (if shift ?B ?b))))
+ 'idlwave-shell-break-here)))
(define-key idlwave-mode-map "\C-c\C-f" 'idlwave-for)
;; (define-key idlwave-mode-map "\C-c\C-f" 'idlwave-function)
;; (define-key idlwave-mode-map "\C-c\C-p" 'idlwave-procedure)
(define-key idlwave-mode-map "\C-c\C-r" 'idlwave-repeat)
(define-key idlwave-mode-map "\C-c\C-w" 'idlwave-while)
+(define-key idlwave-mode-map "\C-c\C-k" 'idlwave-kill-autoloaded-buffers)
(define-key idlwave-mode-map "\C-c\C-s" 'idlwave-shell)
(define-key idlwave-mode-map "\C-c\C-l" 'idlwave-shell-recenter-shell-window)
+(define-key idlwave-mode-map "\C-c\C-b" 'idlwave-list-buffer-load-path-shadows)
+(autoload 'idlwave-shell "idlw-shell"
+ "Run an inferior IDL, with I/O through buffer `(idlwave-shell-buffer)'." t)
(autoload 'idlwave-shell-send-command "idlw-shell")
(autoload 'idlwave-shell-recenter-shell-window "idlw-shell"
"Run `idlwave-shell' and switch back to current window" t)
(autoload 'idlwave-shell-save-and-run "idlw-shell"
"Save and run buffer under the shell." t)
+(autoload 'idlwave-shell-break-here "idlw-shell"
+ "Set breakpoint in current line." t)
(define-key idlwave-mode-map "\C-c\C-v" 'idlwave-find-module)
(define-key idlwave-mode-map "\C-c?" 'idlwave-routine-info)
-(define-key idlwave-mode-map "\M-?" 'idlwave-routine-info-from-idlhelp)
+(define-key idlwave-mode-map "\M-?" 'idlwave-context-help)
(define-key idlwave-mode-map [(meta tab)] 'idlwave-complete)
(define-key idlwave-mode-map "\C-c\C-i" 'idlwave-update-routine-info)
(define-key idlwave-mode-map "\C-c=" 'idlwave-resolve)
+(define-key idlwave-mode-map
+ (if (featurep 'xemacs) [(shift button3)] [(shift mouse-3)])
+ 'idlwave-mouse-context-help)
;; Set action and key bindings.
;; See description of the function `idlwave-action-and-binding'.
(idlwave-action-and-binding "&" '(idlwave-surround -1 -1))
(idlwave-action-and-binding "<" '(idlwave-surround -1 -1))
(idlwave-action-and-binding ">" '(idlwave-surround -1 -1 '(?-)))
+(idlwave-action-and-binding "->" '(idlwave-surround -1 -1 nil 2))
(idlwave-action-and-binding "," '(idlwave-surround 0 -1))
;; Automatically add spaces to equal sign if not keyword
(idlwave-action-and-binding "=" '(idlwave-expand-equal -1 -1))
;;
;; Templates
;;
- (define-abbrev tb (concat c "c") "" (idlwave-code-abbrev idlwave-case))
- (define-abbrev tb (concat c "f") "" (idlwave-code-abbrev idlwave-for))
- (define-abbrev tb (concat c "fu") "" (idlwave-code-abbrev idlwave-function))
- (define-abbrev tb (concat c "pr") "" (idlwave-code-abbrev idlwave-procedure))
- (define-abbrev tb (concat c "r") "" (idlwave-code-abbrev idlwave-repeat))
- (define-abbrev tb (concat c "w") "" (idlwave-code-abbrev idlwave-while))
- (define-abbrev tb (concat c "i") "" (idlwave-code-abbrev idlwave-if))
- (define-abbrev tb (concat c "elif") "" (idlwave-code-abbrev idlwave-elif))
+ (define-abbrev tb (concat c "c") "" (idlwave-code-abbrev idlwave-case) 0 t)
+ (define-abbrev tb (concat c "sw") "" (idlwave-code-abbrev idlwave-switch) 0 t)
+ (define-abbrev tb (concat c "f") "" (idlwave-code-abbrev idlwave-for) 0 t)
+ (define-abbrev tb (concat c "fu") "" (idlwave-code-abbrev idlwave-function) 0 t)
+ (define-abbrev tb (concat c "pr") "" (idlwave-code-abbrev idlwave-procedure) 0 t)
+ (define-abbrev tb (concat c "r") "" (idlwave-code-abbrev idlwave-repeat) 0 t)
+ (define-abbrev tb (concat c "w") "" (idlwave-code-abbrev idlwave-while) 0 t)
+ (define-abbrev tb (concat c "i") "" (idlwave-code-abbrev idlwave-if) 0 t)
+ (define-abbrev tb (concat c "elif") "" (idlwave-code-abbrev idlwave-elif) 0 t)
;;
;; Keywords, system functions, conversion routines
;;
- (define-abbrev tb (concat c "b") "begin" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb (concat c "co") "common" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb (concat c "cb") "byte()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "cx") "fix()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "cl") "long()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "cf") "float()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "cs") "string()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "cc") "complex()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "cd") "double()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "e") "else" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb (concat c "ec") "endcase" 'idlwave-show-begin)
- (define-abbrev tb (concat c "ee") "endelse" 'idlwave-show-begin)
- (define-abbrev tb (concat c "ef") "endfor" 'idlwave-show-begin)
- (define-abbrev tb (concat c "ei") "endif else if" 'idlwave-show-begin)
- (define-abbrev tb (concat c "el") "endif else" 'idlwave-show-begin)
- (define-abbrev tb (concat c "en") "endif" 'idlwave-show-begin)
- (define-abbrev tb (concat c "er") "endrep" 'idlwave-show-begin)
- (define-abbrev tb (concat c "ew") "endwhile" 'idlwave-show-begin)
- (define-abbrev tb (concat c "g") "goto," (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb (concat c "h") "help," (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "k") "keyword_set()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "n") "n_elements()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "on") "on_error," (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "oi") "on_ioerror," (idlwave-keyword-abbrev 0 1))
- (define-abbrev tb (concat c "ow") "openw," (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "or") "openr," (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "ou") "openu," (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "p") "print," (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "pt") "plot," (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "re") "read," (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "rf") "readf," (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "ru") "readu," (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "rt") "return" (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "sc") "strcompress()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "sn") "strlen()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "sl") "strlowcase()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "su") "strupcase()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "sm") "strmid()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "sp") "strpos()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "st") "strput()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "sr") "strtrim()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "t") "then" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb (concat c "u") "until" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb (concat c "wu") "writeu," (idlwave-keyword-abbrev 0))
+ (define-abbrev tb (concat c "b") "begin" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb (concat c "co") "common" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb (concat c "cb") "byte()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "cx") "fix()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "cl") "long()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "cf") "float()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "cs") "string()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "cc") "complex()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "cd") "double()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "e") "else" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb (concat c "ec") "endcase" 'idlwave-show-begin 0 t)
+ (define-abbrev tb (concat c "es") "endswitch" 'idlwave-show-begin 0 t)
+ (define-abbrev tb (concat c "ee") "endelse" 'idlwave-show-begin 0 t)
+ (define-abbrev tb (concat c "ef") "endfor" 'idlwave-show-begin 0 t)
+ (define-abbrev tb (concat c "ei") "endif else if" 'idlwave-show-begin 0 t)
+ (define-abbrev tb (concat c "el") "endif else" 'idlwave-show-begin 0 t)
+ (define-abbrev tb (concat c "en") "endif" 'idlwave-show-begin 0 t)
+ (define-abbrev tb (concat c "er") "endrep" 'idlwave-show-begin 0 t)
+ (define-abbrev tb (concat c "ew") "endwhile" 'idlwave-show-begin 0 t)
+ (define-abbrev tb (concat c "g") "goto," (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb (concat c "h") "help," (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "k") "keyword_set()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "n") "n_elements()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "on") "on_error," (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "oi") "on_ioerror," (idlwave-keyword-abbrev 0 1) 0 t)
+ (define-abbrev tb (concat c "ow") "openw," (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "or") "openr," (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "ou") "openu," (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "p") "print," (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "pt") "plot," (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "re") "read," (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "rf") "readf," (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "ru") "readu," (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "rt") "return" (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "sc") "strcompress()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "sn") "strlen()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "sl") "strlowcase()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "su") "strupcase()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "sm") "strmid()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "sp") "strpos()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "st") "strput()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "sr") "strtrim()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "t") "then" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb (concat c "u") "until" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb (concat c "wu") "writeu," (idlwave-keyword-abbrev 0) 0 t)
(define-abbrev tb (concat c "ine") "if n_elements() eq 0 then"
- (idlwave-keyword-abbrev 11))
+ (idlwave-keyword-abbrev 11) 0 t)
(define-abbrev tb (concat c "inn") "if n_elements() ne 0 then"
- (idlwave-keyword-abbrev 11))
- (define-abbrev tb (concat c "np") "n_params()" (idlwave-keyword-abbrev 0))
- (define-abbrev tb (concat c "s") "size()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "wi") "widget_info()" (idlwave-keyword-abbrev 1))
- (define-abbrev tb (concat c "wc") "widget_control," (idlwave-keyword-abbrev 0))
+ (idlwave-keyword-abbrev 11) 0 t)
+ (define-abbrev tb (concat c "np") "n_params()" (idlwave-keyword-abbrev 0) 0 t)
+ (define-abbrev tb (concat c "s") "size()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "wi") "widget_info()" (idlwave-keyword-abbrev 1) 0 t)
+ (define-abbrev tb (concat c "wc") "widget_control," (idlwave-keyword-abbrev 0) 0 t)
;; This section is reserved words only. (From IDL user manual)
;;
- (define-abbrev tb "and" "and" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "begin" "begin" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "case" "case" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "common" "common" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "do" "do" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "else" "else" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "end" "end" 'idlwave-show-begin-check)
- (define-abbrev tb "endcase" "endcase" 'idlwave-show-begin-check)
- (define-abbrev tb "endelse" "endelse" 'idlwave-show-begin-check)
- (define-abbrev tb "endfor" "endfor" 'idlwave-show-begin-check)
- (define-abbrev tb "endif" "endif" 'idlwave-show-begin-check)
- (define-abbrev tb "endrep" "endrep" 'idlwave-show-begin-check)
- (define-abbrev tb "endwhi" "endwhi" 'idlwave-show-begin-check)
- (define-abbrev tb "endwhile" "endwhile" 'idlwave-show-begin-check)
- (define-abbrev tb "eq" "eq" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "for" "for" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "function" "function" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "ge" "ge" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "goto" "goto" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "gt" "gt" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "if" "if" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "le" "le" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "lt" "lt" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "mod" "mod" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "ne" "ne" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "not" "not" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "of" "of" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "on_ioerror" "on_ioerror" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "or" "or" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "pro" "pro" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "repeat" "repeat" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "then" "then" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "until" "until" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "while" "while" (idlwave-keyword-abbrev 0 t))
- (define-abbrev tb "xor" "xor" (idlwave-keyword-abbrev 0 t)))
+ (define-abbrev tb "and" "and" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "begin" "begin" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "break" "break" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "case" "case" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "common" "common" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "continue" "continue" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "do" "do" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "else" "else" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "end" "end" 'idlwave-show-begin-check 0 t)
+ (define-abbrev tb "endcase" "endcase" 'idlwave-show-begin-check 0 t)
+ (define-abbrev tb "endelse" "endelse" 'idlwave-show-begin-check 0 t)
+ (define-abbrev tb "endfor" "endfor" 'idlwave-show-begin-check 0 t)
+ (define-abbrev tb "endif" "endif" 'idlwave-show-begin-check 0 t)
+ (define-abbrev tb "endrep" "endrep" 'idlwave-show-begin-check 0 t)
+ (define-abbrev tb "endswitch" "endswitch" 'idlwave-show-begin-check 0 t)
+ (define-abbrev tb "endwhi" "endwhi" 'idlwave-show-begin-check 0 t)
+ (define-abbrev tb "endwhile" "endwhile" 'idlwave-show-begin-check 0 t)
+ (define-abbrev tb "eq" "eq" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "for" "for" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "function" "function" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "ge" "ge" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "goto" "goto" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "gt" "gt" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "if" "if" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "le" "le" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "lt" "lt" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "mod" "mod" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "ne" "ne" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "not" "not" (idlwave-keyword-abbrev 0 t 0 t))
+ (define-abbrev tb "of" "of" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "on_ioerror" "on_ioerror" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "or" "or" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "pro" "pro" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "repeat" "repeat" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "switch" "switch" (idlwave-keyword-abbrev 0 t 0 t))
+ (define-abbrev tb "then" "then" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "until" "until" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "while" "while" (idlwave-keyword-abbrev 0 t) 0 t)
+ (define-abbrev tb "xor" "xor" (idlwave-keyword-abbrev 0 t) 0 t))
(defvar imenu-create-index-function)
(defvar extract-index-name-function)
These commands know about system routines, all routines in idlwave-mode
buffers and (when the idlwave-shell is active) about all modules
currently compiled under this shell. Use \\[idlwave-update-routine-info] to update this
- information, which is also used for completion (see next item).
+ information, which is also used for completion (see item 4).
+
+3. Online IDL Help
+ ---------------
+ \\[idlwave-context-help] displays the IDL documentation relevant
+ for the system variable, keyword, or routine at point. A single key
+ stroke gets you directly to the right place in the docs. Two additional
+ files (an ASCII version of the IDL documentation and a topics file) must
+ be installed for this - check the IDLWAVE webpage for these files.
-3. Completion
+4. Completion
----------
- \\[idlwave-complete] completes the names of procedures, functions and
- keyword parameters. It is context sensitive and figures out what
- is expected at point (procedure/function/keyword). Lower case
- strings are completed in lower case, other strings in mixed or
- upper case.
+ \\[idlwave-complete] completes the names of procedures, functions
+ class names and keyword parameters. It is context sensitive and
+ figures out what is expected at point (procedure/function/keyword).
+ Lower case strings are completed in lower case, other strings in
+ mixed or upper case.
-4. Code Templates and Abbreviations
+5. Code Templates and Abbreviations
--------------------------------
Many Abbreviations are predefined to expand to code fragments and templates.
The abbreviations start generally with a `\\`. Some examples
\\pr PROCEDURE template
\\fu FUNCTION template
\\c CASE statement template
+ \\sw SWITCH statement template
\\f FOR loop template
\\r REPEAT Loop template
\\w WHILE loop template
current program unit (pro, function or main). Change log entries
can be added to the current program unit with \\[idlwave-doc-modification].
-5. Automatic Case Conversion
+6. Automatic Case Conversion
-------------------------
The case of reserved words and some abbrevs is controlled by
`idlwave-reserved-word-upcase' and `idlwave-abbrev-change-case'.
-6. Automatic END completion
+7. Automatic END completion
------------------------
If the variable `idlwave-expand-generic-end' is non-nil, each END typed
will be converted to the specific version, like ENDIF, ENDFOR, etc.
-7. Hooks
+8. Hooks
-----
Loading idlwave.el runs `idlwave-load-hook'.
Turning on `idlwave-mode' runs `idlwave-mode-hook'.
-8. Documentation and Customization
+9. Documentation and Customization
-------------------------------
Info documentation for this package is available. Use \\[idlwave-info]
to display (complain to your sysadmin if that does not work).
homepage at `http://www.strw.leidenuniv.nl/~dominik/Tools/idlwave'.
IDLWAVE has customize support - see the group `idlwave'.
-9. Keybindings
+10.Keybindings
-----------
Here is a list of all keybindings of this mode.
If some of the key bindings below show with ??, use \\[describe-key]
;; Make a local post-command-hook and add our hook to it
(make-local-hook 'post-command-hook)
- (add-hook 'post-command-hook 'idlwave-command-hook nil t)
+ (add-hook 'post-command-hook 'idlwave-command-hook nil 'local)
+
+ ;; Make local hooks for buffer updates
+ (make-local-hook 'kill-buffer-hook)
+ (add-hook 'kill-buffer-hook 'idlwave-kill-buffer-update nil 'local)
+ (make-local-hook 'after-save-hook)
+ (add-hook 'after-save-hook 'idlwave-save-buffer-update nil 'local)
+ (add-hook 'after-save-hook 'idlwave-revoke-license-to-kill nil 'local)
+
+ ;; Update the routine info with info about current buffer?
+ (idlwave-new-buffer-update)
;; Run the mode hook
(run-hooks 'idlwave-mode-hook))
(defun idlwave-show-begin ()
"Finds the start of current block and blinks to it for a second.
Also checks if the correct end statement has been used."
+ ;; Re-indent end line
+ (if idlwave-reindent-end
+ (idlwave-indent-line))
;; All end statements are reserved words
(let* ((pos (point))
end end1)
(let ((case-fold-search t))
(save-excursion
(cond
- ((looking-at "pro\\|case\\|function\\>")
+ ((looking-at "pro\\|case\\|switch\\|function\\>")
(assoc (downcase (match-string 0)) idlwave-block-matches))
((looking-at "begin\\>")
(let ((limit (save-excursion
(bolp))
(let ((idlwave-show-block nil))
(newline-and-indent)))
+ (insert "end")
+ (idlwave-show-begin))
- ;; Check which end is needed and insert it.
- (let ((case-fold-search t) end)
- (save-excursion
- (idlwave-beginning-of-statement)
- (idlwave-block-jump-out -1 'nomark)
- (if (setq end (idlwave-block-master))
- (setq end (cdr end))
- (error "Cannot close block")))
- (insert end)
- (idlwave-newline)))
-
-(defun idlwave-surround (&optional before after escape-chars)
- "Surround the character before point with blanks.
+(defun idlwave-surround (&optional before after escape-chars length)
+ "Surround the LENGTH characters before point with blanks.
+LENGTH defaults to 1.
Optional arguments BEFORE and AFTER affect the behavior before and
-after the previous character. See description of `idlwave-make-space'.
+after the characters (see also description of `idlwave-make-space'):
+
+nil do nothing
+0 force no spaces
+integer > 0 force exactly n spaces
+integer < 0 at least |n| spaces
The function does nothing if any of the following conditions is true:
- `idlwave-surround-by-blank' is nil
- the character before point is inside a string or comment
-
-When the character 2 positions before point is a member of
-ESCAPE-CHARS, BEFORE is forced to nil."
-
- (if (and idlwave-surround-by-blank
- (not (idlwave-quoted)))
- (progn
- (if (memq (char-after (- (point) 2)) escape-chars)
- (setq before nil))
- (backward-char 1)
- (save-restriction
- (let ((here (point)))
- (skip-chars-backward " \t")
- (if (bolp)
- ;; avoid clobbering indent
- (progn
- (move-to-column (idlwave-calculate-indent))
- (if (<= (point) here)
- (narrow-to-region (point) here))
- (goto-char here)))
- (idlwave-make-space before))
- (skip-chars-forward " \t"))
- (forward-char 1)
- (idlwave-make-space after)
- ;; Check to see if the line should auto wrap
- (if (and (equal (char-after (1- (point))) ? )
- (> (current-column) fill-column))
- (funcall auto-fill-function)))))
+- the char preceeding the string to be surrounded is a member of ESCAPE-CHARS.
+ This hack is used to avoid padding of `>' when it is part of
+ the '->' operator. In this case, ESCAPE-CHARS would be '(?-)."
+
+ (setq length (or length 1)) ; establish a default for LENGTH
+
+ (when (and idlwave-surround-by-blank
+ (not (idlwave-quoted))
+ (not (memq (char-after (- (point) (1+ length))) escape-chars)))
+ (backward-char length)
+ (save-restriction
+ (let ((here (point)))
+ (skip-chars-backward " \t")
+ (if (bolp)
+ ;; avoid clobbering indent
+ (progn
+ (move-to-column (idlwave-calculate-indent))
+ (if (<= (point) here)
+ (narrow-to-region (point) here))
+ (goto-char here)))
+ (idlwave-make-space before))
+ (skip-chars-forward " \t"))
+ (forward-char length)
+ (idlwave-make-space after)
+ ;; Check to see if the line should auto wrap
+ (if (and (equal (char-after (1- (point))) ?\ )
+ (> (current-column) fill-column))
+ (funcall auto-fill-function))))
(defun idlwave-make-space (n)
"Make space at point.
The amount of space at point is determined by N.
If the value of N is:
nil - do nothing.
-c > 0 - exactly c spaces.
-c < 0 - a minimum of -c spaces, i.e., do not change if there are
- already -c spaces.
-0 - no spaces."
+> 0 - exactly N spaces.
+< 0 - a minimum of -N spaces, i.e., do not change if there are
+ already -N spaces.
+0 - no spaces (i.e. remove any existing space)."
(if (integerp n)
(let
((start-col (progn (skip-chars-backward " \t") (current-column)))
Splits strings with the IDL operator `+' if `idlwave-split-line-string' is
non-nil."
(interactive)
+ ;; Expand abbreviation, just like normal RET would.
+ (and abbrev-mode (expand-abbrev))
(let (beg)
(if (not (idlwave-in-comment))
;; For code line add continuation.
(message "Warning: continuation inside string!!")
(insert " " idlwave-continuation-char))
;; Not splitting a string.
- (insert " " idlwave-continuation-char))
+ (if (not (member (char-before) '(?\ ?\t)))
+ (insert " "))
+ (insert idlwave-continuation-char))
(newline-and-indent))
(indent-new-comment-line))
;; Indent previous line
(message "Could not find doc library header start.")
(goto-char here)))))
+
+(defun idlwave-current-routine ()
+ "Return (NAME TYPE CLASS) of current routine."
+ (idlwave-routines)
+ (save-excursion
+ (idlwave-beginning-of-subprogram)
+ (if (looking-at "[ \t]*\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)")
+ (let* ((type (if (string= (downcase (match-string 1)) "pro")
+ 'pro 'function))
+ (class (idlwave-sintern-class (match-string 3)))
+ (name (idlwave-sintern-routine-or-method (match-string 4) class)))
+ (list name type class)))))
+
(defvar idlwave-shell-prompt-pattern)
(defun idlwave-beginning-of-statement ()
"Move to beginning of the current statement.
(= (forward-line -1) 0)))
first-statement)))
-;; FIXME: end-of-statement does not work correctly when comment lines
-;; are inside the statement. It does work correctly for line-end
-;; comments, though.
(defun idlwave-end-of-statement ()
"Moves point to the end of the current IDL statement.
+If not in a statement just moves to end of line. Returns position."
+ (interactive)
+ (while (and (idlwave-is-continuation-line)
+ (= (forward-line 1) 0))
+ (while (and (idlwave-is-comment-or-empty-line)
+ (= (forward-line 1) 0))))
+ (end-of-line)
+ (point))
+
+(defun idlwave-end-of-statement0 ()
+ "Moves point to the end of the current IDL statement.
If not in a statement just moves to end of line. Returns position."
(interactive)
(while (and (idlwave-is-continuation-line)
(looking-at "^@")))))
last-statement))
-(defun idlwave-skip-label ()
+(defun idlwave-skip-label-or-case ()
"Skip label or case statement element.
Returns position after label.
If there is no label point is not moved and nil is returned."
- ;; Just look for the first non quoted colon and check to see if it
- ;; is inside a sexp. If is not in a sexp it must be part of a label
- ;; or case statement element.
+ ;; Case expressions and labels are terminated by a colon.
+ ;; So we find the first colon in the line and make sure
+ ;; - no `?' is before it (might be a ? b : c)
+ ;; - it is not in a comment
+ ;; - not in a string constant
+ ;; - not in parenthesis (like a[0:3])
+ ;; As many in this mode, this function is heuristic and not an exact
+ ;; parser.
(let ((start (point))
(end (idlwave-find-key ":" 1 'nomark
(save-excursion
(idlwave-end-of-statement) (point)))))
(if (and end
- (= (nth 0 (parse-partial-sexp start end)) 0))
+ (= (nth 0 (parse-partial-sexp start end)) 0)
+ (not (string-match "\\?" (buffer-substring start end))))
(progn
(forward-char)
(point))
statement is on a new line or is a subpart of the current statement.
Returns point at start of substatement modulo whitespace.
If optional argument is non-nil move to beginning of current
-substatement. "
+substatement."
(let ((orig (point))
(eos (idlwave-end-of-statement))
(ifnest 0)
st nst last)
(idlwave-beginning-of-statement)
- (idlwave-skip-label)
+ (idlwave-skip-label-or-case)
(setq last (point))
;; Continue looking for substatements until we are past orig
(while (and (<= (point) orig) (not (eobp)))
(t (setq ifnest 0)
(idlwave-next-statement))))
(if pre (goto-char last))
+ ;; If a continuation line starts here, move to next line
+ (if (looking-at "[ \t]*\\$\\([ \t]*\\(;\\|$\\)\\)")
+ (beginning-of-line 2))
(point)))
(defun idlwave-statement-type ()
The case is determined using `idlwave-start-of-substatement' and
`idlwave-statement-type'.
The equal sign will be surrounded by BEFORE and AFTER blanks.
-If `idlwave-pad-keyword' is non-nil then keyword
-assignment is treated just like assignment statements. Otherwise,
-spaces are removed for keyword assignment.
+If `idlwave-pad-keyword' is t then keyword assignment is treated just
+like assignment statements. When nil, spaces are removed for keyword
+assignment. Any other value keeps the current space around the `='.
Limits in for loops are treated as keyword assignment.
See `idlwave-surround'. "
;; Even though idlwave-surround checks `idlwave-surround-by-blank' this
(let ((st (save-excursion
(idlwave-start-of-substatement t)
(idlwave-statement-type))))
- (if (or
- (and (equal (car (car st)) 'assign)
- (equal (cdr st) (point)))
- idlwave-pad-keyword)
- ;; An assignment statement
- (idlwave-surround before after)
- (idlwave-surround 0 0)))))
+
+ (cond ((or (and (equal (car (car st)) 'assign)
+ (equal (cdr st) (point)))
+ (eq t idlwave-pad-keyword))
+ ;; An assignment statement or keywor and we need padding
+ (idlwave-surround before after))
+ ((null idlwave-pad-keyword)
+ ;; Spaces should be removed at a keyword
+ (idlwave-surround 0 0))
+ (t)))))
(defun idlwave-indent-and-action ()
"Call `idlwave-indent-line' and do expand actions."
(interactive)
+ (save-excursion
+ (if (and idlwave-expand-generic-end
+ (re-search-backward "\\<\\(end\\)\\s-*\\="
+ (max 0 (- (point) 10)) t)
+ (looking-at "\\(end\\)\\([ \n\t]\\|\\'\\)"))
+ (progn (goto-char (match-end 1))
+ (idlwave-show-begin))))
(idlwave-indent-line t)
)
Inserts space before markers at point."
(if (not min) (setq min 0))
(insert-before-markers
- (make-string (max min (- col (current-column))) ? )))
+ (make-string (max min (- col (current-column))) ?\ )))
(defun idlwave-indent-left-margin (col)
"Indent the current line to column COL.
;; Ordinary continuation
(idlwave-continuation-indent))))))))
-(defun idlwave-find-key (key-reg &optional dir nomark limit)
- "Move in direction of the optional second argument DIR to the
-next keyword not contained in a comment or string and occurring before
-optional fourth argument LIMIT. DIR defaults to forward direction. If
-DIR is negative the search is backwards, otherwise, it is
-forward. LIMIT defaults to the beginning or end of the buffer
-according to the direction of the search. The keyword is given by the
-regular expression argument KEY-REG. The search is case insensitive.
-Returns position if successful and nil otherwise. If found
-`push-mark' is executed unless the optional third argument NOMARK is
-non-nil. If found, the point is left at the keyword beginning."
- (or dir (setq dir 0))
- (or limit (setq limit (cond ((>= dir 0) (point-max)) ((point-min)))))
- (let (found
- (old-syntax-table (syntax-table))
- (case-fold-search t))
- (unwind-protect
- (save-excursion
- (set-syntax-table idlwave-find-symbol-syntax-table)
- (if (>= dir 0)
- (while (and (setq found (and
- (re-search-forward key-reg limit t)
- (match-beginning 0)))
- (idlwave-quoted)
- (not (eobp))))
- (while (and (setq found (and
- (re-search-backward key-reg limit t)
- (match-beginning 0)))
- (idlwave-quoted)
- (not (bobp))))))
- (set-syntax-table old-syntax-table))
- (if found (progn
- (if (not nomark) (push-mark))
- (goto-char found)))))
+(defun idlwave-find-key (key-re &optional dir nomark limit)
+ "Move to next match of the regular expression KEY-RE.
+Matches inside comments or string constants will be ignored.
+If DIR is negative, the search will be backwards.
+At a successful match, the mark is pushed unless NOMARK is non-nil.
+Searches are limited to LIMIT.
+Searches are case-insensitive and use a special syntax table which
+treats `$' and `_' as word characters.
+Return value is the beginning of the match or (in case of failure) nil."
+ (setq dir (or dir 0))
+ (let ((case-fold-search t)
+ (search-func (if (> dir 0) 're-search-forward 're-search-backward))
+ found)
+ (idlwave-with-special-syntax
+ (save-excursion
+ (catch 'exit
+ (while (funcall search-func key-re limit t)
+ (if (not (idlwave-quoted))
+ (throw 'exit (setq found (match-beginning 0))))))))
+ (if found
+ (progn
+ (if (not nomark) (push-mark))
+ (goto-char found)
+ found)
+ nil)))
(defun idlwave-block-jump-out (&optional dir nomark)
"When optional argument DIR is non-negative, move forward to end of
(idlwave-look-at "\\<\\$")))
(defun idlwave-is-comment-line ()
+ "Tests if the current line is a comment line."
(save-excursion
(beginning-of-line 1)
(looking-at "[ \t]*;")))
+(defun idlwave-is-comment-or-empty-line ()
+ "Tests if the current line is a comment line."
+ (save-excursion
+ (beginning-of-line 1)
+ (looking-at "[ \t]*[;\n]")))
+
(defun idlwave-look-at (regexp &optional cont beg)
- "Searches current line from current point for the regular expression
-REGEXP. If optional argument CONT is non-nil, searches to the end of
-the current statement. If optional arg BEG is non-nil, search starts
-from the beginning of the current statement. Ignores matches that end
-in a comment or inside a string expression. Returns point if
-successful, nil otherwise. This function produces unexpected results
-if REGEXP contains quotes or a comment delimiter. The search is case
-insensitive. If successful leaves point after the match, otherwise,
-does not move point."
+ "Searches current line from current point for REGEXP.
+If optional argument CONT is non-nil, searches to the end of
+the current statement.
+If optional arg BEG is non-nil, search starts from the beginning of the
+current statement.
+Ignores matches that end in a comment or inside a string expression.
+Returns point if successful, nil otherwise.
+This function produces unexpected results if REGEXP contains quotes or
+a comment delimiter. The search is case insensitive.
+If successful leaves point after the match, otherwise, does not move point."
(let ((here (point))
- (old-syntax-table (syntax-table))
(case-fold-search t)
- eos
+ (eos (save-excursion
+ (if cont (idlwave-end-of-statement) (end-of-line))
+ (point)))
found)
- (unwind-protect
- (progn
- (set-syntax-table idlwave-find-symbol-syntax-table)
- (setq eos
- (if cont
- (save-excursion (idlwave-end-of-statement) (point))
- (save-excursion (end-of-line) (point))))
- (if beg (idlwave-beginning-of-statement))
- (while (and (setq found (re-search-forward regexp eos t))
- (idlwave-quoted))))
- (set-syntax-table old-syntax-table))
+ (idlwave-with-special-syntax
+ (if beg (idlwave-beginning-of-statement))
+ (while (and (setq found (re-search-forward regexp eos t))
+ (idlwave-quoted))))
(if (not found) (goto-char here))
found))
;; adjust the original location for the
;; inserted text.
(setq here (+ here diff)))
- (insert (make-string diff ? ))))
+ (insert (make-string diff ?\ ))))
(forward-line -1))
)
)
(setq fill-prefix (concat fill-prefix
(make-string (- indent pre)
- ? )))
+ ?\ )))
;; first-line indent
(setq first-indent
(max
(save-excursion
(setq diff
(buffer-substring start (+ start first-indent -1)))
- (subst-char-in-region start (+ start first-indent -1) ? ?~ nil)
+ (subst-char-in-region start (+ start first-indent -1) ?\ ?~ nil)
(fill-region-as-paragraph
start
(- (point-max) end)
(idlwave-fill-paragraph)
;; Insert a blank line comment to separate from the date entry -
;; will keep the entry from flowing onto date line if re-filled.
- (insert "\n;\n;\t\t"))
+ (insert "\n;\n;\t\t"))t
(defun idlwave-doc-modification ()
"Insert a brief modification log at the beginning of the current program.
location on mark ring so that the user can return to previous point."
(interactive)
(push-mark)
- ;; make sure we catch the current line if it begins the unit
- (end-of-line)
- (idlwave-beginning-of-subprogram)
- (let ((pro (idlwave-look-at "\\<\\(function\\|pro\\)\\>"))
- (case-fold-search nil))
- (if (re-search-forward
- (concat idlwave-doc-modifications-keyword ":")
- ;; set search limit at next unit beginning
- (save-excursion (idlwave-end-of-subprogram) (point))
- t)
- (end-of-line)
- ;; keyword not present, insert keyword
- (if pro (idlwave-next-statement)) ; skip past pro or function statement
- (beginning-of-line)
- (insert "\n" comment-start "\n")
- (forward-line -2)
- (insert comment-start " " idlwave-doc-modifications-keyword ":")))
- (idlwave-newline)
- (beginning-of-line)
- (insert ";\n;\t")
- (run-hooks 'idlwave-timestamp-hook))
+ (let* (beg end)
+ (if (and (or (re-search-backward idlwave-doclib-start nil t)
+ (progn
+ (goto-char (point-min))
+ (re-search-forward idlwave-doclib-start nil t)))
+ (setq beg (match-beginning 0))
+ (re-search-forward idlwave-doclib-end nil t)
+ (setq end (match-end 0)))
+ (progn
+ (goto-char beg)
+ (if (re-search-forward
+ (concat idlwave-doc-modifications-keyword ":")
+ end t)
+ (end-of-line)
+ (goto-char end)
+ (end-of-line -1)
+ (insert "\n" comment-start "\n")
+ (insert comment-start " " idlwave-doc-modifications-keyword ":"))
+ (insert "\n;\n;\t")
+ (run-hooks 'idlwave-timestamp-hook))
+ (error "No valid DOCLIB header"))))
;;; CJC 3/16/93
;;; Interface to expand-region-abbrevs which did not work when the
Opens a line if point is not followed by a newline modulo intervening
whitespace. S1 and S2 are strings. S1 is inserted at point followed
-by S2. Point is inserted between S1 and S2. If optional argument
+by S2. Point is inserted between S1 and S2. The case of S1 and S2 is
+adjusted according to `idlwave-abbrev-change-case'. If optional argument
PROMPT is a string then it is displayed as a message in the
minibuffer. The PROMPT serves as a reminder to the user of an
expression to enter.
The lines containing S1 and S2 are reindented using `indent-region'
unless the optional second argument NOINDENT is non-nil."
- (let ((beg (save-excursion (beginning-of-line) (point)))
- end)
- (if (not (looking-at "\\s-*\n"))
- (open-line 1))
- (insert s1)
- (save-excursion
- (insert s2)
- (setq end (point)))
- (if (not noindent)
- (indent-region beg end nil))
- (if (stringp prompt)
- (message prompt))))
+ (if (eq major-mode 'idlwave-shell-mode)
+ ;; This is a gross hack to avoit template abbrev expansion
+ ;; in the shell. FIXME: This is a dirty hack.
+ (if (and (eq this-command 'self-insert-command)
+ (equal last-abbrev-location (point)))
+ (insert last-abbrev-text)
+ (error "No templates in idlwave-shell"))
+ (cond ((eq idlwave-abbrev-change-case 'down)
+ (setq s1 (downcase s1) s2 (downcase s2)))
+ (idlwave-abbrev-change-case
+ (setq s1 (upcase s1) s2 (upcase s2))))
+ (let ((beg (save-excursion (beginning-of-line) (point)))
+ end)
+ (if (not (looking-at "\\s-*\n"))
+ (open-line 1))
+ (insert s1)
+ (save-excursion
+ (insert s2)
+ (setq end (point)))
+ (if (not noindent)
+ (indent-region beg end nil))
+ (if (stringp prompt)
+ (message prompt)))))
+
+(defun idlwave-rw-case (string)
+ "Make STRING have the case required by `idlwave-reserved-word-upcase'."
+ (if idlwave-reserved-word-upcase
+ (upcase string)
+ string))
(defun idlwave-elif ()
"Build skeleton IDL if-else block."
(interactive)
- (idlwave-template "if"
- " then begin\n\nendif else begin\n\nendelse"
- "Condition expression"))
+ (idlwave-template
+ (idlwave-rw-case "if")
+ (idlwave-rw-case " then begin\n\nendif else begin\n\nendelse")
+ "Condition expression"))
(defun idlwave-case ()
"Build skeleton IDL case statement."
(interactive)
- (idlwave-template "case" " of\n\nendcase" "Selector expression"))
+ (idlwave-template
+ (idlwave-rw-case "case")
+ (idlwave-rw-case " of\n\nendcase")
+ "Selector expression"))
+
+(defun idlwave-switch ()
+ "Build skeleton IDL switch statement."
+ (interactive)
+ (idlwave-template
+ (idlwave-rw-case "switch")
+ (idlwave-rw-case " of\n\nendswitch")
+ "Selector expression"))
(defun idlwave-for ()
"Build skeleton for loop statment."
(interactive)
- (idlwave-template "for" " do begin\n\nendfor" "Loop expression"))
+ (idlwave-template
+ (idlwave-rw-case "for")
+ (idlwave-rw-case " do begin\n\nendfor")
+ "Loop expression"))
(defun idlwave-if ()
"Build skeleton for loop statment."
(interactive)
- (idlwave-template "if" " then begin\n\nendif" "Scalar logical expression"))
+ (idlwave-template
+ (idlwave-rw-case "if")
+ (idlwave-rw-case " then begin\n\nendif")
+ "Scalar logical expression"))
(defun idlwave-procedure ()
(interactive)
- (idlwave-template "pro" "\n\nreturn\nend" "Procedure name"))
+ (idlwave-template
+ (idlwave-rw-case "pro")
+ (idlwave-rw-case "\n\nreturn\nend")
+ "Procedure name"))
(defun idlwave-function ()
(interactive)
- (idlwave-template "function" "\n\nreturn\nend" "Function name"))
+ (idlwave-template
+ (idlwave-rw-case "function")
+ (idlwave-rw-case "\n\nreturn\nend")
+ "Function name"))
(defun idlwave-repeat ()
(interactive)
- (idlwave-template "repeat begin\n\nendrep until" "" "Exit condition"))
+ (idlwave-template
+ (idlwave-rw-case "repeat begin\n\nendrep until")
+ (idlwave-rw-case "")
+ "Exit condition"))
(defun idlwave-while ()
(interactive)
- (idlwave-template "while" " do begin\n\nendwhile" "Entry condition"))
+ (idlwave-template
+ (idlwave-rw-case "while")
+ (idlwave-rw-case " do begin\n\nendwhile")
+ "Entry condition"))
(defun idlwave-split-string (string &optional pattern)
"Return a list of substrings of STRING which are separated by PATTERN.
(find-buffer-visiting file))
(t (error "This should not happen (idlwave-get-buffer-visiting)"))))
-(defun idlwave-find-file-noselect (file)
+(defvar idlwave-outlawed-buffers nil
+ "List of buffer pulled up by idlwave for special reasons.
+Buffers in this list may be killed by `idlwave-kill-autoloaded-buffers'.")
+
+(defun idlwave-find-file-noselect (file &optional why)
;; Return a buffer visiting file.
(or (idlwave-get-buffer-visiting file)
- (find-file-noselect file)))
-
-(defvar idlwave-scanned-lib-directories)
-(defun idlwave-find-lib-file-noselet (file)
+ (let ((buf (find-file-noselect file)))
+ (if why (add-to-list 'idlwave-outlawed-buffers (cons buf why)))
+ buf)))
+
+(defun idlwave-kill-autoloaded-buffers ()
+ "Cleanup by killing buffers created automatically by IDLWAVE.
+Function prompts for a letter to identify the buffers to kill.
+Possible letters are:
+
+f Buffers created by the command \\[idlwave-find-module] or mouse
+ clicks in the routine info window.
+s Buffers created by the IDLWAVE Shell to display where execution
+ stopped or an error was found.
+a Both of the above.
+
+Buffer containing unsaved changes require confirmation before they are killed."
+ (interactive)
+ (if (null idlwave-outlawed-buffers)
+ (error "No IDLWAVE-created buffers available")
+ (princ (format "Kill IDLWAVE-created buffers: [f]ind source(%d), [s]hell display(%d), [a]ll ? "
+ (idlwave-count-outlawed-buffers 'find)
+ (idlwave-count-outlawed-buffers 'shell)))
+ (let ((c (read-char)))
+ (cond
+ ((member c '(?f ?\C-f))
+ (idlwave-do-kill-autoloaded-buffers 'find))
+ ((member c '(?s ?\C-s))
+ (idlwave-do-kill-autoloaded-buffers 'shell))
+ ((member c '(?a ?\C-a))
+ (idlwave-do-kill-autoloaded-buffers t))
+ (t (error "Abort"))))))
+
+(defun idlwave-count-outlawed-buffers (tag)
+ "How many outlawed buffers have tag TAG?"
+ (length (delq nil
+ (mapcar
+ (lambda (x) (eq (cdr x) tag))
+ idlwave-outlawed-buffers))))
+
+(defun idlwave-do-kill-autoloaded-buffers (&rest reasons)
+ "Kill all buffers pulled up by IDLWAVE matching REASONS."
+ (let* ((list (copy-sequence idlwave-outlawed-buffers))
+ (cnt 0)
+ entry)
+ (while (setq entry (pop list))
+ (if (buffer-live-p (car entry))
+ (and (or (memq t reasons)
+ (memq (cdr entry) reasons))
+ (kill-buffer (car entry))
+ (incf cnt)
+ (setq idlwave-outlawed-buffers
+ (delq entry idlwave-outlawed-buffers)))
+ (setq idlwave-outlawed-buffers
+ (delq entry idlwave-outlawed-buffers))))
+ (message "%d buffer%s killed" cnt (if (= cnt 1) "" "s"))))
+
+(defun idlwave-revoke-license-to-kill ()
+ "Remove BUFFER from the buffers which may be killed.
+Killing would be done by `idlwave-do-kill-autoloaded-buffers'.
+Intended for `after-save-hook'."
+ (let* ((buf (current-buffer))
+ (entry (assq buf idlwave-outlawed-buffers)))
+ ;; Revoke license
+ (if entry
+ (setq idlwave-outlawed-buffers
+ (delq entry idlwave-outlawed-buffers)))
+ ;; Remove this function from the hook.
+ (remove-hook 'after-save-hook 'idlwave-revoke-license-to-kill 'local)))
+
+(defvar idlwave-path-alist)
+(defun idlwave-locate-lib-file (file)
;; Find FILE on the scanned lib path and return a buffer visiting it
- (let* ((dirs idlwave-scanned-lib-directories)
+ (let* ((dirs idlwave-path-alist)
dir efile)
(catch 'exit
- (while (setq dir (pop dirs))
+ (while (setq dir (car (pop dirs)))
(if (file-regular-p
(setq efile (expand-file-name file dir)))
- (throw 'exit (idlwave-find-file-noselect efile)))))))
+ (throw 'exit efile))))))
+(defun idlwave-expand-lib-file-name (file)
+ ;; Find FILE on the scanned lib path and return a buffer visiting it
+ (cond
+ ((null file) nil)
+ ((string-match "\\`\\({\\([0-9]+\\)}/\\)\\(.*\\)" file)
+ (expand-file-name (match-string 3 file)
+ (car (nth (1- (string-to-int (match-string 2 file)))
+ idlwave-path-alist))))
+ ((file-name-absolute-p file) file)
+ (t (idlwave-locate-lib-file file))))
(defun idlwave-make-tags ()
"Creates the IDL tags file IDLTAGS in the current directory from
(setq res (cons new res)))
(nreverse res)))
+;; Creating new sintern tables
+
+(defun idlwave-new-sintern-type (tag)
+ "Define a variable and a function to sintern the new type TAG.
+This defines the function `idlwave-sintern-TAG' and the variable
+`idlwave-sint-TAGs'."
+ (let* ((name (symbol-name tag))
+ (names (concat name "s"))
+ (var (intern (concat "idlwave-sint-" names)))
+ (func (intern (concat "idlwave-sintern-" name))))
+ (set var nil) ; initial value of the association list
+ (fset func ; set the function
+ `(lambda (name &optional set)
+ (cond ((not (stringp name)) name)
+ ((cdr (assoc (downcase name) ,var)))
+ (set
+ (setq ,var (cons (cons (downcase name) name) ,var))
+ name)
+ (name))))))
+
+(defun idlwave-reset-sintern-type (tag)
+ "Reset the sintern variable associated with TAG."
+ (set (intern (concat "idlwave-sint-" (symbol-name tag) "s")) nil))
+
;;---------------------------------------------------------------------------
;; The variables which hold the information
-(defvar idlwave-builtin-routines nil
+(defvar idlwave-system-routines nil
"Holds the routine-info obtained by scanning buffers.")
(defvar idlwave-buffer-routines nil
"Holds the routine-info obtained by scanning buffers.")
(defvar idlwave-compiled-routines nil
- "Holds the procedure routine-info obtained by asking the shell.")
+ "Holds the routine-info obtained by asking the shell.")
+(defvar idlwave-unresolved-routines nil
+ "Holds the unresolved routine-info obtained by asking the shell.")
(defvar idlwave-library-routines nil
"Holds the procedure routine-info from the library scan.")
-(defvar idlwave-scanned-lib-directories nil
- "The directories scanned to get libinfo.")
+(defvar idlwave-path-alist nil
+ "Alist with !PATH directories and a flag if the dir has been scanned.")
+(defvar idlwave-true-path-alist nil
+ "Like `idlwave-path-alist', but with true filenames.")
(defvar idlwave-routines nil
"Holds the combinded procedure routine-info.")
(defvar idlwave-class-alist nil
(defvar idlwave-force-class-query nil)
(defvar idlwave-before-completion-wconf nil
"The window configuration just before the completion buffer was displayed.")
+(defvar idlwave-last-system-routine-info-cons-cell nil
+ "The last cons cell in the system routine info.")
;;
;; The code to get routine info from different sources.
-(defvar idlwave-builtin-routines)
+(defvar idlwave-system-routines)
(defun idlwave-routines ()
"Provide a list of IDL routines.
This routine loads the builtin routines on the first call. Later it
;; return the current value
idlwave-routines)))
+(defvar idlwave-update-rinfo-hook nil
+ "List of functions which should run after a global rinfo update.
+Does not run after automatic updates of buffer or the shell.")
+
(defun idlwave-update-routine-info (&optional arg)
"Update the internal routine-info lists.
These lists are used by `idlwave-routine-info' (\\[idlwave-routine-info])
(idlwave-create-libinfo-file t)
(let* ((reload (or arg
idlwave-buffer-case-takes-precedence
- (null idlwave-builtin-routines))))
+ (null idlwave-system-routines))))
(setq idlwave-buffer-routines nil
- idlwave-compiled-routines nil)
+ idlwave-compiled-routines nil
+ idlwave-unresolved-routines nil)
;; Reset the appropriate hashes
(idlwave-reset-sintern (cond (reload t)
- ((null idlwave-builtin-routines) t)
+ ((null idlwave-system-routines) t)
(t 'bufsh)))
(if idlwave-buffer-case-takes-precedence
;; causes the concatenation *delayed*, so not in time for
;; the current command. Therefore, we do a concatenation
;; now, even though the shell might do it again.
- (idlwave-concatenate-rinfo-lists))
+ (idlwave-concatenate-rinfo-lists nil t))
(when ask-shell
;; Ask the shell about the routines it knows.
(message "Querying the shell")
- (idlwave-shell-update-routine-info))))))
+ (idlwave-shell-update-routine-info nil t))))))
(defun idlwave-load-system-rinfo ()
;; Load and case-treat the system and lib info files.
- (load "idlwave-rinfo" t)
- (message "Normalizing idlwave-builtin-routines...")
- (setq idlwave-builtin-routines
- (idlwave-sintern-rinfo-list idlwave-builtin-routines 'sys))
- (message "Normalizing idlwave-builtin-routines...done")
- (setq idlwave-routines idlwave-builtin-routines)
+ (load "idlw-rinfo" t)
+ (message "Normalizing idlwave-system-routines...")
+ (setq idlwave-system-routines
+ (idlwave-sintern-rinfo-list idlwave-system-routines 'sys))
+ (message "Normalizing idlwave-system-routines...done")
+ (setq idlwave-routines (copy-sequence idlwave-system-routines))
+ (setq idlwave-last-system-routine-info-cons-cell
+ (nthcdr (1- (length idlwave-routines)) idlwave-routines))
(when (and (stringp idlwave-libinfo-file)
(file-regular-p idlwave-libinfo-file))
(condition-case nil
(progn
(load-file idlwave-libinfo-file)
+ (setq idlwave-true-path-alist nil)
(message "Normalizing idlwave-library-routines...")
(setq idlwave-library-routines (idlwave-sintern-rinfo-list
idlwave-library-routines 'sys))
(message "Normalizing idlwave-library-routines...done"))
- (error nil))))
+ (error nil)))
+ (run-hooks 'idlwave-after-load-rinfo-hook))
+
(defun idlwave-update-buffer-routine-info ()
(let (res)
- (if idlwave-scan-all-buffers-for-routine-info
- (progn
- ;; Scan all buffers, current buffer last
- (message "Scanning all buffers...")
- (setq res (idlwave-get-routine-info-from-buffers
- (reverse (buffer-list)))))
+ (cond
+ ((eq idlwave-scan-all-buffers-for-routine-info t)
+ ;; Scan all buffers, current buffer last
+ (message "Scanning all buffers...")
+ (setq res (idlwave-get-routine-info-from-buffers
+ (reverse (buffer-list)))))
+ ((null idlwave-scan-all-buffers-for-routine-info)
+ ;; Don't scan any buffers
+ (setq res nil))
+ (t
;; Just scan this buffer
(if (eq major-mode 'idlwave-mode)
(progn
(message "Scanning current buffer...")
(setq res (idlwave-get-routine-info-from-buffers
- (list (current-buffer)))))))
+ (list (current-buffer))))))))
;; Put the result into the correct variable
(setq idlwave-buffer-routines
(idlwave-sintern-rinfo-list res t))))
-(defun idlwave-concatenate-rinfo-lists ()
+(defun idlwave-concatenate-rinfo-lists (&optional quiet run-hook)
"Put the different sources for routine information together."
;; The sequence here is important because earlier definitions shadow
;; later ones. We assume that if things in the buffers are newer
;; then in the shell of the system, it is meant to be different.
- ;; FIXME: should the builtin stuff be before the library?
- ;; This is how IDL searches, the user may also have
- ;; functions overloading system stuff, and then the lib
- ;; should be first. Difficult to find a general solution.
- ;; FIXME: can't we use nconc here in some way, to save memory?
- ;; This is possible for buffer abd shell stuff, but these are
- ;; small anyway, and so it is not so critical.
- (setq idlwave-routines (append idlwave-buffer-routines
- idlwave-compiled-routines
- idlwave-library-routines
- idlwave-builtin-routines))
+
+ (setcdr idlwave-last-system-routine-info-cons-cell
+ (append idlwave-buffer-routines
+ idlwave-compiled-routines
+ idlwave-library-routines))
(setq idlwave-class-alist nil)
- (let (class)
- (loop for x in idlwave-routines do
- (when (and (setq class (nth 2 x))
- (not (assq class idlwave-class-alist)))
- (push (list class) idlwave-class-alist))))
+
;; Give a message with information about the number of routines we have.
- (message
- "Routine info updated: buffer(%d) compiled(%d) library(%d) system(%d)"
- (length idlwave-buffer-routines)
- (length idlwave-compiled-routines)
- (length idlwave-library-routines)
- (length idlwave-builtin-routines)))
+ (unless quiet
+ (message
+ "Routine info updated: buffer(%d) compiled(%d) catalog(%d) system(%d)"
+ (length idlwave-buffer-routines)
+ (length idlwave-compiled-routines)
+ (length idlwave-library-routines)
+ (length idlwave-system-routines)))
+ (if run-hook
+ (run-hooks 'idlwave-update-rinfo-hook)))
+
+(defun idlwave-class-alist ()
+ "Return the class alist - make it if necessary."
+ (or idlwave-class-alist
+ (let (class)
+ (loop for x in idlwave-routines do
+ (when (and (setq class (nth 2 x))
+ (not (assq class idlwave-class-alist)))
+ (push (list class) idlwave-class-alist)))
+ idlwave-class-alist)))
+
+;; Three functions for the hooks
+(defun idlwave-save-buffer-update ()
+ (idlwave-update-current-buffer-info 'save-buffer))
+(defun idlwave-kill-buffer-update ()
+ (idlwave-update-current-buffer-info 'kill-buffer))
+(defun idlwave-new-buffer-update ()
+ (idlwave-update-current-buffer-info 'find-file))
+
+(defun idlwave-update-current-buffer-info (why)
+ "Undate idlwave-routines for current buffer. Can run from after-save-hook."
+ (when (and (eq major-mode 'idlwave-mode)
+ (or (eq t idlwave-auto-routine-info-updates)
+ (memq why idlwave-auto-routine-info-updates))
+ idlwave-scan-all-buffers-for-routine-info
+ idlwave-routines)
+ (condition-case nil
+ (let (routines)
+ (idlwave-replace-buffer-routine-info
+ (buffer-file-name)
+ (if (eq why 'kill-buffer)
+ nil
+ (setq routines
+ (idlwave-sintern-rinfo-list
+ (idlwave-get-routine-info-from-buffers
+ (list (current-buffer))) 'set))))
+ (idlwave-concatenate-rinfo-lists 'quiet)
+ routines)
+ (error nil))))
+
+(defun idlwave-replace-buffer-routine-info (file new)
+ "Cut the part from FILE out of `idlwave-buffer-routines' and add NEW."
+ (let ((list idlwave-buffer-routines)
+ found)
+ (while list
+ ;; The following test uses eq to make sure it works correctly
+ ;; when two buffers visit the same file. Then the file names
+ ;; will be equal, but not eq.
+ (if (eq (cdr (nth 3 (car list))) file)
+ (progn
+ (setcar list nil)
+ (setq found t))
+ (if found
+ ;; End of that section reached. Jump.
+ (setq list nil)))
+ (setq list (cdr list)))
+ (setq idlwave-buffer-routines
+ (append new (delq nil idlwave-buffer-routines)))))
;;----- Scanning buffers -------------------
(save-excursion
(while (setq buf (pop buffers))
(set-buffer buf)
- (if (eq major-mode 'idlwave-mode)
+ (if (and (eq major-mode 'idlwave-mode)
+ buffer-file-name)
;; yes, this buffer has the right mode.
(progn (setq res (condition-case nil
(idlwave-get-buffer-routine-info)
(widen)
(goto-char (point-min))
(while (re-search-forward
- "^[ \t]*\\<\\(pro\\|function\\)\\>" nil t)
+ "^[ \t]*\\(pro\\|function\\)[ \t]" nil t)
(setq string (buffer-substring
(match-beginning 0)
(progn
(push entry routine-list))))
routine-list))
+(defvar idlwave-scanning-lib-dir)
(defun idlwave-parse-definition (string)
"Parse a module definition."
(let ((case-fold-search t)
;; Remove the continuation line stuff
(while (string-match "\\([^a-zA-Z0-9$_]\\)\\$[ \t]*\n" string)
(setq string (replace-match "\\1 " t nil string)))
+ (while (string-match "\n" string)
+ (setq string (replace-match " " t nil string)))
;; Match the name and type.
(when (string-match
"\\<\\(pro\\|function\\)\\>\\s-+\\(\\([a-zA-Z0-9$_]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)" string)
(setq name (match-string 4 string)))
;; Match normal args and keyword args
(while (string-match
- ",\\s-*\\([a-zA-Z][a-zA-Z0-9$_]*\\|_extra\\)\\s-*\\(=\\)?"
+ ",\\s-*\\([a-zA-Z][a-zA-Z0-9$_]*\\|\\(_ref\\)?_extra\\)\\s-*\\(=\\)?"
string start)
(setq start (match-end 0))
- (if (match-beginning 2)
+ (if (match-beginning 3)
(push (match-string 1 string) keywords)
(push (match-string 1 string) args)))
;; Normalize and sort.
class
(cond ((not (boundp 'idlwave-scanning-lib))
(cons 'buffer (buffer-file-name)))
- ((string= (downcase
- (file-name-sans-extension
- (file-name-nondirectory (buffer-file-name))))
- (downcase name))
- (list 'lib))
- (t (cons 'lib (file-name-nondirectory (buffer-file-name)))))
+; ((string= (downcase
+; (file-name-sans-extension
+; (file-name-nondirectory (buffer-file-name))))
+; (downcase name))
+; (list 'lib))
+; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
+ (t (cons 'lib (concat idlwave-scanning-lib-dir
+ (file-name-nondirectory (buffer-file-name))))))
(concat
(if (string= type "function") "Result = " "")
(if class "Obj ->[%s::]" "")
;;----- Scanning the library -------------------
+(defvar idlwave-sys-dir nil
+ "Internal variable.")
+
+(defun idlwave-sys-dir ()
+ "Return the syslib directory, or a dummy that never matches."
+ (or idlwave-sys-dir
+ "@@@@@@@@"))
+
+(defvar idlwave-shell-path-query)
(defun idlwave-create-libinfo-file (&optional arg)
"Scan all files on selected dirs of IDL search path for routine information.
A widget checklist will allow you to choose the directories.
(error nil)))
;; Make sure the file name makes sense
(unless (and (stringp idlwave-libinfo-file)
+ (> (length idlwave-libinfo-file) 0)
(file-accessible-directory-p
(file-name-directory idlwave-libinfo-file))
(not (string= "" (file-name-nondirectory
idlwave-libinfo-file))))
- (error "`idlwave-libinfo-file' does not point to file in accessible directory."))
+ (error "`idlwave-libinfo-file' does not point to file in accessible directory"))
(cond
- ((and arg idlwave-scanned-lib-directories)
+ ((and arg idlwave-path-alist
+ (consp (car idlwave-path-alist))
+ idlwave-sys-dir)
;; Rescan the known directories
- (idlwave-scan-lib-files idlwave-scanned-lib-directories))
+ (idlwave-scan-lib-files
+ idlwave-sys-dir
+ idlwave-path-alist))
(idlwave-library-path
;; Get the directories from that variable
(idlwave-display-libinfo-widget
+ idlwave-system-directory
(idlwave-expand-path idlwave-library-path)
- idlwave-scanned-lib-directories))
+ (delq nil (mapcar (lambda (x) (if (consp x) (if (cdr x) (car x) nil) x))
+ idlwave-path-alist))))
(t
;; Ask the shell for the path and run the widget
(message "Asking the shell for IDL path...")
- (idlwave-shell-send-command
- "__pa=expand_path(!path,/array)&for i=0,n_elements(__pa)-1 do print,'PATH:',__pa[i]"
- '(idlwave-libinfo-command-hook nil)
- 'hide))))
+ (require 'idlw-shell)
+ (idlwave-shell-send-command idlwave-shell-path-query
+ '(idlwave-libinfo-command-hook nil)
+ 'hide))))
(defun idlwave-libinfo-command-hook (&optional arg)
;; Command hook used by `idlwave-create-libinfo-file'.
(if arg
;; Scan immediately
- (idlwave-scan-lib-files idlwave-scanned-lib-directories)
+ (idlwave-scan-lib-files
+ idlwave-sys-dir
+ idlwave-path-alist)
;; Display the widget
- (idlwave-display-libinfo-widget (idlwave-shell-path-filter)
- idlwave-scanned-lib-directories)))
-
-(defvar idlwave-shell-command-output)
-(defun idlwave-shell-path-filter ()
- ;; Convert the output of the path query into a list of directories
- (let ((path-string idlwave-shell-command-output)
- (case-fold-search t)
- (start 0)
- dirs)
- (while (string-match "^PATH:[ \t]*\\(.*\\)\n" path-string start)
- (push (match-string 1 path-string) dirs)
- (setq start (match-end 0)))
- (nreverse dirs)))
+ (let* ((rpl (idlwave-shell-path-filter))
+ (sysdir (car rpl))
+ (dirs (cdr rpl)))
+ (idlwave-display-libinfo-widget
+ sysdir dirs
+ (delq nil (mapcar (lambda (x) (if (cdr x) (car x) nil))
+ idlwave-path-alist))))))
(defconst idlwave-libinfo-widget-help-string
- "This is the front-end to the creation of IDLWAVE library routine info.
+ "This is the front-end to the creation of IDLWAVE library catalog.
Please select below the directories on IDL's search path from which you
would like to extract routine information, which will be stored in the file
If this is not the correct file, first set variable `idlwave-libinfo-file'.
Then call this command again.
+
+For writing code, you need to include the directories which contain the
+routines you use. If IDLWAVE should be able to analyse routine shadowing
+it is best to scan all directories.
+
After selecting the directories, choose [Scan & Save] to scan the library
directories and save the routine info.
\n")
(defvar idlwave-widget)
(defvar widget-keymap)
-(defun idlwave-display-libinfo-widget (dirs selected-dirs)
+(defun idlwave-display-libinfo-widget (sysdir dirs selected-dirs)
"Create the widget to select IDL search path directories for scanning."
(interactive)
(require 'widget)
(widget-create 'push-button
:notify 'idlwave-widget-scan-lib-files
- :help-echo "testing"
"Scan & Save")
(widget-insert " ")
(widget-create 'push-button
(widget-create 'push-button
:notify '(lambda (&rest ignore)
(idlwave-display-libinfo-widget
+ (widget-get idlwave-widget :sysdir)
(widget-get idlwave-widget :path-dirs)
(widget-get idlwave-widget :path-dirs)))
"Select All")
(widget-create 'push-button
:notify '(lambda (&rest ignore)
(idlwave-display-libinfo-widget
+ (widget-get idlwave-widget :sysdir)
(widget-get idlwave-widget :path-dirs)
nil))
"Deselect All")
:tag "List of directories"
(mapcar (lambda (x) (list 'item x)) dirs)))
(widget-put idlwave-widget :path-dirs dirs)
+ (widget-put idlwave-widget :sysdir sysdir)
(widget-insert "\n")
(use-local-map widget-keymap)
(widget-setup)
(defun idlwave-widget-scan-lib-files (&rest ignore)
;; Call `idlwave-scan-lib-files' with data taken from the widget.
(let* ((widget idlwave-widget)
- (selected-dirs (widget-value widget)))
- (idlwave-scan-lib-files selected-dirs)))
+ (selected-dirs (widget-value widget))
+ (sysdir (widget-get widget :sysdir))
+ (path-dirs (widget-get widget :path-dirs))
+ (path-dir-alist
+ (mapcar (lambda (x) (cons x (if (member x selected-dirs) t nil)))
+ path-dirs)))
+ (idlwave-scan-lib-files sysdir path-dir-alist)))
(defvar font-lock-mode)
-(defun idlwave-scan-lib-files (selected-dirs)
- ;; Scan the files in SELECTED-DIRS and store the info in a file
+(defun idlwave-scan-lib-files (sysdir path-alist)
+ ;; Scan the files in PATH-ALIST and store the info in a file
(let* ((idlwave-scanning-lib t)
+ (idlwave-scanning-lib-dir "")
+ (dircnt (1+ (length path-alist)))
(idlwave-completion-case nil)
- dirs dir files file)
+ dirs-alist dir files file)
(setq idlwave-library-routines nil)
- (setq idlwave-scanned-lib-directories selected-dirs)
+ (setq idlwave-path-alist path-alist)
+ (setq idlwave-true-path-alist nil)
+ (setq idlwave-sys-dir sysdir)
(save-excursion
(set-buffer (get-buffer-create "*idlwave-scan.pro*"))
(idlwave-mode)
- (setq dirs (reverse selected-dirs))
- (while (setq dir (pop dirs))
- (when (file-directory-p dir)
- (setq files (directory-files dir 'full "\\.[pP][rR][oO]\\'"))
- (while (setq file (pop files))
- (when (file-regular-p file)
- (if (not (file-readable-p file))
- (message "Skipping %s (no read permission)" file)
- (message "Scanning %s..." file)
- (erase-buffer)
- (insert-file-contents file 'visit)
- (setq idlwave-library-routines
- (append (idlwave-get-routine-info-from-buffers
- (list (current-buffer)))
- idlwave-library-routines)))
- )))))
+ (setq dirs-alist (reverse path-alist))
+ (while (setq dir (pop dirs-alist))
+ (decf dircnt)
+ (when (cdr dir)
+ ;; Has the flag of scanned directories
+ (setq dir (car dir))
+ (setq idlwave-scanning-lib-dir (format "{%d}/" dircnt))
+ (when (file-directory-p dir)
+ (setq files (directory-files dir 'full "\\.[pP][rR][oO]\\'"))
+ (while (setq file (pop files))
+ (when (file-regular-p file)
+ (if (not (file-readable-p file))
+ (message "Skipping %s (no read permission)" file)
+ (message "Scanning %s..." file)
+ (erase-buffer)
+ (insert-file-contents file 'visit)
+ (setq idlwave-library-routines
+ (append (idlwave-get-routine-info-from-buffers
+ (list (current-buffer)))
+ idlwave-library-routines)))
+ ))))))
+ ;; Sorting is not necessary since we sort each time before a routine
+ ;; is used. So we don't do it here - the catalog file looks nicer
+ ;; when it is unsorted.
+ ;;(message "Sorting...")
+ ;;(setq idlwave-library-routines
+ ;;(sort idlwave-library-routines 'idlwave-routine-entry-compare))
+ ;;(message "Sorting...done")
+ (message "Creating libinfo file...")
(kill-buffer "*idlwave-scan.pro*")
(kill-buffer (get-buffer-create "*IDLWAVE Widget*"))
- (let ((font-lock-maximum-size 0))
+ (let ((font-lock-maximum-size 0)
+ (auto-mode-alist nil))
(find-file idlwave-libinfo-file))
(if (and (boundp 'font-lock-mode)
font-lock-mode)
(insert ";; IDLWAVE libinfo file\n")
(insert (format ";; Created %s\n\n" (current-time-string)))
+ ;; Define the variable which knows the value of "!DIR"
+ (insert (format "\n(setq idlwave-sys-dir \"%s\")\n"
+ idlwave-sys-dir))
+
;; Define the variable which contains a list of all scanned directories
- (insert "\n(setq idlwave-scanned-lib-directories\n '(")
+ (insert "\n(setq idlwave-path-alist\n '(")
(mapcar (lambda (x)
- (insert (format "\n \"%s\"" x)))
- selected-dirs)
+ (insert (format "\n (\"%s\" . %s)" (car x) (cdr x))))
+ path-alist)
(insert "))\n")
+
;; Define the routine info list
(insert "\n(setq idlwave-library-routines\n '(")
(mapcar (lambda (x)
;; Save the buffer
(save-buffer 0)
(kill-buffer (current-buffer)))
+ (message "Creating libinfo file...done")
(message "Info for %d routines saved in %s"
(length idlwave-library-routines)
idlwave-libinfo-file)
;; defined routines.
(defconst idlwave-routine-info.pro
"
-function idlwave_make_info_entry,name,func=func,separator=sep
+;; START OF IDLWAVE SUPPORT ROUTINES
+pro idlwave_print_info_entry,name,func=func,separator=sep
;; See if it's an object method
+ if name eq '' then return
func = keyword_set(func)
methsep = strpos(name,'::')
meth = methsep ne -1
endfor
endif
- ret=(['IDLWAVE-PRO','IDLWAVE-FUN', $
- 'IDLWAVE-PRO','IDLWAVE-FUN'])(func+2*meth)
+ ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])(func)
- return,ret + ': ' + name + sep + class + sep + source(0).path $
+ print,ret + ': ' + name + sep + class + sep + source(0).path $
+ sep + cs + sep + kwstring
end
print,'>>>BEGIN OF IDLWAVE ROUTINE INFO (\"' + sep + '\" IS THE SEPARATOR)'
all = routine_info()
for i=0,n_elements(all)-1 do $
- print,idlwave_make_info_entry(all(i),separator=sep)
+ idlwave_print_info_entry,all(i),separator=sep
all = routine_info(/functions)
for i=0,n_elements(all)-1 do $
- print,idlwave_make_info_entry(all(i),/func,separator=sep)
+ idlwave_print_info_entry,all(i),/func,separator=sep
print,'>>>END OF IDLWAVE ROUTINE INFO'
end
+
+pro idlwave_get_sysvars
+ forward_function strjoin,strtrim,strsplit
+ catch,error_status
+ if error_status ne 0 then begin
+ print, 'Cannot get info about system variables'
+ endif else begin
+ help,/brief,output=s,/system_variables ; ? unsafe use of OUTPUT=
+ s = strtrim(strjoin(s,' ',/single),2) ; make one line
+ v = strsplit(s,' +',/regex,/extract) ; get variables
+ for i=0,n_elements(v)-1 do begin
+ t = [''] ; get tag list
+ a=execute('if n_tags('+v[i]+') gt 0 then t=tag_names('+v[i]+')')
+ print, 'IDLWAVE-SYSVAR: '+v[i]+' '+strjoin(t,' ',/single)
+ endfor
+ endelse
+end
+
+pro idlwave_get_class_tags, class
+ res = execute('tags=tag_names({'+class+'})')
+ if res then print,'IDLWAVE-CLASS-TAGS: '+class+string(format='(1000(\" \",A))',tags)
+end
+;; END OF IDLWAVE SUPPORT ROUTINES
"
- "The idl program to get the routine info stuff.
-The output of this program is parsed by `idlwave-shell-routine-info-filter'.")
+ "The idl programs to get info from the shell.")
-(defun idlwave-shell-routine-info-filter ()
- "Function which parses the special output from idlwave_routine_info.pro."
- (let ((text idlwave-shell-command-output)
- (start 0)
- sep sep-re file type spec specs name cs key keys class)
- ;; Initialize variables
- (setq idlwave-compiled-routines nil)
- ;; Cut out the correct part of the output.
- (if (string-match
- "^>>>BEGIN OF IDLWAVE ROUTINE INFO (\"\\(.+\\)\" IS THE SEPARATOR.*"
- text)
- (setq sep (match-string 1 text)
- sep-re (concat (regexp-quote sep) " *")
- text (substring text (match-end 0)))
- (error "Routine Info error: No match for BEGIN line"))
- (if (string-match "^>>>END OF IDLWAVE ROUTINE INFO.*" text)
- (setq text (substring text 0 (match-beginning 0)))
- (error "Routine Info error: No match for END line"))
- ;; Match the output lines
- (while (string-match "^IDLWAVE-\\(PRO\\|FUN\\): \\(.*\\)" text start)
- (setq start (match-end 0))
- (setq type (match-string 1 text)
- spec (match-string 2 text)
- specs (idlwave-split-string spec sep-re)
- name (nth 0 specs)
- class (if (equal (nth 1 specs) "") nil (nth 1 specs))
- file (nth 2 specs)
- cs (nth 3 specs)
- key (nth 4 specs)
- keys (if (and (stringp key)
- (not (string-match "\\` *\\'" key)))
- (mapcar 'list
- (delete "" (idlwave-split-string key " +")))))
- (setq name (idlwave-sintern-routine-or-method name class t)
- class (idlwave-sintern-class class t)
- keys (mapcar (lambda (x)
- (list (idlwave-sintern-keyword (car x) t))) keys))
- ;; Make sure we use the same string object for the same file
- (setq file (idlwave-sintern-file file t))
- ;; FIXME: What should I do with routines from the temp file???
- ;; Maybe just leave it in - there is a chance that the
- ;; routine is still in there.
- ;; (if (equal file idlwave-shell-temp-pro-file)
- ;; (setq file nil))
-
- ;; In the following ignore routines already defined in buffers,
- ;; assuming that if the buffer stuff differs, it is a "new"
- ;; version.
- ;; We could do the same for the library to avoid duplicates -
- ;; but I think frequently a user might have several versions of
- ;; the same function in different programs, and in this case the
- ;; compiled one will be the best guess of all version.
- ;; Therefore, we leave duplicates of library routines in.
-
- (cond ((string= name "$MAIN$")) ; ignore this one
- ((and (string= type "PRO")
- ;; FIXME: is it OK to make the buffer routines dominate?
- (not (idlwave-rinfo-assq name 'pro class
- idlwave-buffer-routines))
- ;; FIXME: is it OK to make the library routines dominate?
- ;;(not (idlwave-rinfo-assq name 'pro class
- ;; idlwave-library-routines))
- )
- (push (list name 'pro class (cons 'compiled file) cs keys)
- idlwave-compiled-routines))
- ((and (string= type "FUN")
- ;; FIXME: is it OK to make the buffer routines dominate?
- (not (idlwave-rinfo-assq name 'fun class
- idlwave-buffer-routines))
- ;; FIXME: is it OK to make the library routines dominate?
- ;; (not (idlwave-rinfo-assq name 'fun class
- ;; idlwave-library-routines))
- )
- (push (list name 'fun class (cons 'compiled file) cs keys)
- idlwave-compiled-routines)))))
- ;; Reverse the definitions so that they are alphabetically sorted.
- (setq idlwave-compiled-routines
- (nreverse idlwave-compiled-routines)))
+(defvar idlwave-idlwave_routine_info-compiled nil
+ "Remembers if the routine info procedure is already compiled.")
(defvar idlwave-shell-temp-pro-file)
-(defun idlwave-shell-update-routine-info ()
+(defvar idlwave-shell-temp-rinfo-save-file)
+(defun idlwave-shell-update-routine-info (&optional quiet run-hooks)
"Query the shell for routine_info of compiled modules and update the lists."
- ;; Save and compile the procedure
- (save-excursion
- (set-buffer (idlwave-find-file-noselect
- idlwave-shell-temp-pro-file))
- (erase-buffer)
- (insert idlwave-routine-info.pro)
- (save-buffer 0))
- (idlwave-shell-send-command (concat ".run " idlwave-shell-temp-pro-file)
- nil 'hide)
-
- ;; Execute the procedure and analyze the output
- (idlwave-shell-send-command "idlwave_routine_info"
- '(progn
- (idlwave-shell-routine-info-filter)
- (idlwave-concatenate-rinfo-lists))
- 'hide))
+ ;; Save and compile the procedure. The compiled procedure is then
+ ;; saved into an IDL SAVE file, to allow for fast RESTORE.
+ ;; We need to RESTORE the procedure each time we use it, since
+ ;; the user may have killed or redefined it. In particluar,
+ ;; .RESET_SESSION will kill all user procedures.
+ (unless (and idlwave-idlwave_routine_info-compiled
+ (file-readable-p idlwave-shell-temp-rinfo-save-file))
+ (save-excursion
+ (set-buffer (idlwave-find-file-noselect
+ idlwave-shell-temp-pro-file))
+ (erase-buffer)
+ (insert idlwave-routine-info.pro)
+ (save-buffer 0))
+ (idlwave-shell-send-command
+ (concat ".run " idlwave-shell-temp-pro-file)
+ nil 'hide)
+ (idlwave-shell-send-command
+ (format "save,'idlwave_routine_info','idlwave_print_info_entry',FILE='%s',/ROUTINES"
+ idlwave-shell-temp-rinfo-save-file)
+ nil 'hide))
+
+ ;; Restore and execute the procedure, analyze the output
+ (idlwave-shell-send-command
+ (format "RESTORE, '%s' & idlwave_routine_info"
+ idlwave-shell-temp-rinfo-save-file)
+ `(progn
+ (idlwave-shell-routine-info-filter)
+ (idlwave-concatenate-rinfo-lists ,quiet ,run-hooks))
+ 'hide))
;; ---------------------------------------------------------------------------
;;
;; Completion and displaying routine calling sequences
+(defvar idlwave-completion-help-info nil)
+(defvar idlwave-current-obj_new-class nil)
+(defvar idlwave-complete-special nil)
+
(defun idlwave-complete (&optional arg module class)
"Complete a function, procedure or keyword name at point.
This function is smart and figures out what can be legally completed
(idlwave-make-force-complete-where-list arg module class)
(idlwave-where)))
(what (nth 2 where-list))
- (idlwave-force-class-query (equal arg '(4)))
- cwin)
+ (idlwave-force-class-query (equal arg '(4))))
(if (and module (string-match "::" module))
(setq class (substring module 0 (match-beginning 0))
((and (null arg)
(eq (car-safe last-command) 'idlwave-display-completion-list)
- (setq cwin (get-buffer-window "*Completions*")))
+ (get-buffer-window "*Completions*"))
(setq this-command last-command)
(idlwave-scroll-completions))
+ ;; Check for any special completion functions
+ ((and idlwave-complete-special
+ (idlwave-complete-special)))
+
+ ((and (idlwave-in-quote)
+ (not (eq what 'class)))
+ (idlwave-complete-filename))
+
((null what)
(error "Nothing to complete here"))
((eq what 'class)
+ (setq idlwave-completion-help-info '(class))
(idlwave-complete-class))
((eq what 'procedure)
;; Complete a procedure name
(let* ((class-selector (idlwave-determine-class (nth 3 where-list) 'pro))
+ (super-classes (idlwave-all-class-inherits class-selector))
(isa (concat "procedure" (if class-selector "-method" "")))
(type-selector 'pro))
+ (setq idlwave-completion-help-info
+ (list 'routine nil type-selector class-selector nil super-classes))
(idlwave-complete-in-buffer
'procedure (if class-selector 'method 'routine)
(idlwave-routines) 'idlwave-selector
((eq what 'function)
;; Complete a function name
(let* ((class-selector (idlwave-determine-class (nth 3 where-list) 'fun))
+ (super-classes (idlwave-all-class-inherits class-selector))
(isa (concat "function" (if class-selector "-method" "")))
(type-selector 'fun))
+ (setq idlwave-completion-help-info
+ (list 'routine nil type-selector class-selector nil super-classes))
(idlwave-complete-in-buffer
'function (if class-selector 'method 'routine)
(idlwave-routines) 'idlwave-selector
(type-selector 'pro)
(class (idlwave-determine-class where 'pro))
(class-selector class)
+ (super-classes (idlwave-all-class-inherits class-selector))
(isa (format "procedure%s-keyword" (if class "-method" "")))
- (entry (idlwave-rinfo-assq
+ (entry (idlwave-best-rinfo-assq
name 'pro class (idlwave-routines)))
(list (nth 5 entry)))
(unless (or entry (eq class t))
(setq list (idlwave-fix-keywords name 'pro class list))
(unless list (error (format "No keywords available for procedure %s"
(idlwave-make-full-name class name))))
+ (setq idlwave-completion-help-info
+ (list 'keyword name type-selector class-selector nil super-classes))
(idlwave-complete-in-buffer
'keyword 'keyword list nil
(format "Select keyword for procedure %s%s"
(idlwave-make-full-name class name)
- (if (member '("_EXTRA") list) " (note _EXTRA)" ""))
+ (if (or (member '("_EXTRA") list)
+ (member '("_REF_EXTRA") list))
+ " (note _EXTRA)" ""))
isa
'idlwave-attach-keyword-classes)))
(type-selector 'fun)
(class (idlwave-determine-class where 'fun))
(class-selector class)
+ (super-classes (idlwave-all-class-inherits class-selector))
(isa (format "function%s-keyword" (if class "-method" "")))
- (entry (idlwave-rinfo-assq
+ (entry (idlwave-best-rinfo-assq
name 'fun class (idlwave-routines)))
- (list (nth 5 entry)))
+ (list (nth 5 entry))
+ msg-name)
(unless (or entry (eq class t))
(error "Nothing known about function %s"
(idlwave-make-full-name class name)))
(setq list (idlwave-fix-keywords name 'fun class list))
+ ;; OBJ_NEW: Messages mention the proper Init method
+ (setq msg-name (if (and (null class)
+ (string= (upcase name) "OBJ_NEW"))
+ (concat idlwave-current-obj_new-class
+ "::Init (via OBJ_NEW)")
+ (idlwave-make-full-name class name)))
(unless list (error (format "No keywords available for function %s"
- (idlwave-make-full-name class name))))
+ msg-name)))
+ (setq idlwave-completion-help-info
+ (list 'keyword name type-selector class-selector nil super-classes))
(idlwave-complete-in-buffer
'keyword 'keyword list nil
- (format "Select keyword for function %s%s"
- (idlwave-make-full-name class name)
- (if (member '("_EXTRA") list) " (note _EXTRA)" ""))
+ (format "Select keyword for function %s%s" msg-name
+ (if (or (member '("_EXTRA") list)
+ (member '("_REF_EXTRA") list))
+ " (note _EXTRA)" ""))
isa
'idlwave-attach-keyword-classes)))
-
+
(t (error "This should not happen (idlwave-complete)")))))
+(defvar idlwave-complete-special nil
+ "List of special completion functions.
+These functions are called for each completion. Each function must check
+if its own special completion context is present. If yes, it should
+use `idlwave-complete-in-buffer' to do some completion and return `t'.
+If such a function returns `t', *no further* attempts to complete
+other contexts will be done. If the function returns `nil', other completions
+will be tried.")
+(defun idlwave-complete-special ()
+ (let ((functions idlwave-complete-special)
+ fun)
+ (catch 'exit
+ (while (setq fun (pop functions))
+ (if (funcall fun)
+ (throw 'exit t)))
+ nil)))
+
(defun idlwave-make-force-complete-where-list (what &optional module class)
;; Return an artificial WHERE specification to force the completion
;; routine to complete a specific item independent of context.
((eq what 'procedure-keyword)
(let* ((class-selector nil)
+ (super-classes nil)
(type-selector 'pro)
(pro (or module
(idlwave-completing-read
((eq what 'function-keyword)
(let* ((class-selector nil)
+ (super-classes nil)
(type-selector 'fun)
(func (or module
(idlwave-completing-read
((eq what 'procedure-method-keyword)
(let* ((class (idlwave-determine-class class-list 'pro))
(class-selector class)
+ (super-classes (idlwave-all-class-inherits class-selector))
(type-selector 'pro)
(pro (or module
(idlwave-completing-read
((eq what 'function-method-keyword)
(let* ((class (idlwave-determine-class class-list 'fun))
(class-selector class)
+ (super-classes (idlwave-all-class-inherits class-selector))
(type-selector 'fun)
(func (or module
(idlwave-completing-read
(apply 'completing-read args))
(setq-default completion-ignore-case old-value))))
+(defvar idlwave-shell-default-directory)
+(defun idlwave-complete-filename ()
+ "Use the comint stuff to complete a file name."
+ (require 'comint)
+ (let* ((comint-file-name-chars "~/A-Za-z0-9+@:_.$#%={}\\-")
+ (comint-completion-addsuffix nil)
+ (default-directory
+ (if (and (boundp 'idlwave-shell-default-directory)
+ (stringp idlwave-shell-default-directory)
+ (file-directory-p idlwave-shell-default-directory))
+ idlwave-shell-default-directory
+ default-directory)))
+ (comint-dynamic-complete-filename)))
+
(defun idlwave-make-full-name (class name)
;; Make a fully qualified module name including the class name
(concat (if class (format "%s::" class) "") name))
+(defun idlwave-rinfo-assoc (name type class list)
+ "Like `idlwave-rinfo-assq', but sintern strings first."
+ (idlwave-rinfo-assq
+ (idlwave-sintern-routine-or-method name class)
+ type (idlwave-sintern-class class) list))
+
(defun idlwave-rinfo-assq (name type class list)
;; Works like assq, but also checks type and class
(catch 'exit
(throw 'exit match))
(setq list (cdr (memq match list)))))))
+(defun idlwave-rinfo-assq-any-class (name type class list)
+ (let* ((classes (cons class (idlwave-all-class-inherits class)))
+ class rtn)
+ (while classes
+ (if (setq rtn (idlwave-rinfo-assq name type (pop classes) list))
+ (setq classes nil)))
+ rtn))
+
+(defun idlwave-best-rinfo-assq (name type class list)
+ "Like `idlwave-rinfo-assq', but get all twins and sort, then return first."
+ (let ((twins (idlwave-routine-twins
+ (idlwave-rinfo-assq-any-class name type class list)
+ list))
+ syslibp)
+ (when (> (length twins) 1)
+ (setq twins (sort twins 'idlwave-routine-entry-compare-twins))
+ (if (and (eq 'system (car (nth 3 (car twins))))
+ (setq syslibp (idlwave-any-syslib (cdr twins)))
+ (not (equal 1 syslibp)))
+ ;; Its a syslib, so we need to remove the system entry
+ (setq twins (cdr twins))))
+ (car twins)))
+
+(defun idlwave-best-rinfo-assoc (name type class list)
+ "Like `idlwave-best-rinfo-assq', but sintern strings first."
+ (idlwave-best-rinfo-assq
+ (idlwave-sintern-routine-or-method name class)
+ type (idlwave-sintern-class class) list))
+
+(defun idlwave-any-syslib (entries)
+ "Does the entry list ENTRIES contain a syslib entry?
+If yes, return the index (>=1)."
+ (let (file (cnt 0))
+ (catch 'exit
+ (while entries
+ (incf cnt)
+ (setq file (cdr (nth 3 (car entries))))
+ (if (and file
+ (idlwave-syslib-p
+ (idlwave-expand-lib-file-name file)))
+ (throw 'exit cnt)
+ (setq entries (cdr entries))))
+ nil)))
+
(defun idlwave-all-assq (key list)
"Return a list of all associations of Key in LIST."
(let (rtn elt)
"Return all classes which have a method METHOD. TYPE is 'fun or 'pro.
When TYPE is not specified, both procedures and functions will be considered."
(if (null method)
- (mapcar 'car idlwave-class-alist)
+ (mapcar 'car (idlwave-class-alist))
(let (rtn)
(mapcar (lambda (x)
(and (nth 2 x)
(idlwave-all-assq method (idlwave-routines)))
(idlwave-uniquify rtn))))
+(defun idlwave-members-only (list club)
+ "Return list of all elements in LIST which are also in CLUB."
+ (let (rtn)
+ (while list
+ (if (member (car list) club)
+ (setq rtn (cons (car list) rtn)))
+ (setq list (cdr list)))
+ (nreverse rtn)))
+
+(defun idlwave-nonmembers-only (list club)
+ "Return list of all elements in LIST which are not in CLUB."
+ (let (rtn)
+ (while list
+ (if (member (car list) club)
+ nil
+ (setq rtn (cons (car list) rtn)))
+ (setq list (cdr list)))
+ (nreverse rtn)))
+
(defun idlwave-determine-class (info type)
;; Determine the class of a routine call. INFO is the structure returned
;; `idlwave-what-function' or `idlwave-what-procedure'.
;; The third element in this structure is the class. When nil, we return nil.
- ;; When t, try to get the class from text properties at the arrow,
+ ;; When t, try to get the class from text properties at the arrow. When
+ ;; the object is "self", we use the class of the current routine.
;; otherwise prompt the user for a class name. Also stores the selected
;; class as a text property at the arrow.
;; TYPE is 'fun or 'pro.
(dassoc (cdr dassoc))
(t t)))
(arrow (and apos (string= (buffer-substring apos (+ 2 apos)) "->")))
+ (is-self
+ (and arrow
+ (save-excursion (goto-char apos)
+ (forward-word -1)
+ (let ((case-fold-search t))
+ (looking-at "self\\>")))))
(force-query idlwave-force-class-query)
store class-alist)
(cond
(not force-query))
(setq class (get-text-property apos 'idlwave-class)
class (idlwave-sintern-class class)))
+ (when (and (eq t class)
+ is-self)
+ (setq class (or (nth 2 (idlwave-current-routine)) class)))
(when (and (eq class t)
(or force-query query))
(setq class-alist
(defvar type-selector)
(defvar class-selector)
(defvar method-selector)
+(defvar super-classes)
(defun idlwave-selector (a)
(and (eq (nth 1 a) type-selector)
(or (and (nth 2 a) (eq class-selector t))
- (eq (nth 2 a) class-selector))))
+ (eq (nth 2 a) class-selector)
+ (memq (nth 2 a) super-classes)
+ )))
(defun idlwave-where ()
"Find out where we are.
CLASS: What class has the routine (nil=no, t=is method, but class unknown)
ARROW: Where is the arrow?"
(idlwave-routines)
- (let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
+ (let* (;(bos (save-excursion (idlwave-beginning-of-statement) (point)))
+ (bos (save-excursion (idlwave-start-of-substatement 'pre) (point)))
(func-entry (idlwave-what-function bos))
(func (car func-entry))
(func-class (nth 1 func-entry))
cw cw-mod cw-arrow cw-class cw-point)
(if (< func-point pro-point) (setq func nil))
(cond
+ ((string-match "\\`[ \t]*\\(pro\\|function\\)[ \t]+[a-zA-Z0-9_]*\\'"
+ (buffer-substring bos (point)))
+ (setq cw 'class))
((string-match
"\\`[ \t]*\\([a-zA-Z][a-zA-Z0-9$_]*\\)?\\'"
(buffer-substring (if (> pro-point 0) pro-point bos) (point)))
((string-match "\\`[ \t]*\\(pro\\|function\\)\\>"
(buffer-substring bos (point)))
nil)
- ((string-match "OBJ_NEW([ \t]*'\\([a-zA-Z][a-zA-Z0-9$_]*\\)?\\'"
+ ((string-match "OBJ_NEW([ \t]*['\"]\\([a-zA-Z0-9$_]*\\)?\\'"
+ (buffer-substring bos (point)))
+ (setq cw 'class))
+ ((string-match "\\<inherits\\s-+\\([a-zA-Z0-9$_]*\\)?\\'"
(buffer-substring bos (point)))
(setq cw 'class))
((and func
(progn (skip-chars-backward class) (point))
(progn (skip-chars-forward class) (point)))))
-(defvar idlwave-find-symbol-syntax-table)
(defun idlwave-what-function (&optional bound)
;; Find out if point is within the argument list of a function.
;; The return value is ("function-name" (point) level).
(catch 'exit
(let (pos
func-point
- (old-syntax (syntax-table))
(cnt 0)
func arrow-start class)
- (unwind-protect
- (save-restriction
- (save-excursion
- (set-syntax-table idlwave-find-symbol-syntax-table)
- (narrow-to-region (max 1 (or bound 0)) (point-max))
- ;; move back out of the current parenthesis
- (while (condition-case nil
- (progn (up-list -1) t)
- (error nil))
- (setq pos (point))
- (incf cnt)
- (when (and (= (following-char) ?\()
- (re-search-backward
- "\\(::\\|\\<\\)\\([a-zA-Z][a-zA-Z0-9$_]*\\)\\="
- bound t))
- (setq func (match-string 2)
- func-point (goto-char (match-beginning 2))
- pos func-point)
- (if (re-search-backward
- "->[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\=" bound t)
- (setq arrow-start (match-beginning 0)
- class (or (match-string 2) t)))
- (throw
- 'exit
- (list
- (idlwave-sintern-routine-or-method func class)
- (idlwave-sintern-class class)
- arrow-start func-point cnt)))
- (goto-char pos))
- (throw 'exit nil)))
- (set-syntax-table old-syntax)))))
+ (idlwave-with-special-syntax
+ (save-restriction
+ (save-excursion
+ (narrow-to-region (max 1 (or bound 0)) (point-max))
+ ;; move back out of the current parenthesis
+ (while (condition-case nil
+ (progn (up-list -1) t)
+ (error nil))
+ (setq pos (point))
+ (incf cnt)
+ (when (and (= (following-char) ?\()
+ (re-search-backward
+ "\\(::\\|\\<\\)\\([a-zA-Z][a-zA-Z0-9$_]*\\)[ \t]*\\="
+ bound t))
+ (setq func (match-string 2)
+ func-point (goto-char (match-beginning 2))
+ pos func-point)
+ (if (re-search-backward
+ "->[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\=" bound t)
+ (setq arrow-start (match-beginning 0)
+ class (or (match-string 2) t)))
+ (throw
+ 'exit
+ (list
+ (idlwave-sintern-routine-or-method func class)
+ (idlwave-sintern-class class)
+ arrow-start func-point cnt)))
+ (goto-char pos))
+ (throw 'exit nil)))))))
(defun idlwave-what-procedure (&optional bound)
;; Find out if point is within the argument list of a procedure.
(let ((pos (point)) pro-point
pro class arrow-start string)
(save-excursion
- (idlwave-beginning-of-statement)
+ ;;(idlwave-beginning-of-statement)
+ (idlwave-start-of-substatement 'pre)
(setq string (buffer-substring (point) pos))
(if (string-match
"\\`[ \t]*\\([a-zA-Z][a-zA-Z0-9$_]*\\)[ \t]*\\(,\\|\\'\\)" string)
;; We cannot add something - offer a list.
(message "Making completion list...")
(let* ((list all-completions)
+ ;; "complete" means, this is already a valid completion
(complete (memq spart all-completions))
(completion-highlight-first-word-only t) ; XEmacs
(completion-fixup-function ; Emacs
(interactive)
;; Call `idlwave-routines' to make sure the class list will be available
(idlwave-routines)
- ;; Now do the completion
- (idlwave-complete-in-buffer 'class 'class idlwave-class-alist nil
- "Select a class" "class"))
-
+ ;; Check for the special case of completing empty string after pro/function
+ (if (let ((case-fold-search t))
+ (save-excursion
+ (and
+ (re-search-backward "\\<\\(pro\\|function\\)[ \t]+\\="
+ (- (point) 15) t)
+ (goto-char (point-min))
+ (re-search-forward
+ "^[ \t]*\\(pro\\|function\\)[ \t]+\\([a-zA-Z0-9_]+::\\)" nil t))))
+ ;; Yank the full class specification
+ (insert (match-string 2))
+ ;; Do the completion
+ (idlwave-complete-in-buffer 'class 'class (idlwave-class-alist) nil
+ "Select a class" "class")))
(defun idlwave-attach-classes (list is-kwd show-classes)
- ;; attach the proper class list to a LIST of completion items.
+ ;; Attach the proper class list to a LIST of completion items.
;; IS-KWD, when non-nil, shows its keywords - otherwise its methods
;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
(catch 'exit
- (if (or (null show-classes) ; don't wnat to see classes
- (null class-selector) ; not a method call
- (stringp class-selector)) ; the class is already known
+ (if (or (null show-classes) ; don't want to see classes
+ (null class-selector) ; not a method call
+ (and (stringp class-selector) ; the class is already known
+ (not super-classes))) ; no possibilities for inheritance
;; In these cases, we do not have to do anything
(throw 'exit list))
- ;; The property and dots stuff currently only make sense with XEmacs
- ;; because Emacs drops text properties when filling the *Completions*
- ;; buffer.
- (let* ((do-prop (and (featurep 'xemacs) (>= show-classes 0)))
+ (let* ((do-prop (and (>= show-classes 0)
+ (>= emacs-major-version 21)))
(do-buf (not (= show-classes 0)))
- (do-dots (featurep 'xemacs))
+ ; (do-dots (featurep 'xemacs))
+ (do-dots t)
+ (inherit (if super-classes
+ (cons class-selector super-classes)))
(max (abs show-classes))
(lmax (if do-dots (apply 'max (mapcar 'length list))))
classes nclasses class-info space)
(idlwave-all-method-keyword-classes
method-selector x type-selector)
(idlwave-all-method-classes x type-selector)))
+ (if inherit
+ (setq classes
+ (delq nil
+ (mapcar (lambda (x) (if (memq x inherit) x nil))
+ classes))))
(setq nclasses (length classes))
;; Make the separator between item and class-info
(if do-dots
;;----------------------------------------------------------------------
;;----------------------------------------------------------------------
+(defvar idlwave-completion-setup-hook nil)
+
(defun idlwave-scroll-completions (&optional message)
"Scroll the completion window on this frame."
(let ((cwin (get-buffer-window "*Completions*" 'visible))
(setq idlwave-before-completion-wconf (current-window-configuration)))
(if (featurep 'xemacs)
- (idlwave-display-completion-list-xemacs list)
+ (idlwave-display-completion-list-xemacs
+ list)
(idlwave-display-completion-list-emacs list))
;; Store a special value in `this-command'. When `idlwave-complete'
(consp (car list)))
(idlwave-completion-fontify-classes))
+ ;; Run the hook
+ (run-hooks 'idlwave-completion-setup-hook)
+
;; Display the message
(message (or message "Making completion list...done")))
"Call FUNCTION as a completion chooser and pass ARGS to it."
(let ((completion-ignore-case t)) ; install correct value
(apply function args))
+ (if (and (eq major-mode 'idlwave-shell-mode)
+ (boundp 'font-lock-mode)
+ (not font-lock-mode))
+ ;; Remove the fontification of the word before point
+ (let ((beg (save-excursion
+ (skip-chars-backward "a-zA-Z0-9_")
+ (point))))
+ (remove-text-properties beg (point) '(face nil))))
(eval idlwave-complete-after-success-form-force))
(defun idlwave-restore-wconf-after-completion ()
(and (local-variable-p var (current-buffer))
(symbol-value var))))
-;; In XEmacs, we can use :activate-callback directly
+;; In XEmacs, we can use :activate-callback directly to advice the
+;; choose functions. We use the private keymap only for the online
+;; help feature.
-(defun idlwave-display-completion-list-xemacs (list)
+(defvar idlwave-completion-map nil
+ "Keymap for completion-list-mode with idlwave-complete.")
+
+(defun idlwave-display-completion-list-xemacs (list &rest cl-args)
(with-output-to-temp-buffer "*Completions*"
- (display-completion-list list :activate-callback
- 'idlwave-default-choose-completion)))
+ (apply 'display-completion-list list
+ ':activate-callback 'idlwave-default-choose-completion
+ cl-args))
+ (save-excursion
+ (set-buffer "*Completions*")
+ (use-local-map
+ (or idlwave-completion-map
+ (setq idlwave-completion-map
+ (idlwave-make-modified-completion-map-xemacs
+ (current-local-map)))))))
(defun idlwave-default-choose-completion (&rest args)
"Execute `default-choose-completion' and then restore the win-conf."
(apply 'idlwave-choose 'default-choose-completion args))
-;; In Emacs we have to replace the keymap in the *Completions* buffer
-;; in order to install our wrappers.
+(defun idlwave-make-modified-completion-map-xemacs (old-map)
+ "Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
+ (let ((new-map (copy-keymap old-map)))
+ (define-key new-map [button3up] 'idlwave-mouse-completion-help)
+ (define-key new-map [button3] (lambda ()
+ (interactive)
+ (setq this-command last-command)))
+ new-map))
-(defvar idlwave-completion-map nil
- "Keymap for completion-list-mode with idlwave-complete.")
+;; In Emacs we also to replace choose keybindings in the completion
+;; map in order to install our wrappers.
(defun idlwave-display-completion-list-emacs (list)
"Display completion list and install the choose wrappers."
(use-local-map
(or idlwave-completion-map
(setq idlwave-completion-map
- (idlwave-make-modified-completion-map (current-local-map)))))))
-
-(defun idlwave-make-modified-completion-map (old-map)
+ (idlwave-make-modified-completion-map-emacs
+ (current-local-map)))))))
+
+(defun idlwave-make-modified-completion-map-emacs (old-map)
"Replace `choose-completion' and `mouse-choose-completion' in OLD-MAP."
(let ((new-map (copy-keymap old-map)))
(substitute-key-definition
'choose-completion 'idlwave-choose-completion new-map)
(substitute-key-definition
'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
+ (define-key new-map [mouse-3] 'idlwave-mouse-completion-help)
new-map))
(defun idlwave-choose-completion (&rest args)
;;----------------------------------------------------------------------
;;----------------------------------------------------------------------
+;;; ------------------------------------------------------------------------
+;;; Sturucture parsing code, and code to manage class info
+
+;;
+;; - Go again over the documentation how to write a completion
+;; plugin. It is in self.el, but currently still very bad.
+;; This could be in a separate file in the distribution, or
+;; in an appendix for the manual.
+
+(defun idlwave-struct-tags ()
+ "Return a list of all tags in the structure defined at point.
+Point is expected just before the opening `{' of the struct definition."
+ (save-excursion
+ (let* ((borders (idlwave-struct-borders))
+ (beg (car borders))
+ (end (cdr borders))
+ tags)
+ (goto-char beg)
+ (while (re-search-forward "[{,][ \t]*\\(\\$.*\n[ \t]*\\)?\\([a-zA-Z][a-zA-Z0-9_]*\\)[ \t]*:" end t)
+ ;; Check if we are still on the top level of the structure.
+ (if (and (condition-case nil (progn (up-list -1) t) (error nil))
+ (= (point) beg))
+ (push (match-string 2) tags))
+ (goto-char (match-end 0)))
+ (nreverse tags))))
+
+(defun idlwave-struct-inherits ()
+ "Return a list of all `inherits' names in the struct at point.
+Point is expected just before the opening `{' of the struct definition."
+ (save-excursion
+ (let* ((borders (idlwave-struct-borders))
+ (beg (car borders))
+ (end (cdr borders))
+ (case-fold-search t)
+ names)
+ (goto-char beg)
+ (while (re-search-forward "[{,][ \t]*\\(\\$.*\n[ \t]*\\)?inherits[ \t]*\\(\\$.*\n[ \t]*\\)?\\([a-zA-Z][a-zA-Z0-9_]*\\)" end t)
+ ;; Check if we are still on the top level of the structure.
+ (if (and (condition-case nil (progn (up-list -1) t) (error nil))
+ (= (point) beg))
+ (push (match-string 3) names))
+ (goto-char (match-end 0)))
+ (nreverse names))))
+
+
+(defun idlwave-struct-borders ()
+ "Return the borders of the {...} after point as a cons cell."
+ (let (beg)
+ (save-excursion
+ (skip-chars-forward "^{")
+ (setq beg (point))
+ (condition-case nil (forward-list 1)
+ (error (goto-char beg)))
+ (cons beg (point)))))
+
+(defun idlwave-find-structure-definition (&optional var name bound)
+ "Search forward for a structure definition.
+If VAR is non-nil, search for a structure assigned to variable VAR.
+If NAME is non-nil, search for a named structure NAME.
+If BOUND is an integer, limit the search.
+If BOUND is the symbol `all', we search first back and then forward
+through the entire file."
+ (let* ((ws "[ \t]*\\(\\$.*\n[ \t]*\\)?")
+ (case-fold-search t)
+ (lim (if (integerp bound) bound nil))
+ (re (concat
+ (if var
+ (concat "\\<" (regexp-quote (downcase var)) "\\>" ws)
+ "\\(\\)")
+ "=" ws "\\({\\)"
+ (if name (concat ws "\\<" (downcase name) "[^a-zA-Z0-9_$]") ""))))
+ (if (or (and (eq bound 'all)
+ (re-search-backward re nil t))
+ (re-search-forward re lim t))
+ (goto-char (match-beginning 3)))))
+
+(defvar idlwave-class-info nil)
+(defvar idlwave-system-class-info nil)
+(add-hook 'idlwave-update-rinfo-hook
+ (lambda () (setq idlwave-class-info nil)))
+(add-hook 'idlwave-after-load-rinfo-hook
+ (lambda () (setq idlwave-class-info nil)))
+
+(defun idlwave-class-info (class)
+ (let (list entry)
+ (unless idlwave-class-info
+ ;; Info is nil, put in the system stuff.
+ (setq idlwave-class-info idlwave-system-class-info)
+ (setq list idlwave-class-info)
+ (while (setq entry (pop list))
+ (idlwave-sintern-class-info entry)))
+ (setq class (idlwave-sintern-class class))
+ (setq entry (assq class idlwave-class-info))
+ (unless entry
+ (setq entry (idlwave-find-class-info class))
+ (when entry
+ ;; Sintern and cache the info
+ (idlwave-sintern-class-info entry)
+ (push entry idlwave-class-info)))
+ entry))
+
+(defun idlwave-sintern-class-info (entry)
+ "Sintern the class names in a class-info entry."
+ (let ((taglist (assq 'tags entry))
+ (inherits (assq 'inherits entry)))
+ (setcar entry (idlwave-sintern-class (car entry) 'set))
+ (if inherits
+ (setcdr inherits (mapcar (lambda (x) (idlwave-sintern-class x 'set))
+ (cdr inherits))))))
+
+(defun idlwave-find-class-info (class)
+ "Find the __define procedure for a class structure and return info entry."
+ (let* ((pro (concat (downcase class) "__define"))
+ (class (idlwave-sintern-class class))
+ (idlwave-auto-routine-info-updates nil)
+ (file (cdr (nth 3 (idlwave-rinfo-assoc pro 'pro nil
+ (idlwave-routines)))))
+ buf)
+ (if (or (not file)
+ (not (file-regular-p
+ (setq file (idlwave-expand-lib-file-name file)))))
+ nil ; Cannot get info
+ (save-excursion
+ (if (setq buf (idlwave-get-buffer-visiting file))
+ (set-buffer buf)
+ (set-buffer (get-buffer-create " *IDLWAVE-tmp*"))
+ (erase-buffer)
+ (unless (eq major-mode 'idlwave-mode)
+ (idlwave-mode))
+ (insert-file-contents file))
+ (save-excursion
+ (goto-char 1)
+ (setq case-fold-search t)
+ (when (and (re-search-forward
+ (concat "^[ \t]*pro[ \t]+" pro "\\>") nil t)
+ ;; FIXME: should we limit to end of pro here?
+ (idlwave-find-structure-definition nil class))
+ (list class
+ (cons 'tags (idlwave-struct-tags))
+ (cons 'inherits (idlwave-struct-inherits)))))))))
+
+(defun idlwave-class-tags (class)
+ "Return the native tags in CLASS."
+ (cdr (assq 'tags (idlwave-class-info class))))
+(defun idlwave-class-inherits (class)
+ "Return the direct superclasses of CLASS."
+ (cdr (assq 'inherits (idlwave-class-info class))))
+
+(defun idlwave-all-class-tags (class)
+ "Return a list of native and inherited tags in CLASS."
+ (apply 'append (mapcar 'idlwave-class-tags
+ (cons class (idlwave-all-class-inherits class)))))
+
+(defun idlwave-all-class-inherits (class)
+ "Return a list of all superclasses of CLASS (recursively expanded).
+The list is cashed in `idlwave-class-info' for faster access."
+ (cond
+ ((not idlwave-support-inheritance) nil)
+ ((eq class nil) nil)
+ ((eq class t) nil)
+ (t
+ (let ((info (idlwave-class-info class))
+ entry)
+ (if (setq entry (assq 'all-inherits info))
+ (cdr entry)
+ (let ((inherits (idlwave-class-inherits class))
+ rtn all-inherits cl)
+ (while inherits
+ (setq cl (pop inherits)
+ rtn (cons cl rtn)
+ inherits (append inherits (idlwave-class-inherits cl))))
+ (setq all-inherits (nreverse rtn))
+ (nconc info (list (cons 'all-inherits all-inherits)))
+ all-inherits))))))
+
+
+;;==========================================================================
+;;
+;; Completing class structure tags. This is a completion plugin.
+;; The necessary taglist is constructed dynamically
+
+(defvar idlwave-current-tags-class nil)
+(defvar idlwave-current-class-tags nil)
+(defvar idlwave-current-native-class-tags nil)
+(defvar idlwave-sint-classtags nil)
+(idlwave-new-sintern-type 'classtag)
+(add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
+(add-hook 'idlwave-update-rinfo-hook 'idlwave-classtag-reset)
+
+(defun idlwave-complete-class-structure-tag ()
+ "Complete a structure tag on a `self' argument in an object method."
+ (interactive)
+ (let ((pos (point))
+ (case-fold-search t))
+ (if (save-excursion
+ ;; Check if the context is right
+ (skip-chars-backward "[a-zA-Z0-9._$]")
+ (and (< (point) (- pos 4))
+ (looking-at "self\\.")))
+ (let* ((class (nth 2 (idlwave-current-routine))))
+ ;; Check if we are in a class routine
+ (unless class
+ (error "Not in a method procedure or function"))
+ ;; Check if we need to update the "current" class
+ (if (not (equal class idlwave-current-tags-class))
+ (idlwave-prepare-class-tag-completion class))
+ (setq idlwave-completion-help-info nil)
+ (let ((idlwave-cpl-bold idlwave-current-native-class-tags))
+ (idlwave-complete-in-buffer
+ 'classtag 'classtag
+ idlwave-current-class-tags nil
+ (format "Select a tag of class %s" class)
+ "class tag"))
+ t) ; return t to skip other completions
+ nil)))
+
+(defun idlwave-classtag-reset ()
+ (setq idlwave-current-tags-class nil))
+
+(defun idlwave-prepare-class-tag-completion (class)
+ "Find and parse the necessary class definitions for class structure tags."
+ (setq idlwave-sint-classtags nil)
+ (setq idlwave-current-tags-class class)
+ (setq idlwave-current-class-tags
+ (mapcar (lambda (x)
+ (list (idlwave-sintern-classtag x 'set)))
+ (idlwave-all-class-tags class)))
+ (setq idlwave-current-native-class-tags
+ (mapcar 'downcase (idlwave-class-tags class))))
+
+;===========================================================================
+;;
+;; Completing system variables and their structure fields
+;; This is also a plugin. It is a bit bigger since we support loading
+;; current system variables from the shell and highlighting in the
+;; completions buffer.
+
+(defvar idlwave-sint-sysvars nil)
+(defvar idlwave-sint-sysvartags nil)
+(idlwave-new-sintern-type 'sysvar)
+(idlwave-new-sintern-type 'sysvartag)
+(add-to-list 'idlwave-complete-special 'idlwave-complete-sysvar-or-tag)
+(add-hook 'idlwave-update-rinfo-hook 'idlwave-sysvars-reset)
+(add-hook 'idlwave-after-load-rinfo-hook 'idlwave-remember-builtin-sysvars)
+(add-hook 'idlwave-after-load-rinfo-hook 'idlwave-sintern-sysvar-alist)
+
+(defvar idlwave-system-variables-alist nil
+ "Alist of system variables and the associated structure tags.
+Gets set in `idlw-rinfo.el'.")
+(defvar idlwave-builtin-system-variables nil)
+
+(defun idlwave-complete-sysvar-or-tag ()
+ "Complete a system variable."
+ (interactive)
+ (let ((pos (point))
+ (case-fold-search t))
+ (cond ((save-excursion
+ ;; Check if the context is right for system variable
+ (skip-chars-backward "[a-zA-Z0-9_$]")
+ (equal (char-before) ?!))
+ (setq idlwave-completion-help-info '(idlwave-complete-sysvar-help))
+ (idlwave-complete-in-buffer 'sysvar 'sysvar
+ idlwave-system-variables-alist nil
+ "Select a system variable"
+ "system variable")
+ t) ; return t to skip other completions
+ ((save-excursion
+ ;; Check if the context is right for sysvar tag
+ (skip-chars-backward "[a-zA-Z0-9_$.]")
+ (and (equal (char-before) ?!)
+ (looking-at "\\([a-zA-Z][a-zA-Z0-9_$]*\\)\\.")
+ (<= (match-end 0) pos)))
+ ;; Complete a system variable tag
+ (let* ((var (idlwave-sintern-sysvar (match-string 1)))
+ (entry (assq var idlwave-system-variables-alist))
+ (tags (cdr entry)))
+ (or entry (error "!%s is not know to be a system variable" var))
+ (or tags (error "System variable !%s is not a structure" var))
+ (setq idlwave-completion-help-info
+ (list 'idlwave-complete-sysvar-help var))
+ (idlwave-complete-in-buffer 'sysvartag 'sysvartag
+ tags nil
+ "Select a system variable tag"
+ "system variable tag")
+ t)) ; return t to skip other completions
+ (t nil))))
+
+(defvar name)
+(defvar kwd)
+(defun idlwave-complete-sysvar-help (mode word)
+ (cond
+ ((eq mode 'test)
+ (or (and (eq nil (nth 1 idlwave-completion-help-info))
+ (member (downcase word) idlwave-builtin-system-variables))
+ (and (stringp (nth 1 idlwave-completion-help-info))
+ (member (downcase (nth 1 idlwave-completion-help-info))
+ idlwave-builtin-system-variables))))
+ ((eq mode 'set)
+ (setq name "system variables"
+ kwd (concat "!"
+ (if (stringp (nth 1 idlwave-completion-help-info))
+ (nth 1 idlwave-completion-help-info)
+ word))))
+ (t (error "This should not happen"))))
+
+
+(defun idlwave-sysvars-reset ()
+ (if (and (fboundp 'idlwave-shell-is-running)
+ (idlwave-shell-is-running))
+ (idlwave-shell-send-command "idlwave_get_sysvars"
+ 'idlwave-process-sysvars 'hide)))
+
+(defun idlwave-process-sysvars ()
+ (idlwave-shell-filter-sysvars)
+ (setq idlwave-sint-sysvars nil
+ idlwave-sint-sysvartags nil)
+ (idlwave-sintern-sysvar-alist))
+
+(defun idlwave-remember-builtin-sysvars ()
+ (setq idlwave-builtin-system-variables
+ (mapcar 'downcase
+ (mapcar 'car idlwave-system-variables-alist))))
+
+(defun idlwave-sintern-sysvar-alist ()
+ (let ((list idlwave-system-variables-alist) entry)
+ (while (setq entry (pop list))
+ (setcar entry (idlwave-sintern-sysvar (car entry) 'set))
+ (setcdr entry (mapcar (lambda (x)
+ (list (idlwave-sintern-sysvartag (car x) 'set)))
+ (cdr entry))))))
+
+(defvar idlwave-shell-command-output)
+(defun idlwave-shell-filter-sysvars ()
+ "Get the system variables and structure tags."
+ (let ((text idlwave-shell-command-output)
+ (start 0)
+ (old idlwave-system-variables-alist)
+ var tags type name class)
+ (setq idlwave-system-variables-alist nil)
+ (while (string-match "^IDLWAVE-SYSVAR: !\\([a-zA-Z0-9_$]+\\)\\( \\(.*\\)\\)?"
+ text start)
+ (setq start (match-end 0)
+ var (match-string 1 text)
+ tags (if (match-end 3) (idlwave-split-string (match-string 3 text))))
+ (setq idlwave-system-variables-alist
+ (cons (cons var (mapcar 'list tags))
+ idlwave-system-variables-alist)))
+ ;; Keep the old value if query was not successful
+ (setq idlwave-system-variables-alist
+ (or idlwave-system-variables-alist old))))
+
(defun idlwave-completion-fontify-classes ()
"Goto the *Completions* buffer and fontify the class info."
(when (featurep 'font-lock)
(move-marker idlwave-completion-mark nil)
(setq idlwave-before-completion-wconf nil))
-(defun idlwave-routine-info-from-idlhelp (&optional arg)
- "Make IDLHELP display the online documentation about the routine at point.
-Sends the command `? MODULE' to the IDLWAVE-Shell. Shell must be running,
-it does not autostart for this task."
+(defun idlwave-mouse-context-help (ev &optional arg)
+ "Call `idlwave-context-help' on the clicked location."
+ (interactive "eP")
+ (mouse-set-point ev)
+ (idlwave-context-help arg))
+
+(defvar idlwave-last-context-help-pos nil)
+(defun idlwave-context-help (&optional arg)
+ "Display IDL Online Help on context.
+If point is on a keyword, help for that keyword will be shown.
+If point is on a routine name or in the argument list of a routine,
+help for that routine will be displayed.
+Works for system routines and keywords only."
(interactive "P")
- (idlwave-routine-info arg 'external))
+ (idlwave-require-online-help)
+ (idlwave-do-context-help arg))
+
+(defun idlwave-mouse-completion-help (ev)
+ "Display online help about the completion at point."
+ (interactive "eP")
+ (idlwave-require-online-help)
+ ;; Restore last-command for next command, to make scrolling of completions
+ ;; work.
+ (setq this-command last-command)
+ (idlwave-do-mouse-completion-help ev))
+
+
+(defvar idlwave-help-is-loaded nil
+ "Is online help avaiable?")
+;; The following variables will be defined by `idlw-help.el'.
+(defvar idlwave-help-frame-width nil)
+(defvar idlwave-help-file nil)
+(defvar idlwave-help-topics nil)
+
+(defun idlwave-help-directory ()
+ "Return the help directory, or nil if that is not known."
+ (or (and (stringp idlwave-help-directory)
+ (> (length idlwave-help-directory) 0)
+ idlwave-help-directory)
+ (getenv "IDLWAVE_HELP_DIRECTORY")))
+
+(defun idlwave-require-online-help ()
+ (if idlwave-help-is-loaded
+ t ;; everything is OK.
+ (let* ((dir (or (idlwave-help-directory)
+ (error "Online Help is not installed (idlwave-help-directory is unknown)")))
+ (lfile1 (expand-file-name "idlw-help.elc" dir))
+ (lfile2 (expand-file-name "idlw-help.el" dir))
+ (hfile (expand-file-name "idlw-help.txt" dir)))
+ (if (or (and (file-regular-p lfile1) (load-file lfile1))
+ (and (file-regular-p lfile2) (load-file lfile2)))
+ (progn
+ (if (and idlwave-help-frame-parameters
+ (not (assoc 'width idlwave-help-frame-parameters)))
+ (push (cons 'width idlwave-help-frame-width)
+ idlwave-help-frame-parameters))
+ (or idlwave-help-topics
+ (error "File `%s' in help dir `%s' does not define `idlwave-help-topics'"
+ "idlw-help.el" dir)))
+ (error "No such file `%s' in help dir `%s'" "idlw-help.el" dir))
+ (if (file-regular-p hfile)
+ (setq idlwave-help-is-loaded t
+ idlwave-help-file hfile)
+ (error "No such file `%s' in dir `%s'" "idlw-help.txt" dir)))))
(defun idlwave-routine-info (&optional arg external)
"Display a routines calling sequence and list of keywords.
(let* ((idlwave-query-class nil)
(idlwave-force-class-query (equal arg '(4)))
(module (idlwave-what-module)))
- (cond ((car module)
- (if external
- (apply 'idlwave-search-online-help module)
- (apply 'idlwave-display-calling-sequence module)))
- (t
- (error "Don't know which calling sequence to show."))))))
-
-(defun idlwave-search-online-help (name &optional type class olh)
- "Tell IDL to lookup CLASS::NAME with type TYPE in the online help.
-If TYPE and CLASS are both nil, just look up NAME in the default help file."
- ;; If only the IDLHELP application was better designed, so that
- ;; we could make it open the right thing right away. As things are,
- ;; we need to pipe the stuff through the help search engine, and we
- ;; cannot enter a space.
- (let* (extra book full string cmd)
-
- ;; Try to find a clue for the right help book
- (if (and type (not olh))
- (setq olh (or (nth 6 (idlwave-rinfo-assq
- name type class idlwave-builtin-routines))
- (nth 6 (idlwave-rinfo-assq
- name type class idlwave-routines)))))
-
- ;; Sometimes the book is given as a symbol - make it a string
- (if (and olh (symbolp olh)) (setq olh (symbol-name olh)))
- (setq book (or olh "idl")) ; We need a default
- ;; Add the FULL_PATH keyword if appropriate
- (if (and (file-name-absolute-p book)
- (file-exists-p book))
- (setq full ",/FULL_PATH")
- (setq full ""))
-
- ;; We would like to add "Method" or so, but stupid IDL online help
- ;; command treats a space as a separator and interprets the next thing as
- ;; the book name.
- ;; (setq extra (cond ((eq type 'kwd) " keyword")
- ;; (class " method")
- ;; ((eq type 'pro) " procedure")
- ;; ((eq type 'fun) " function")
- ;; (t "")))
- (setq extra "")
-
- ;; Methods are subitems of classes, the separator is a single `:'
- (if (and name class (not (eq type 'kwd)))
- (setq name (concat class ":" name)))
- ;; FIXME: We used to use book, but in idl5.3, all help is in idl.hlp
- (setq string (concat name extra)
- cmd (format "ONLINE_HELP,'%s',BOOK='%s'%s" string "idl" full))
-; cmd (format "ONLINE_HELP,'%s',BOOK='%s'%s" string book full))
- (message "Sending to IDL: %s" cmd) (sit-for 2)
- (idlwave-shell-send-command cmd)))
+ (if (car module)
+ (apply 'idlwave-display-calling-sequence
+ (idlwave-fix-module-if-obj_new module))
+ (error "Don't know which calling sequence to show")))))
(defun idlwave-resolve (&optional arg)
"Call RESOLVE on the module name at point.
(interactive "P")
(let* ((idlwave-query-class nil)
(idlwave-force-class-query (equal arg '(4)))
- (module (idlwave-what-module))
+ (module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
(default (concat (idlwave-make-full-name (nth 2 module) (car module))
(if (eq (nth 1 module) 'pro) "<p>" "<f>")))
(list
(t t)))
(idlwave-do-find-module name type class)))
-(defun idlwave-do-find-module (name type class)
+(defun idlwave-do-find-module (name type class &optional force-source)
(let ((name1 (idlwave-make-full-name class name))
source buf1 entry
(buf (current-buffer))
- (pos (point)))
- (setq entry (idlwave-rinfo-assq name type class (idlwave-routines))
- source (nth 3 entry))
+ (pos (point))
+ name2)
+ (setq entry (idlwave-best-rinfo-assq name type class (idlwave-routines))
+ source (or force-source (nth 3 entry))
+ name2 (if (nth 2 entry)
+ (idlwave-make-full-name (nth 2 entry) name)
+ name1))
(cond
((or (null name) (equal name ""))
(error "Abort"))
((null entry)
- (error "Nothing known about a module %s" name1))
+ (error "Nothing known about a module %s" name2))
((eq (car source) 'system)
- (error "Source code for system routine %s is not available."
- name1))
+ (error "Source code for system routine %s is not available"
+ name2))
((equal (cdr source) "")
- (error "Source code for routine %s is not available."
- name1))
+ (error "Source code for routine %s is not available"
+ name2))
((memq (car source) '(buffer lib compiled))
(setq buf1
(if (eq (car source) 'lib)
- (idlwave-find-lib-file-noselet
- (or (cdr source)
- (format "%s.pro" (downcase name))))
- (idlwave-find-file-noselect (cdr source))))
- (pop-to-buffer buf1)
- (goto-char 1)
+ (idlwave-find-file-noselect
+ (idlwave-expand-lib-file-name
+ (or (cdr source)
+ (format "%s.pro" (downcase name)))) 'find)
+ (idlwave-find-file-noselect (cdr source) 'find)))
+ (pop-to-buffer buf1 t)
+ (goto-char (point-max))
(let ((case-fold-search t))
- (if (re-search-forward
+ (if (re-search-backward
(concat "^[ \t]*\\<"
(cond ((equal type "f") "function")
((equal type "p") "pro")
(t "\\(pro\\|function\\)"))
"\\>[ \t]+"
- (regexp-quote (downcase name1))
+ (regexp-quote (downcase name2))
"[^a-zA-Z0-9_$]")
nil t)
(goto-char (match-beginning 0))
(pop-to-buffer buf)
(goto-char pos)
- (error "Could not find routine %s" name1)))))))
+ (error "Could not find routine %s" name2)))))))
(defun idlwave-what-module ()
"Return a default module for stuff near point.
Used by `idlwave-routine-info' and `idlwave-find-module'."
(idlwave-routines)
- (let* ((where (idlwave-where))
- (cw (nth 2 where))
- (pro (car (nth 0 where)))
- (func (car (nth 1 where)))
- (this-word (idlwave-this-word "a-zA-Z0-9$_"))
- (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
- (following-char)))
- )
- (cond
- ((and (eq cw 'procedure)
- (not (equal this-word "")))
- (setq this-word (idlwave-sintern-routine-or-method
- this-word (nth 2 (nth 3 where))))
- (list this-word 'pro
- (idlwave-determine-class
- (cons this-word (cdr (nth 3 where)))
- 'pro)))
- ((and (eq cw 'function)
- (not (equal this-word ""))
- (eq next-char ?\()) ; exclude arrays, vars.
- (setq this-word (idlwave-sintern-routine-or-method
- this-word (nth 2 (nth 3 where))))
- (list this-word 'fun
- (idlwave-determine-class
- (cons this-word (cdr (nth 3 where)))
- 'fun)))
- (func
- (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
- (pro
- (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
- (t nil))))
+ (if (let ((case-fold-search t))
+ (save-excursion
+ (idlwave-beginning-of-statement)
+ (looking-at "[ \t]*\\(pro\\|function\\)[ \t]+\\(\\([a-zA-Z0-9_$]+\\)::\\)?\\([a-zA-Z0-9$_]+\\)\\([, \t\n]\\|$\\)")))
+ ;; This is a function or procedure definition statement
+ ;; We return the defined routine as module.
+ (list
+ (idlwave-sintern-routine-or-method (match-string 4)
+ (match-string 2))
+ (if (equal (downcase (match-string 1)) "pro") 'pro 'fun)
+ (idlwave-sintern-class (match-string 3)))
+
+ ;; Not a definition statement - analyze precise positon.
+ (let* ((where (idlwave-where))
+ (cw (nth 2 where))
+ (pro (car (nth 0 where)))
+ (func (car (nth 1 where)))
+ (this-word (idlwave-this-word "a-zA-Z0-9$_"))
+ (next-char (save-excursion (skip-chars-forward "a-zA-Z0-9$_")
+ (following-char)))
+ )
+ (cond
+ ((and (eq cw 'procedure)
+ (not (equal this-word "")))
+ (setq this-word (idlwave-sintern-routine-or-method
+ this-word (nth 2 (nth 3 where))))
+ (list this-word 'pro
+ (idlwave-determine-class
+ (cons this-word (cdr (nth 3 where)))
+ 'pro)))
+ ((and (eq cw 'function)
+ (not (equal this-word ""))
+ (or (eq next-char ?\() ; exclude arrays, vars.
+ (looking-at "[a-zA-Z0-9_]*[ \t]*(")))
+ (setq this-word (idlwave-sintern-routine-or-method
+ this-word (nth 2 (nth 3 where))))
+ (list this-word 'fun
+ (idlwave-determine-class
+ (cons this-word (cdr (nth 3 where)))
+ 'fun)))
+ ((and (memq cw '(function-keyword procedure-keyword))
+ (not (equal this-word ""))
+ (eq next-char ?\()) ; A function!
+ (setq this-word (idlwave-sintern-routine this-word))
+ (list this-word 'fun nil))
+ (func
+ (list func 'fun (idlwave-determine-class (nth 1 where) 'fun)))
+ (pro
+ (list pro 'pro (idlwave-determine-class (nth 0 where) 'pro)))
+ (t nil)))))
+
+(defun idlwave-what-module-find-class ()
+ "Call idlwave-what-module and find the inherited class if necessary."
+ (let* ((module (idlwave-what-module))
+ (class (nth 2 module))
+ classes)
+ (if (and (= (length module) 3)
+ (stringp class))
+ (list (car module)
+ (nth 1 module)
+ (apply 'idlwave-find-inherited-class module))
+ module)))
+
+(defun idlwave-find-inherited-class (name type class)
+ "Find the class which defines TYPE NAME and is CLASS or inherited by CLASS."
+ (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
+ (if entry
+ (nth 2 entry)
+ class)))
+
+(defun idlwave-fix-module-if-obj_new (module)
+ "Check if MODULE points to obj_new. If yes, and if the cursor is in the
+keyword region, change to the appropriate Init method."
+ (let* ((name (car module))
+ (pos (point))
+ (case-fold-search t)
+ string)
+ (if (and (stringp name)
+ (equal (downcase name) "obj_new")
+ (save-excursion
+ (idlwave-beginning-of-statement)
+ (setq string (buffer-substring (point) pos))
+ (string-match "obj_new([^'\"]*['\"]\\([a-zA-Z0-9_]+\\)"
+ string)))
+ (let ((name "Init")
+ (class (match-string 1 string)))
+ (setq module (list (idlwave-sintern-method "Init")
+ 'fun
+ (idlwave-sintern-class class)))))
+ module))
+
(defun idlwave-fix-keywords (name type class keywords)
;; This fixes the list of keywords.
;; If this is the OBJ_NEW function, try to figure out the class and use
;; the keywords from the corresponding INIT method.
(if (and (equal name "OBJ_NEW")
- (eq major-mode 'idlwave-mode))
+ (or (eq major-mode 'idlwave-mode)
+ (eq major-mode 'idlwave-shell-mode)))
(let* ((bos (save-excursion (idlwave-beginning-of-statement) (point)))
(string (buffer-substring bos (point)))
(case-fold-search t)
(and (string-match "obj_new([^'\"]*['\"]\\([a-zA-Z0-9_]+\\)"
string)
(setq class (idlwave-sintern-class (match-string 1 string)))
+ (setq idlwave-current-obj_new-class class)
(setq keywords
(append keywords
(nth 5 (idlwave-rinfo-assq
(mapcar (lambda (k) (add-to-list 'keywords k))
(nth 5 x))))
(setq keywords (idlwave-uniquify keywords)))
+
+ ;; If we have inheritance, add all keywords from superclasses
+ ;; :-( Taken out because JD says it does not work this way.
+; (when (and (stringp class)
+; (or (assq (idlwave-sintern-keyword "_extra") keywords)
+; (assq (idlwave-sintern-keyword "_ref_extra") keywords))
+; (boundp 'super-classes))
+; (loop for x in (idlwave-routines) do
+; (and (nth 2 x) ; non-nil class
+; (or (eq (nth 2 x) class) ; the right class
+; (memq (nth 2 x) super-classes)) ; an inherited class
+; (or (and (eq (nth 1 x) type) ; default type
+; (eq (car x) name)) ; default name
+; (and (eq (nth 1 x) type1) ; backup type
+; (eq (car x) name1))) ; backup name
+; (mapcar (lambda (k) (add-to-list 'keywords k))
+; (nth 5 x))))
+; (setq keywords (idlwave-uniquify keywords)))
+
;; Return the final list
keywords))
+(defun idlwave-expand-keyword (keyword module)
+ "Expand KEYWORD to one of the legal keyword parameters of MODULE.
+KEYWORD may be an exact match or an abbreviation of a keyword.
+If the match is exact, KEYWORD itself is returned, even if there may be other
+keywords of which KEYWORD is an abbreviation. This is necessary because some
+system routines have keywords which are prefixes of other keywords.
+If KEYWORD is an abbreviation of several keywords, a list of all possible
+completions is returned.
+If the abbreviation was unique, the correct keyword is returned.
+If it cannot be a keyword, the function return nil.
+If we do not know about MODULE, just return KEYWORD literally."
+ (let* ((name (car module))
+ (type (nth 1 module))
+ (class (nth 2 module))
+ (kwd (idlwave-sintern-keyword keyword))
+ (entry (idlwave-best-rinfo-assoc name type class (idlwave-routines)))
+ (kwd-alist (nth 5 entry))
+ (extra (or (assq (idlwave-sintern-keyword "_EXTRA") kwd-alist)
+ (assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
+ (completion-ignore-case t)
+ candidates)
+ (cond ((assq kwd kwd-alist)
+ kwd)
+ ((setq candidates (all-completions kwd kwd-alist))
+ (if (= (length candidates) 1)
+ (car candidates)
+ candidates))
+ ((and entry extra)
+ ;; Inheritance may cause this keyword to be correct
+ keyword)
+ (entry
+ ;; We do know the function, which does not have the keyword.
+ nil)
+ (t
+ ;; We do not know the function, so this just might be a correct
+ ;; keyword - return it as it is.
+ keyword))))
+
+(defvar idlwave-rinfo-mouse-map (make-sparse-keymap))
(defvar idlwave-rinfo-map (make-sparse-keymap))
-(define-key idlwave-rinfo-map
+(define-key idlwave-rinfo-mouse-map
(if (featurep 'xemacs) [button2] [mouse-2])
'idlwave-mouse-active-rinfo)
-(define-key idlwave-rinfo-map
+(define-key idlwave-rinfo-mouse-map
+ (if (featurep 'xemacs) [(shift button2)] [(shift mouse-2)])
+ 'idlwave-mouse-active-rinfo-shift)
+(define-key idlwave-rinfo-mouse-map
(if (featurep 'xemacs) [button3] [mouse-3])
'idlwave-mouse-active-rinfo-right)
-(defvar idlwave-popup-source)
+(define-key idlwave-rinfo-mouse-map " " 'idlwave-active-rinfo-space)
+(define-key idlwave-rinfo-map "q" 'idlwave-quit-help)
+(define-key idlwave-rinfo-mouse-map "q" 'idlwave-quit-help)
+(defvar idlwave-popup-source nil)
+(defvar idlwave-rinfo-marker (make-marker))
-(defun idlwave-display-calling-sequence (name type class)
+(defun idlwave-quit-help ()
+ (interactive)
+ (let ((ri-window (get-buffer-window "*Help*"))
+ (olh-window (get-buffer-window "*IDLWAVE Help*")))
+ (when (and olh-window
+ (fboundp 'idlwave-help-quit))
+ (select-window olh-window)
+ (idlwave-help-quit))
+ (when (window-live-p ri-window)
+ (delete-window ri-window))))
+
+(defun idlwave-display-calling-sequence (name type class
+ &optional initial-class)
;; Display the calling sequence of module NAME, type TYPE in class CLASS.
- (let* ((entry (idlwave-rinfo-assq
- name type class (idlwave-routines)))
+ (let* ((initial-class (or initial-class class))
+ (entry (or (idlwave-best-rinfo-assq name type class
+ (idlwave-routines))
+ (idlwave-rinfo-assq name type class
+ idlwave-unresolved-routines)))
(name (or (car entry) name))
(class (or (nth 2 entry) class))
- (source (nth 3 entry))
- ;;(system (eq (car source) 'system))
+ (superclasses (idlwave-all-class-inherits initial-class))
+ (twins (idlwave-routine-twins entry))
+ (dtwins (idlwave-study-twins twins))
+ (all dtwins)
+ (system (idlwave-rinfo-assq
+ name type class idlwave-system-routines))
+ (have-sysdoc (and system (idlwave-help-directory)))
+ ;; (source (nth 3 entry))
+ (have-olh (and (or system idlwave-extra-help-function)
+ (idlwave-help-directory)))
(calling-seq (nth 4 entry))
(keywords (nth 5 entry))
(olh (nth 6 entry))
- (help-echo3 " Button3: IDL Online Help")
- (help-echo23 "Button2: Pop to source and back. Button3: IDL Online Help")
+ (help-echo-kwd
+ (if have-olh
+ "Button2: Insert KEYWORD (SHIFT=`/KEYWORD') Button3: Online Help "
+ "Button2: Insert KEYWORD (SHIFT=`/KEYWORD')."))
+ (help-echo-use
+ (if have-olh
+ "Button2/3: Online Help"
+ nil))
+ (help-echo-src
+ (if (idlwave-help-directory)
+ "Button2: Pop to source and back. Button3: Source in Help window."
+ "Button2: Pop to source and back."))
+ (help-echo-class
+ "Button2: Display info about same method in superclass")
(col 0)
- (data (list name type class (current-buffer) olh))
+ (data (list name type class (current-buffer) olh initial-class))
(km-prop (if (featurep 'xemacs) 'keymap 'local-map))
- beg props win)
+ (face 'idlwave-help-link-face)
+ beg props win cnt total)
(setq keywords (idlwave-fix-keywords name type class keywords))
(cond
((null entry)
- (error "No %s %s known" type name))
+ (error "No %s %s known %s" type name
+ (if initial-class (concat "in class " initial-class) "")))
((or (null name) (equal name ""))
- (error "No function or procedure call at point."))
+ (error "No function or procedure call at point"))
((null calling-seq)
(error "Calling sequence of %s %s is not available" type name))
(t
(save-excursion
+ (move-marker idlwave-rinfo-marker (point))
(set-buffer (get-buffer-create "*Help*"))
+ (use-local-map idlwave-rinfo-map)
(setq buffer-read-only nil)
(erase-buffer)
(set (make-local-variable 'idlwave-popup-source) nil)
- (setq props (list 'mouse-face 'highlight
- km-prop idlwave-rinfo-map
- 'help-echo help-echo23
- 'data (cons 'usage data)))
+ (set (make-local-variable 'idlwave-current-obj_new-class)
+ idlwave-current-obj_new-class)
+ (when superclasses
+ (setq props (list 'mouse-face 'highlight
+ km-prop idlwave-rinfo-mouse-map
+ 'help-echo help-echo-class
+ 'data (cons 'class data)))
+ (let ((classes (cons initial-class superclasses)) c)
+ (insert "Classes: ")
+ (while (setq c (pop classes))
+ (insert " ")
+ (setq beg (point))
+ (insert c)
+ (if (equal (downcase c) (downcase class))
+ (add-text-properties beg (point) (list 'face 'bold))
+ (if (idlwave-rinfo-assq name type c (idlwave-routines))
+ (add-text-properties beg (point) props))))
+ (insert "\n")))
+ (setq props (if have-olh
+ (list 'mouse-face 'highlight
+ km-prop idlwave-rinfo-mouse-map
+ 'help-echo help-echo-use
+ 'data (cons 'usage data))))
+ (if have-sysdoc (setq props (append (list 'face face) props)))
(insert "Usage: ")
(setq beg (point))
(insert (if class
(format calling-seq name))
"\n")
(add-text-properties beg (point) props)
-
+
(insert "Keywords:")
(if (null keywords)
(insert " No keywords accepted.")
(insert " ")
(setq beg (point)
props (list 'mouse-face 'highlight
- km-prop idlwave-rinfo-map
+ km-prop idlwave-rinfo-mouse-map
'data (cons 'keyword data)
- 'help-echo help-echo3
+ 'help-echo help-echo-kwd
'keyword (car x)))
+ (if have-sysdoc (setq props (append (list 'face face) props)))
(insert (car x))
(add-text-properties beg (point) props)
(setq col (+ col 1 (length (car x)))))
keywords))
- (insert "\n")
-
- (insert "Origin: ")
- (setq beg (point)
- props (list 'mouse-face 'highlight
- km-prop idlwave-rinfo-map
- 'help-echo help-echo23
- 'data (cons 'origin data)))
- (cond
- ((eq (car source) 'system)
- (insert "system routine"))
- ((equal source '(lib))
- (insert (format "library file %s.pro" (downcase name))))
- ((eq (car source) 'lib)
- (insert "library file ")
- (insert (cdr source)))
- ((eq (car source) 'buffer)
- (insert "buffer visiting ")
- (insert (abbreviate-file-name (cdr source))))
- ((eq (car source) 'compiled)
- (insert "compiled from ")
- (insert (cdr source))))
- (add-text-properties beg (point) props)
+
+ (setq cnt 1 total (length all))
+ (while (setq entry (pop all))
+ (setq props (list 'mouse-face 'highlight
+ km-prop idlwave-rinfo-mouse-map
+ 'help-echo help-echo-src
+ 'source (cons (car (nth 2 entry)) (nth 1 entry))
+ 'data (cons 'source data)))
+ (idlwave-insert-source-location
+ (format "\n%-8s %s"
+ (if (equal cnt 1)
+ (if (> total 1) "Sources:" "Source:")
+ "")
+ (if (> total 1) "- " ""))
+ entry props)
+ (incf cnt)
+ (when (and all (> cnt idlwave-rinfo-max-source-lines))
+ ;; No more source lines, please
+ (insert (format
+ "\n Source information truncated to %d entries."
+ idlwave-rinfo-max-source-lines))
+ (setq all nil)))
+
(setq buffer-read-only t))
(display-buffer "*Help*")
(if (and (setq win (get-buffer-window "*Help*"))
(shrink-window-if-larger-than-buffer))
(select-window ww)))))))))
+(defun idlwave-insert-source-location (prefix entry &optional file-props)
+ "Insert a source location into the routine info buffer.
+Start line with PREFIX.
+If a file name is inserted, add FILE-PROPS to it."
+
+ (let* ((key (car entry))
+ (file (nth 1 entry))
+ (types (nth 2 entry))
+ (shell-flag (member 'compiled types))
+ (buffer-flag (member 'buffer types))
+ (lib-flag (member 'lib types))
+ (ndupl (or (and buffer-flag (idlwave-count-eq 'buffer types))
+ (and lib-flag (idlwave-count-eq 'lib types))
+ 1))
+ (doflags t)
+ beg special)
+
+ (insert prefix)
+
+ (cond
+ ((eq key 'system)
+ (setq doflags nil)
+ (insert "System "))
+ ((eq key 'builtin)
+ (setq doflags nil)
+ (insert "Builtin "))
+ ((and (not file) shell-flag)
+ (insert "Unresolved"))
+ ((null file) (insert "ERROR"))
+ ((setq special (idlwave-special-lib-test file))
+ (insert (format "%-10s" special)))
+ ((idlwave-syslib-p file)
+ (if (string-match "obsolete" (file-name-directory file))
+ (insert "Obsolete ")
+ (insert "SystemLib ")))
+ ((idlwave-lib-p file) (insert "Library "))
+ (t (insert "Other ")))
+
+ (when doflags
+ (insert (concat
+ " ["
+ (if lib-flag "C" "-")
+ (if shell-flag "S" "-")
+ (if buffer-flag "B" "-")
+ "] ")))
+ (when (> ndupl 1)
+ (setq beg (point))
+ (insert (format "(%dx) " ndupl))
+ (add-text-properties beg (point) (list 'face 'bold)))
+ (when (and file (not (equal file "")))
+ (setq beg (point))
+ (insert (apply 'abbreviate-file-name
+ (if (featurep 'xemacs) (list file t) (list file))))
+ (if file-props
+ (add-text-properties beg (point) file-props)))))
+
+(defun idlwave-special-lib-test (file)
+ "Check the path of FILE against the regexps which define special libs.
+Return the name of the special lib if there is a match."
+ (let ((alist idlwave-special-lib-alist)
+ entry rtn)
+ (cond
+ ((stringp file)
+ (while (setq entry (pop alist))
+ (if (string-match (car entry) file)
+ (setq rtn (cdr entry)
+ alist nil)))
+ rtn)
+ (t nil))))
+
(defun idlwave-mouse-active-rinfo-right (ev)
(interactive "e")
(idlwave-mouse-active-rinfo ev 'right))
-(defun idlwave-mouse-active-rinfo (ev &optional right)
+(defun idlwave-mouse-active-rinfo-shift (ev)
(interactive "e")
- (mouse-set-point ev)
- (let (data id name type class buf keyword olh bufwin)
+ (idlwave-mouse-active-rinfo ev nil 'shift))
+
+(defun idlwave-active-rinfo-space ()
+ (interactive)
+ (idlwave-mouse-active-rinfo nil 'right))
+
+(defun idlwave-mouse-active-rinfo (ev &optional right shift)
+ "Does the mouse actions in the routine info buffer.
+Optional args RIGHT and SHIFT indicate, if mouse-3 was used, and if SHIFT
+was pressed."
+ (interactive "e")
+ (if ev (mouse-set-point ev))
+ (let (data id name type class buf keyword bufwin source word initial-class)
(setq data (get-text-property (point) 'data)
+ source (get-text-property (point) 'source)
keyword (get-text-property (point) 'keyword)
id (car data)
- name (nth 1 data)
- type (nth 2 data)
- class (nth 3 data)
+ name (nth 1 data) type (nth 2 data) class (nth 3 data)
buf (nth 4 data)
- olh (nth 5 data)
+ initial-class (nth 6 data)
+ word (idlwave-this-word)
bufwin (get-buffer-window buf t))
- (cond ((or (eq id 'usage) (eq id 'origin))
- (if right
- (idlwave-search-online-help name type class)
+ (cond ((eq id 'class)
+ (if (window-live-p bufwin) (select-window bufwin))
+ (idlwave-display-calling-sequence
+ (idlwave-sintern-method name)
+ type (idlwave-sintern-class word)
+ initial-class))
+ ((eq id 'usage)
+ (idlwave-require-online-help)
+ (idlwave-online-help nil name type class))
+ ((eq id 'source)
+ (if (and right (idlwave-help-directory))
+ (let ((idlwave-extra-help-function 'idlwave-help-with-source)
+ (idlwave-help-source-try-header nil)
+ ;; Fake idlwave-routines, to make help find the right entry
+ (idlwave-routines
+ (list (list (nth 1 data) (nth 2 data) (nth 3 data) source ""))))
+ (idlwave-require-online-help)
+ (idlwave-help-get-special-help name type class nil))
(setq idlwave-popup-source (not idlwave-popup-source))
(if idlwave-popup-source
(condition-case err
- (idlwave-do-find-module name type class)
+ (idlwave-do-find-module name type class source)
(error
(setq idlwave-popup-source nil)
(if (window-live-p bufwin) (select-window bufwin))
(error (nth 1 err))))
(if bufwin
(select-window bufwin)
- (pop-to-buffer buf)))))
+ (pop-to-buffer buf))
+ (goto-char (marker-position idlwave-rinfo-marker)))))
((eq id 'keyword)
(if right
- (idlwave-search-online-help keyword 'kwd class olh)
- (error "Button2 not active for keywords"))))))
+ (progn
+ (idlwave-require-online-help)
+ (idlwave-online-help nil name type class keyword))
+ (idlwave-rinfo-insert-keyword keyword buf shift))))))
+
+(defun idlwave-rinfo-insert-keyword (keyword buffer &optional shift)
+ "Insert KEYWORD in BUFFER. Make sure buffer is displayed in a window."
+ (let ((bwin (get-buffer-window buffer)))
+ (if idlwave-complete-empty-string-as-lower-case
+ (setq keyword (downcase keyword)))
+ (if bwin
+ (select-window bwin)
+ (pop-to-buffer buffer)
+ (setq bwin (get-buffer-window buffer)))
+ (if (eq (preceding-char) ?/)
+ (insert keyword)
+ (unless (save-excursion
+ (re-search-backward
+ "[(,][ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\)?[ \t]*\\="
+ (min (- (point) 100) (point-min)) t))
+ (insert ", "))
+ (if shift (insert "/"))
+ (insert keyword)
+ (if (and (not shift)
+ idlwave-keyword-completion-adds-equal)
+ (insert "=")))))
+
+(defun idlwave-list-buffer-load-path-shadows (&optional arg)
+ "List the load path shadows of all routines defined in current buffer."
+ (interactive "P")
+ (idlwave-routines)
+ (if (eq major-mode 'idlwave-mode)
+ (idlwave-list-load-path-shadows
+ nil (idlwave-update-current-buffer-info 'save-buffer)
+ "in current buffer")
+ (error "Current buffer is not in idlwave-mode")))
+
+(defun idlwave-list-shell-load-path-shadows (&optional arg)
+ "List the load path shadows of all routines compiled under the shell.
+This is very useful for checking an IDL application. Just compile the
+application, do RESOLVE_ALL, and `C-c C-i' to compile all referenced
+routines and update IDLWAVE internal info. Then check for shadowing
+with this command."
+ (interactive "P")
+ (cond
+ ((or (not (fboundp 'idlwave-shell-is-running))
+ (not (idlwave-shell-is-running)))
+ (error "Shell is not running"))
+ ((null idlwave-compiled-routines)
+ (error "No compiled routines. Maybe you need to update with `C-c C-i'"))
+ (t
+ (idlwave-list-load-path-shadows nil idlwave-compiled-routines
+ "in the shell"))))
+
+(defun idlwave-list-all-load-path-shadows (&optional arg)
+ "List the load path shadows of all routines known to IDLWAVE."
+ (interactive "P")
+ (idlwave-list-load-path-shadows nil nil "globally"))
+
+(defun idlwave-list-load-path-shadows (arg &optional special-routines loc)
+ "List the routines which are defined multiple times.
+Search the information IDLWAVE has about IDL routines for multiple
+definitions.
+When SPECIAL-ROUTINES in non-nil, only look for shadows of these routines.
+
+When IDL hits a routine call which is not defined, it will search on
+the load path in order to find a definition. The output of this
+command can be used to detect possible name clashes during this process."
+ (idlwave-routines) ; Make sure everything is loaded.
+ (unless idlwave-library-routines
+ (or (y-or-n-p
+ "You don't have a library catalog. Continue anyway? ")
+ (error "Abort")))
+ (let* ((routines (append idlwave-system-routines
+ idlwave-compiled-routines
+ idlwave-library-routines
+ idlwave-buffer-routines
+ nil))
+ (km-prop (if (featurep 'xemacs) 'keymap 'local-map))
+ (keymap (make-sparse-keymap))
+ (props (list 'mouse-face 'highlight
+ km-prop keymap
+ 'help-echo "Mouse2: Find source"))
+ (nroutines (length (or special-routines routines)))
+ (step (/ nroutines 99))
+ (n 0)
+ (next-perc 1)
+ (cnt 0)
+ (idlwave-sort-prefer-buffer-info nil)
+ routine twins dtwins twin done props1 lroutines)
+
+ (if special-routines
+ ;; Just looking for shadows of a few special routines
+ (setq lroutines routines
+ routines special-routines))
+
+ (message "Sorting routines...")
+ (setq routines (sort routines
+ (lambda (a b)
+ (string< (downcase (idlwave-make-full-name
+ (nth 2 a) (car a)))
+ (downcase (idlwave-make-full-name
+ (nth 2 b) (car b)))))))
+ (message "Sorting routines...done")
+
+ (define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
+ (lambda (ev)
+ (interactive "e")
+ (mouse-set-point ev)
+ (apply 'idlwave-do-find-module
+ (get-text-property (point) 'find-args))))
+ (define-key keymap [(return)]
+ (lambda ()
+ (interactive)
+ (apply 'idlwave-do-find-module
+ (get-text-property (point) 'find-args))))
+ (message "Compiling list...( 0%%)")
+ (save-excursion
+ (set-buffer (get-buffer-create "*Shadows*"))
+ (setq buffer-read-only nil)
+ (erase-buffer)
+ (while (setq routine (pop routines))
+ (setq n (1+ n))
+ (if (= (* next-perc step) n)
+ (progn
+ (message "Compiling list...(%2d%%)" next-perc)
+ (setq next-perc (1+ next-perc))))
+ ;; Get a list of all twins
+ (setq twins (idlwave-routine-twins routine (or lroutines routines)))
+ (if (memq routine done)
+ (setq dtwins nil)
+ (setq dtwins (idlwave-study-twins twins)))
+ ;; Mark all twins as delt with
+ (setq done (append twins done))
+ (when (or (> (length dtwins) 1)
+ (> (idlwave-count-eq 'lib (nth 2 (car dtwins))) 1)
+ (> (idlwave-count-eq 'buffer (nth 2 (car dtwins))) 1))
+ (incf cnt)
+ (insert (format "\n%s%s"
+ (idlwave-make-full-name (nth 2 routine) (car routine))
+ (if (eq (nth 1 routine) 'fun) "()" "")))
+ (while (setq twin (pop dtwins))
+ (setq props1 (append (list 'find-args
+ (list (nth 0 routine)
+ (nth 1 routine)
+ (nth 2 routine)
+ (cons 'lib (nth 1 twin))))
+ props))
+ (idlwave-insert-source-location "\n - " twin props1))))
+ (goto-char (point-min))
+ (setq buffer-read-only t))
+ (setq loc (or loc ""))
+ (if (> cnt 0)
+ (progn
+ (display-buffer (get-buffer "*Shadows*"))
+ (message "%d case%s of shadowing found %s"
+ cnt (if (= cnt 1) "" "s") loc))
+ (message "No shadowing conflicts found %s" loc))))
+
+(defun idlwave-print-source (routine)
+ (let* ((source (nth 3 routine))
+ (stype (car source))
+ (sfile (cdr source)))
+ (if (and (eq stype 'lib) sfile)
+ (progn
+ (setq sfile (idlwave-expand-lib-file-name sfile))
+ (if (idlwave-syslib-p sfile) (setq stype 'syslib))))
+ (if (and (eq stype 'compiled)
+ (or (not (stringp sfile))
+ (not (string-match "\\S-" sfile))))
+ (setq stype 'unresolved))
+ (princ (format " %-10s %s\n"
+ stype
+ (if sfile sfile "No source code available")))))
+
+(defun idlwave-routine-twins (entry &optional list)
+ "Return all twin entries of ENTRY in LIST.
+LIST defaults to `idlwave-routines'.
+Twin entries are those which have the same name, type, and class.
+ENTRY will also be returned, as the first item of this list."
+ (let* ((name (car entry))
+ (type (nth 1 entry))
+ (class (nth 2 entry))
+ (candidates (idlwave-all-assq name (or list (idlwave-routines))))
+ twins candidate)
+ (while (setq candidate (pop candidates))
+ (if (and (not (eq candidate entry))
+ (eq type (nth 1 candidate))
+ (eq class (nth 2 candidate)))
+ (push candidate twins)))
+ (if (setq candidate (idlwave-rinfo-assq name type class
+ idlwave-unresolved-routines))
+ (push candidate twins))
+ (cons entry (nreverse twins))))
+
+(defun idlwave-study-twins (entries)
+ "Return dangerous twins of first entry in TWINS.
+Dangerous twins are routines with same name, but in different files
+on the load path.
+If a file is in the system library and has an entry in the
+`idlwave-system-routines' list, we omit the latter because many IDL
+routines are implemented as library routines."
+ (let* ((entry (car entries))
+ (name (car entry)) ;
+ (type (nth 1 entry)) ; Must be bound for
+ (class (nth 2 entry)) ; idlwave-routine-twin-compare
+ (cnt 0)
+ source type file thefile alist syslibp key)
+ (while (setq entry (pop entries))
+ (incf cnt)
+ (setq source (nth 3 entry)
+ type (car source)
+ file (cdr source))
+ (if (eq type 'lib)
+ (setq file (idlwave-expand-lib-file-name file)))
+ ;; Make KEY to index entry properly
+ (setq key (cond ((eq type 'system) type)
+ (file (file-truename file))
+ (t 'unresolved)))
+ (if (and file
+ (not syslibp)
+ (idlwave-syslib-p file))
+ ;; We do have an entry in the system library
+ (setq syslibp t))
+
+ (setq thefile (or thefile file))
+ (if (setq entry (assoc key alist))
+ (push type (nth 2 entry))
+ (push (list key file (list type)) alist)))
+
+ (setq alist (nreverse alist))
+
+ (when syslibp
+ ;; File is system *library* - remove any system entry
+ (setq alist (delq (assoc 'system alist) alist)))
+
+ (when (and (idlwave-syslib-scanned-p)
+ (setq entry (assoc 'system alist)))
+ (setcar entry 'builtin))
+ (sort alist 'idlwave-routine-twin-compare)))
+
+(defvar name)
+(defvar type)
+(defvar class)
+(defvar idlwave-sort-prefer-buffer-info t
+ "Internal variable used to influence `idlwave-routine-twin-compare'.")
+
+(defmacro idlwave-xor (a b)
+ `(and (or ,a ,b)
+ (not (and ,a ,b))))
+
+(defun idlwave-routine-entry-compare (a b)
+ "Compare two routine info entries for sortiung. This is the general case.
+It first compates class, names, and type. If it turns out that A and B
+are twins (same name, class, and type), calls another routine which
+compares twins on the basis of their file names and path locations."
+ (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)))
+ (cond
+ ((not (equal (idlwave-downcase-safe class)
+ (idlwave-downcase-safe (nth 2 b))))
+ ;; Class decides
+ (cond ((null (nth 2 b)) nil)
+ ((null class) t)
+ (t (string< (downcase class) (downcase (nth 2 b))))))
+ ((not (equal (downcase name) (downcase (car b))))
+ ;; Name decides
+ (string< (downcase name) (downcase (car b))))
+ ((not (eq type (nth 1 b)))
+ ;; Type decides
+ (< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
+ (t
+ ;; A and B are twins - so the decision is more complicated.
+ ;; Call twin-compare with the proper arguments.
+ (idlwave-routine-entry-compare-twins a b)))))
+
+(defun idlwave-routine-entry-compare-twins (a b)
+ "Compare two routine entries, under the assumption that they are twins.
+This basically calles `idlwave-routine-twin-compare' with the correct args."
+ (let ((name (car a)) (type (nth 1 a)) (class (nth 2 a)) ; needed outside
+ (atype (car (nth 3 a)))
+ (btype (car (nth 3 b)))
+ (afile (cdr (nth 3 a)))
+ (bfile (cdr (nth 3 b))))
+ (if (eq atype 'lib)
+ (setq afile (idlwave-expand-lib-file-name afile)))
+ (if (eq btype 'lib)
+ (setq bfile (idlwave-expand-lib-file-name bfile)))
+ (idlwave-routine-twin-compare
+ (if (stringp afile)
+ (list (file-truename afile) afile (list atype))
+ (list atype afile (list atype)))
+ (if (stringp bfile)
+ (list (file-truename bfile) bfile (list btype))
+ (list btype bfile (list btype))))
+ ))
+
+(defun idlwave-routine-twin-compare (a b)
+ "Compare two routine twin entries for sorting.
+In here, A and B are not normal routine info entries, but special
+lists (KEY FILENAME (TYPES...)).
+This expects NAME TYPE CLASS to be bound to the right values."
+ (let* (;; Dis-assemble entries
+ (akey (car a)) (bkey (car b))
+ (afile (nth 1 a)) (bfile (nth 1 b))
+ (atypes (nth 2 a)) (btypes (nth 2 b))
+ ;; System routines?
+ (asysp (memq akey '(builtin system)))
+ (bsysp (memq bkey '(builtin system)))
+ ;; Compiled routines?
+ (acompp (memq 'compiled atypes))
+ (bcompp (memq 'compiled btypes))
+ ;; Unresolved?
+ (aunresp (or (eq akey 'unresolved)
+ (and acompp (not afile))))
+ (bunresp (or (eq bkey 'unresolved)
+ (and bcompp (not bfile))))
+ ;; Buffer info available?
+ (abufp (memq 'buffer atypes))
+ (bbufp (memq 'buffer btypes))
+ ;; On search path?
+ (tpath-alist (idlwave-true-path-alist))
+ (apathp (assoc akey tpath-alist))
+ (bpathp (assoc bkey tpath-alist))
+ ;; How early on search path? High number means early since we
+ ;; measure the tail of the path list
+ (anpath (length (memq apathp tpath-alist)))
+ (bnpath (length (memq bpathp tpath-alist)))
+ ;; Look at file names
+ (aname (if (stringp afile) (downcase (file-name-nondirectory afile)) ""))
+ (bname (if (stringp bfile) (downcase (file-name-nondirectory bfile)) ""))
+ (fname-re (if class (format "\\`%s__\\(%s\\|define\\)\\.pro\\'"
+ (regexp-quote (downcase class))
+ (regexp-quote (downcase name)))
+ (format "\\`%s\\.pro" (regexp-quote (downcase name)))))
+ ;; Is file name derived from the routine name?
+ ;; Method file or class definition file?
+ (anamep (string-match fname-re aname))
+ (adefp (and class anamep (string= "define" (match-string 1 aname))))
+ (bnamep (string-match fname-re bname))
+ (bdefp (and class bnamep (string= "define" (match-string 1 bname)))))
+
+ ;; Now: follow JD's ideas about sorting. Looks really simple now,
+ ;; doesn't it? The difficult stuff is hidden above...
+ (cond
+ ((idlwave-xor asysp bsysp) asysp) ; System entries first
+ ((idlwave-xor aunresp bunresp) bunresp) ; Unresolved last
+ ((and idlwave-sort-prefer-buffer-info
+ (idlwave-xor abufp bbufp)) abufp) ; Buffers before non-buffers
+ ((idlwave-xor acompp bcompp) acompp) ; Compiled entries
+ ((idlwave-xor apathp bpathp) apathp) ; Library before non-library
+ ((idlwave-xor anamep bnamep) anamep) ; Correct file names first
+ ((and class anamep bnamep ; both file names match ->
+ (idlwave-xor adefp bdefp)) bdefp) ; __define after __method
+ ((> anpath bnpath) t) ; Who is first on path?
+ (t nil)))) ; Default
+
+(defun idlwave-downcase-safe (string)
+ "Donwcase if string, else return unchanged."
+ (if (stringp string)
+ (downcase string)
+ string))
+
+(defun idlwave-count-eq (elt list)
+ "How often is ELT in LIST?"
+ (length (delq nil (mapcar (lambda (x) (eq x elt)) list))))
+
+(defun idlwave-syslib-p (file)
+ "Non-nil of FILE is in the system library."
+ (let* ((true-syslib (file-name-as-directory
+ (file-truename
+ (expand-file-name "lib" (idlwave-sys-dir)))))
+ (true-file (file-truename file)))
+ (string-match (concat "^" (regexp-quote true-syslib)) true-file)))
+
+(defun idlwave-lib-p (file)
+ "Non-nil if file is in the library"
+ (let ((true-dir (file-name-directory (file-truename file))))
+ (assoc true-dir (idlwave-true-path-alist))))
+
+(defun idlwave-true-path-alist ()
+ "Return `idlwave-path-alist' alist with true-names.
+Info is cached, but relies on the functons setting `idlwave-path-alist'
+to reset the variable `idlwave-true-path-alist' to nil."
+ (or idlwave-true-path-alist
+ (setq idlwave-true-path-alist
+ (mapcar (lambda(x) (cons
+ (file-name-as-directory
+ (file-truename
+ (directory-file-name
+ (car x))))
+ (cdr x)))
+ idlwave-path-alist))))
+
+(defun idlwave-syslib-scanned-p ()
+ "Non-nil if the system lib file !DIR/lib has been scanned."
+ (let* ((true-syslib (file-name-as-directory
+ (file-truename
+ (expand-file-name "lib" (idlwave-sys-dir))))))
+ (cdr (assoc true-syslib (idlwave-true-path-alist)))))
+
+;; ----------------------------------------------------------------------------
+;;
+;; Online Help display
+
;; ----------------------------------------------------------------------------
;;
["While" idlwave-while t]
"--"
["Close Block" idlwave-close-block t])
- ("Completion / RInfo"
+ ("Completion"
["Complete" idlwave-complete t]
("Complete Special"
["1 Procedure Name" (idlwave-complete 'procedure) t]
["7 Function Method Name" (idlwave-complete 'function-method) t]
["8 Function Method Keyword" (idlwave-complete 'function-method-keyword) t]
"--"
- ["9 Class Name" idlwave-complete-class t])
- "--"
+ ["9 Class Name" idlwave-complete-class t]))
+ ("Routine Info"
["Show Routine Info" idlwave-routine-info t]
- ["Show Routine Doc with IDLHELP" idlwave-routine-info-from-idlhelp t]
+ ["Online Context Help" idlwave-context-help (idlwave-help-directory)]
"--"
["Find Routine Source" idlwave-find-module t]
+ ["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
"--"
["Update Routine Info" idlwave-update-routine-info t]
"--"
- "IDL Library Routine Info"
- ["Select Library Directories" idlwave-create-libinfo-file t]
- ["Scan Directories" (idlwave-update-routine-info '(16)) idlwave-scanned-lib-directories])
+ "IDL Library Catalog"
+ ["Select Catalog Directories" idlwave-create-libinfo-file t]
+ ["Scan Directories" (idlwave-update-routine-info '(16))
+ idlwave-path-alist]
+ "--"
+ "Routine Shadows"
+ ["Check Current Buffer" idlwave-list-buffer-load-path-shadows t]
+ ["Check Compiled Routines" idlwave-list-shell-load-path-shadows t]
+ ["Check Everything" idlwave-list-all-load-path-shadows t])
+ ("Misc"
+ ["Kill auto-created buffers" idlwave-kill-autoloaded-buffers t]
+ "--"
+ ["Insert TAB character" idlwave-hard-tab t])
"--"
("External"
["Generate IDL tags" idlwave-make-tags t]
["Abbreviation List" idlwave-list-abbrevs t]
"--"
["Commentary in idlwave.el" idlwave-show-commentary t]
- ["Commentary in idlwave-shell.el" idlwave-shell-show-commentary t]
+ ["Commentary in idlw-shell.el" idlwave-shell-show-commentary t]
"--"
["Info" idlwave-info t]
"--"
(interactive)
;; Try to load the code for the shell, so that we can customize it
;; as well.
- (or (featurep 'idlwave-shell)
- (load "idlwave-shell" t))
+ (or (featurep 'idlw-shell)
+ (load "idlw-shell" t))
(customize-browse 'idlwave))
(defun idlwave-create-customize-menu ()
(progn
;; Try to load the code for the shell, so that we can customize it
;; as well.
- (or (featurep 'idlwave-shell)
- (load "idlwave-shell" t))
+ (or (featurep 'idlw-shell)
+ (load "idlw-shell" t))
(easy-menu-change
'("IDLWAVE") "Customize"
`(["Browse IDLWAVE group" idlwave-customize t]
(finder-commentary "idlwave.el"))
(defun idlwave-shell-show-commentary ()
- "Use the finder to view the file documentation from `idlwave-shell.el'."
+ "Use the finder to view the file documentation from `idlw-shell.el'."
(interactive)
(require 'finder)
- (finder-commentary "idlwave-shell.el"))
+ (finder-commentary "idlw-shell.el"))
(defun idlwave-info ()
"Read documentation for IDLWAVE in the info system."
(set-buffer "*Help*")
(setq truncate-lines t)))
+;; Try to load online help, but catch any errors.
+(condition-case nil
+ (idlwave-require-online-help)
+ (error nil))
+
+;; Run the hook
(run-hooks 'idlwave-load-hook)
(provide 'idlwave)
;;; idlwave.el ends here
-