Permalink
Browse files

- Query shell for structure tag completion if in the shell.

- Some general cleanup.
  • Loading branch information...
1 parent d5a980a commit 9af997eaf9f67e9bf85ac2e1766bd46aa316e500 jdsmith committed May 6, 2005
Showing with 135 additions and 57 deletions.
  1. +135 −57 idlw-complete-structtag.el
View
@@ -2,9 +2,9 @@
;; Copyright (c) 2001,2002 Free Software Foundation
;; Author: Carsten Dominik <dominik@astro.uva.nl>
-;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu
-;; Version: 1.1
-;; Date: $Date: 2002/09/12 16:38:29 $
+;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
+;; Version: 1.2
+;; Date: $Date: 2005/05/06 22:53:56 $
;; Keywords: languages
;; This file is part of GNU Emacs.
@@ -26,23 +26,30 @@
;;; Commentary:
-;; Completion of structure tags is highly ambiguous since you never
-;; know what kind of structure a variable will hold at runtime.
-;; However, in some applications there is one main structure which
-;; contains a large amount of information. For example, in many
-;; widget applications, a "state" structure contains all important
-;; data about the application is stored in the main widget. The
-;; different routines called by the event handler then use this
-;; structure for their actions. If you use the same variable name for
-;; this structure throughout your application (a good idea for many
-;; reasons), IDLWAVE can support completion for its tags.
+;; Completion of structure tags can be done automatically in the
+;; shell, since the list of tags can be determined dynamically through
+;; interaction with IDL.
+
+;; Completion of structure tags in a source buffer is highly ambiguous
+;; since you never know what kind of structure a variable will hold at
+;; runtime. To make this feature useful in source buffers, we need a
+;; special assumption/convention. We will assume that the structure is
+;; defined in the same buffer and directly assigned to the correct
+;; variable. This is mainly useful for applications in which there is one
+;; main structure which contains a large amount of information (and many
+;; tags). For example, many widget applications define a "state" structure
+;; that contains all important data about the application. The different
+;; routines called by the event handler then use this structure. If you
+;; use the same variable name for this structure throughout your
+;; application (a good idea for many reasons), IDLWAVE can support
+;; completion for its tags.
;;
;; This file is a completion plugin which implements this kind of
-;; completion. It is also an example which shows how completion
-;; plugins should be programmed.
+;; completion. It is also an example which shows how completion plugins
+;; should be programmed.
;;
-;; New versions of IDLWAVE, documentation, and more information
-;; available from:
+;; New versions of IDLWAVE, documentation, and more information available
+;; from:
;; http://idlwave.org
;;
;; INSTALLATION
@@ -67,95 +74,166 @@
;;
;; and offers the tags for completion.
;;
+;; In the idlwave shell, idlwave sends a "print,tag_names()" for the
+;; variable to idl and determines the current tag list dynamically.
+;;
;; Notes
;; -----
;; - The structure definition assignment "state = {...}" must use the
;; same variable name as the the completion location "state.*".
;; - The structure definition must be in the same file.
-;; - The structure definition is searched backwards from the end of
-;; the file, until a definition with tags is found.
-;; - The file is parsed again for the definition only if the variable
-;; name (like "state") of the current completion differs from the
-;; previous tag completion.
-;; - You can force and update of the tag list with the usual command
+;; - The structure definition is searched backwards and then forward
+;; from the current position, until a definition with tags is found.
+;; - The file is parsed again for each new completion variable and location.
+;; - You can force an update of the tag list with the usual command
;; to update routine info in IDLWAVE: C-c C-i
-;;
-;;
+
+
+;; Some variables to identify the previously used structure
(defvar idlwave-current-tags-var nil)
(defvar idlwave-current-tags-buffer nil)
+(defvar idlwave-current-tags-completion-pos nil)
+
+;; The tag list used for completion will be stored in the following vars
(defvar idlwave-current-struct-tags nil)
(defvar idlwave-sint-structtags nil)
+
+;; Create the sintern type for structure talks
(idlwave-new-sintern-type 'structtag)
+
+;; Hook the plugin into idlwave
(add-to-list 'idlwave-complete-special 'idlwave-complete-structure-tag)
(add-hook 'idlwave-update-rinfo-hook 'idlwave-structtag-reset)
+;;; The main code follows below
+
(defun idlwave-complete-structure-tag ()
"Complete a structure tag.
This works by looking in the current file for a structure assignment to a
variable with the same name and takes the tags from there. Quite useful
-for big structures like the state variables of a widget application."
+for big structures like the state variables of a widget application.
+
+In the idlwave shell, the current content of the variable is used to get
+an up-to-date completion list."
(interactive)
(let ((pos (point))
+ start
(case-fold-search t))
(if (save-excursion
- ;; Check if the context is right
+ ;; Check if the context is right.
+ ;; In the shell, this could be extended to expressions like
+ ;; x[i+4].name.g*. But it is complicated because we would have
+ ;; to really parse this expression. For now, we allow only
+ ;; substructures, like "aaa.bbb.ccc.ddd"
(skip-chars-backward "[a-zA-Z0-9._$]")
+ (setq start (point)) ;; remember the start of the completion pos.
(and (< (point) pos)
(not (equal (char-before) ?!)) ; no sysvars
- (looking-at "\\([a-zA-Z][a-zA-Z0-9_]*\\)\\.")
+ (looking-at "\\([a-zA-Z][.a-zA-Z0-9_]*\\)\\.")
(>= pos (match-end 0))
- (not (string= (downcase (match-string 1)) "self")))) ;; FIXME: Can we avoid checking for self here?
+ (not (string= (downcase (match-string 1)) "self"))))
(let* ((var (downcase (match-string 1))))
- ;; Check if we need to update the "current" structure
+ ;; Check if we need to update the "current" structure. Basically we
+ ;; do it always, except for subsequent completions at the same
+ ;; spot, to save a bit of time. Implementation: We require
+ ;; an update if
+ ;; - the variable is different or
+ ;; - the buffer is different or
+ ;; - we are completing at a different position
(if (or (not (string= var (or idlwave-current-tags-var "@")))
- (not (eq (current-buffer) idlwave-current-tags-buffer)))
+ (not (eq (current-buffer) idlwave-current-tags-buffer))
+ (not (equal start idlwave-current-tags-completion-pos)))
(idlwave-prepare-structure-tag-completion var))
+ (setq idlwave-current-tags-completion-pos start)
(setq idlwave-completion-help-info
(list 'idlwave-complete-structure-tag-help))
(idlwave-complete-in-buffer 'structtag 'structtag
idlwave-current-struct-tags nil
"Select a structure tag" "structure tag")
- t) ; return t to skip other completions
- nil)))
+ t) ; we did the completion: return t to skip other completions
+ nil))) ; return nil to allow looking for other ways to complete
(defun idlwave-structtag-reset ()
+ "Force an update of the current structure tag list upon next use."
(setq idlwave-current-tags-buffer nil))
-(defvar idlwave-structtag-struct-location nil)
+(defvar idlwave-structtag-struct-location nil
+ "The location of the structure definition, for help display.")
+
(defun idlwave-prepare-structure-tag-completion (var)
- "Find and parse the necessary class definitions for class structure tags."
- ;; (message "switching to var %s" var) ; FIXME: take this out.
- ;; (sit-for 2)
- (unless
- (catch 'exit
- (save-excursion
- (goto-char (point-max))
- (while (idlwave-find-structure-definition var nil 'back)
- (let ((tags (idlwave-struct-tags)))
- (when tags
- (setq idlwave-sint-structtags nil
- idlwave-current-tags-buffer (current-buffer)
- idlwave-current-tags-var var
- idlwave-structtag-struct-location (point)
- idlwave-current-struct-tags
- (mapcar (lambda (x)
- (list (idlwave-sintern-structtag x 'set)))
- tags))
- (throw 'exit t))))))
- (error "Cannot complete structure tags of variable %s" var)))
+ "Find and parse the tag list for structure tag completion."
+ ;; This works differently in source buffers and in the shell
+ (if (eq major-mode 'idlwave-shell-mode)
+ ;; OK, we are in the shell, do it dynamically
+ (progn
+ (message "preparing shell tags")
+ ;; The following call puts the tags into `idlwave-current-struct-tags'
+ (idlwave-complete-structure-tag-query-shell var)
+ ;; initialize
+ (setq idlwave-sint-structtags nil
+ idlwave-current-tags-buffer (current-buffer)
+ idlwave-current-tags-var var
+ idlwave-structtag-struct-location (point)
+ idlwave-current-struct-tags
+ (mapcar (lambda (x)
+ (list (idlwave-sintern-structtag x 'set)))
+ idlwave-current-struct-tags))
+ (if (not idlwave-current-struct-tags)
+ (error "Cannot complete structure tags of variable %s" var)))
+ ;; Not the shell, so probably a source buffer.
+ (unless
+ (catch 'exit
+ (save-excursion
+ (goto-char (point-max))
+ ;; Find possible definitions of the structure.
+ (while (idlwave-find-structure-definition var nil 'all)
+ (let ((tags (idlwave-struct-tags)))
+ (when tags
+ ;; initialize
+ (setq idlwave-sint-structtags nil
+ idlwave-current-tags-buffer (current-buffer)
+ idlwave-current-tags-var var
+ idlwave-structtag-struct-location (point)
+ idlwave-current-struct-tags
+ (mapcar (lambda (x)
+ (list (idlwave-sintern-structtag x 'set)))
+ tags))
+ (throw 'exit t))))))
+ (error "Cannot complete structure tags of variable %s" var))))
+
+(defun idlwave-complete-structure-tag-query-shell (var)
+ "Ask the shell for the tags of the structure in variable or expression VAR."
+ (idlwave-shell-send-command
+ (format "if size(%s,/TYPE) eq 8 then print,tag_names(%s)" var var)
+ 'idlwave-complete-structure-tag-get-tags-from-help
+ 'hide 'wait))
+
+(defun idlwave-complete-structure-tag-get-tags-from-help ()
+ "Filter structure tag name output, result to `idlwave-current-struct-tags'."
+ (setq idlwave-current-struct-tags
+ (if (string-match (concat "tag_names(.*) *\n"
+ "\\(\\(.*[\r\n]?\\)*\\)"
+ "\\(" idlwave-shell-prompt-pattern "\\)")
+ idlwave-shell-command-output)
+ (split-string (match-string 1 idlwave-shell-command-output)))))
+
;; Fake help in the source buffer for structure tags.
;; kwd and name are global-variables here.
(defvar idlwave-help-do-struct-tag)
(defun idlwave-complete-structure-tag-help (mode word)
(cond
- ((eq mode 'test) ; nothing gets fontified for class tags
- nil)
+ ((eq mode 'test)
+ ;; fontify only in source buffers, not in the shell.
+ (not (equal idlwave-current-tags-buffer
+ (get-buffer (idlwave-shell-buffer)))))
((eq mode 'set)
(setq kwd word
idlwave-help-do-struct-tag idlwave-structtag-struct-location))
(t (error "This should not happen"))))
(provide 'idlw-complete-structtag)
-;;; idlw-complete-structtag.el ends here
+;;; idlw-complete-structtag.el ends here
+
+

0 comments on commit 9af997e

Please sign in to comment.