;; idlwave.el --- IDL editing mode for GNU Emacs
-;; Copyright (c) 1999, 2000, 2001, 2002, 2003, 2004 Free Software Foundation
+
+;; Copyright (C) 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
+;; Free Software Foundation, Inc.
;; Authors: J.D. Smith <jdsmith@as.arizona.edu>
-;; Carsten Dominik <dominik@astro.uva.nl>
+;; Carsten Dominik <dominik@science.uva.nl>
;; Chris Chase <chase@att.com>
;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
-;; Version: 5.5
+;; Version: 6.1_em22
;; Keywords: languages
;; 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
-;; the Free Software Foundation; either version 2, or (at your option)
+;; the Free Software Foundation; either version 3, or (at your option)
;; any later version.
;; GNU Emacs is distributed in the hope that it will be useful,
;; You should have received a copy of the GNU General Public License
;; along with GNU Emacs; see the file COPYING. If not, write to the
-;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
+;; Boston, MA 02110-1301, USA.
;;; Commentary:
+;; IDLWAVE enables feature-rich development and interaction with IDL,
+;; the Interactive Data Language. It provides a compelling,
+;; full-featured alternative to the IDLDE development environment
+;; bundled with IDL.
+
;; In the remotely distant past, based on pascal.el, though bears
;; little resemblance to it now.
;;
;; of the documentation is available from the maintainers webpage (see
;; SOURCE).
;;
-;;
+;;
;; ACKNOWLEDGMENTS
;; ===============
;;
;; IDLWAVE support for the IDL-derived PV-WAVE CL language of Visual
;; Numerics, Inc. is growing less and less complete as the two
;; languages grow increasingly apart. The mode probably shouldn't
-;; even have "WAVE" in it's title, but it's catchy, and was required
+;; even have "WAVE" in its title, but it's catchy, and was required
;; to avoid conflict with the CORBA idl.el mode. Caveat WAVEor.
;;
;; Moving the point backwards in conjunction with abbrev expansion
;; up inserting the character that expanded the abbrev after moving
;; 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,
+;; using a temporary function in `post-command-hook' - not pretty,
;; but it works.
;;
;; Tabs and spaces are treated equally as whitespace when filling a
(defalias 'line-end-position 'point-at-eol))
(unless (fboundp 'char-valid-p)
(defalias 'char-valid-p 'characterp))
+(unless (fboundp 'match-string-no-properties)
+ (defalias 'match-string-no-properties 'match-string))
+
+(if (not (fboundp 'cancel-timer))
+ (condition-case nil
+ (require 'timer)
+ (error nil)))
(eval-and-compile
;; Kludge to allow `defcustom' for Emacs 19.
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)
+ (defmacro defcustom (var value doc &rest args)
`(defvar ,var ,value ,doc))))
+(declare-function idlwave-shell-get-path-info "idlw-shell")
+(declare-function idlwave-shell-temp-file "idlw-shell")
+(declare-function idlwave-shell-is-running "idlw-shell")
+(declare-function widget-value "wid-edit" (widget))
+(declare-function comint-dynamic-complete-filename "comint" ())
+(declare-function Info-goto-node "info" (nodename &optional fork))
+
(defgroup idlwave nil
- "Major mode for editing IDL .pro files"
+ "Major mode for editing IDL .pro files."
:tag "IDLWAVE"
- :link '(url-link :tag "Home Page"
+ :link '(url-link :tag "Home Page"
"http://idlwave.org")
:link '(emacs-commentary-link :tag "Commentary in idlw-shell.el"
"idlw-shell.el")
"Indentation and formatting options for IDLWAVE mode."
:group 'idlwave)
-(defcustom idlwave-main-block-indent 0
+(defcustom idlwave-main-block-indent 2
"*Extra indentation for the main block of code.
That is the block between the FUNCTION/PRO statement and the END
statement for that program unit."
:group 'idlwave-code-formatting
:type 'integer)
-(defcustom idlwave-block-indent 4
+(defcustom idlwave-block-indent 3
"*Extra indentation applied to block lines.
If you change this, you probably also want to change `idlwave-end-offset'."
:group 'idlwave-code-formatting
:type 'integer)
-(defcustom idlwave-end-offset -4
+(defcustom idlwave-end-offset -3
"*Extra indentation applied to block END lines.
A value equal to negative `idlwave-block-indent' will make END lines
line up with the block BEGIN lines."
:group 'idlwave-code-formatting
:type 'integer)
-(defcustom idlwave-continuation-indent 2
+(defcustom idlwave-continuation-indent 3
"*Extra indentation applied to continuation lines.
This extra offset applies to the first of a set of continuation lines.
The following lines receive the same indentation as the first."
:group 'idlwave-code-formatting
:type 'integer)
-(defcustom idlwave-max-extra-continuation-indent 20
+(defcustom idlwave-max-extra-continuation-indent 40
"*Maximum additional indentation for special continuation indent.
Several special indentations are tried to help line up continuation
lines in routine calls or definitions, other statements with
(defcustom idlwave-auto-fill-split-string t
"*If non-nil then auto fill will split strings with the IDL `+' operator.
-When the line end falls within a string, string concatenation with the
-'+' operator will be used to distribute a long string over lines.
+When the line end falls within a string, string concatenation with the
+'+' operator will be used to distribute a long string over lines.
If nil and a string is split then a terminal beep and warning are issued.
This variable is ignored when `idlwave-fill-comment-line-only' is
:type 'boolean)
(defcustom idlwave-init-rinfo-when-idle-after 10
- "*Seconds of idle time before routine info is automatically initialized.
-Initializing the routine info can take long, in particular if a large
-library catalog is involved. When Emacs is idle for more than the number
-of seconds specified by this variable, it starts the initialization.
-The process is split into five steps, in order to keep possible work
-interruption as short as possible. If one of the steps finishes, and no
-user input has arrived in the mean time, initialization proceeds immediately
-to the next step.
-A good value for this variable is about 1/3 of the time initialization
-take in you setup. So if you have a fast machine and no problems with a slow network connection, don't hesitate to set this to 2 seconds.
-A Value of 0 means, don't initialize automatically."
+ "*Seconds of idle time before routine info is automatically
+initialized. Initializing the routine info can take a long time, in
+particular if a large number of library catalogs are involved. When
+Emacs is idle for more than the number of seconds specified by this
+variable, it starts the initialization. The process is split into
+five steps, in order to keep work interruption as short as possible.
+If one of the steps finishes, and no user input has arrived in the
+mean time, initialization proceeds immediately to the next step. A
+good value for this variable is about 1/3 of the time initialization
+take in your setup. So if you have a fast machine and no problems
+with a slow network connection, don't hesitate to set this to 2
+seconds. A Value of 0 means, don't initialize automatically, but
+instead wait until routine information is needed, and initialize
+then."
:group 'idlwave-routine-info
:type 'number)
(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.
: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 user catalog routine info,
-IDLWAVE can, under UNIX, query the shell for the exact search path
-\(the value of !PATH). However, under Windows and MacOS (pre-OSX),
-the IDLWAVE shell does not work. In this case, this variable can be
-set to specify the paths where IDLWAVE can find PRO files. The shell
-will only be asked for a list of paths when this variable is nil. The
-value is a list of directories. A directory preceeded by a `+' will
-be searched recursively. If you set this variable on a UNIX system,
-the shell will not be queried. See also `idlwave-system-directory'."
+ "Library path for Windows and MacOS (OS9). Not needed under UNIX.
+When selecting the directories to scan for IDL user catalog routine
+info, IDLWAVE can, under UNIX, query the shell for the exact search
+path \(the value of !PATH). However, under Windows and MacOS
+\(pre-OSX), the IDLWAVE shell does not work. In this case, this
+variable can be set to specify the paths where IDLWAVE can find PRO
+files. The shell will only be asked for a list of paths when this
+variable is nil. The value is a list of directories. A directory
+preceeded by a `+' will be searched recursively. If you set this
+variable on a UNIX system, the shell will not be queried. See also
+`idlwave-system-directory'."
:group 'idlwave-routine-info
:type '(repeat (directory)))
:group 'idlwave-routine-info
:type 'directory)
-(defcustom idlwave-config-directory
+;; Configuration files
+(defcustom idlwave-config-directory
(convert-standard-filename "~/.idlwave")
"*Directory for configuration files and user-library catalog."
:group 'idlwave-routine-info
:type 'file)
(defvar idlwave-user-catalog-file "idlusercat.el")
+(defvar idlwave-xml-system-rinfo-converted-file "idl_xml_rinfo.el")
(defvar idlwave-path-file "idlpath.el")
(defvar idlwave-libinfo-file nil
(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'
+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
(cons regexp string)))
(defcustom idlwave-auto-write-paths t
- "Write out path (!PATH) and system directory (!DIR) info automatically.
+ "Write out path (!PATH) and system directory (!DIR) info automatically.
Path info is needed to locate library catalog files. If non-nil,
whenever the path-list changes as a result of shell-query, etc., it is
written to file. Otherwise, the menu option \"Write Paths\" can be
This variable determines the case (UPPER/lower/Capitalized...) of
words inserted into the buffer by completion. The preferred case can
be specified separately for routine names, keywords, classes and
-methods.
+methods.
This alist should therefore have entries for `routine' (normal
functions and procedures, i.e. non-methods), `keyword', `class', and
`method'. Plausible values are
for which to assume this can be set here."
:group 'idlwave-routine-info
:type '(repeat (regexp :tag "Match method:")))
-
+
(defcustom idlwave-completion-show-classes 1
"*Number of classes to show when completing object methods and keywords.
When completing methods or keywords for an object with unknown class,
-the *Completions* buffer will show the legal classes for each completion
+the *Completions* buffer will show the valid classes for each completion
like this:
MyMethod <Class1,Class2,Class3>
specify if the class should be found during method and keyword
completion, respectively.
-The alist may have additional entries specifying exceptions from the
+The alist may have additional entries specifying exceptions from the
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."
(cons (string :tag "MODULE" :value "")
(boolean :tag "Determine class for this method")))))
-(defcustom idlwave-store-inquired-class nil
+(defcustom idlwave-store-inquired-class t
"*Non-nil means, store class of a method call as text property on `->'.
IDLWAVE sometimes has to ask the user for the class associated with a
particular object method call. This happens during the commands
value of the variable `idlwave-query-class'.
When you specify a class, this information can be stored as a text
-property on the `->' arrow in the source code, so that during the same
+property on the `->' arrow in the source code, so that during the same
editing session, IDLWAVE will not have to ask again. When this
variable is non-nil, IDLWAVE will store and reuse the class information.
The class stored can be checked and removed with `\\[idlwave-routine-info]'
For example you might set PATHNAME to the path for the
lib_template.pro file included in the IDL distribution.")
-(defcustom idlwave-header-to-beginning-of-file nil
+(defcustom idlwave-header-to-beginning-of-file t
"*Non-nil means, the documentation header will always be at start of file.
When nil, the header is positioned between the PRO/FUNCTION line of
the current routine and the code, allowing several routine headers in
"Path locations of external commands used by IDLWAVE."
:group 'idlwave)
-;; WARNING: The following variable has recently been moved from
-;; idlw-shell.el to this file. I hope this does not break
-;; anything.
-
(defcustom idlwave-shell-explicit-file-name "idl"
"*If non-nil, this is the command to run IDL.
Should be an absolute file path or path relative to the current environment
:group 'idlwave-external-programs)
(defcustom idlwave-help-application "idlhelp"
- "*The external application providing reference help for programming."
+ "*The external application providing reference help for programming.
+Obsolete, if the IDL Assistant is being used for help."
:group 'idlwave-external-programs
:type 'string)
(defgroup idlwave-misc nil
"Miscellaneous options for IDLWAVE mode."
+ :link '(custom-group-link :tag "Font Lock Faces group" font-lock-faces)
:group 'idlwave)
(defcustom idlwave-startup-message t
:group 'idlwave-misc
:type 'boolean)
-(defcustom idlwave-default-font-lock-items
+(defcustom idlwave-default-font-lock-items
'(pros-and-functions batch-files idlwave-idl-keywords label goto
common-blocks class-arrows)
"Items which should be fontified on the default fontification level 2.
;;; and Carsten Dominik...
;; The following are the reserved words in IDL. Maybe we should
-;; highlight some more stuff as well?
+;; highlight some more stuff as well?
;; Procedure declarations. Fontify keyword plus procedure name.
(defvar idlwave-idl-keywords
- ;; To update this regexp, update the list of keywords and
+ ;; To update this regexp, update the list of keywords and
;; evaluate the form.
- ;; (insert
+ ;; (insert
;; (prin1-to-string
- ;; (concat
+ ;; (concat
;; "\\<\\("
- ;; (regexp-opt
+ ;; (regexp-opt
;; '("||" "&&" "and" "or" "xor" "not"
- ;; "eq" "ge" "gt" "le" "lt" "ne"
+ ;; "eq" "ge" "gt" "le" "lt" "ne"
;; "for" "do" "endfor"
- ;; "if" "then" "endif" "else" "endelse"
+ ;; "if" "then" "endif" "else" "endelse"
;; "case" "of" "endcase"
;; "switch" "break" "continue" "endswitch"
;; "begin" "end"
;; "repeat" "until" "endrep"
- ;; "while" "endwhile"
+ ;; "while" "endwhile"
;; "goto" "return"
;; "inherits" "mod"
;; "compile_opt" "forward_function"
'("\\<\\(common\\)\\>[ \t]*\\(\\sw+\\)?[ \t]*,?"
(1 font-lock-keyword-face) ; "common"
(2 font-lock-reference-face nil t) ; block name
- (font-lock-match-c++-style-declaration-item-and-skip-to-next
+ ("[ \t]*\\(\\sw+\\)[ ,]*"
;; Start with point after block name and comma
- (goto-char (match-end 0)) ; needed for XEmacs, could be nil
+ (goto-char (match-end 0)) ; needed for XEmacs, could be nil
nil
(1 font-lock-variable-name-face) ; variable names
)))
;; Treats continuation lines, works only during whole buffer
;; fontification. Slow, use it only in fancy fontification.
(keyword-parameters
- '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\\(\n[ \t]*;.*\\)*\n[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
- (5 font-lock-reference-face)))
+ '("\\(,\\|[a-zA-Z0-9_](\\)[ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\([ \t]*\\(;.*\\)?\n\\)*[ \t]*\\)?\\(/[a-zA-Z_]\\sw*\\|[a-zA-Z_]\\sw*[ \t]*=\\)"
+ (6 font-lock-reference-face)))
;; System variables start with a bang.
(system-variables
;; All operators (not used because too noisy)
(all-operators
'("[-*^#+<>/]" (0 font-lock-keyword-face)))
-
+
;; Arrows with text property `idlwave-class'
(class-arrows
'(idlwave-match-class-arrows (0 idlwave-class-arrow-face))))
(defvar idlwave-font-lock-defaults
'((idlwave-font-lock-keywords
- idlwave-font-lock-keywords-1
+ idlwave-font-lock-keywords-1
idlwave-font-lock-keywords-2
idlwave-font-lock-keywords-3)
- nil t
- ((?$ . "w") (?_ . "w") (?. . "w") (?| . "w") (?& . "w"))
+ nil t
+ ((?$ . "w") (?_ . "w") (?. . "w") (?| . "w") (?& . "w"))
beginning-of-line))
-(put 'idlwave-mode 'font-lock-defaults
+(put 'idlwave-mode 'font-lock-defaults
idlwave-font-lock-defaults) ; XEmacs
(defconst idlwave-comment-line-start-skip "^[ \t]*;"
That is the _beginning_ of a line containing a comment delimiter `;' preceded
only by whitespace.")
-(defconst idlwave-begin-block-reg
+(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.")
'(goto . ("goto\\>" nil))
'(case . ("case\\>" nil))
'(switch . ("switch\\>" nil))
- (cons 'call (list (concat "\\(" idlwave-variable "\\) *= *"
+ (cons 'call (list (concat "\\(" idlwave-variable "\\) *= *"
"\\(" idlwave-method-call "\\s *\\)?"
idlwave-identifier
"\\s *(") nil))
- (cons 'call (list (concat
+ (cons 'call (list (concat
"\\(" idlwave-method-call "\\s *\\)?"
- idlwave-identifier
+ idlwave-identifier
"\\( *\\($\\|\\$\\)\\|\\s *,\\)") nil))
- (cons 'assign (list (concat
+ (cons 'assign (list (concat
"\\(" idlwave-variable "\\) *=") nil)))
-
+
"Associated list of statement matching regular expressions.
Each regular expression matches the start of an IDL statement. The
first element of each association is a symbol giving the statement
;; Note that this is documented in the v18 manuals as being a string
;; of length one rather than a single character.
;; The code in this file accepts either format for compatibility.
-(defvar idlwave-comment-indent-char ?\
+(defvar idlwave-comment-indent-char ?\
"Character to be inserted for IDL comment indentation.
Normally a space.")
"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 "5.5")
+(defconst idlwave-mode-version "6.1_em22")
(defmacro idlwave-keyword-abbrev (&rest args)
"Creates a function for abbrev hooks to call `idlwave-check-abbrev' with args."
;; Add action
(let* ((table (if select 'idlwave-indent-action-table
'idlwave-indent-expand-table))
- (cell (assoc key (eval table))))
+ (table-key (regexp-quote key))
+ (cell (assoc table-key (eval table))))
(if cell
;; Replace action command
(setcdr cell cmd)
;; New action
- (set table (append (eval table) (list (cons key cmd)))))))
+ (set table (append (eval table) (list (cons table-key cmd)))))))
;; Make key binding for action
(if (or (and (null select) (= (length key) 1))
(equal select 'noaction)
(define-key idlwave-mode-map "\C-c{" 'idlwave-beginning-of-block)
(define-key idlwave-mode-map "\C-c}" 'idlwave-end-of-block)
(define-key idlwave-mode-map "\C-c]" 'idlwave-close-block)
-(define-key idlwave-mode-map "\M-\C-h" 'idlwave-mark-subprogram)
+(define-key idlwave-mode-map [(meta control h)] 'idlwave-mark-subprogram)
(define-key idlwave-mode-map "\M-\C-n" 'idlwave-forward-block)
(define-key idlwave-mode-map "\M-\C-p" 'idlwave-backward-block)
(define-key idlwave-mode-map "\M-\C-d" 'idlwave-down-block)
(define-key idlwave-mode-map "\C-c\C-n" 'idlwave-next-statement)
;; (define-key idlwave-mode-map "\r" 'idlwave-newline)
;; (define-key idlwave-mode-map "\t" 'idlwave-indent-line)
-(define-key idlwave-mode-map [(shift tab)] 'idlwave-indent-statement)
+(define-key idlwave-mode-map [(shift iso-lefttab)] 'idlwave-indent-statement)
(define-key idlwave-mode-map "\C-c\C-a" 'idlwave-auto-fill-mode)
(define-key idlwave-mode-map "\M-q" 'idlwave-fill-paragraph)
(define-key idlwave-mode-map "\M-s" 'idlwave-edit-in-idlde)
(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
+ (mods-noshift (delq 'shift
(copy-sequence idlwave-shell-debug-modifiers))))
- (define-key idlwave-mode-map
+ (define-key idlwave-mode-map
(vector (append mods-noshift (list (if shift ?C ?c))))
'idlwave-shell-save-and-run)
- (define-key idlwave-mode-map
+ (define-key idlwave-mode-map
(vector (append mods-noshift (list (if shift ?B ?b))))
'idlwave-shell-break-here)
- (define-key idlwave-mode-map
+ (define-key idlwave-mode-map
(vector (append mods-noshift (list (if shift ?E ?e))))
'idlwave-shell-run-region)))
(define-key idlwave-mode-map "\C-c\C-d\C-c" 'idlwave-shell-save-and-run)
(autoload 'idlwave-shell-run-region "idlw-shell"
"Compile and run the region." t)
(define-key idlwave-mode-map "\C-c\C-v" 'idlwave-find-module)
+(define-key idlwave-mode-map "\C-c\C-t" 'idlwave-find-module-this-file)
(define-key idlwave-mode-map "\C-c?" 'idlwave-routine-info)
(define-key idlwave-mode-map "\M-?" 'idlwave-context-help)
-(define-key idlwave-mode-map [(control meta ?\?)] 'idlwave-online-help)
+(define-key idlwave-mode-map [(control meta ?\?)]
+ 'idlwave-help-assistant-help-with-topic)
;; Pickup both forms of Esc/Meta binding
(define-key idlwave-mode-map [(meta tab)] 'idlwave-complete)
(define-key idlwave-mode-map [?\e?\t] 'idlwave-complete)
(define-key idlwave-mode-map "\M-\C-i" '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
+(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'.
;; Automatically add spaces for the following characters
-;(idlwave-action-and-binding "&" '(idlwave-surround -1 -1 '(?&) 1
-; (lambda (char) 0)))
-(idlwave-action-and-binding "<" '(idlwave-surround -1 -1))
-;; Binding works for both > and ->, by changing the length of the token.
-(idlwave-action-and-binding ">" '(idlwave-surround -1 -1 '(?-) 1
- 'idlwave-gtr-pad-hook))
-(idlwave-action-and-binding "->" '(idlwave-surround -1 -1 nil 2) t)
-(idlwave-action-and-binding "," '(idlwave-surround 0 -1))
-
-;; Automatically add spaces to equal sign if not keyword
+
+;; Actions for & are complicated by &&
+(idlwave-action-and-binding "&" 'idlwave-custom-ampersand-surround)
+
+;; Automatically add spaces to equal sign if not keyword. This needs
+;; to go ahead of > and <, so >= and <= will be treated correctly
(idlwave-action-and-binding "=" '(idlwave-expand-equal -1 -1))
+;; Actions for > and < are complicated by >=, <=, and ->...
+(idlwave-action-and-binding "<" '(idlwave-custom-ltgtr-surround nil))
+(idlwave-action-and-binding ">" '(idlwave-custom-ltgtr-surround 'gtr))
+
+(idlwave-action-and-binding "," '(idlwave-surround 0 -1 1))
+
+
;;;
;;; Abbrev Section
;;;
(error (apply 'define-abbrev args)))))
(condition-case nil
- (modify-syntax-entry (string-to-char idlwave-abbrev-start-char)
+ (modify-syntax-entry (string-to-char idlwave-abbrev-start-char)
"w" idlwave-mode-syntax-table)
(error nil))
(idlwave-define-abbrev "s" "size()" (idlwave-keyword-abbrev 1))
(idlwave-define-abbrev "wi" "widget_info()" (idlwave-keyword-abbrev 1))
(idlwave-define-abbrev "wc" "widget_control," (idlwave-keyword-abbrev 0))
-
+(idlwave-define-abbrev "pv" "ptr_valid()" (idlwave-keyword-abbrev 1))
+(idlwave-define-abbrev "ipv" "if ptr_valid() then" (idlwave-keyword-abbrev 6))
+
;; This section is reserved words only. (From IDL user manual)
;;
(idlwave-define-abbrev "and" "and" (idlwave-keyword-abbrev 0 t) t)
(defvar imenu-extract-index-name-function)
(defvar imenu-prev-index-position-function)
;; defined later - so just make the compiler hush
-(defvar idlwave-mode-menu)
+(defvar idlwave-mode-menu)
(defvar idlwave-mode-debug-menu)
;;;###autoload
(defun idlwave-mode ()
- "Major mode for editing IDL source files (version 5.5).
+ "Major mode for editing IDL source files (version 6.1_em22).
The main features of this mode are
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. The
- HTML help files package must be installed for this to work -- check
- the IDLWAVE webpage for the correct package for your version. See
+ for the system variable, keyword, or routines at point. A single
+ key stroke gets you directly to the right place in the docs. See
the manual to configure where and how the HTML help is displayed.
4. Completion
\\i IF statement template
\\elif IF-ELSE statement template
\\b BEGIN
-
+
For a full list, use \\[idlwave-list-abbrevs]. Some templates also
have direct keybindings - see the list of keybindings below.
(interactive)
(kill-all-local-variables)
-
+
(if idlwave-startup-message
(message "Emacs IDLWAVE mode version %s." idlwave-mode-version))
(setq idlwave-startup-message nil)
-
+
(setq local-abbrev-table idlwave-mode-abbrev-table)
(set-syntax-table idlwave-mode-syntax-table)
-
+
(set (make-local-variable 'indent-line-function) 'idlwave-indent-and-action)
-
+
(make-local-variable idlwave-comment-indent-function)
(set idlwave-comment-indent-function 'idlwave-comment-hook)
-
+
(set (make-local-variable 'comment-start-skip) ";+[ \t]*")
(set (make-local-variable 'comment-start) ";")
- (set (make-local-variable 'require-final-newline) mode-require-final-newline)
+ (set (make-local-variable 'comment-add) 1) ; ";;" for new and regions
+ (set (make-local-variable 'require-final-newline) t)
(set (make-local-variable 'abbrev-all-caps) t)
(set (make-local-variable 'indent-tabs-mode) nil)
(set (make-local-variable 'completion-ignore-case) t)
-
+
(use-local-map idlwave-mode-map)
(when (featurep 'easymenu)
(setq mode-name "IDLWAVE")
(setq major-mode 'idlwave-mode)
(setq abbrev-mode t)
-
+
(set (make-local-variable idlwave-fill-function) 'idlwave-auto-fill)
(setq comment-end "")
(set (make-local-variable 'comment-multi-line) nil)
- (set (make-local-variable 'paragraph-separate)
+ (set (make-local-variable 'paragraph-separate)
"[ \t\f]*$\\|[ \t]*;+[ \t]*$\\|;+[+=-_*]+$")
(set (make-local-variable 'paragraph-start) "[ \t\f]\\|[ \t]*;+[ \t]")
(set (make-local-variable 'paragraph-ignore-fill-prefix) nil)
(set (make-local-variable 'parse-sexp-ignore-comments) t)
+ ;; ChangeLog
+ (set (make-local-variable 'add-log-current-defun-function)
+ 'idlwave-current-routine-fullname)
+
;; Set tag table list to use IDLTAGS as file name.
(if (boundp 'tag-table-alist)
(add-to-list 'tag-table-alist '("\\.pro$" . "IDLTAGS")))
-
- ;; Font-lock additions - originally Phil Williams, then Ulrik Dickow
+
+ ;; Font-lock additions
;; Following line is for Emacs - XEmacs uses the corresponding property
;; on the `idlwave-mode' symbol.
(set (make-local-variable 'font-lock-defaults) idlwave-font-lock-defaults)
+ (set (make-local-variable 'font-lock-mark-block-function)
+ 'idlwave-mark-subprogram)
+ (set (make-local-variable 'font-lock-fontify-region-function)
+ 'idlwave-font-lock-fontify-region)
;; Imenu setup
(set (make-local-variable 'imenu-create-index-function)
(set (make-local-variable 'imenu-prev-index-position-function)
'idlwave-prev-index-position)
+ ;; HideShow setup
+ (add-to-list 'hs-special-modes-alist
+ (list 'idlwave-mode
+ idlwave-begin-block-reg
+ idlwave-end-block-reg
+ ";"
+ 'idlwave-forward-block nil))
+
;; Make a local post-command-hook and add our hook to it
;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
- (make-local-hook 'post-command-hook)
+ ;; (make-local-hook 'post-command-hook)
(add-hook 'post-command-hook 'idlwave-command-hook nil 'local)
;; Make local hooks for buffer updates
;; NB: `make-local-hook' needed for older/alternative Emacs compatibility
- (make-local-hook 'kill-buffer-hook)
+ ;; (make-local-hook 'kill-buffer-hook)
(add-hook 'kill-buffer-hook 'idlwave-kill-buffer-update nil 'local)
- (make-local-hook 'after-save-hook)
+ ;; (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)
+ ;; Check help location
+ (idlwave-help-check-locations)
+
;; Run the mode hook
- (run-hooks 'idlwave-mode-hook))
+ (run-mode-hooks 'idlwave-mode-hook))
(defvar idlwave-setup-done nil)
(defun idlwave-setup ()
(unless idlwave-setup-done
(if (not (file-directory-p idlwave-config-directory))
(make-directory idlwave-config-directory))
- (setq idlwave-user-catalog-file (expand-file-name
- idlwave-user-catalog-file
- idlwave-config-directory)
- idlwave-path-file (expand-file-name
- idlwave-path-file
- idlwave-config-directory))
+ (setq
+ idlwave-user-catalog-file (expand-file-name
+ idlwave-user-catalog-file
+ idlwave-config-directory)
+ idlwave-xml-system-rinfo-converted-file
+ (expand-file-name
+ idlwave-xml-system-rinfo-converted-file
+ idlwave-config-directory)
+ idlwave-path-file (expand-file-name
+ idlwave-path-file
+ idlwave-config-directory))
(idlwave-read-paths) ; we may need these early
(setq idlwave-setup-done t)))
+(defun idlwave-font-lock-fontify-region (beg end &optional verbose)
+ "Fontify continuation lines correctly."
+ (let (pos)
+ (save-excursion
+ (goto-char beg)
+ (forward-line -1)
+ (when (setq pos (idlwave-is-continuation-line))
+ (goto-char pos)
+ (idlwave-beginning-of-statement)
+ (setq beg (point)))))
+ (font-lock-default-fontify-region beg end verbose))
+
;;
;; Code Formatting ----------------------------------------------------
-;;
-
-(defun idlwave-push-mark (&rest rest)
- "Push mark for compatibility with Emacs 18/19."
- (if (fboundp 'iconify-frame)
- (apply 'push-mark rest)
- (push-mark)))
+;;
(defun idlwave-hard-tab ()
"Inserts TAB in buffer in current position."
(if (> end-pos eol-pos)
(setq end-pos pos))
(goto-char end-pos)
- (setq end (buffer-substring
+ (setq end (buffer-substring
(progn
(skip-chars-backward "a-zA-Z")
(point))
(sit-for 1))
(t
(beep)
- (message "Warning: Shouldn't this be \"%s\" instead of \"%s\"?"
+ (message "Warning: Shouldn't this be \"%s\" instead of \"%s\"?"
end1 end)
(sit-for 1))))))))
;;(delete-char 1))
((looking-at "pro\\|case\\|switch\\|function\\>")
(assoc (downcase (match-string 0)) idlwave-block-matches))
((looking-at "begin\\>")
- (let ((limit (save-excursion
- (idlwave-beginning-of-statement)
+ (let ((limit (save-excursion
+ (idlwave-beginning-of-statement)
(point))))
(cond
((re-search-backward ":[ \t]*\\=" limit t)
(defun idlwave-close-block ()
"Terminate the current block with the correct END statement."
(interactive)
-
;; Start new line if we are not in a new line
(unless (save-excursion
(skip-chars-backward " \t")
(insert "end")
(idlwave-show-begin)))
-(defun idlwave-gtr-pad-hook (char)
- "Let the > symbol expand around -> if present. The new token length
-is returned."
- 2)
-
-(defun idlwave-surround (&optional before after escape-chars length ec-hook)
+(defun idlwave-custom-ampersand-surround (&optional is-action)
+ "Surround &, leaving room for && (which surrround as well)."
+ (let* ((prev-char (char-after (- (point) 2)))
+ (next-char (char-after (point)))
+ (amp-left (eq prev-char ?&))
+ (amp-right (eq next-char ?&))
+ (len (if amp-left 2 1)))
+ (unless amp-right ;no need to do it twice, amp-left will catch it.
+ (idlwave-surround -1 (if (or is-action amp-left) -1) len))))
+
+(defun idlwave-custom-ltgtr-surround (gtr &optional is-action)
+ "Surround > and < by blanks, leaving room for >= and <=, and considering ->."
+ (let* ((prev-char (char-after (- (point) 2)))
+ (next-char (char-after (point)))
+ (method-invoke (and gtr (eq prev-char ?-)))
+ (len (if method-invoke 2 1)))
+ (unless (eq next-char ?=)
+ ;; Key binding: pad only on left, to save for possible >=/<=
+ (idlwave-surround -1 (if (or is-action method-invoke) -1) len))))
+
+(defun idlwave-surround (&optional before after length is-action)
"Surround the LENGTH characters before point with blanks.
LENGTH defaults to 1.
Optional arguments BEFORE and AFTER affect the behavior before and
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
-- 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 '(?-).
-
-If a function is passed in EC-HOOK, and an ESCAPE-CHARS match occurs,
-the named function will be called with a single argument of the
-preceeding character. Then idlwave-surround will run as usual if
-EC-HOOK returns non-nil, and a new length will be taken from the
-return value."
+- the character before point is inside a string or comment"
(when (and idlwave-surround-by-blank (not (idlwave-quoted)))
- (let* ((length (or length 1)) ; establish a default for LENGTH
- (prev-char (char-after (- (point) (1+ length)))))
- (when (or (not (memq prev-char escape-chars))
- (and (fboundp ec-hook)
- (setq length
- (save-excursion (funcall ec-hook prev-char)))))
- (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))))))
+ (let ((length (or length 1))) ; establish a default for LENGTH
+ (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.
;; Reindent new line
(idlwave-indent-line)))
-(defun idlwave-beginning-of-subprogram ()
- "Moves point to the beginning of the current program unit."
+(defun idlwave-beginning-of-subprogram (&optional nomark)
+ "Moves point to the beginning of the current program unit.
+If NOMARK is non-nil, do not push mark."
(interactive)
- (idlwave-find-key idlwave-begin-unit-reg -1))
+ (idlwave-find-key idlwave-begin-unit-reg -1 nomark))
-(defun idlwave-end-of-subprogram ()
- "Moves point to the start of the next program unit."
+(defun idlwave-end-of-subprogram (&optional nomark)
+ "Moves point to the start of the next program unit.
+If NOMARK is non-nil, do not push mark."
(interactive)
(idlwave-end-of-statement)
- (idlwave-find-key idlwave-end-unit-reg 1))
+ (idlwave-find-key idlwave-end-unit-reg 1 nomark))
(defun idlwave-mark-statement ()
"Mark current IDL statement."
(idlwave-end-of-statement)
(let ((end (point)))
(idlwave-beginning-of-statement)
- (idlwave-push-mark end nil t)))
+ (push-mark end nil t)))
(defun idlwave-mark-block ()
"Mark containing block."
(let ((end (point)))
(idlwave-backward-block)
(idlwave-beginning-of-statement)
- (idlwave-push-mark end nil t)))
+ (push-mark end nil t)))
(defun idlwave-mark-subprogram ()
(idlwave-beginning-of-subprogram)
(let ((beg (point)))
(idlwave-forward-block)
- (idlwave-push-mark beg nil t))
+ (push-mark beg nil t))
(exchange-point-and-mark))
(defun idlwave-backward-up-block (&optional arg)
(idlwave-block-jump-out 1 'nomark)
(backward-word 1))
-(defun idlwave-forward-block ()
+(defun idlwave-forward-block (&optional arg)
"Move across next nested block."
(interactive)
- (if (idlwave-down-block 1)
- (idlwave-block-jump-out 1 'nomark)))
+ (let ((arg (or arg 1)))
+ (if (idlwave-down-block arg)
+ (idlwave-block-jump-out arg 'nomark))))
(defun idlwave-backward-block ()
"Move backward across previous nested block."
(let ((eos (save-excursion
(idlwave-block-jump-out -1 'nomark)
(point))))
- (if (setq status (idlwave-find-key
+ (if (setq status (idlwave-find-key
idlwave-end-block-reg -1 'nomark eos))
(idlwave-beginning-of-statement)
(message "No nested block before beginning of containing block.")))
(let ((eos (save-excursion
(idlwave-block-jump-out 1 'nomark)
(point))))
- (if (setq status (idlwave-find-key
+ (if (setq status (idlwave-find-key
idlwave-begin-block-reg 1 'nomark eos))
(idlwave-end-of-statement)
(message "No nested block before end of containing block."))))
(here (point)))
(goto-char (point-max))
(if (re-search-backward idlwave-doclib-start nil t)
- (progn
+ (progn
(setq beg (progn (beginning-of-line) (point)))
(if (re-search-forward idlwave-doclib-end nil t)
(progn
(forward-line 1)
- (idlwave-push-mark beg nil t)
+ (push-mark beg nil t)
(message "Could not find end of doc library header.")))
(message "Could not find doc library header start.")
(goto-char here)))))
+(defun idlwave-current-routine-fullname ()
+ (let ((name (idlwave-current-routine)))
+ (idlwave-make-full-name (nth 2 name) (car name))))
(defun idlwave-current-routine ()
"Return (NAME TYPE CLASS) of current routine."
(idlwave-routines)
(save-excursion
- (idlwave-beginning-of-subprogram)
+ (idlwave-beginning-of-subprogram 'nomark)
(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))
((eq major-mode 'idlwave-shell-mode)
(if (re-search-backward idlwave-shell-prompt-pattern nil t)
(goto-char (match-end 0))))
- (t
+ (t
(if (save-excursion (forward-line -1) (idlwave-is-continuation-line))
(idlwave-previous-statement)
(beginning-of-line)))))
(let ((save-point (point)))
(when (re-search-forward ".*&" lim t)
(goto-char (match-end 0))
- (if (idlwave-quoted)
+ (if (idlwave-quoted)
(goto-char save-point)
(if (eq (char-after (- (point) 2)) ?&) (goto-char save-point))))
(point)))
;; - not in parenthesis (like a[0:3])
;; - not followed by another ":" in explicit class, ala a->b::c
;; As many in this mode, this function is heuristic and not an exact
- ;; parser.
+ ;; parser.
(let* ((start (point))
(eos (save-excursion (idlwave-end-of-statement) (point)))
(end (idlwave-find-key ":" 1 'nomark eos)))
(if st
(append st (match-end 0))))))
-(defun idlwave-expand-equal (&optional before after)
+(defun idlwave-expand-equal (&optional before after is-action)
"Pad '=' with spaces. Two cases: Assignment statement, and keyword
assignment. Which case is determined using
`idlwave-start-of-substatement' and `idlwave-statement-type'. The
`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.
+Limits in for loops are treated as keyword assignment.
Starting with IDL 6.0, a number of op= assignments are available.
Since ambiguities of the form:
\(not just for padding, but for proper parsing by IDL too!). Other
operators, such as ##=, ^=, etc., will be pre-padded.
+IS-ACTION is ignored.
+
See `idlwave-surround'."
(if idlwave-surround-by-blank
- (let
+ (let
((non-an-ops "\\(##\\|\\*\\|\\+\\|-\\|/\\|<\\|>\\|\\^\\)\\=")
- (an-ops
+ (an-ops
"\\s-\\(AND\\|EQ\\|GE\\|GT\\|LE\\|LT\\|MOD\\|NE\\|OR\\|XOR\\)\\=")
(len 1))
-
- (save-excursion
+
+ (save-excursion
(let ((case-fold-search t))
(backward-char)
- (if (or
+ (if (or
(re-search-backward non-an-ops nil t)
;; Why doesn't ##? work for both?
- (re-search-backward "\\(#\\)\\=" nil t))
+ (re-search-backward "\\(#\\)\\=" nil t))
(setq len (1+ (length (match-string 1))))
(when (re-search-backward an-ops nil t)
- (setq begin nil) ; won't modify begin
+ ;(setq begin nil) ; won't modify begin
(setq len (1+ (length (match-string 1))))))))
-
- (if (eq t idlwave-pad-keyword)
+
+ (if (eq t idlwave-pad-keyword)
;; Everything gets padded equally
- (idlwave-surround before after nil len)
+ (idlwave-surround before after len)
;; Treating keywords/for variables specially...
(let ((st (save-excursion ; To catch "for" variables
(idlwave-start-of-substatement t)
(skip-chars-backward "= \t")
(nth 2 (idlwave-where)))))
(cond ((or (memq what '(function-keyword procedure-keyword))
- (memq (caar st) '(for pdef)))
- (cond
+ (memq (caar st) '(for pdef)))
+ (cond
((null idlwave-pad-keyword)
(idlwave-surround 0 0)
) ; remove space
(t))) ; leave any spaces alone
- (t (idlwave-surround before after nil len))))))))
-
+ (t (idlwave-surround before after len))))))))
+
(defun idlwave-indent-and-action (&optional arg)
"Call `idlwave-indent-line' and do expand actions.
With prefix ARG non-nil, indent the entire sub-statement."
(interactive "p")
(save-excursion
- (if (and idlwave-expand-generic-end
- (re-search-backward "\\<\\(end\\)\\s-*\\="
+ (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))
(when (and (not arg) current-prefix-arg)
(setq arg current-prefix-arg)
(setq current-prefix-arg nil))
- (if arg
+ (if arg
(idlwave-indent-statement)
(idlwave-indent-line t)))
;; Before indenting, run action routines.
;;
(if (and expand idlwave-do-actions)
- (mapcar 'idlwave-do-action idlwave-indent-expand-table))
+ (mapc 'idlwave-do-action idlwave-indent-expand-table))
;;
(if idlwave-do-actions
- (mapcar 'idlwave-do-action idlwave-indent-action-table))
+ (mapc 'idlwave-do-action idlwave-indent-action-table))
;;
;; No longer expand abbrevs on the line. The user can do this
;; manually using expand-region-abbrevs.
(set-marker mloc nil)))
(defun idlwave-do-action (action)
- "Perform an action repeatedly on a line.
-ACTION is a list (REG . FUNC). REG is a regular expression. FUNC is
-either a function name to be called with `funcall' or a list to be
-evaluated with `eval'. The action performed by FUNC should leave point
-after the match for REG - otherwise an infinite loop may be entered."
+ "Perform an action repeatedly on a line. ACTION is a list (REG
+. FUNC). REG is a regular expression. FUNC is either a function name
+to be called with `funcall' or a list to be evaluated with `eval'.
+The action performed by FUNC should leave point after the match for
+REG - otherwise an infinite loop may be entered. FUNC is always
+passed a final argument of 'is-action, so it can discriminate between
+being run as an action, or a key binding"
(let ((action-key (car action))
(action-routine (cdr action)))
(beginning-of-line)
(while (idlwave-look-at action-key)
(if (listp action-routine)
- (eval action-routine)
- (funcall action-routine)))))
+ (eval (append action-routine '('is-action)))
+ (funcall action-routine 'is-action)))))
(defun idlwave-indent-to (col &optional min)
"Indent from point with spaces until column COL.
(save-excursion
(cond
;; Beginning of file
- ((prog1
+ ((prog1
(idlwave-previous-statement)
(setq beg-prev-pos (point)))
0)
idlwave-main-block-indent))
;; Begin block
((idlwave-look-at idlwave-begin-block-reg t)
- (+ (idlwave-min-current-statement-indent)
+ (+ (idlwave-min-current-statement-indent)
idlwave-block-indent))
;; End Block
((idlwave-look-at idlwave-end-block-reg t)
(idlwave-min-current-statement-indent)))
;; idlwave-end-offset
;; idlwave-block-indent))
-
+
;; Default to current indent
((idlwave-current-statement-indent))))))
;; adjust the indentation based on the current statement
(defun idlwave-calculate-paren-indent (beg-reg end-reg close-exp)
"Calculate the continuation indent inside a paren group.
-Returns a cons-cell with (open . indent), where open is the
+Returns a cons-cell with (open . indent), where open is the
location of the open paren"
(let ((open (nth 1 (parse-partial-sexp beg-reg end-reg))))
;; Found an innermost open paren.
(end-reg (progn (beginning-of-line) (point)))
(beg-last-statement (save-excursion (idlwave-previous-statement)
(point)))
- (beg-reg (progn (idlwave-start-of-substatement 'pre)
+ (beg-reg (progn (idlwave-start-of-substatement 'pre)
(if (eq (line-beginning-position) end-reg)
(goto-char beg-last-statement)
(point))))
(basic-indent (+ (idlwave-min-current-statement-indent end-reg)
idlwave-continuation-indent))
fancy-nonparen-indent fancy-paren-indent)
- (cond
+ (cond
;; Align then with its matching if, etc.
((let ((matchers '(("\\<if\\>" . "[ \t]*then")
("\\<\\(if\\|end\\(if\\)?\\)\\>" . "[ \t]*else")
("\\<\\(for\\|while\\)\\>" . "[ \t]*do")
- ("\\<\\(repeat\\|end\\(rep\\)?\\)\\>" .
+ ("\\<\\(repeat\\|end\\(rep\\)?\\)\\>" .
"[ \t]*until")
("\\<case\\>" . "[ \t]*of")))
match cont-re)
(goto-char end-reg)
- (and
+ (and
(setq cont-re
(catch 'exit
(while (setq match (car matchers))
(setq matchers (cdr matchers)))))
(idlwave-find-key cont-re -1 'nomark beg-last-statement)))
(if (looking-at "end") ;; that one's special
- (- (idlwave-current-indent)
+ (- (idlwave-current-indent)
(+ idlwave-block-indent idlwave-end-offset))
(idlwave-current-indent)))
(let* ((end-reg end-reg)
(close-exp (progn
(goto-char end-reg)
- (skip-chars-forward " \t")
+ (skip-chars-forward " \t")
(looking-at "\\s)")))
indent-cons)
(catch 'loop
(if (save-match-data (looking-at "[ \t$]*\\(;.*\\)?$"))
nil
(current-column)))
-
+
;; Continued assignment (with =):
((catch 'assign ;
(while (looking-at "[^=\n\r]*\\(=\\)[ \t]*")
(goto-char (match-end 0))
- (if (null (idlwave-what-function beg-reg))
+ (if (null (idlwave-what-function beg-reg))
(throw 'assign t))))
(unless (or
(idlwave-in-quote)
(let* ((here (point))
(case-fold-search t)
(limit (if (>= dir 0) (point-max) (point-min)))
- (block-limit (if (>= dir 0)
+ (block-limit (if (>= dir 0)
idlwave-begin-block-reg
idlwave-end-block-reg))
found
(idlwave-find-key
idlwave-begin-unit-reg dir t limit)
(end-of-line)
- (idlwave-find-key
+ (idlwave-find-key
idlwave-end-unit-reg dir t limit)))
limit)))
(if (>= dir 0) (end-of-line)) ;Make sure we are in current block
(or (null end-reg) (< (point) end-reg)))
(unless comm-or-empty (setq min (min min (idlwave-current-indent)))))
(if (or comm-or-empty (and end-reg (>= (point) end-reg)))
- min
+ min
(min min (idlwave-current-indent))))))
(defun idlwave-current-statement-indent (&optional last-line)
"Tests if current line is continuation line.
Blank or comment-only lines following regular continuation lines (with
`$') count as continuations too."
- (save-excursion
- (or
- (idlwave-look-at "\\<\\$")
- (catch 'loop
- (while (and (looking-at "^[ \t]*\\(;.*\\)?$")
- (eq (forward-line -1) 0))
- (if (idlwave-look-at "\\<\\$") (throw 'loop t)))))))
+ (let (p)
+ (save-excursion
+ (or
+ (idlwave-look-at "\\<\\$")
+ (catch 'loop
+ (while (and (looking-at "^[ \t]*\\(;.*\\)?$")
+ (eq (forward-line -1) 0))
+ (if (setq p (idlwave-look-at "\\<\\$")) (throw 'loop p))))))))
(defun idlwave-is-comment-line ()
"Tests if the current line is a comment line."
(beginning-of-line) (point))
(point))))
"[^;]"))
-
+
;; Mark the beginning and end of the paragraph
(goto-char bcl)
(while (and (looking-at fill-prefix-reg)
(insert (make-string diff ?\ ))))
(forward-line -1))
)
-
+
;; No hang. Instead find minimum indentation of paragraph
;; after first line.
;; For the following while statement, since START is at the
t)
(current-column))
indent))
-
+
;; try to keep point at its original place
(goto-char here)
(current-column)))))
(defun idlwave-auto-fill ()
- "Called to break lines in auto fill mode.
+ "Called to break lines in auto fill mode.
Only fills non-comment lines if `idlwave-fill-comment-line-only' is
non-nil. Places a continuation character at the end of the line if
not in a comment. Splits strings with IDL concatenation operator `+'
(idlwave-indent-line)
;; Prevent actions do-auto-fill which calls indent-line-function.
(let (idlwave-do-actions
- (paragraph-start ".")
(paragraph-separate ".")
(fill-nobreak-predicate
(if (and (idlwave-in-quote)
(save-excursion
(end-of-line 0)
;; Indent the split line
- (idlwave-indent-line)
- )
+ (idlwave-indent-line))
(if (save-excursion
(beginning-of-line)
(looking-at idlwave-comment-line-start-skip))
(let ((pos (point)))
(if idlwave-file-header
(cond ((car idlwave-file-header)
- (insert-file (car idlwave-file-header)))
+ (insert-file-contents (car idlwave-file-header)))
((stringp (car (cdr idlwave-file-header)))
(insert (car (cdr idlwave-file-header))))))
(goto-char pos)))
(insert (current-time-string))
(insert ", " (user-full-name))
(if (boundp 'user-mail-address)
- (insert " <" user-mail-address ">")
+ (insert " <" user-mail-address ">")
(insert " <" (user-login-name) "@" (system-name) ">"))
;; Remove extra spaces from line
(idlwave-fill-paragraph)
(setq end (match-end 0)))
(progn
(goto-char beg)
- (if (re-search-forward
+ (if (re-search-forward
(concat idlwave-doc-modifications-keyword ":")
end t)
(end-of-line)
(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
;;; abbrev hook associated with an abbrev moves point backwards
(not (idlwave-in-quote))
(save-excursion
(forward-char)
- (re-search-backward (concat "\\(" idlwave-idl-keywords
+ (re-search-backward (concat "\\(" idlwave-idl-keywords
"\\|[[(*+-/=,^><]\\)\\s-*\\*") limit t)))))
(if (not noindent)
(indent-region beg end nil))
(if (stringp prompt)
- (message prompt)))))
-
+ (message "%s" prompt)))))
+
(defun idlwave-rw-case (string)
"Make STRING have the case required by `idlwave-reserved-word-upcase'."
(if idlwave-reserved-word-upcase
(defun idlwave-case ()
"Build skeleton IDL case statement."
(interactive)
- (idlwave-template
+ (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-template
(idlwave-rw-case "switch")
(idlwave-rw-case " of\n\nendswitch")
"Selector expression"))
(defun idlwave-for ()
"Build skeleton for loop statment."
(interactive)
- (idlwave-template
+ (idlwave-template
(idlwave-rw-case "for")
(idlwave-rw-case " do begin\n\nendfor")
"Loop expression"))
(defun idlwave-procedure ()
(interactive)
- (idlwave-template
+ (idlwave-template
(idlwave-rw-case "pro")
(idlwave-rw-case "\n\nreturn\nend")
"Procedure name"))
(defun idlwave-function ()
(interactive)
- (idlwave-template
+ (idlwave-template
(idlwave-rw-case "function")
(idlwave-rw-case "\n\nreturn\nend")
"Function name"))
(defun idlwave-while ()
(interactive)
- (idlwave-template
+ (idlwave-template
(idlwave-rw-case "while")
(idlwave-rw-case " do begin\n\nendwhile")
"Entry condition"))
(defun idlwave-count-outlawed-buffers (tag)
"How many outlawed buffers have tag TAG?"
(length (delq nil
- (mapcar
- (lambda (x) (eq (cdr x) tag))
+ (mapcar
+ (lambda (x) (eq (cdr x) tag))
idlwave-outlawed-buffers))))
(defun idlwave-do-kill-autoloaded-buffers (&rest reasons)
(memq (cdr entry) reasons))
(kill-buffer (car entry))
(incf cnt)
- (setq idlwave-outlawed-buffers
+ (setq idlwave-outlawed-buffers
(delq entry idlwave-outlawed-buffers)))
- (setq idlwave-outlawed-buffers
+ (setq idlwave-outlawed-buffers
(delq entry idlwave-outlawed-buffers))))
(message "%d buffer%s killed" cnt (if (= cnt 1) "" "s"))))
(entry (assq buf idlwave-outlawed-buffers)))
;; Revoke license
(if entry
- (setq idlwave-outlawed-buffers
+ (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)))
(defun idlwave-expand-lib-file-name (file)
;; Find FILE on the scanned lib path and return a buffer visiting it
;; This is for, e.g., finding source with no user catalog
- (cond
+ (cond
((null file) nil)
((file-name-absolute-p file) file)
(t (idlwave-locate-lib-file file))))
(interactive)
(let (directory directories cmd append status numdirs dir getsubdirs
buffer save_buffer files numfiles item errbuf)
-
+
;;
;; Read list of directories
(setq directory (read-string "Tag Directories: " "."))
;; Call etags
(if (not (string-match "^[ \\t]*$" item))
(progn
- (message (concat "Tagging " item "..."))
+ (message "%s" (concat "Tagging " item "..."))
(setq errbuf (get-buffer-create "*idltags-error*"))
(setq status (+ status
- (if (eq 0 (call-process
+ (if (eq 0 (call-process
"sh" nil errbuf nil "-c"
(concat cmd append item)))
0
(setq numfiles (1+ numfiles))
(setq item (nth numfiles files))
)))
-
+
(setq numdirs (1+ numdirs))
(setq dir (nth numdirs directories)))
(progn
(setq numdirs (1+ numdirs))
(setq dir (nth numdirs directories)))))
-
+
(setq errbuf (get-buffer-create "*idltags-error*"))
(if (= status 0)
(kill-buffer errbuf))
;; Make sure the hash functions are accessible.
(if (or (not (fboundp 'gethash))
(not (fboundp 'puthash)))
- (progn
+ (progn
(require 'cl)
(or (fboundp 'puthash)
(defalias 'puthash 'cl-puthash))))
for var = (car entry)
do (if (not (consp (symbol-value var))) (set var (list nil))))
+ ;; Reset the system & library hash
(when (or (eq what t) (eq what 'syslib)
(null (cdr idlwave-sint-routines)))
- ;; Reset the system & library hash
(loop for entry in entries
for var = (car entry) for size = (nth 1 entry)
- do (setcdr (symbol-value var)
+ do (setcdr (symbol-value var)
(make-hash-table ':size size ':test 'equal)))
(setq idlwave-sint-dirs nil
idlwave-sint-libnames nil))
+ ;; Reset the buffer & shell hash
(when (or (eq what t) (eq what 'bufsh)
(null (car idlwave-sint-routines)))
- ;; Reset the buffer & shell hash
(loop for entry in entries
for var = (car entry) for size = (nth 1 entry)
- do (setcar (symbol-value var)
+ do (setcar (symbol-value var)
(make-hash-table ':size size ':test 'equal))))))
(defun idlwave-sintern-routine-or-method (name &optional class set)
(defun idlwave-sintern-keyword-list (kwd-list &optional set)
"Sintern a set of keywords (file (key . link) (key2 . link2) ...)"
- (mapcar (lambda(x)
- (setcar x (idlwave-sintern-keyword (car x) set)))
- (cdr kwd-list))
+ (mapc (lambda(x)
+ (setcar x (idlwave-sintern-keyword (car x) set)))
+ (cdr kwd-list))
kwd-list)
(defun idlwave-sintern-rinfo-list (list &optional set default-dir)
(setq class (idlwave-sintern-class class set))
(setq name (idlwave-sintern-method name set)))
(setq name (idlwave-sintern-routine name set)))
-
+
;; The source
(let ((source-type (car source))
(source-file (nth 1 source))
- (source-dir (if default-dir
+ (source-dir (if default-dir
(file-name-as-directory default-dir)
(nth 2 source)))
(source-lib (nth 3 source)))
(if (stringp source-lib)
(setq source-lib (idlwave-sintern-libname source-lib set)))
(setq source (list source-type source-file source-dir source-lib)))
-
+
;; The keywords
(setq kwds (mapcar (lambda (x)
(idlwave-sintern-keyword-list x set))
(defvar idlwave-user-catalog-routines nil
"Holds the procedure routine-info from the user scan.")
(defvar idlwave-library-catalog-routines nil
- "Holds the procedure routine-info from the library catalog files.")
+ "Holds the procedure routine-info from the .idlwave_catalog library files.")
+(defvar idlwave-library-catalog-libname nil
+ "Name of library catalog loaded from .idlwave_catalog files.")
(defvar idlwave-path-alist nil
"Alist with !PATH directories and zero or more flags if the dir has
been scanned in a user catalog ('user) or discovered in a library
(defvar idlwave-true-path-alist nil
"Like `idlwave-path-alist', but with true filenames.")
(defvar idlwave-routines nil
- "Holds the combinded procedure/function/method routine-info.")
+ "Holds the combined procedure/function/method routine-info.")
(defvar idlwave-class-alist nil
"Holds the class names known to IDLWAVE.")
(defvar idlwave-class-history nil
(idlwave-update-routine-info '(16)))
(defun idlwave-rescan-asynchronously ()
- "Dispatch another emacs instance to update the idlwave catalog.
+ "Dispatch another Emacs instance to update the idlwave catalog.
After the process finishes normally, the first access to routine info
will re-read the catalog."
(interactive)
(not (stringp idlwave-user-catalog-file))
(not (file-regular-p idlwave-user-catalog-file)))
(error "No catalog has been produced yet"))
- (let* ((emacs (expand-file-name (invocation-name) (invocation-directory)))
+ (let* ((emacs (concat invocation-directory invocation-name))
(args (list "-batch"
"-l" (expand-file-name "~/.emacs")
"-l" "idlwave"
"-f" "idlwave-rescan-catalog-directories"))
- (process (apply 'start-process "idlcat"
+ (process (apply 'start-process "idlcat"
nil emacs args)))
(setq idlwave-catalog-process process)
- (set-process-sentinel
+ (set-process-sentinel
process
(lambda (pro why)
(when (string-match "finished" why)
;; ("ROUTINE" type class
;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
;; (buffer pro_file dir) | (compiled pro_file dir)
-;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...)))
+;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
+;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
;;
;; DIR will be supplied dynamically while loading library catalogs,
;; and is sinterned to save space, as is LIBNAME. PRO_FILE can be a
(defvar idlwave-load-rinfo-idle-timer)
+(defvar idlwave-shell-path-query)
+
(defun idlwave-update-routine-info (&optional arg no-concatenate)
"Update the internal routine-info lists.
These lists are used by `idlwave-routine-info' (\\[idlwave-routine-info])
;; The override-idle means, even if the idle timer has done some
;; preparing work, load and renormalize everything anyway.
(override-idle (or arg idlwave-buffer-case-takes-precedence)))
-
+
(setq idlwave-buffer-routines nil
idlwave-compiled-routines nil
idlwave-unresolved-routines nil)
(idlwave-reset-sintern (cond (load t)
((null idlwave-system-routines) t)
(t 'bufsh))))
-
+
(if idlwave-buffer-case-takes-precedence
;; We can safely scan the buffer stuff first
(progn
(idlwave-update-buffer-routine-info)
- (and load (idlwave-load-system-rinfo override-idle)))
+ (and load (idlwave-load-all-rinfo override-idle)))
;; We first do the system info, and then the buffers
- (and load (idlwave-load-system-rinfo override-idle))
+ (and load (idlwave-load-all-rinfo override-idle))
(idlwave-update-buffer-routine-info))
;; Let's see if there is a shell
(idlwave-shell-is-running)))
(ask-shell (and shell-is-running
idlwave-query-shell-for-routine-info)))
-
+
;; Load the library catalogs again, first re-scanning the path
- (when arg
+ (when arg
(if shell-is-running
(idlwave-shell-send-command idlwave-shell-path-query
'(progn
;; Therefore, we do a concatenation now, even though
;; the shell might do it again.
(idlwave-concatenate-rinfo-lists nil 'run-hooks))
-
+
(when ask-shell
;; Ask the shell about the routines it knows of.
(message "Querying the shell")
nil 'idlwave-load-rinfo-next-step)))
(error nil))))
+(defvar idlwave-library-routines nil "Obsolete variable.")
+
+;;------ XML Help routine info system
+(defun idlwave-load-system-routine-info ()
+ ;; Load the system routine info from the cached routine info file,
+ ;; which, if necessary, will be re-created from the XML file on
+ ;; disk. As a last fallback, load the (likely outdated) idlw-rinfo
+ ;; file distributed with older IDLWAVE versions (<6.0)
+ (unless (and (load idlwave-xml-system-rinfo-converted-file
+ 'noerror 'nomessage)
+ (idlwave-xml-system-routine-info-up-to-date))
+ ;; See if we can create it from XML source
+ (condition-case nil
+ (idlwave-convert-xml-system-routine-info)
+ (error
+ (unless (load idlwave-xml-system-rinfo-converted-file
+ 'noerror 'nomessage)
+ (if idlwave-system-routines
+ (message
+ "Failed to load converted routine info, using old conversion.")
+ (message
+ "Failed to convert XML routine info, falling back on idlw-rinfo.")
+ (if (not (load "idlw-rinfo" 'noerror 'nomessage))
+ (message
+ "Could not locate any system routine information."))))))))
+
+(defun idlwave-xml-system-routine-info-up-to-date()
+ (let* ((dir (file-name-as-directory
+ (expand-file-name "help/online_help" (idlwave-sys-dir))))
+ (catalog-file (expand-file-name "idl_catalog.xml" dir)))
+ (file-newer-than-file-p ;converted file is newer than catalog
+ idlwave-xml-system-rinfo-converted-file
+ catalog-file)))
+
+(defvar idlwave-system-class-info nil) ; Gathered from idlw-rinfo
+(defvar idlwave-system-variables-alist nil
+ "Alist of system variables and the associated structure tags.
+Gets set in cached XML rinfo, or `idlw-rinfo.el'.")
+(defvar idlwave-executive-commands-alist nil
+ "Alist of system variables and their help files.")
+(defvar idlwave-help-special-topic-words nil)
+
+
+(defun idlwave-shorten-syntax (syntax name &optional class)
+ ;; From a list of syntax statments, shorten with %s and group with "or"
+ (let ((case-fold-search t))
+ (mapconcat
+ (lambda (x)
+ (while (string-match name x)
+ (setq x (replace-match "%s" t t x)))
+ (if class
+ (while (string-match class x)
+ (setq x (replace-match "%s" t t x))))
+ x)
+ (nreverse syntax)
+ " or ")))
+
+(defun idlwave-xml-create-class-method-lists (xml-entry)
+ ;; Create a class list entry from the xml parsed list., returning a
+ ;; cons of form (class-entry method-entries).
+ (let* ((nameblock (nth 1 xml-entry))
+ (class (cdr (assq 'name nameblock)))
+ (link (cdr (assq 'link nameblock)))
+ (params (cddr xml-entry))
+ (case-fold-search t)
+ class-entry
+ method methods-entry extra-kwds
+ props get-props set-props init-props inherits
+ pelem ptype)
+ (while params
+ (setq pelem (car params))
+ (when (listp pelem)
+ (setq ptype (car pelem)
+ props (car (cdr pelem)))
+ (cond
+ ((eq ptype 'SUPERCLASS)
+ (let ((pname (cdr (assq 'name props)))
+ (plink (cdr (assq 'link props))))
+ (unless (and (string= pname "None")
+ (string= plink "None"))
+ (push pname inherits))))
+
+ ((eq ptype 'PROPERTY)
+ (let ((pname (cdr (assq 'name props)))
+ (plink (cdr (assq 'link props)))
+ (get (string= (cdr (assq 'get props)) "Yes"))
+ (set (string= (cdr (assq 'set props)) "Yes"))
+ (init (string= (cdr (assq 'init props)) "Yes")))
+ (if get (push (list pname plink) get-props))
+ (if set (push (list pname plink) set-props))
+ (if init (push (list pname plink) init-props))))
+
+ ((eq ptype 'METHOD)
+ (setq method (cdr (assq 'name props)))
+ (setq extra-kwds ;;Assume all property keywords are gathered already
+ (cond
+ ((string-match (concat class "::Init") method)
+ (put 'init-props 'matched t)
+ init-props)
+ ((string-match (concat class "::GetProperty") method)
+ (put 'get-props 'matched t)
+ get-props)
+ ((string-match (concat class "::SetProperty") method)
+ (put 'set-props 'matched t)
+ set-props)
+ (t nil)))
+ (setq methods-entry
+ (nconc (idlwave-xml-create-rinfo-list pelem class extra-kwds)
+ methods-entry)))
+ (t)))
+ (setq params (cdr params)))
+ ;(unless (get 'init-props 'matched)
+ ; (message "Failed to match Init in class %s" class))
+ ;(unless (get 'get-props 'matched)
+ ; (message "Failed to match GetProperty in class %s" class))
+ ;(unless (get 'set-props 'matched)
+ ; (message "Failed to match SetProperty in class %s" class))
+ (setq class-entry
+ (if inherits
+ (list class (append '(inherits) inherits) (list 'link link))
+ (list class (list 'link link))))
+ (cons class-entry methods-entry)))
+
+(defun idlwave-xml-create-rinfo-list (xml-entry &optional class extra-kws)
+ ;; Create correctly structured list elements from ROUTINE or METHOD
+ ;; XML list structures. Return a list of list elements, with more
+ ;; than one sub-list possible if a routine can serve as both
+ ;; procedure and function (e.g. call_method).
+ (let* ((nameblock (nth 1 xml-entry))
+ (name (cdr (assq 'name nameblock)))
+ (link (cdr (assq 'link nameblock)))
+ (params (cddr xml-entry))
+ (syntax-vec (make-vector 3 nil)) ; procedure, function, exec command
+ (case-fold-search t)
+ syntax kwd klink pref-list kwds pelem ptype entry props result type)
+ (if class ;; strip out class name from class method name string
+ (if (string-match (concat class "::") name)
+ (setq name (substring name (match-end 0)))))
+ (while params
+ (setq pelem (car params))
+ (when (listp pelem)
+ (setq ptype (car pelem)
+ props (car (cdr pelem)))
+ (cond
+ ((eq ptype 'SYNTAX)
+ (setq syntax (cdr (assq 'name props)))
+ (if (string-match "->" syntax)
+ (setq syntax (replace-match "->" t nil syntax)))
+ (setq type (cdr (assq 'type props)))
+ (push syntax
+ (aref syntax-vec (cond
+ ((string-match "^pro" type) 0)
+ ((string-match "^fun" type) 1)
+ ((string-match "^exec" type) 2)))))
+ ((eq ptype 'KEYWORD)
+ (setq kwd (cdr (assq 'name props))
+ klink (cdr (assq 'link props)))
+ (if (string-match "^\\[XY\\(Z?\\)\\]" kwd)
+ (progn
+ (setq pref-list
+ (if (match-string 1 kwd) '("X" "Y" "Z") '("X" "Y"))
+ kwd (substring kwd (match-end 0)))
+ (loop for x in pref-list do
+ (push (list (concat x kwd) klink) kwds)))
+ (push (list kwd klink) kwds)))
+
+ (t))); Do nothing for the others
+ (setq params (cdr params)))
+
+ ;; Debug
+; (if (and (null (aref syntax-vec 0))
+; (null (aref syntax-vec 1))
+; (null (aref syntax-vec 2)))
+; (with-current-buffer (get-buffer-create "IDL_XML_catalog_complaints")
+; (if class
+; (insert (format "Missing SYNTAX entry for %s::%s\n" class name))
+; (insert (message "Missing SYNTAX entry for %s\n" name)))))
+
+ ;; Executive commands are treated specially
+ (if (aref syntax-vec 2)
+ (cons (substring name 1) link)
+ (if extra-kws (setq kwds (nconc kwds extra-kws)))
+ (setq kwds (idlwave-rinfo-group-keywords kwds link))
+ (loop for idx from 0 to 1 do
+ (if (aref syntax-vec idx)
+ (push (append (list name (if (eq idx 0) 'pro 'fun)
+ class '(system)
+ (idlwave-shorten-syntax
+ (aref syntax-vec idx) name class))
+ kwds) result)))
+ result)))
+
+
+(defun idlwave-rinfo-group-keywords (kwds master-link)
+ ;; Group keywords by link file, as a list with elements
+ ;; (linkfile ( ("KWD1" . link1) ("KWD2" . link2))
+ (let (kwd link anchor linkfiles block master-elt)
+ (while kwds
+ (setq kwd (car kwds)
+ link (idlwave-split-link-target (nth 1 kwd))
+ anchor (cdr link)
+ link (car link)
+ kwd (car kwd))
+ (if (setq block (assoc link linkfiles))
+ (push (cons kwd anchor) (cdr block))
+ (push (list link (cons kwd anchor)) linkfiles))
+ (setq kwds (cdr kwds)))
+ ;; Ensure the master link is there
+ (if (setq master-elt (assoc master-link linkfiles))
+ (if (eq (car linkfiles) master-elt)
+ linkfiles
+ (cons master-elt (delq master-elt linkfiles)))
+ (push (list master-link) linkfiles))))
+
+(defun idlwave-convert-xml-clean-statement-aliases (aliases)
+ ;; Clean up the syntax of routines which are actually aliases by
+ ;; removing the "OR" from the statements
+ (let (syntax entry)
+ (loop for x in aliases do
+ (setq entry (assoc x idlwave-system-routines))
+ (when entry
+ (while (string-match " +or +" (setq syntax (nth 4 entry)))
+ (setf (nth 4 entry) (replace-match ", " t t syntax)))))))
+
+(defun idlwave-convert-xml-clean-routine-aliases (aliases)
+ ;; Duplicate and trim original routine aliases from rinfo list
+ ;; This if for, e.g. OPENR/OPENW/OPENU
+ (let (alias remove-list new parts all-parts)
+ (loop for x in aliases do
+ (when (setq parts (split-string (cdr x) "/"))
+ (setq new (assoc (cdr x) all-parts))
+ (unless new
+ (setq new (cons (cdr x) parts))
+ (push new all-parts))
+ (setcdr new (delete (car x) (cdr new)))))
+
+ ;; Add any missing aliases (separate by slashes)
+ (loop for x in all-parts do
+ (if (cdr x)
+ (push (cons (nth 1 x) (car x)) aliases)))
+
+ (loop for x in aliases do
+ (when (setq alias (assoc (cdr x) idlwave-system-routines))
+ (unless (memq alias remove-list) (push alias remove-list))
+ (setq alias (copy-sequence alias))
+ (setcar alias (car x))
+ (push alias idlwave-system-routines)))
+ (loop for x in remove-list do
+ (delq x idlwave-system-routines))))
+
+(defun idlwave-convert-xml-clean-sysvar-aliases (aliases)
+ ;; Duplicate and trim original routine aliases from rinfo list
+ ;; This if for, e.g. !X, !Y, !Z.
+ (let (alias remove-list new parts all-parts)
+ (loop for x in aliases do
+ (when (setq alias (assoc (cdr x) idlwave-system-variables-alist))
+ (unless (memq alias remove-list) (push alias remove-list))
+ (setq alias (copy-sequence alias))
+ (setcar alias (car x))
+ (push alias idlwave-system-variables-alist)))
+ (loop for x in remove-list do
+ (delq x idlwave-system-variables-alist))))
+
+
+(defun idlwave-xml-create-sysvar-alist (xml-entry)
+ ;; Create a sysvar list entry from the xml parsed list.
+ (let* ((nameblock (nth 1 xml-entry))
+ (name (cdr (assq 'name nameblock)))
+ (sysvar (substring name (progn (string-match "^ *!" name)
+ (match-end 0))))
+ (link (cdr (assq 'link nameblock)))
+ (params (cddr xml-entry))
+ (case-fold-search t)
+ pelem ptype props fields tags)
+ (while params
+ (setq pelem (car params))
+ (when (listp pelem)
+ (setq ptype (car pelem)
+ props (car (cdr pelem)))
+ (cond
+ ((eq ptype 'FIELD)
+ (push (cons (cdr (assq 'name props))
+ (cdr
+ (idlwave-split-link-target (cdr (assq 'link props)))))
+ tags))))
+ (setq params (cdr params)))
+ (delq nil
+ (list sysvar (if tags (cons 'tags tags)) (list 'link link)))))
+
+
+(defvar idlwave-xml-routine-info-file nil)
+
+(defun idlwave-save-routine-info ()
+ (if idlwave-xml-routine-info-file
+ (with-temp-file idlwave-xml-system-rinfo-converted-file
+ (insert
+ (concat ";; *-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*-*
+;; IDLWAVE Routine Information File (IDLWAVE version " idlwave-mode-version ")
+;; Automatically generated from source file:
+;; " idlwave-xml-routine-info-file "
+;; on " (current-time-string) "
+;; Do not edit."))
+ (insert (format "\n(setq idlwave-xml-routine-info-file \n \"%s\")"
+ idlwave-xml-routine-info-file))
+ (insert "\n(setq idlwave-system-routines\n '")
+ (prin1 idlwave-system-routines (current-buffer))
+ (insert ")")
+ (insert "\n(setq idlwave-system-variables-alist\n '")
+ (prin1 idlwave-system-variables-alist (current-buffer))
+ (insert ")")
+ (insert "\n(setq idlwave-system-class-info\n '")
+ (prin1 idlwave-system-class-info (current-buffer))
+ (insert ")")
+ (insert "\n(setq idlwave-executive-commands-alist\n '")
+ (prin1 idlwave-executive-commands-alist (current-buffer))
+ (insert ")")
+ (insert "\n(setq idlwave-help-special-topic-words\n '")
+ (prin1 idlwave-help-special-topic-words (current-buffer))
+ (insert ")"))))
+
+(defun idlwave-convert-xml-system-routine-info ()
+ "Convert XML supplied IDL routine info into internal form.
+Cache to disk for quick recovery."
+ (interactive)
+ (let* ((dir (file-name-as-directory
+ (expand-file-name "help/online_help" (idlwave-sys-dir))))
+ (catalog-file (expand-file-name "idl_catalog.xml" dir))
+ (elem-cnt 0)
+ props rinfo msg-cnt elem type nelem class-result alias
+ routines routine-aliases statement-aliases sysvar-aliases
+ version-string)
+ (if (not (file-exists-p catalog-file))
+ (error "No such XML routine info file: %s" catalog-file)
+ (if (not (file-readable-p catalog-file))
+ (error "Cannot read XML routine info file: %s" catalog-file)))
+ (require 'xml)
+ (message "Reading XML routine info...")
+ (setq rinfo (xml-parse-file catalog-file))
+ (message "Reading XML routine info...done")
+ (setq rinfo (assq 'CATALOG rinfo))
+ (unless rinfo (error "Failed to parse XML routine info"))
+ ;;(setq rinfo (car rinfo)) ; Skip the catalog stuff.
+
+ (setq version-string (cdr (assq 'version (nth 1 rinfo)))
+ rinfo (cddr rinfo))
+
+ (setq nelem (length rinfo)
+ msg-cnt (/ nelem 20))
+
+ (setq idlwave-xml-routine-info-file nil)
+ (message "Converting XML routine info...")
+ (setq idlwave-system-routines nil
+ idlwave-system-variables-alist nil
+ idlwave-system-class-info nil
+ idlwave-executive-commands-alist nil
+ idlwave-help-special-topic-words nil)
+
+ (while rinfo
+ (setq elem (car rinfo)
+ rinfo (cdr rinfo))
+ (incf elem-cnt)
+ (when (listp elem)
+ (setq type (car elem)
+ props (car (cdr elem)))
+ (if (= (mod elem-cnt msg-cnt) 0)
+ (message "Converting XML routine info...%2d%%"
+ (/ (* elem-cnt 100) nelem)))
+ (cond
+ ((eq type 'ROUTINE)
+ (if (setq alias (assq 'alias_to props))
+ (push (cons (cdr (assq 'name props)) (cdr alias))
+ routine-aliases)
+ (setq routines (idlwave-xml-create-rinfo-list elem))
+ (if (listp (cdr routines))
+ (setq idlwave-system-routines
+ (nconc idlwave-system-routines routines))
+ ;; a cons cell is an executive commands
+ (push routines idlwave-executive-commands-alist))))
+
+ ((eq type 'CLASS)
+ (setq class-result (idlwave-xml-create-class-method-lists elem))
+ (push (car class-result) idlwave-system-class-info)
+ (setq idlwave-system-routines
+ (nconc idlwave-system-routines (cdr class-result))))
+
+ ((eq type 'STATEMENT)
+ (push (cons (cdr (assq 'name props))
+ (cdr (assq 'link props)))
+ idlwave-help-special-topic-words)
+ ;; Save the links to those which are statement aliases (not routines)
+ (if (setq alias (assq 'alias_to props))
+ (unless (member (cdr alias) statement-aliases)
+ (push (cdr alias) statement-aliases))))
+
+ ((eq type 'SYSVAR)
+ (if (setq alias (cdr (assq 'alias_to props)))
+ (push (cons (substring (cdr (assq 'name props)) 1)
+ (substring alias 1))
+ sysvar-aliases)
+ (push (idlwave-xml-create-sysvar-alist elem)
+ idlwave-system-variables-alist)))
+ (t))))
+ (idlwave-convert-xml-clean-routine-aliases routine-aliases)
+ (idlwave-convert-xml-clean-statement-aliases statement-aliases)
+ (idlwave-convert-xml-clean-sysvar-aliases sysvar-aliases)
+
+ (setq idlwave-xml-routine-info-file catalog-file)
+ (idlwave-save-routine-info)
+ (message "Converting XML routine info...done")))
+
+
+;; ("ROUTINE" type class
+;; (system) | (lib pro_file dir "LIBNAME") | (user pro_file dir "USERLIB") |
+;; (buffer pro_file dir) | (compiled pro_file dir)
+;; "calling_string" ("HELPFILE" (("KWD1" . link1) ...))
+;; ("HELPFILE2" (("KWD2" . link) ...)) ...)
+
+
(defun idlwave-load-rinfo-next-step ()
(let ((inhibit-quit t)
(arr idlwave-load-rinfo-steps-done))
- (when (catch 'exit
+ (if (catch 'exit
(when (not (aref arr 0))
- (message "Loading idlw-rinfo.el in idle time...")
- (load "idlw-rinfo" 'noerror 'nomessage)
- (message "Loading idlw-rinfo.el in idle time...done")
+ (message "Loading system routine info in idle time...")
+ (idlwave-load-system-routine-info)
+ ;;(load "idlw-rinfo" 'noerror 'nomessage)
+ (message "Loading system routine info in idle time...done")
(aset arr 0 t)
(throw 'exit t))
+
(when (not (aref arr 1))
(message "Normalizing idlwave-system-routines in idle time...")
(idlwave-reset-sintern t)
(message "Normalizing idlwave-system-routines in idle time...done")
(aset arr 1 t)
(throw 'exit t))
+
(when (not (aref arr 2))
(when (and (stringp idlwave-user-catalog-file)
(file-regular-p idlwave-user-catalog-file))
(progn
(setq idlwave-library-routines nil)
(ding)
- (message "Outdated user catalog: %s... recreate"
+ (message "Outdated user catalog: %s... recreate"
idlwave-user-catalog-file))
- (message "Loading user catalog in idle time...done"))
- (aset arr 2 t)
- (throw 'exit t)))
+ (message "Loading user catalog in idle time...done")))
+ (aset arr 2 t)
+ (throw 'exit t))
+
(when (not (aref arr 3))
(when idlwave-user-catalog-routines
(message "Normalizing user catalog routines in idle time...")
- (setq idlwave-user-catalog-routines
+ (setq idlwave-user-catalog-routines
(idlwave-sintern-rinfo-list
idlwave-user-catalog-routines 'sys))
- (message
+ (message
"Normalizing user catalog routines in idle time...done"))
(aset arr 3 t)
(throw 'exit t))
+
(when (not (aref arr 4))
- (idlwave-scan-library-catalogs
+ (idlwave-scan-library-catalogs
"Loading and normalizing library catalogs in idle time...")
(aset arr 4 t)
(throw 'exit t))
(message "Finishing initialization in idle time...")
(idlwave-routines)
(message "Finishing initialization in idle time...done")
+ (aset arr 5 t)
(throw 'exit nil)))
;; restart the timer
(if (sit-for 1)
idlwave-init-rinfo-when-idle-after
nil 'idlwave-load-rinfo-next-step))))))
-(defun idlwave-load-system-rinfo (&optional force)
- ;; Load and case-treat the system and catalog files.
+(defun idlwave-load-all-rinfo (&optional force)
+ ;; Load and case-treat the system, user catalog, and library routine
+ ;; info files.
+
+ ;; System
(when (or force (not (aref idlwave-load-rinfo-steps-done 0)))
- (load "idlw-rinfo" 'noerror 'nomessage))
+ ;;(load "idlw-rinfo" 'noerror 'nomessage))
+ (idlwave-load-system-routine-info))
(when (or force (not (aref idlwave-load-rinfo-steps-done 1)))
(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 idlwave-system-routines
+ (setq idlwave-routines (copy-sequence idlwave-system-routines))
+ (setq idlwave-last-system-routine-info-cons-cell
+ (nthcdr (1- (length idlwave-routines)) idlwave-routines)))
+
+ ;; User catalog
(when (and (stringp idlwave-user-catalog-file)
(file-regular-p idlwave-user-catalog-file))
(condition-case nil
(when (or force (not (aref idlwave-load-rinfo-steps-done 2)))
(load-file idlwave-user-catalog-file))
(error nil))
- (when (boundp 'idlwave-library-routines)
+ (when (and
+ (boundp 'idlwave-library-routines)
+ idlwave-library-routines)
(setq idlwave-library-routines nil)
- (error "Outdated user catalog: %s... recreate" idlwave-user-catalog-file))
+ (error "Outdated user catalog: %s... recreate"
+ idlwave-user-catalog-file))
(setq idlwave-true-path-alist nil)
(when (or force (not (aref idlwave-load-rinfo-steps-done 3)))
(message "Normalizing user catalog routines...")
- (setq idlwave-user-catalog-routines
- (idlwave-sintern-rinfo-list
+ (setq idlwave-user-catalog-routines
+ (idlwave-sintern-rinfo-list
idlwave-user-catalog-routines 'sys))
(message "Normalizing user catalog routines...done")))
+
+ ;; Library catalog
(when (or force (not (aref idlwave-load-rinfo-steps-done 4)))
(idlwave-scan-library-catalogs
"Loading and normalizing library catalogs..."))
(defun idlwave-update-buffer-routine-info ()
(let (res)
- (cond
+ (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
+ (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 (idlwave-get-routine-info-from-buffers
(list (current-buffer))))))))
;; Put the result into the correct variable
- (setq idlwave-buffer-routines
+ (setq idlwave-buffer-routines
(idlwave-sintern-rinfo-list res 'set))))
(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
+ ;; 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, they are meant to be different.
(setcdr idlwave-last-system-routine-info-cons-cell
;; Give a message with information about the number of routines we have.
(unless quiet
- (message
+ (message
"Routines Found: buffer(%d) compiled(%d) library(%d) user(%d) system(%d)"
(length idlwave-buffer-routines)
(length idlwave-compiled-routines)
(when (and (setq class (nth 2 x))
(not (assq class idlwave-class-alist)))
(push (list class) idlwave-class-alist)))
- idlwave-class-alist)))
+ idlwave-class-alist)))
;; Three functions for the hooks
(defun idlwave-save-buffer-update ()
(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)
+ (let ((list idlwave-buffer-routines)
found)
(while list
;; The following test uses eq to make sure it works correctly
(setcar list nil)
(setq found t))
(if found
- ;; End of that section reached. Jump.
+ ;; End of that section reached. Jump.
(setq list nil)))
(setq list (cdr list)))
(setq idlwave-buffer-routines
(save-restriction
(widen)
(goto-char (point-min))
- (while (re-search-forward
+ (while (re-search-forward
"^[ \t]*\\(pro\\|function\\)[ \t]" nil t)
(setq string (buffer-substring-no-properties
(match-beginning 0)
- (progn
+ (progn
(idlwave-end-of-statement)
(point))))
(setq entry (idlwave-parse-definition string))
(push (match-string 1 string) args)))
;; Normalize and sort.
(setq args (nreverse args))
- (setq keywords (sort keywords (lambda (a b)
+ (setq keywords (sort keywords (lambda (a b)
(string< (downcase a) (downcase b)))))
;; Make and return the entry
;; We don't know which argument are optional, so this information
class
(cond ((not (boundp 'idlwave-scanning-lib))
(list 'buffer (buffer-file-name)))
-; ((string= (downcase
+; ((string= (downcase
; (file-name-sans-extension
; (file-name-nondirectory (buffer-file-name))))
; (downcase name))
; (t (cons 'lib (file-name-nondirectory (buffer-file-name))))
(t (list 'user (file-name-nondirectory (buffer-file-name))
idlwave-scanning-lib-dir "UserLib")))
- (concat
+ (concat
(if (string= type "function") "Result = " "")
(if class "Obj ->[%s::]" "")
"%s"
(defun idlwave-sys-dir ()
"Return the syslib directory, or a dummy that never matches."
- (if (string= idlwave-system-directory "")
- "@@@@@@@@"
- idlwave-system-directory))
+ (cond
+ ((and idlwave-system-directory
+ (not (string= idlwave-system-directory "")))
+ idlwave-system-directory)
+ ((getenv "IDL_DIR"))
+ (t "@@@@@@@@")))
-(defvar idlwave-shell-path-query)
(defun idlwave-create-user-catalog-file (&optional arg)
"Scan all files on selected dirs of IDL search path for routine information.
(> (length idlwave-user-catalog-file) 0)
(file-accessible-directory-p
(file-name-directory idlwave-user-catalog-file))
- (not (string= "" (file-name-nondirectory
+ (not (string= "" (file-name-nondirectory
idlwave-user-catalog-file))))
(error "`idlwave-user-catalog-file' does not point to a file in an accessible directory"))
-
+
(cond
;; Rescan the known directories
((and arg idlwave-path-alist
;; Expand the directories from library-path and run the widget
(idlwave-library-path
(idlwave-display-user-catalog-widget
- (if idlwave-true-path-alist
+ (if idlwave-true-path-alist
;; Propagate any flags on the existing path-alist
(mapcar (lambda (x)
(let ((path-entry (assoc (file-truename x)
idlwave-true-path-alist)))
(if path-entry
- (cons x (cdr path-entry))
+ (cons x (cdr path-entry))
(list x))))
(idlwave-expand-path idlwave-library-path))
(mapcar 'list (idlwave-expand-path idlwave-library-path)))))
(idlwave-scan-library-catalogs "Locating library catalogs..." 'no-load)
(idlwave-display-user-catalog-widget idlwave-path-alist)))
-(defconst idlwave-user-catalog-widget-help-string
+(defconst idlwave-user-catalog-widget-help-string
"This is the front-end to the creation of the IDLWAVE user catalog.
Please select the directories on IDL's search path from which you
would like to extract routine information, to be stored in the file:
(make-local-variable 'idlwave-widget)
(widget-insert (format idlwave-user-catalog-widget-help-string
idlwave-user-catalog-file))
-
+
(widget-create 'push-button
:notify 'idlwave-widget-scan-user-lib-files
"Scan & Save")
"Delete File")
(widget-insert " ")
(widget-create 'push-button
- :notify
+ :notify
'(lambda (&rest ignore)
(let ((path-list (widget-get idlwave-widget :path-dirs)))
(mapcar (lambda (x)
"Select All Non-Lib")
(widget-insert " ")
(widget-create 'push-button
- :notify
+ :notify
'(lambda (&rest ignore)
(let ((path-list (widget-get idlwave-widget :path-dirs)))
(mapcar (lambda (x)
(widget-insert "\n\n")
(widget-insert "Select Directories: \n")
-
+
(setq idlwave-widget
(apply 'widget-create
'checklist
- :value (delq nil (mapcar (lambda (x)
- (if (memq 'user (cdr x))
+ :value (delq nil (mapcar (lambda (x)
+ (if (memq 'user (cdr x))
(car x)))
dirs-list))
:greedy t
:tag "List of directories"
- (mapcar (lambda (x)
- (list 'item
+ (mapcar (lambda (x)
+ (list 'item
(if (memq 'lib (cdr x))
(concat "[LIB] " (car x) )
(car x)))) dirs-list)))
(widget-setup)
(goto-char (point-min))
(delete-other-windows))
-
+
(defun idlwave-delete-user-catalog-file (&rest ignore)
(if (yes-or-no-p
(format "Delete file %s " idlwave-user-catalog-file))
(this-path-alist path-alist)
dir-entry)
(while (setq dir-entry (pop this-path-alist))
- (if (member
+ (if (member
(if (memq 'lib (cdr dir-entry))
(concat "[LIB] " (car dir-entry))
(car dir-entry))
;; Define the routine info list
(insert "\n(setq idlwave-user-catalog-routines\n '(")
(let ((standard-output (current-buffer)))
- (mapcar (lambda (x)
- (insert "\n ")
- (prin1 x)
- (goto-char (point-max)))
- idlwave-user-catalog-routines))
+ (mapc (lambda (x)
+ (insert "\n ")
+ (prin1 x)
+ (goto-char (point-max)))
+ idlwave-user-catalog-routines))
(insert (format "))\n\n;;; %s ends here\n"
(file-name-nondirectory idlwave-user-catalog-file)))
(goto-char (point-min))
;; Define the variable which knows the value of "!DIR"
(insert (format "\n(setq idlwave-system-directory \"%s\")\n"
idlwave-system-directory))
-
+
;; Define the variable which contains a list of all scanned directories
(insert "\n(setq idlwave-path-alist\n '(")
(let ((standard-output (current-buffer)))
- (mapcar (lambda (x)
- (insert "\n ")
- (prin1 x)
- (goto-char (point-max)))
- idlwave-path-alist))
+ (mapc (lambda (x)
+ (insert "\n ")
+ (prin1 x)
+ (goto-char (point-max)))
+ idlwave-path-alist))
(insert "))\n")
(save-buffer 0)
(kill-buffer (current-buffer))))
(when (file-directory-p dir)
(setq files (nreverse (directory-files dir t "[^.]")))
(while (setq file (pop files))
- (if (file-directory-p file)
+ (if (file-directory-p file)
(push (file-name-as-directory file) path)))
(push dir path1)))
path1))
;;----- Scanning the library catalogs ------------------
+
+
+
(defun idlwave-scan-library-catalogs (&optional message-base no-load)
- "Scan for library catalog files (.idlwave_catalog) and ingest.
+ "Scan for library catalog files (.idlwave_catalog) and ingest.
All directories on `idlwave-path-alist' (or `idlwave-library-path'
instead, if present) are searched. Print MESSAGE-BASE along with the
NO-LOAD is non-nil. The variable `idlwave-use-library-catalogs' can
be set to nil to disable library catalog scanning."
(when idlwave-use-library-catalogs
- (let ((dirs
+ (let ((dirs
(if idlwave-library-path
(idlwave-expand-path idlwave-library-path)
(mapcar 'car idlwave-path-alist)))
(if message-base (message message-base))
(while (setq dir (pop dirs))
(catch 'continue
- (when (file-readable-p
+ (when (file-readable-p
(setq catalog (expand-file-name ".idlwave_catalog" dir)))
(unless no-load
(setq idlwave-library-catalog-routines nil)
(condition-case nil
(load catalog t t t)
(error (throw 'continue t)))
- (when (and
- message-base
- (not (string= idlwave-library-catalog-libname
+ (when (and
+ message-base
+ (not (string= idlwave-library-catalog-libname
old-libname)))
- (message (concat message-base
- idlwave-library-catalog-libname))
+ (message "%s" (concat message-base
+ idlwave-library-catalog-libname))
(setq old-libname idlwave-library-catalog-libname))
(when idlwave-library-catalog-routines
(setq all-routines
- (append
+ (append
(idlwave-sintern-rinfo-list
idlwave-library-catalog-routines 'sys dir)
all-routines))))
-
+
;; Add a 'lib flag if on path-alist
(when (and idlwave-path-alist
(setq dir-entry (assoc dir idlwave-path-alist)))
;;----- Communicating with the Shell -------------------
;; First, here is the idl program which can be used to query IDL for
-;; defined routines.
+;; defined routines.
(defconst idlwave-routine-info.pro
"
;; START OF IDLWAVE SUPPORT ROUTINES
+pro idlwave_print_safe,item,limit
+ catch,err
+ if err ne 0 then begin
+ print,'Could not print item.'
+ return
+ endif
+ if n_elements(item) gt limit then $
+ print,item[0:limit-1],'<... truncated at ',strtrim(limit,2),' elements>' $
+ else print,item
+end
+
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)
+ func = keyword_set(func)
methsep = strpos(name,'::')
meth = methsep ne -1
-
+
;; Get routine info
pars = routine_info(name,/parameters,functions=func)
source = routine_info(name,/source,functions=func)
nkw = pars.num_kw_args
if nargs gt 0 then args = pars.args
if nkw gt 0 then kwargs = pars.kw_args
-
+
;; Trim the class, and make the name
- if meth then begin
+ if meth then begin
class = strmid(name,0,methsep)
name = strmid(name,methsep+2,strlen(name)-1)
- if nargs gt 0 then begin
+ if nargs gt 0 then begin
;; remove the self argument
wh = where(args ne 'SELF',nargs)
if nargs gt 0 then args = args[wh]
;; No class, just a normal routine.
class = \"\"
endelse
-
+
;; Calling sequence
cs = \"\"
if func then cs = 'Result = '
kwstring = kwstring + ' ' + kwargs[j]
endfor
endif
-
+
ret=(['IDLWAVE-PRO','IDLWAVE-FUN'])[func]
-
+
print,ret + ': ' + name + sep + class + sep + source[0].path $
+ sep + cs + sep + kwstring
end
-pro idlwave_routine_info
+pro idlwave_routine_info,file
on_error,1
sep = '<@>'
print,'>>>BEGIN OF IDLWAVE ROUTINE INFO (\"' + sep + '\" IS THE SEPARATOR)'
all = routine_info()
- for i=0,n_elements(all)-1 do $
- idlwave_print_info_entry,all[i],separator=sep
+ fileQ=n_elements(file) ne 0
+ if fileQ then file=strtrim(file,2)
+ for i=0L,n_elements(all)-1L do begin
+ if fileQ then begin
+ if (routine_info(all[i],/SOURCE)).path eq file then $
+ idlwave_print_info_entry,all[i],separator=sep
+ endif else idlwave_print_info_entry,all[i],separator=sep
+ endfor
all = routine_info(/functions)
- for i=0,n_elements(all)-1 do $
- idlwave_print_info_entry,all[i],/func,separator=sep
+ for i=0L,n_elements(all)-1L do begin
+ if fileQ then begin
+ if (routine_info(all[i],/FUNCTIONS,/SOURCE)).path eq file then $
+ idlwave_print_info_entry,all[i],separator=sep,/FUNC
+ endif else idlwave_print_info_entry,all[i],separator=sep,/FUNC
+ endfor
print,'>>>END OF IDLWAVE ROUTINE INFO'
end
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
+ for i=0L,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)
if res then print,'IDLWAVE-CLASS-TAGS: '+class+' '+strjoin(tags,' ',/single)
end
;; END OF IDLWAVE SUPPORT ROUTINES
-"
+"
"The idl programs to get info from the shell.")
(defvar idlwave-idlwave_routine_info-compiled nil
(defvar idlwave-shell-temp-pro-file)
(defvar idlwave-shell-temp-rinfo-save-file)
-(defun idlwave-shell-update-routine-info (&optional quiet run-hooks wait)
- "Query the shell for routine_info of compiled modules and update the lists."
- ;; 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 particular,
- ;; .RESET_SESSION will kill all user procedures.
+
+(defun idlwave-shell-compile-helper-routines (&optional wait)
(unless (and idlwave-idlwave_routine_info-compiled
(file-readable-p (idlwave-shell-temp-file 'rinfo)))
(save-excursion
(erase-buffer)
(insert idlwave-routine-info.pro)
(save-buffer 0))
- (idlwave-shell-send-command
- (concat ".run " idlwave-shell-temp-pro-file)
+ (idlwave-shell-send-command
+ (concat ".run \"" idlwave-shell-temp-pro-file "\"")
nil 'hide wait)
-; (message "SENDING SAVE") ; ????????????????????????
(idlwave-shell-send-command
- (format "save,'idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
+ (format "save,'idlwave_print_safe','idlwave_routine_info','idlwave_print_info_entry','idlwave_get_class_tags','idlwave_get_sysvars',FILE='%s',/ROUTINES"
(idlwave-shell-temp-file 'rinfo))
- nil 'hide wait))
+ nil 'hide)
+ (setq idlwave-idlwave_routine_info-compiled t))
- ;; Restore and execute the procedure, analyze the output
-; (message "SENDING RESTORE & EXECUTE") ; ????????????????????????
+ ;; Restore if necessary. Must use execute to hide lame routine_info
+ ;; errors on undefinded routine
(idlwave-shell-send-command
- (format "RESTORE, '%s' & idlwave_routine_info"
+ (format "if execute(\"_v=routine_info('idlwave_routine_info',/SOURCE)\") eq 0 then restore,'%s' else if _v.path eq '' then restore,'%s'"
+ idlwave-shell-temp-rinfo-save-file
idlwave-shell-temp-rinfo-save-file)
+ nil 'hide))
+
+
+(defun idlwave-shell-update-routine-info (&optional quiet run-hooks wait file)
+ "Query the shell for routine_info of compiled modules and update the lists."
+ ;; Save and compile the procedure. The compiled procedure is then
+ ;; saved into an IDL SAVE file, to allow for fast RESTORE. We may
+ ;; need to test for and possibly RESTORE the procedure each time we
+ ;; use it, since the user may have killed or redefined it. In
+ ;; particular, .RESET_SESSION will kill all user procedures. If
+ ;; FILE is set, only update routine info for routines in that file.
+
+ (idlwave-shell-compile-helper-routines wait)
+ ; execute the routine_info procedure, and analyze the output
+ (idlwave-shell-send-command
+ (format "idlwave_routine_info%s" (if file (concat ",'" file "'") ""))
`(progn
(idlwave-shell-routine-info-filter)
(idlwave-concatenate-rinfo-lists ,quiet ,run-hooks))
(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
+This function is smart and figures out what can be completed
at this point.
- At the beginning of a statement it completes procedure names.
- In the middle of a statement it completes function names.
(completion-regexp-list
(if (equal arg '(16))
(list (read-string (concat "Completion Regexp: "))))))
-
+
(if (and module (string-match "::" module))
(setq class (substring module 0 (match-beginning 0))
module (substring module (match-end 0))))
;; Check for any special completion functions
((and idlwave-complete-special
(idlwave-call-special idlwave-complete-special)))
-
+
((null what)
(error "Nothing to complete here"))
(idlwave-all-class-inherits class-selector)))
(isa (concat "procedure" (if class-selector "-method" "")))
(type-selector 'pro))
- (setq idlwave-completion-help-info
+ (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)
(format "Select a %s name%s"
isa
(if class-selector
- (format " (class is %s)"
- (if (eq class-selector t)
+ (format " (class is %s)"
+ (if (eq class-selector t)
"unknown" class-selector))
""))
isa
(idlwave-all-class-inherits class-selector)))
(isa (concat "function" (if class-selector "-method" "")))
(type-selector 'fun))
- (setq idlwave-completion-help-info
+ (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)
(format "Select a %s name%s"
isa
(if class-selector
- (format " (class is %s)"
+ (format " (class is %s)"
(if (eq class-selector t)
"unknown" class-selector))
""))
(isa (format "procedure%s-keyword" (if class "-method" "")))
(entry (idlwave-best-rinfo-assq
name 'pro class (idlwave-routines)))
+ (system (if entry (eq (car (nth 3 entry)) 'system)))
(list (idlwave-entry-keywords entry 'do-link)))
(unless (or entry (eq class t))
(error "Nothing known about procedure %s"
(idlwave-make-full-name class name)))
- (setq list (idlwave-fix-keywords name 'pro class list super-classes))
- (unless list (error (format "No keywords available for procedure %s"
- (idlwave-make-full-name class name))))
- (setq idlwave-completion-help-info
+ (setq list (idlwave-fix-keywords name 'pro class list
+ super-classes system))
+ (unless list (error "No keywords available for procedure %s"
+ (idlwave-make-full-name class name)))
+ (setq idlwave-completion-help-info
(list 'keyword name type-selector class-selector entry super-classes))
(idlwave-complete-in-buffer
'keyword 'keyword list nil
(format "Select keyword for procedure %s%s"
(idlwave-make-full-name class name)
(if (or (member '("_EXTRA") list)
- (member '("_REF_EXTRA") list))
+ (member '("_REF_EXTRA") list))
" (note _EXTRA)" ""))
isa
'idlwave-attach-keyword-classes)))
(isa (format "function%s-keyword" (if class "-method" "")))
(entry (idlwave-best-rinfo-assq
name 'fun class (idlwave-routines)))
+ (system (if entry (eq (car (nth 3 entry)) 'system)))
(list (idlwave-entry-keywords entry 'do-link))
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 super-classes))
+ (setq list (idlwave-fix-keywords name 'fun class list
+ super-classes system))
;; 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"
- msg-name)))
- (setq idlwave-completion-help-info
+ (unless list (error "No keywords available for function %s"
+ 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" msg-name
(if (or (member '("_EXTRA") list)
- (member '("_REF_EXTRA") list))
+ (member '("_REF_EXTRA") list))
" (note _EXTRA)" ""))
isa
'idlwave-attach-keyword-classes)))
("class")))
(module (idlwave-sintern-routine-or-method module class))
(class (idlwave-sintern-class class))
- (what (cond
+ (what (cond
((equal what 0)
(setq what
- (intern (completing-read
+ (intern (completing-read
"Complete what? " what-list nil t))))
((integerp what)
(setq what (intern (car (nth (1- what) what-list)))))
(symbolp what)
(assoc (symbol-name what) what-list))
what)
- (t (error "Illegal WHAT"))))
+ (t (error "Invalid WHAT"))))
(nil-list '(nil nil nil nil))
(class-list (list nil nil (or class t) nil)))
(super-classes nil)
(type-selector 'pro)
(pro (or module
- (idlwave-completing-read
+ (idlwave-completing-read
"Procedure: " (idlwave-routines) 'idlwave-selector))))
(setq pro (idlwave-sintern-routine pro))
(list nil-list nil-list 'procedure-keyword
(super-classes nil)
(type-selector 'fun)
(func (or module
- (idlwave-completing-read
+ (idlwave-completing-read
"Function: " (idlwave-routines) 'idlwave-selector))))
(setq func (idlwave-sintern-routine func))
(list nil-list nil-list 'function-keyword
((eq what 'class)
(list nil-list nil-list 'class nil-list nil))
-
- (t (error "Illegal value for WHAT")))))
+
+ (t (error "Invalid value for WHAT")))))
(defun idlwave-completing-read (&rest args)
;; Completing read, case insensitive
(stringp idlwave-shell-default-directory)
(file-directory-p idlwave-shell-default-directory))
idlwave-shell-default-directory
- default-directory)))
+ default-directory)))
(comint-dynamic-complete-filename)))
(defun idlwave-make-full-name (class name)
(defun idlwave-rinfo-assoc (name type class list)
"Like `idlwave-rinfo-assq', but sintern strings first."
- (idlwave-rinfo-assq
+ (idlwave-rinfo-assq
(idlwave-sintern-routine-or-method name class)
type (idlwave-sintern-class class) list))
(setq classes nil)))
rtn))
-(defun idlwave-best-rinfo-assq (name type class list &optional with-file
+(defun idlwave-best-rinfo-assq (name type class list &optional with-file
keep-system)
"Like `idlwave-rinfo-assq', but get all twins and sort, then return first.
If WITH-FILE is passed, find the best rinfo entry with a file
twins)))))
(car twins)))
-(defun idlwave-best-rinfo-assoc (name type class list &optional with-file
+(defun idlwave-best-rinfo-assoc (name type class list &optional with-file
keep-system)
"Like `idlwave-best-rinfo-assq', but sintern strings first."
(idlwave-best-rinfo-assq
(if (null method)
(mapcar 'car (idlwave-class-alist))
(let (rtn)
- (mapcar (lambda (x)
- (and (nth 2 x)
- (or (not type)
- (eq type (nth 1 x)))
- (push (nth 2 x) rtn)))
- (idlwave-all-assq method (idlwave-routines)))
+ (mapc (lambda (x)
+ (and (nth 2 x)
+ (or (not type)
+ (eq type (nth 1 x)))
+ (push (nth 2 x) rtn)))
+ (idlwave-all-assq method (idlwave-routines)))
(idlwave-uniquify rtn))))
(defun idlwave-all-method-keyword-classes (method keyword &optional type)
(null keyword))
nil
(let (rtn)
- (mapcar (lambda (x)
- (and (nth 2 x) ; non-nil class
- (or (not type) ; correct or unspecified type
- (eq type (nth 1 x)))
- (assoc keyword (idlwave-entry-keywords x))
- (push (nth 2 x) rtn)))
- (idlwave-all-assq method (idlwave-routines)))
+ (mapc (lambda (x)
+ (and (nth 2 x) ; non-nil class
+ (or (not type) ; correct or unspecified type
+ (eq type (nth 1 x)))
+ (assoc keyword (idlwave-entry-keywords x))
+ (push (nth 2 x) rtn)))
+ (idlwave-all-assq method (idlwave-routines)))
(idlwave-uniquify rtn))))
(defun idlwave-members-only (list club)
Must accept two arguments: `apos' and `info'")
(defun idlwave-determine-class (info type)
- ;; Determine the class of a routine call.
+ ;; Determine the class of a routine call.
;; INFO is the `cw-list' structure as returned by idlwave-where.
;; The second element in this structure is the class. When nil, we
;; return nil. When t, try to get the class from text properties at
(dassoc (cdr dassoc))
(t t)))
(arrow (and apos (string= (buffer-substring apos (+ 2 apos)) "->")))
- (is-self
+ (is-self
(and arrow
(save-excursion (goto-char apos)
(forward-word -1)
(setq class (or (nth 2 (idlwave-current-routine)) class)))
;; Before prompting, try any special class determination routines
- (when (and (eq t class)
+ (when (and (eq t class)
idlwave-determine-class-special
(not force-query))
- (setq special-class
+ (setq special-class
(idlwave-call-special idlwave-determine-class-special apos))
- (if special-class
+ (if special-class
(setq class (idlwave-sintern-class special-class)
store idlwave-store-inquired-class)))
-
+
;; Prompt for a class, if we need to
(when (and (eq class t)
(or force-query query))
- (setq class-alist
+ (setq class-alist
(mapcar 'list (idlwave-all-method-classes (car info) type)))
(setq class
(idlwave-sintern-class
(error "No classes available with method %s" (car info)))
((and (= (length class-alist) 1) (not force-query))
(car (car class-alist)))
- (t
+ (t
(setq store idlwave-store-inquired-class)
- (idlwave-completing-read
+ (idlwave-completing-read
(format "Class%s: " (if (stringp (car info))
(format " for %s method %s"
type (car info))
;; We have a real class here
(when (and store arrow)
(condition-case ()
- (add-text-properties
- apos (+ apos 2)
- `(idlwave-class ,class face ,idlwave-class-arrow-face
+ (add-text-properties
+ apos (+ apos 2)
+ `(idlwave-class ,class face ,idlwave-class-arrow-face
rear-nonsticky t))
(error nil)))
(setf (nth 2 info) class))
(defun idlwave-where ()
- "Find out where we are.
+ "Find out where we are.
The return value is a list with the following stuff:
\(PRO-LIST FUNC-LIST COMPLETE-WHAT CW-LIST LAST-CHAR)
PRO-LIST (PRO POINT CLASS ARROW)
FUNC-LIST (FUNC POINT CLASS ARROW)
COMPLETE-WHAT a symbol indicating what kind of completion makes sense here
-CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
+CW-LIST (PRO-OR-FUNC POINT CLASS ARROW) Like PRO-LIST, for what can
be completed here.
LAST-CHAR last relevant character before point (non-white non-comment,
not part of current identifier or leading slash).
CLASS: What class has the routine (nil=no, t=is method, but class unknown)
ARROW: Location of 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))
((string-match "\\`[ \t]*\\(pro\\|function\\)[ \t]+[a-zA-Z0-9_]*\\'"
match-string)
(setq cw 'class))
- ((string-match
- "\\`[ \t]*\\([a-zA-Z][a-zA-Z0-9$_]*\\)?\\'"
+ ((string-match
+ "\\`[ \t]*\\([a-zA-Z][a-zA-Z0-9$_]*\\)?\\'"
(if (> pro-point 0)
(buffer-substring pro-point (point))
match-string))
nil)
((string-match "OBJ_NEW([ \t]*['\"]\\([a-zA-Z0-9$_]*\\)?\\'"
match-string)
- (setq cw 'class))
+ (setq cw 'class))
((string-match "\\<inherits\\s-+\\([a-zA-Z0-9$_]*\\)?\\'"
match-string)
- (setq cw 'class))
- ((and func
+ (setq cw 'class))
+ ((and func
(> func-point pro-point)
(= func-level 1)
(memq last-char '(?\( ?,)))
;; searches to this point.
(catch 'exit
- (let (pos
+ (let (pos
func-point
(cnt 0)
func arrow-start class)
(setq pos (point))
(incf cnt)
(when (and (= (following-char) ?\()
- (re-search-backward
+ (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
+ (if (re-search-backward
"->[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\=" bound t)
(setq arrow-start (copy-marker (match-beginning 0))
class (or (match-string 2) t)))
- (throw
- 'exit
+ (throw
+ 'exit
(list
(idlwave-sintern-routine-or-method func class)
(idlwave-sintern-class class)
;; searches to this point.
(let ((pos (point)) pro-point
pro class arrow-start string)
- (save-excursion
+ (save-excursion
;;(idlwave-beginning-of-statement)
(idlwave-start-of-substatement 'pre)
(setq string (buffer-substring (point) pos))
- (if (string-match
+ (if (string-match
"\\`[ \t]*\\([a-zA-Z][a-zA-Z0-9$_]*\\)[ \t]*\\(,\\|\\'\\)" string)
(setq pro (match-string 1 string)
pro-point (+ (point) (match-beginning 1)))
(if (and (idlwave-skip-object)
(setq string (buffer-substring (point) pos))
- (string-match
- "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
+ (string-match
+ "\\`[ \t]*\\(->\\)[ \t]*\\(\\([a-zA-Z][a-zA-Z0-9$_]*\\)::\\)?\\([a-zA-Z][a-zA-Z0-9$_]*\\)?[ \t]*\\(,\\|\\(\\$\\s *\\(;.*\\)?\\)?$\\)"
string))
(setq pro (if (match-beginning 4)
(match-string 4 string))
(throw 'exit nil))))
(goto-char pos)
nil)))
-
+
(defun idlwave-last-valid-char ()
"Return the last character before point which is not white or a comment
and also not part of the current identifier. Since we do this in
((memq (preceding-char) '(?\; ?\$)) (throw 'exit nil))
((eq (preceding-char) ?\n)
(beginning-of-line 0)
- (if (looking-at "\\([^;\n]*\\)\\$[ \t]*\\(;[^\n]*\\)?\n")
+ (if (looking-at "\\([^\n]*\\)\\$[ \t]*\\(;[^\n]*\\)?\n")
;; continuation line
(goto-char (match-end 1))
(throw 'exit nil)))
((or (eq completion t)
(and (= 1 (length (setq all-completions
(idlwave-uniquify
- (all-completions part list
- (or special-selector
+ (all-completions part list
+ (or special-selector
selector))))))
(equal dpart dcompletion)))
;; This is already complete
(idlwave-after-successful-completion type slash beg)
(message "%s is already the complete %s" part isa)
nil)
- (t
+ (t
;; We cannot add something - offer a list.
(message "Making completion list...")
-
+
(unless idlwave-completion-help-links ; already set somewhere?
- (mapcar (lambda (x) ; Pass link prop through to highlight-linked
- (let ((link (get-text-property 0 'link (car x))))
- (if link
- (push (cons (car x) link)
- idlwave-completion-help-links))))
- list))
+ (mapc (lambda (x) ; Pass link prop through to highlight-linked
+ (let ((link (get-text-property 0 'link (car x))))
+ (if link
+ (push (cons (car x) link)
+ idlwave-completion-help-links))))
+ list))
(let* ((list all-completions)
;; "complete" means, this is already a valid completion
(complete (memq spart all-completions))
; (completion-fixup-function ; Emacs
; (lambda () (and (eq (preceding-char) ?>)
; (re-search-backward " <" beg t)))))
-
+
(setq list (sort list (lambda (a b)
(string< (downcase a) (downcase b)))))
(if prepare-display-function
idlwave-complete-empty-string-as-lower-case)
(not idlwave-completion-force-default-case))
(setq list (mapcar (lambda (x)
- (if (listp x)
+ (if (listp x)
(setcar x (downcase (car x)))
(setq x (downcase x)))
x)
(re-search-backward "\\<\\(pro\\|function\\)[ \t]+\\="
(- (point) 15) t)
(goto-char (point-min))
- (re-search-forward
+ (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, using list gathered from `idlwave-routines'
- (idlwave-complete-in-buffer
- 'class 'class (idlwave-class-alist) nil
+ (idlwave-complete-in-buffer
+ 'class 'class (idlwave-class-alist) nil
"Select a class" "class"
'(lambda (list) ;; Push it to help-links if system help available
(mapcar (lambda (x)
(let* ((entry (idlwave-class-info x))
(link (nth 1 (assq 'link entry))))
- (if link (push (cons x link)
+ (if link (push (cons x link)
idlwave-completion-help-links))
x))
list)))))
;; SHOW-CLASSES is the value of `idlwave-completion-show-classes'.
(if (or (null show-classes) ; don't want to see classes
(null class-selector) ; not a method call
- (and
+ (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
(max (abs show-classes))
(lmax (if do-dots (apply 'max (mapcar 'length list))))
classes nclasses class-info space)
- (mapcar
+ (mapcar
(lambda (x)
;; get the classes
(if (eq type 'class-tag)
;; Just one class for tags
(setq classes
- (list
+ (list
(idlwave-class-or-superclass-with-tag class-selector x)))
;; Multiple classes for method or method-keyword
(setq classes
method-selector x type-selector)
(idlwave-all-method-classes x type-selector)))
(if inherit
- (setq classes
+ (setq classes
(delq nil
(mapcar (lambda (x) (if (memq x inherit) x nil))
classes)))))
(defun idlwave-attach-class-tag-classes (list)
;; Call idlwave-attach-classes with class structure tags
(idlwave-attach-classes list 'class-tag idlwave-completion-show-classes))
-
+
;;----------------------------------------------------------------------
;;----------------------------------------------------------------------
((= 1 (length list))
(setq rtn (car list)))
((featurep 'xemacs)
- (if sort (setq list (sort list (lambda (a b)
+ (if sort (setq list (sort list (lambda (a b)
(string< (upcase a) (upcase b))))))
(setq menu
(append (list title)
(setq resp (get-popup-menu-response menu))
(funcall (event-function resp) (event-object resp)))
(t
- (if sort (setq list (sort list (lambda (a b)
+ (if sort (setq list (sort list (lambda (a b)
(string< (upcase a) (upcase b))))))
(setq menu (cons title
(list
(select-window win)
(eval idlwave-complete-after-success-form))
(set-window-start cwin (point-min)))))
- (and message (message message)))
+ (and message (message "%s" message)))
(select-window win))))
(defun idlwave-display-completion-list (list &optional message beg complete)
(setq idlwave-before-completion-wconf (current-window-configuration)))
(if (featurep 'xemacs)
- (idlwave-display-completion-list-xemacs
+ (idlwave-display-completion-list-xemacs
list)
(idlwave-display-completion-list-emacs list))
(run-hooks 'idlwave-completion-setup-hook)
;; Display the message
- (message (or message "Making completion list...done")))
+ (message "%s" (or message "Making completion list...done")))
(defun idlwave-choose (function &rest args)
"Call FUNCTION as a completion chooser and pass ARGS to it."
"Make the user select an element from the alist in the variable SYM.
The keys of the alist are expected to be strings. The function returns the
car of the selected association.
-To do this, PROMPT is displayed and and the user must hit a letter key to
+To do this, PROMPT is displayed and the user must hit a letter key to
select an entry. If the user does not reply within DELAY seconds, a help
window with the options is displayed automatically.
The key which is associated with each option is generated automatically.
(mapcar (lambda(x)
(princ (nth 1 x))
(princ "\n"))
- keys-alist))
+ keys-alist))
(setq char (read-char)))
(setq char (read-char)))
(message nil)
(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
+ (substitute-key-definition
'choose-completion 'idlwave-choose-completion new-map)
(substitute-key-definition
'mouse-choose-completion 'idlwave-mouse-choose-completion new-map)
;;
;; - 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.
+;; This could be in a separate file in the distribution, or
+;; in an appendix for the manual.
(defvar idlwave-struct-skip
"[ \t]*\\(\\$.*\n\\(^[ \t]*\\(\\$[ \t]*\\)?\\(;.*\\)?\n\\)*\\)?[ \t]*"
(beg (car borders))
(end (cdr borders))
(case-fold-search t))
- (re-search-forward (concat "\\(^[ \t]*\\|[,{][ \t]*\\)" tag "[ \t]*:")
+ (re-search-forward (concat "\\(^[ \t]*\\|[,{][ \t]*\\)" tag "[ \t]*:")
end t)))
(defun idlwave-struct-inherits ()
(goto-char beg)
(save-restriction
(narrow-to-region beg end)
- (while (re-search-forward
+ (while (re-search-forward
(concat "[{,]" ;leading comma/brace
idlwave-struct-skip ; 4 groups
"inherits" ; The INHERITS tag
(concat "\\<" (regexp-quote (downcase var)) "\\>" ws)
"\\(\\)")
"=" ws "\\({\\)"
- (if name
+ (if name
(if (stringp name)
- (concat ws "\\(\\<" (downcase name) "\\)[^a-zA-Z0-9_$]")
+ (concat ws "\\(\\<" (downcase name) "\\)[^a-zA-Z0-9_$]")
;; Just a generic name
(concat ws "\\<\\([a-zA-Z_0-9$]+\\)" ws ","))
""))))
(goto-char (match-beginning 3))
(match-string-no-properties 5)))))
-(defvar idlwave-class-info nil)
-(defvar idlwave-system-class-info nil) ; Gathered from idlw-rinfo
+(defvar idlwave-class-info nil)
(defvar idlwave-class-reset nil) ; to reset buffer-local classes
(add-hook 'idlwave-update-rinfo-hook
(let (list entry)
(if idlwave-class-info
(if idlwave-class-reset
- (setq
+ (setq
idlwave-class-reset nil
idlwave-class-info ; Remove any visited in a buffer
- (delq nil (mapcar
- (lambda (x)
- (let ((filebuf
- (idlwave-class-file-or-buffer
+ (delq nil (mapcar
+ (lambda (x)
+ (let ((filebuf
+ (idlwave-class-file-or-buffer
(or (cdr (assq 'found-in x)) (car x)))))
(if (cdr filebuf)
nil
(progn
;; For everything there
(setq end-lim (save-excursion (idlwave-end-of-subprogram) (point)))
- (while (setq name
+ (while (setq name
(idlwave-find-structure-definition nil t end-lim))
(funcall all-hook name)))
(idlwave-find-structure-definition nil (or alt-class class))))))
(insert-file-contents file))
(save-excursion
(goto-char 1)
- (idlwave-find-class-definition class
+ (idlwave-find-class-definition class
;; Scan all of the structures found there
(lambda (name)
(let* ((this-class (idlwave-sintern-class name))
- (entry
+ (entry
(list this-class
(cons 'tags (idlwave-struct-tags))
(cons 'inherits (idlwave-struct-inherits)))))
(condition-case err
(apply 'append (mapcar 'idlwave-class-tags
(cons class (idlwave-all-class-inherits class))))
- (error
+ (error
(idlwave-class-tag-reset)
(error "%s" (error-message-string err)))))
all-inherits))))))
(defun idlwave-entry-keywords (entry &optional record-link)
- "Return the flat entry keywords alist from routine-info entry.
+ "Return the flat entry keywords alist from routine-info entry.
If RECORD-LINK is non-nil, the keyword text is copied and a text
property indicating the link is added."
(let (kwds)
- (mapcar
- (lambda (key-list)
+ (mapc
+ (lambda (key-list)
(let ((file (car key-list)))
(mapcar (lambda (key-cons)
(let ((key (car key-cons))
(link (cdr key-cons)))
(when (and record-link file)
(setq key (copy-sequence key))
- (put-text-property
+ (put-text-property
0 (length key)
- 'link
- (concat
- file
- (if link
+ 'link
+ (concat
+ file
+ (if link
(concat idlwave-html-link-sep
(number-to-string link))))
key))
"Find keyword KEYWORD in entry ENTRY, and return (with link) if set"
(catch 'exit
(mapc
- (lambda (key-list)
+ (lambda (key-list)
(let ((file (car key-list))
(kwd (assoc keyword (cdr key-list))))
(when kwd
- (setq kwd (cons (car kwd)
+ (setq kwd (cons (car kwd)
(if (and file (cdr kwd))
- (concat file
+ (concat file
idlwave-html-link-sep
(number-to-string (cdr kwd)))
(cdr kwd))))
(defvar idlwave-current-class-tags nil)
(defvar idlwave-current-native-class-tags nil)
(defvar idlwave-sint-class-tags nil)
+(declare-function idlwave-sintern-class-tag "idlwave" t t)
(idlwave-new-sintern-type 'class-tag)
(add-to-list 'idlwave-complete-special 'idlwave-complete-class-structure-tag)
(add-hook 'idlwave-update-rinfo-hook 'idlwave-class-tag-reset)
;; Check if we need to update the "current" class
(if (not (equal class-selector idlwave-current-tags-class))
(idlwave-prepare-class-tag-completion class-selector))
- (setq idlwave-completion-help-info
+ (setq idlwave-completion-help-info
(list 'idlwave-complete-class-structure-tag-help
- (idlwave-sintern-routine
+ (idlwave-sintern-routine
(concat class-selector "__define"))
nil))
(let ((idlwave-cpl-bold idlwave-current-native-class-tags))
(idlwave-complete-in-buffer
- 'class-tag 'class-tag
+ 'class-tag 'class-tag
idlwave-current-class-tags nil
(format "Select a tag of class %s" class-selector)
"class tag"
(defvar idlwave-sint-sysvars nil)
(defvar idlwave-sint-sysvartags nil)
+(declare-function idlwave-sintern-sysvar "idlwave" t t)
+(declare-function idlwave-sintern-sysvartag "idlwave" t t)
(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-sintern-sysvar-alist)
-(defvar idlwave-executive-commands-alist nil
- "Alist of system variables and their help files.")
-
-(defvar idlwave-system-variables-alist nil
- "Alist of system variables and the associated structure tags.
-Gets set in `idlw-rinfo.el'.")
(defun idlwave-complete-sysvar-or-tag ()
"Complete a 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-complete-in-buffer 'sysvar 'sysvar
idlwave-system-variables-alist nil
"Select a system variable"
"system variable")
(or tags (error "System variable !%s is not a structure" var))
(setq idlwave-completion-help-info
(list 'idlwave-complete-sysvar-tag-help var))
- (idlwave-complete-in-buffer 'sysvartag 'sysvartag
+ (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 link) ;dynamic variables set by help callback
+(defvar props)
(defun idlwave-complete-sysvar-help (mode word)
(let ((word (or (nth 1 idlwave-completion-help-info) word))
(entry (assoc word idlwave-system-variables-alist)))
((eq mode 'test) ; we can at least link the main
(and (stringp word) entry main))
((eq mode 'set)
- (if entry
- (setq link
- (if (setq target (cdr (assoc word tags)))
+ (if entry
+ (setq link
+ (if (setq target (cdr (assoc-string word tags t)))
(idlwave-substitute-link-target main target)
main)))) ;; setting dynamic!!!
(t (error "This should not happen")))))
+(defun idlwave-split-link-target (link)
+ "Split a given link into link file and anchor."
+ (if (string-match idlwave-html-link-sep link)
+ (cons (substring link 0 (match-beginning 0))
+ (string-to-number (substring link (match-end 0))))))
+
(defun idlwave-substitute-link-target (link target)
"Substitute the target anchor for the given link."
(let (main-base)
;; Fake help in the source buffer for class structure tags.
;; KWD AND NAME ARE GLOBAL-VARIABLES HERE.
-(defvar name)
+(defvar name)
(defvar kwd)
(defvar idlwave-help-do-class-struct-tag nil)
(defun idlwave-complete-class-structure-tag-help (mode word)
nil)
((eq mode 'set)
(let (class-with found-in)
- (when (setq class-with
- (idlwave-class-or-superclass-with-tag
+ (when (setq class-with
+ (idlwave-class-or-superclass-with-tag
idlwave-current-tags-class
word))
- (if (assq (idlwave-sintern-class class-with)
+ (if (assq (idlwave-sintern-class class-with)
idlwave-system-class-info)
- (error "No help available for system class tags."))
+ (error "No help available for system class tags"))
(if (setq found-in (idlwave-class-found-in class-with))
(setq name (cons (concat found-in "__define") class-with))
(setq name (concat class-with "__define")))))
(defun idlwave-class-or-superclass-with-tag (class tag)
"Find and return the CLASS or one of its superclass with the
associated TAG, if any."
- (let ((sclasses (cons class (cdr (assq 'all-inherits
- (idlwave-class-info class)))))
+ (let ((sclasses (cons class (idlwave-all-class-inherits class)))
cl)
(catch 'exit
(while sclasses
(let ((tags (idlwave-class-tags cl)))
(while tags
(if (eq t (compare-strings tag 0 nil (car tags) 0 nil t))
- (throw 'exit cl))
+ (throw 'exit cl))
(setq tags (cdr tags))))))))
(setcar entry (idlwave-sintern-sysvar (car entry) 'set))
(setq tags (assq 'tags entry))
(if tags
- (setcdr tags
- (mapcar (lambda (x)
+ (setcdr tags
+ (mapcar (lambda (x)
(cons (idlwave-sintern-sysvartag (car x) 'set)
(cdr x)))
(cdr tags)))))))
text start)
(setq start (match-end 0)
var (match-string 1 text)
- tags (if (match-end 3)
+ tags (if (match-end 3)
(idlwave-split-string (match-string 3 text))))
;; Maintain old links, if present
(setq old-entry (assq (idlwave-sintern-sysvar var) old))
(setq link (assq 'link old-entry))
(setq idlwave-system-variables-alist
- (cons (list var
- (cons
- 'tags
- (mapcar (lambda (x)
- (cons x
- (cdr (assq
- (idlwave-sintern-sysvartag x)
+ (cons (list var
+ (cons
+ 'tags
+ (mapcar (lambda (x)
+ (cons x
+ (cdr (assq
+ (idlwave-sintern-sysvartag x)
(cdr (assq 'tags old-entry))))))
tags)) link)
idlwave-system-variables-alist)))
(defun idlwave-uniquify (list)
(let ((ht (make-hash-table :size (length list) :test 'equal)))
- (delq nil
+ (delq nil
(mapcar (lambda (x)
- (unless (gethash x ht)
+ (unless (gethash x ht)
(puthash x t ht)
x))
list))))
nil)))
;; Restore the pre-completion window configuration if this is safe.
-
- (if (or (eq verify 'force) ; force
- (and
+
+ (if (or (eq verify 'force) ; force
+ (and
(get-buffer-window "*Completions*") ; visible
- (idlwave-local-value 'idlwave-completion-p
+ (idlwave-local-value 'idlwave-completion-p
"*Completions*") ; cib-buffer
(eq (marker-buffer idlwave-completion-mark)
(current-buffer)) ; buffer OK
(if (string-match "\\(pro\\|function\\)[ \t]+\\(\\(.*\\)::\\)?\\(.*\\)"
resolve)
(setq type (match-string 1 resolve)
- class (if (match-beginning 2)
+ class (if (match-beginning 2)
(match-string 3 resolve)
nil)
name (match-string 4 resolve)))
(cond
((null class)
- (idlwave-shell-send-command
+ (idlwave-shell-send-command
(format "resolve_routine,'%s'%s" (downcase name) kwd)
'idlwave-update-routine-info
nil t))
(t
- (idlwave-shell-send-command
+ (idlwave-shell-send-command
(format "resolve_routine,'%s__define'%s" (downcase class) kwd)
- (list 'idlwave-shell-send-command
- (format "resolve_routine,'%s__%s'%s"
+ (list 'idlwave-shell-send-command
+ (format "resolve_routine,'%s__%s'%s"
(downcase class) (downcase name) kwd)
'(idlwave-update-routine-info)
nil t))))))
+(defun idlwave-find-module-this-file ()
+ (interactive)
+ (idlwave-find-module '(4)))
+
(defun idlwave-find-module (&optional arg)
"Find the source code of an IDL module.
Works for modules for which IDLWAVE has routine info available. The
(this-buffer (equal arg '(4)))
(module (idlwave-fix-module-if-obj_new (idlwave-what-module)))
(default (if module
- (concat (idlwave-make-full-name
+ (concat (idlwave-make-full-name
(nth 2 module) (car module))
(if (eq (nth 1 module) 'pro) "<p>" "<f>"))
"none"))
- (list
+ (list
(idlwave-uniquify
(delq nil
- (mapcar (lambda (x)
+ (mapcar (lambda (x)
(if (eq 'system (car-safe (nth 3 x)))
;; Take out system routines with no source.
nil
(list
- (concat (idlwave-make-full-name
+ (concat (idlwave-make-full-name
(nth 2 x) (car x))
(if (eq (nth 1 x) 'pro) "<p>" "<f>")))))
(if this-buffer
(t t)))
(idlwave-do-find-module name type class nil this-buffer)))
-(defun idlwave-do-find-module (name type class
+(defun idlwave-do-find-module (name type class
&optional force-source this-buffer)
(let ((name1 (idlwave-make-full-name class name))
- source buf1 entry
+ source buf1 entry
(buf (current-buffer))
(pos (point))
file name2)
name2 (if (nth 2 entry)
(idlwave-make-full-name (nth 2 entry) name)
name1))
- (if source
+ (if source
(setq file (idlwave-routine-source-file source)))
(unless file ; Try to find it on the path.
- (setq file
- (idlwave-expand-lib-file-name
+ (setq file
+ (idlwave-expand-lib-file-name
(if class
(format "%s__define.pro" (downcase class))
(format "%s.pro" (downcase name))))))
((or (null name) (equal name ""))
(error "Abort"))
((eq (car source) 'system)
- (error "Source code for system routine %s is not available"
+ (error "Source code for system routine %s is not available"
name2))
((or (not file) (not (file-regular-p file)))
(error "Source code for routine %s is not available"
name2))
(t
(when (not this-buffer)
- (setq buf1
+ (setq buf1
(idlwave-find-file-noselect file 'find))
(pop-to-buffer buf1 t))
(goto-char (point-max))
(cond ((eq type 'fun) "function")
((eq type 'pro) "pro")
(t "\\(pro\\|function\\)"))
- "\\>[ \t]+"
+ "\\>[ \t]+"
(regexp-quote (downcase name2))
"[^a-zA-Z0-9_$]")
nil t)
(cond
((and (eq cw 'procedure)
(not (equal this-word "")))
- (setq this-word (idlwave-sintern-routine-or-method
+ (setq this-word (idlwave-sintern-routine-or-method
this-word (nth 2 (nth 3 where))))
(list this-word 'pro
- (idlwave-determine-class
+ (idlwave-determine-class
(cons this-word (cdr (nth 3 where)))
'pro)))
- ((and (eq cw 'function)
+ ((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
+ (setq this-word (idlwave-sintern-routine-or-method
this-word (nth 2 (nth 3 where))))
(list this-word 'fun
(idlwave-determine-class
class)))
(defun idlwave-fix-module-if-obj_new (module)
- "Check if MODULE points to obj_new.
+ "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))
(idlwave-sintern-class class)))))
module))
-(defun idlwave-fix-keywords (name type class keywords &optional super-classes)
+(defun idlwave-fix-keywords (name type class keywords
+ &optional super-classes system)
"Update a list of keywords.
Translate OBJ_NEW, adding all super-class keywords, or all keywords
-from all classes if class equals t."
+from all classes if class equals t. If SYSTEM is non-nil, don't
+demand _EXTRA in the keyword list."
(let ((case-fold-search t))
;; If this is the OBJ_NEW function, try to figure out the class and use
string)
(setq class (idlwave-sintern-class (match-string 1 string)))
(setq idlwave-current-obj_new-class class)
- (setq keywords
- (append keywords
+ (setq keywords
+ (append keywords
(idlwave-entry-keywords
(idlwave-rinfo-assq
(idlwave-sintern-method "INIT")
'fun
class
(idlwave-routines)) 'do-link))))))
-
+
;; If the class is `t', combine all keywords of all methods NAME
(when (eq class t)
(mapc (lambda (entry)
(and
(nth 2 entry) ; non-nil class
(eq (nth 1 entry) type) ; correct type
- (setq keywords
- (append keywords
+ (setq keywords
+ (append keywords
(idlwave-entry-keywords entry 'do-link)))))
(idlwave-all-assq name (idlwave-routines)))
(setq keywords (idlwave-uniquify keywords)))
-
+
;; If we have inheritance, add all keywords from superclasses, if
;; the user indicated that method in `idlwave-keyword-class-inheritance'
- (when (and
+ (when (and
super-classes
idlwave-keyword-class-inheritance
(stringp class)
- (or (assq (idlwave-sintern-keyword "_extra") keywords)
- (assq (idlwave-sintern-keyword "_ref_extra") keywords))
+ (or
+ system
+ (assq (idlwave-sintern-keyword "_extra") keywords)
+ (assq (idlwave-sintern-keyword "_ref_extra") keywords))
;; Check if one of the keyword-class regexps matches the name
(let ((regexps idlwave-keyword-class-inheritance) re)
(catch 'exit
(memq (nth 2 entry) super-classes) ; an inherited class
(eq (nth 1 entry) type) ; correct type
(eq (car entry) name) ; correct name
- (mapcar (lambda (k) (add-to-list 'keywords k))
- (idlwave-entry-keywords entry 'do-link))))
+ (mapc (lambda (k) (add-to-list 'keywords k))
+ (idlwave-entry-keywords entry 'do-link))))
(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.
+ "Expand KEYWORD to one of the valid 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
(assq (idlwave-sintern-keyword "_REF_EXTRA") kwd-alist)))
(completion-ignore-case t)
candidates)
- (cond ((assq kwd kwd-alist)
+ (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
+ ;; Inheritance may cause this keyword to be correct
keyword)
(entry
;; We do know the function, which does not have the keyword.
(defvar idlwave-rinfo-mouse-map (make-sparse-keymap))
(defvar idlwave-rinfo-map (make-sparse-keymap))
-(define-key idlwave-rinfo-mouse-map
+(define-key idlwave-rinfo-mouse-map
(if (featurep 'xemacs) [button2] [mouse-2])
'idlwave-mouse-active-rinfo)
-(define-key idlwave-rinfo-mouse-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
+(define-key idlwave-rinfo-mouse-map
(if (featurep 'xemacs) [button3] [mouse-3])
'idlwave-mouse-active-rinfo-right)
(define-key idlwave-rinfo-mouse-map " " 'idlwave-active-rinfo-space)
(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-rinfo-assq name type class
idlwave-unresolved-routines)))
(name (or (car entry) name))
(class (or (nth 2 entry) class))
(col 0)
(data (list name type class (current-buffer) nil initial-class))
(km-prop (if (featurep 'xemacs) 'keymap 'local-map))
- (face 'idlwave-help-link-face)
+ (face 'idlwave-help-link)
beg props win cnt total)
- ;; Fix keywords, but don't add chained super-classes, since these
+ ;; Fix keywords, but don't add chained super-classes, since these
;; are shown separately for that super-class
(setq keywords (idlwave-fix-keywords name type class keywords))
(cond
km-prop idlwave-rinfo-mouse-map
'help-echo help-echo-use
'data (cons 'usage data)))
- (if html-file (setq props (append (list 'face face 'link html-file)
+ (if html-file (setq props (append (list 'face face 'link html-file)
props)))
(insert "Usage: ")
(setq beg (point))
(format calling-seq name name name name))
"\n")
(add-text-properties beg (point) props)
-
+
(insert "Keywords:")
(if (null keywords)
(insert " No keywords accepted.")
(setq col 9)
- (mapcar
+ (mapc
(lambda (x)
- (if (>= (+ col 1 (length (car x)))
+ (if (>= (+ col 1 (length (car x)))
(window-width))
(progn
(insert "\n ")
(add-text-properties beg (point) props)
(setq col (+ col 1 (length (car x)))))
keywords))
-
+
(setq cnt 1 total (length all))
;; Here entry is (key file (list of type-conses))
(while (setq entry (pop all))
(cdr (car (nth 2 entry))))
'data (cons 'source data)))
(idlwave-insert-source-location
- (format "\n%-8s %s"
+ (format "\n%-8s %s"
(if (equal cnt 1)
(if (> total 1) "Sources:" "Source:")
"")
(incf cnt)
(when (and all (> cnt idlwave-rinfo-max-source-lines))
;; No more source lines, please
- (insert (format
+ (insert (format
"\n Source information truncated to %d entries."
idlwave-rinfo-max-source-lines))
(setq all nil)))
- (beginning-of-buffer)
+ (goto-char (point-min))
(setq buffer-read-only t))
(display-buffer "*Help*")
(if (and (setq win (get-buffer-window "*Help*"))
(unwind-protect
(progn
(select-window win)
- (enlarge-window (- (/ (frame-height) 2)
+ (enlarge-window (- (/ (frame-height) 2)
(window-height)))
(shrink-window-if-larger-than-buffer))
(select-window ww)))))))))
((and (not file) shell-flag)
(insert "Unresolved"))
- ((null file)
+ ((null file)
(insert "ERROR"))
-
+
((idlwave-syslib-p file)
(if (string-match "obsolete" (file-name-directory file))
(insert "Obsolete ")
;; Old special syntax: a matching regexp
((setq special (idlwave-special-lib-test file))
(insert (format "%-10s" special)))
-
+
;; Catch-all with file
((idlwave-lib-p file) (insert "Library "))
(if shell-flag "S" "-")
(if buffer-flag "B" "-")
"] ")))
- (when (> ndupl 1)
+ (when (> ndupl 1)
(setq beg (point))
(insert (format "(%dx) " ndupl))
(add-text-properties beg (point) (list 'face 'bold)))
alist nil)))
rtn)
(t nil))))
-
+
(defun idlwave-mouse-active-rinfo-right (ev)
(interactive "e")
(idlwave-mouse-active-rinfo ev 'right))
was pressed."
(interactive "e")
(if ev (mouse-set-point ev))
- (let (data id name type class buf bufwin source word initial-class)
+ (let (data id name type class buf bufwin source link keyword
+ word initial-class)
(setq data (get-text-property (point) 'data)
source (get-text-property (point) 'source)
keyword (get-text-property (point) 'keyword)
(cond ((eq id 'class) ; Switch class being displayed
(if (window-live-p bufwin) (select-window bufwin))
- (idlwave-display-calling-sequence
+ (idlwave-display-calling-sequence
(idlwave-sintern-method name)
- type (idlwave-sintern-class word)
+ type (idlwave-sintern-class word)
initial-class))
((eq id 'usage) ; Online help on this routine
(idlwave-online-help link name type class))
(setq bwin (get-buffer-window buffer)))
(if (eq (preceding-char) ?/)
(insert keyword)
- (unless (save-excursion
+ (unless (save-excursion
(re-search-backward
- "[(,][ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\)?[ \t]*\\="
+ "[(,][ \t]*\\(\\$[ \t]*\\(;.*\\)?\n\\)?[ \t]*\\="
(min (- (point) 100) (point-min)) t))
(insert ", "))
(if shift (insert "/"))
command can be used to detect possible name clashes during this process."
(idlwave-routines) ; Make sure everything is loaded.
(unless (or idlwave-user-catalog-routines idlwave-library-catalog-routines)
- (or (y-or-n-p
+ (or (y-or-n-p
"You don't have any user or library catalogs. Continue anyway? ")
(error "Abort")))
(let* ((routines (append idlwave-system-routines
(keymap (make-sparse-keymap))
(props (list 'mouse-face 'highlight
km-prop keymap
- 'help-echo "Mouse2: Find source"))
+ 'help-echo "Mouse2: Find source"))
(nroutines (length (or special-routines routines)))
- (step (/ nroutines 99))
+ (step (/ nroutines 100))
(n 0)
- (next-perc 1)
(cnt 0)
(idlwave-sort-prefer-buffer-info nil)
routine twins dtwins twin done props1 lroutines)
(message "Sorting routines...done")
(define-key keymap (if (featurep 'xemacs) [(button2)] [(mouse-2)])
- (lambda (ev)
+ (lambda (ev)
(interactive "e")
(mouse-set-point ev)
(apply 'idlwave-do-find-module
(get-text-property (point) 'find-args))))
(define-key keymap [(return)]
- (lambda ()
+ (lambda ()
(interactive)
(apply 'idlwave-do-find-module
(get-text-property (point) 'find-args))))
(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))))
+ (if (= (mod (setq n (1+ n)) step) 0)
+ (message "Compiling list...(%2d%%)" (/ (* n 100) nroutines)))
+
;; Get a list of all twins
(setq twins (idlwave-routine-twins routine (or lroutines routines)))
(if (memq routine done)
(> (idlwave-count-memq 'buffer (nth 2 (car dtwins))) 1))
(incf cnt)
(insert (format "\n%s%s"
- (idlwave-make-full-name (nth 2 routine)
+ (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)
+ (list (nth 0 routine)
+ (nth 1 routine)
(nth 2 routine)))
props))
(idlwave-insert-source-location "\n - " twin props1))))
(or (not (stringp sfile))
(not (string-match "\\S-" sfile))))
(setq stype 'unresolved))
- (princ (format " %-10s %s\n"
+ (princ (format " %-10s %s\n"
stype
(if sfile sfile "No source code available")))))
(eq type (nth 1 candidate))
(eq class (nth 2 candidate)))
(push candidate twins)))
- (if (setq candidate (idlwave-rinfo-assq name type class
+ (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 ENTRIES.
+ "Return dangerous twins of first entry in ENTRIES.
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 as
non-dangerous because many IDL routines are implemented as library
routines, and may have been scanned."
(let* ((entry (car entries))
- (name (car entry)) ;
+ (name (car entry)) ;
(type (nth 1 entry)) ; Must be bound for
(class (nth 2 entry)) ; idlwave-routine-twin-compare
(cnt 0)
(t 'unresolved)))
;; Check for an entry in the system library
- (if (and file
+ (if (and file
(not syslibp)
(idlwave-syslib-p file))
(setq syslibp t))
-
+
;; If there's more than one matching entry for the same file, just
;; append the type-cons to the type list.
(if (setq entry (assoc key alist))
(push type-cons (nth 2 entry))
(push (list key file (list type-cons)) alist)))
-
+
(setq alist (nreverse alist))
-
+
(when syslibp
;; File is in system *library* - remove any 'system entry
(setq alist (delq (assq 'system alist) alist)))
-
+
;; If 'system remains and we've scanned the syslib, it's a builtin
;; (rather than a !DIR/lib/.pro file bundled as source).
(when (and (idlwave-syslib-scanned-p)
(setcar entry 'builtin))
(sort alist 'idlwave-routine-twin-compare)))
-(defvar name)
(defvar type)
(defvar class)
(defvar idlwave-sort-prefer-buffer-info t
((not (eq type (nth 1 b)))
;; Type decides
(< (if (eq type 'fun) 1 0) (if (eq (nth 1 b) 'fun) 1 0)))
- (t
+ (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)))))
(tpath-alist (idlwave-true-path-alist))
(apathp (and (stringp akey)
(assoc (file-name-directory akey) tpath-alist)))
- (bpathp (and (stringp bkey)
+ (bpathp (and (stringp bkey)
(assoc (file-name-directory bkey) tpath-alist)))
;; How early on search path? High number means early since we
;; measure the tail of the path list
(t nil)))) ; Default
(defun idlwave-routine-source-file (source)
- (if (nth 2 source)
+ (if (nth 2 source)
(expand-file-name (nth 1 source) (nth 2 source))
(nth 1 source)))
(forward-sexp 2)
(forward-sexp -1)
(let ((begin (point)))
- (re-search-forward
+ (re-search-forward
"[a-zA-Z_][a-zA-Z0-9$_]+\\(::[a-zA-Z_][a-zA-Z0-9$_]+\\)?")
(if (fboundp 'buffer-substring-no-properties)
(buffer-substring-no-properties begin (point))
(interactive)
(start-process "idldeclient" nil
idlwave-shell-explicit-file-name "-c" "-e"
- (buffer-file-name) "&"))
-
+ (buffer-file-name)))
+
+(defvar idlwave-help-use-assistant)
(defun idlwave-launch-idlhelp ()
"Start the IDLhelp application."
(interactive)
- (start-process "idlhelp" nil idlwave-help-application))
-
+ (if idlwave-help-use-assistant
+ (idlwave-help-assistant-raise)
+ (start-process "idlhelp" nil idlwave-help-application)))
+
;; Menus - using easymenu.el
(defvar idlwave-mode-menu-def
`("IDLWAVE"
["Block" idlwave-mark-block t]
["Header" idlwave-mark-doclib t])
("Format"
+ ["Indent Entire Statement" idlwave-indent-statement
+ :active t :keys "C-u \\[indent-for-tab-command]" ]
["Indent Subprogram" idlwave-indent-subprogram t]
- ["(Un)Comment Region" idlwave-toggle-comment-region "C-c ;"]
+ ["(Un)Comment Region" idlwave-toggle-comment-region t]
["Continue/Split line" idlwave-split-line t]
"--"
["Toggle Auto Fill" idlwave-auto-fill-mode :style toggle
["Close Block" idlwave-close-block t])
("Completion"
["Complete" idlwave-complete t]
- ("Complete Special"
+ ("Complete Specific"
["1 Procedure Name" (idlwave-complete 'procedure) t]
["2 Procedure Keyword" (idlwave-complete 'procedure-keyword) t]
"--"
["Resolve Routine" idlwave-resolve (featurep 'idlw-shell)]
"--"
["Update Routine Info" idlwave-update-routine-info t]
+ ["Rescan XML Help Catalog" idlwave-convert-xml-system-routine-info t]
"--"
"IDL User Catalog"
["Select Catalog Directories" (idlwave-create-user-catalog-file nil) t]
["Insert TAB character" idlwave-hard-tab t])
"--"
("External"
- ["Generate IDL tags" idlwave-make-tags t]
["Start IDL shell" idlwave-shell t]
["Edit file in IDLDE" idlwave-edit-in-idlde t]
["Launch IDL Help" idlwave-launch-idlhelp t])
("Customize"
["Browse IDLWAVE Group" idlwave-customize t]
"--"
- ["Build Full Customize Menu" idlwave-create-customize-menu
+ ["Build Full Customize Menu" idlwave-create-customize-menu
(fboundp 'customize-menu-create)])
("Documentation"
["Describe Mode" describe-mode t]
"--"
["Info" idlwave-info t]
"--"
+ ["Help with Topic" idlwave-help-assistant-help-with-topic
+ idlwave-help-use-assistant]
["Launch IDL Help" idlwave-launch-idlhelp t])))
(defvar idlwave-mode-debug-menu-def
'("Debug"
["Start IDL shell" idlwave-shell t]
["Save and .RUN buffer" idlwave-shell-save-and-run
- (and (boundp 'idlwave-shell-automatic-start)
+ (and (boundp 'idlwave-shell-automatic-start)
idlwave-shell-automatic-start)]))
(if (or (featurep 'easymenu) (load "easymenu" t))
(progn
- (easy-menu-define idlwave-mode-menu idlwave-mode-map
- "IDL and WAVE CL editing menu"
+ (easy-menu-define idlwave-mode-menu idlwave-mode-map
+ "IDL and WAVE CL editing menu"
idlwave-mode-menu-def)
- (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
- "IDL and WAVE CL editing menu"
+ (easy-menu-define idlwave-mode-debug-menu idlwave-mode-map
+ "IDL and WAVE CL editing menu"
idlwave-mode-debug-menu-def)))
(defun idlwave-customize ()
"Call the customize function with idlwave as argument."
(interactive)
- ;; Try to load the code for the shell, so that we can customize it
+ ;; Try to load the code for the shell, so that we can customize it
;; as well.
(or (featurep 'idlw-shell)
(load "idlw-shell" t))
(interactive)
(if (fboundp 'customize-menu-create)
(progn
- ;; Try to load the code for the shell, so that we can customize it
+ ;; Try to load the code for the shell, so that we can customize it
;; as well.
(or (featurep 'idlw-shell)
(load "idlw-shell" t))
- (easy-menu-change
+ (easy-menu-change
'("IDLWAVE") "Customize"
`(["Browse IDLWAVE group" idlwave-customize t]
"--"
(let ((table (symbol-value 'idlwave-mode-abbrev-table))
abbrevs
str rpl func fmt (len-str 0) (len-rpl 0))
- (mapatoms
+ (mapatoms
(lambda (sym)
(if (symbol-value sym)
(progn
(with-output-to-temp-buffer "*Help*"
(if arg
(progn
- (princ "Abbreviations and Actions in IDLWAVE-Mode\n")
+ (princ "Abbreviations and Actions in IDLWAVE-Mode\n")
(princ "=========================================\n\n")
(princ (format fmt "KEY" "REPLACE" "HOOK"))
(princ (format fmt "---" "-------" "----")))
;; Will only work on systems which support this.
(or idlwave-routines (idlwave-start-load-rinfo-timer))
-;;;###autoload(add-to-list 'auto-mode-alist '("\\.[Pp][Rr][Oo]\\'" . idlwave-mode))
+;;;###autoload (add-to-list 'auto-mode-alist '("\\.[Pp][Rr][Oo]\\'" . idlwave-mode))
;; Run the hook
(run-hooks 'idlwave-load-hook)
HCoop / bpt / emacs.git / blobdiff