emacs: lisp/progmodes/idlw-help.el comparison

comparison lisp/progmodes/idlw-help.el @ 69821:5baeec79c0cd

Update to IDLWAVE version 6.0; see idlwave.org.

author	J.D. Smith <jdsmith@as.arizona.edu>
date	Thu, 06 Apr 2006 18:46:56 +0000
parents	dc49655f57ae
children	9b44ad1b998d

comparison

equal deleted inserted replaced

-:a26627fd2df2
+:5baeec79c0cd
 ;;; idlw-help.el --- HTML Help code for IDLWAVE
 ;; Copyright (c) 2000 Carsten Dominik
 ;; Copyright (c) 2001, 2002 J.D. Smith
-;; Copyright (c) 2003, 2004, 2005, 2006  Free Software Foundation, Inc.
+;; Copyright (c) 2003,2004,2005,2006 Free Software Foundation
 ;;
 ;; Authors: J.D. Smith <jdsmith@as.arizona.edu>
 ;;          Carsten Dominik <dominik@science.uva.nl>
 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
-;; Version: 5.7_22
+;; Version: 6.0_em22
 ;; This file is part of GNU Emacs.
 ;; This file is free software; you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
 ;; themselves are not distributable with Emacs, but are available,
 ;; along with new versions of IDLWAVE, documentation, and more
 ;; information, at:
 ;;
 ;;           http://idlwave.org
 ;;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
+(require 'idlwave)
 ;;; Code:
-(defvar browse-url-generic-args)
 (defvar idlwave-help-browse-url-available nil
 "Whether browse-url is available")
 (setq idlwave-help-browse-url-available
 (condition-case nil
 (defcustom idlwave-html-help-pre-v6 nil
 "Whether pre or post-v6.0 IDL help documents are being used."
 :group 'idlwave-online-help
 :type 'boolean)
 (defvar idlwave-html-link-sep
 (if idlwave-html-help-pre-v6 "#" "#wp"))
-(defcustom idlwave-html-help-location
+(defcustom idlwave-html-system-help-location   "help/online_help/"
-(if (memq system-type '(ms-dos windows-nt))
+"The directory, relative to idlwave-system-directory, where the idl
+HTML help files live, for IDL 6.2 and later.  This location, if found,
+is used in preference to the old idlwave-html-help-location."
+:group 'idlwave-online-help
+:type 'directory)
+(defcustom idlwave-html-help-location
+(if (memq system-type '(ms-dos windows-nt))
 nil
 "/usr/local/etc/")
-"The directory where the idl_html_help/ dir or idl.chm help file
+"The directory where the idl_html_help/ dir lives.  Obsolete for IDL
-(Windows only) lives."
+6.2 or later (see idlwave-html-system-help-location)."
 :group 'idlwave-online-help
 :type 'directory)
-(defcustom idlwave-help-use-hh nil
+(defvar idlwave-help-use-hh nil
-"Whether to use the HTMLHelp viewer with idl.chm (Windows only)."
+"Obsolete variable.")
-:group 'idlwave-online-help
-:type '(choice :tag "use help viewer"
+(defcustom idlwave-help-use-assistant t
-		 (const :tag "<none>" nil)
+"Whether to use the IDL Assistant as the help browser."
-		 (const :tag "hh" 'hh)
+:group 'idlwave-online-help
-		 (const :tag "keyhh" 'keyhh)))
+:type 'boolean)
 (defcustom idlwave-help-browser-function browse-url-browser-function
 "Function to use to display html help.
 Defaults to `browse-url-browser-function', which see."
 :group 'idlwave-online-help
 (defcustom idlwave-help-browser-generic-program browse-url-generic-program
 "Program to run if using browse-url-generic-program."
 :group 'idlwave-online-help
 :type 'string)
-(defcustom idlwave-help-browser-generic-args
+(defvar browse-url-generic-args)
+(defcustom idlwave-help-browser-generic-args
 (if (boundp 'browse-url-generic-args)
 browse-url-generic-args "")
 "Program args to use if using browse-url-generic-program."
 :group 'idlwave-online-help
 :type 'string)
 "Face for highlighting links into IDLWAVE online help."
 :group 'idlwave-online-help)
 (defvar idlwave-help-activate-links-aggressively nil
 "Obsolete variable.")
 (defvar idlwave-completion-help-info)
 (defvar idlwave-help-frame nil
 "The frame for display of IDL online help.")
 (defvar idlwave-help-frame-width 102
 	      " -%-"))
 (setq buffer-read-only t)
 (set (make-local-variable 'idlwave-help-def-pos) nil)
 (set (make-local-variable 'idlwave-help-args) nil)
 (set (make-local-variable 'idlwave-help-in-header) nil)
-(run-mode-hooks 'idlwave-help-mode-hook))
+(run-hooks 'idlwave-help-mode-hook))
-(defvar idlwave-system-directory)
 (defun idlwave-html-help-location ()
 "Return the help directory where HTML files are, or nil if that is unknown."
-(or (and (stringp idlwave-html-help-location)
+(let ((syshelp-dir (expand-file-name
-	   (> (length idlwave-html-help-location) 0)
+		      idlwave-html-system-help-location (idlwave-sys-dir)))
-	   (file-directory-p idlwave-html-help-location)
+	(help-dir (or (and (stringp idlwave-html-help-location)
-	   idlwave-html-help-location)
+			   (> (length idlwave-html-help-location) 0)
-(getenv "IDLWAVE_HELP_LOCATION")
+			   idlwave-html-help-location)
-(and (memq system-type '(ms-dos windows-nt)) ; Base it on sysdir
+		      (getenv "IDLWAVE_HELP_LOCATION"))))
-	   idlwave-help-use-hh
+(if (file-directory-p syshelp-dir)
-	   (stringp idlwave-system-directory)
+	syshelp-dir
-	   (> (length idlwave-system-directory) 0)
+(setq help-dir (expand-file-name "idl_html_help" help-dir))
-	   (file-directory-p idlwave-system-directory)
+(if (file-directory-p help-dir) help-dir))))
-	   (expand-file-name "HELP" idlwave-system-directory))))
+(defvar idlwave-help-assistant-available nil)
+(defun idlwave-help-check-locations ()
+;; Check help locations and assistant.
+(let ((sys-dir (idlwave-sys-dir))
+	(help-loc (idlwave-html-help-location)))
+(if (or (not (file-directory-p sys-dir))
+	    (not (file-directory-p help-loc)))
+	(message
+	 "HTML help location not found: try setting `idlwave-system-directory' and/or `idlwave-html-help-location'."))
+;; see if we have the assistant
+(when (and idlwave-help-use-assistant
+	       (not (eq (idlwave-help-assistant-available) t)))
+(message "Cannot locate IDL Assistant, enabling default browser.")
+(setq idlwave-help-use-assistant nil)
+(unless idlwave-help-browse-url-available
+	(error "browse-url is not available; install it or IDL Assistant to use HTML help.")))))
 (defvar idlwave-current-obj_new-class)
 (defvar idlwave-help-diagnostics)
 (defvar idlwave-experimental)
 (defvar idlwave-last-context-help-pos)
 	(idlwave-help-select-help-frame)
 ;; Do the real thing.
 (setq idlwave-last-context-help-pos marker)
 (idlwave-do-context-help1 arg)
 (if idlwave-help-diagnostics
 	  (message "%s" (mapconcat 'identity
 				   (nreverse idlwave-help-diagnostics)
 				   "; "))))))
 (defvar idlwave-help-do-class-struct-tag nil)
 (defvar idlwave-structtag-struct-location)
 (defvar idlwave-executive-commands-alist)
 (defvar idlwave-system-class-info)
 (defun idlwave-do-context-help1 (&optional arg)
 "The work-horse version of `idlwave-context-help', which see."
 (save-excursion
 (if (equal (char-after) ?/)
 	(forward-char 1)
 (if (equal (char-before) ?=)
 	  (backward-char 1)))
 (let* ((idlwave-query-class nil)
 	   (idlwave-force-class-query (equal arg '(4)))
 	   (chars "a-zA-Z0-9_$.!")
 	   (beg (save-excursion (skip-chars-backward chars) (point)))
 	   (end (save-excursion (skip-chars-forward chars) (point)))
 	   (this-word (buffer-substring-no-properties beg end))
-	   (st-ass (assoc (downcase this-word)
+	   (st-ass (assoc-string this-word
-			  idlwave-help-special-topic-words))
+				 idlwave-help-special-topic-words t))
 	   (classtag (and (string-match "self\\." this-word)
 			  (< beg (- end 4))))
 	   (structtag (and (fboundp 'idlwave-complete-structure-tag)
 			   (string-match "\\`\\([^.]+\\)\\." this-word)
 			   (< beg (- end 4))))
 	   module keyword cw mod1 mod2 mod3)
 (if (or arg
 	      (and (not st-ass)
 		   (not classtag)
 		   (not structtag)
 		   (not (member (string-to-char this-word) '(?! ?.)))))
 	  ;; Need the module information
 		       (str (buffer-substring bos (point))))
 		  (if (string-match "OBJ_NEW([ \t]*['\"]\\([a-zA-Z][a-zA-Z0-9$_]+\\)['\"]" str)
 		      (setq module (list "init" 'fun (match-string 1 str))
 			    idlwave-current-obj_new-class (match-string 1 str))
 		    )))))
 (cond
 (arg (setq mod1 module))
 ;; A special topic -- only system help
 (st-ass (setq mod1 (list (cdr st-ass))))
 ;; A system variable -- only system help
 ((string-match
 	 "\\`!\\([a-zA-Z0-9_]+\\)\\(\.\\([A-Za-z0-9_]+\\)\\)?"
 	 this-word)
 	(let* ((word  (match-string-no-properties 1 this-word))
 	       (entry (assq (idlwave-sintern-sysvar word)
 			    idlwave-system-variables-alist))
 	       (tag (match-string-no-properties 3 this-word))
 			       (cdr
 				(assq (idlwave-sintern-sysvartag tag)
 				      (cdr (assq 'tags entry))))))
 	       (link (nth 1 (assq 'link entry))))
 	  (if tag-target
 	      (setq link (idlwave-substitute-link-target link
 							 tag-target)))
 	  (setq mod1 (list link))))
 ;; An executive command -- only system help
 ((string-match "^\\.\\([A-Z_]+\\)" this-word)
 	(let* ((word  (match-string 1 this-word))
 	       (link  (cdr (assoc-string
 			    word
 			    idlwave-executive-commands-alist t))))
 	  (setq mod1 (list link))))
 ;; A class -- system OR in-text help (via class__define).
 ((and (eq cw 'class)
 	     (or (idlwave-in-quote)  ; e.g. obj_new
 		 (re-search-backward "\\<inherits[ \t]+[A-Za-z0-9_]*\\="
 				     (max (point-min) (- (point) 40)) t)))
 			(idlwave-sintern-class this-word)
 			idlwave-system-class-info))
 	       (name   (concat (downcase this-word) "__define"))
 	       (link   (nth 1 (assq 'link entry))))
 	  (setq mod1 (list link name 'pro))))
 ;; A class structure tag (self.BLAH) -- only in-text help available
 (classtag
 	(let ((tag (substring this-word (match-end 0)))
 	      class-with found-in)
 	  (when (setq class-with
 		      (idlwave-class-or-superclass-with-tag
 		       (nth 2 (idlwave-current-routine))
 		       tag))
 	    (setq found-in (idlwave-class-found-in class-with))
 	    (if (assq (idlwave-sintern-class class-with)
 		      idlwave-system-class-info)
 		(error "No help available for system class tags"))
 	    (setq idlwave-help-do-class-struct-tag t)
 	    (setq mod1 (list nil
 			     (if found-in
 				 (cons (concat found-in "__define") class-with)
 			       (concat class-with "__define"))
 			     'pro
 			     nil ; no class.... it's a procedure!
 			     tag)))))
 ;; A regular structure tag -- only in text, and if
 ;; optional `complete-structtag' loaded.
 (structtag
 	(let ((var (match-string 1 this-word))
 	      (tag (substring this-word (match-end 0))))
 	  ;; Check if we need to update the "current" structure
 	  (idlwave-prepare-structure-tag-completion var)
 	  (setq idlwave-help-do-struct-tag
 		idlwave-structtag-struct-location
 		mod1 (list nil nil nil nil tag))))
 ;; A routine keyword -- in text or system help
 ((and (memq cw '(function-keyword procedure-keyword))
 	     (stringp this-word)
 	     (string-match "\\S-" this-word)
 	     (not (string-match "!" this-word)))
 	       (setq keyword (idlwave-expand-keyword this-word module))
 	       (if (consp keyword) (setq keyword (car keyword)))
 	       (setq mod1 (append (list t) module (list keyword))
 		     mod2 (list t this-word 'fun nil)
 		     mod3 (append (list t) module)))))
 ;; Everything else
 (t
 	(setq mod1 (append (list t) module))))
 (if mod3
 	  (condition-case nil
 	 (kwd (nth 4 info))
 	 (sclasses (nth 5 info))
 	 word link)
 (mouse-set-point ev)
 ;; See if we can also find help somewhere, e.g. for multiple classes
 (setq word (idlwave-this-word))
 (if (string= word "")
 	(error "No help item selected"))
 (setq link (get-text-property 0 'link word))
 (select-window cw)
 (cond
 ;; Routine name
 ((memq what '(procedure function routine))
 (setq name word)
 (if (or (eq class t)
 	      (and (stringp class) sclasses))
 	  (let* ((classes (idlwave-all-method-classes
 			   (idlwave-sintern-method name)
 			   type)))
 	    (setq link t)		; No specific link valid yet
 	    (if sclasses
 		(setq classes (idlwave-members-only
 			       classes (cons class sclasses))))
 	    (setq class (idlwave-popup-select ev classes
 					      "Select Class" 'sort))))
 ;; XXX is this necessary, given all-method-classes?
 (if (stringp class)
 	  (setq class (idlwave-find-inherited-class
 			   (idlwave-sintern-method name)
 			   (idlwave-sintern-keyword kwd)
 			   type)))
 	    (setq link t) ; Link can't be correct yet
 	    (if sclasses
 		(setq classes (idlwave-members-only
 			       classes (cons class sclasses))))
 	    (setq class (idlwave-popup-select ev classes
 					      "Select Class" 'sort))
 	    ;; XXX is this necessary, given all-method-keyword-classes?
 	    (if (stringp class)
 			     (idlwave-sintern-routine-or-method name class)
 			     type (idlwave-sintern-class class)))))
 	(if (string= (downcase name) "obj_new")
 	    (setq class idlwave-current-obj_new-class
 		  name "Init"))))
 ;; Class name
 ((eq what 'class)
 (setq class word
 	    word nil))
 ;; A special named function to call which sets some of our variables
 ((and (symbolp what)
 	   (fboundp what))
 (funcall what 'set word))
 (t (error "Cannot help with this item")))
 (if (and need-class (not class) (not (and link (not (eq link t)))))
 (defvar idlwave-completion-help-links)
 (defun idlwave-highlight-linked-completions ()
 "Highlight all completions for which help is available and attach link.
 Those words in `idlwave-completion-help-links' have links.  The
 `idlwave-help-link' face is used for this."
 (if idlwave-highlight-help-links-in-completion
 (with-current-buffer (get-buffer "*Completions*")
 	(save-excursion
 	  (let* ((case-fold-search t)
 		 (props (list 'face 'idlwave-help-link))
 		 (info idlwave-completion-help-info) ; global passed in
 	    (while (re-search-forward "\\s-\\([A-Za-z0-9_.]+\\)\\(\\s-\\|\\'\\)"
 				      nil t)
 	      (setq beg (match-beginning 1) end (match-end 1)
 		    word (match-string 1) doit nil)
 	      ;; Call special completion function test
 	      (if (and (symbolp what)
 		       (fboundp what))
 		  (setq doit (funcall what 'test word))
 		;; Look for special link property passed in help-links
 		(if idlwave-completion-help-links
 		    (setq doit (assoc-string
 	 (if (and idlwave-experimental
 		  (frame-live-p idlwave-help-return-frame))
 	     ;; Try to select the return frame.
 	     ;; This can crash on slow network connections, obviously when
 	     ;; we kill the help frame before the return-frame is selected.
 	     ;; To protect the workings, we wait for up to one second
 	     ;; and check if the return-frame *is* now selected.
 	     ;; This is marked "eperimental" since we are not sure when its OK.
 	     (let ((maxtime 1.0) (time 0.) (step 0.1))
 	       (select-frame idlwave-help-return-frame)
 	       (while (and (sit-for step)
 			   (not (eq (selected-frame)
 				    idlwave-help-return-frame))
 			   (< (setq time (+ time step)) maxtime)))))
 	 (delete-frame idlwave-help-frame))
 	((window-configuration-p idlwave-help-window-configuration)
 	 (set-window-configuration idlwave-help-window-configuration)
 (defvar default-toolbar-visible-p)
 (defun idlwave-help-display-help-window (&optional pos-or-func)
 "Display the help window.
 Move window start to POS-OR-FUNC, if passed as a position, or call it
 if passed as a function.  See `idlwave-help-use-dedicated-frame'."
 (let ((cw (selected-window))
 	(buf (idlwave-help-get-help-buffer)))
 (if (and window-system idlwave-help-use-dedicated-frame)
 	(progn
 	  (idlwave-help-show-help-frame)
 	  (switch-to-buffer buf))
 ;; Do it in this frame and save the window configuration
 (if (not (get-buffer-window buf nil))
 	  (setq idlwave-help-window-configuration
 		(current-window-configuration)))
 (display-buffer buf nil (selected-frame))
 (select-window (get-buffer-window buf)))
 (raise-frame)
 (if pos-or-func
 	(if (functionp pos-or-func)
 	    (funcall pos-or-func)
 	  (goto-char pos-or-func)
 	  (recenter 0)))
 (select-window cw)))
 (if (and (frame-live-p idlwave-help-return-frame)
 	   (not (eq (selected-frame) idlwave-help-return-frame)))
 (select-frame idlwave-help-return-frame)))
 (defun idlwave-online-help (link &optional name type class keyword)
 "Display HTML or other special help on a certain topic.
 Either loads an HTML link, if LINK is non-nil, or gets special-help on
 the optional arguments, if any special help is defined.  If LINK is
 `t', first look up the optional arguments in the routine info list to
 see if a link is set for it.  Try extra help functions if necessary."
 ;; Lookup link
 (if (eq link t)
 (let ((entry (idlwave-best-rinfo-assoc name type class
 					     (idlwave-routines) nil t)))
-	(cond
+	(if entry
-	 ;; Try keyword link
+	    (cond
-	 ((and keyword
+	     ;; Try keyword link
-	       (setq link (cdr (idlwave-entry-find-keyword entry keyword)))))
+	     ((and keyword
-	 ;; Default, regular entry link
+		   (setq link (cdr
-	 (t (setq link (idlwave-entry-has-help entry))))))
+			       (idlwave-entry-find-keyword entry keyword)))))
+	     ;; Default, regular entry link
+	     (t (setq link (idlwave-entry-has-help entry))))
+	  (if (and
+	       class
+	       ;; Check for system class help
+	       (setq entry (assq (idlwave-sintern-class class)
+				 idlwave-system-class-info)
+		     link (nth 1 (assq 'link entry))))
+	      (message
+	       (concat "No routine info for %s"
+		       ", falling back on class help.")
+	       (idlwave-make-full-name class name))))))
 (cond
 ;; An explicit link
 ((stringp link)
 (idlwave-help-html-link link))
 ;; Any extra help
 (idlwave-extra-help-function
 (idlwave-help-get-special-help name type class keyword))
 ;; Nothing worked
 (t (idlwave-help-error name type class keyword))))
 (defun idlwave-help-get-special-help (name type class keyword)
 "Call the function given by `idlwave-extra-help-function'."
 (let* ((cw (selected-window))
 	 (help-pos (save-excursion
 		     (set-buffer (idlwave-help-get-help-buffer))
 		     (let ((buffer-read-only nil))
 		       (funcall idlwave-extra-help-function
 				name type class keyword)))))
 (if help-pos
 	(idlwave-help-display-help-window help-pos)
 (idlwave-help-error name type class keyword))
 (select-window cw)))
 	(help-loc (idlwave-html-help-location))
 	(browse-url-generic-program idlwave-help-browser-generic-program)
 	;(browse-url-generic-args idlwave-help-browser-generic-args)
 	full-link)
-(unless idlwave-help-browse-url-available
+;; Just a regular file name (+ anchor name)
-(error "browse-url is not available -- install it to use HTML help."))
+(unless (and (stringp help-loc)
+		 (file-directory-p help-loc))
-(if (and (memq system-type '(ms-dos windows-nt))
+(error "Invalid help location."))
-	     idlwave-help-use-hh)
+(setq full-link (browse-url-file-url (expand-file-name link help-loc)))
-	(progn
-	  (setq browse-url-browser-function 'browse-url-generic
+;; Select the browser
-		full-link (concat (expand-file-name "idl.chm" help-loc)
+(cond
-				  "::/"
+(idlwave-help-use-assistant
-				  link))
+(idlwave-help-assistant-open-link link))
-	  (if (memq 'keyhh idlwave-help-use-hh)
-	      (setq browse-url-generic-program "KEYHH"
+((or idlwave-help-browser-is-local
-		    browse-url-generic-args '("-IDLWAVE"))
+	  (string-match "w3" (symbol-name idlwave-help-browser-function)))
-	    (setq browse-url-generic-program "HH")))
+(idlwave-help-display-help-window '(lambda () (browse-url full-link))))
-;; Just a regular file name (+ anchor name)
-(unless (and (stringp help-loc)
+(t (browse-url full-link)))))
-		   (file-directory-p help-loc))
-	(error
-	 "Invalid help location; customize `idlwave-html-help-location'."))
-(setq full-link (concat
-		       "file://"
-		       (expand-file-name
-			link
-			(expand-file-name "idl_html_help" help-loc)))))
-;; Check for a local browser
-(if (or idlwave-help-browser-is-local
-	    (string-match "w3" (symbol-name idlwave-help-browser-function)))
-	(idlwave-help-display-help-window '(lambda () (browse-url full-link)))
-(browse-url full-link))))
 ;; A special help routine for source-level syntax help in files.
 (defvar idlwave-help-fontify-source-code)
 (defvar idlwave-help-source-try-header)
 (defvar idlwave-current-tags-buffer)
 	 (class-only (and (stringp class) (not (stringp name))))
 	 file header-pos def-pos in-buf)
 (if class-only   ;Help with class?  Using "Init" as source.
 	(setq name "Init"
 	      type 'fun))
 (if (not struct-tag)
 	(setq file
 	      (idlwave-routine-source-file
 	       (nth 3 (idlwave-best-rinfo-assoc
 		       name (or type t) class (idlwave-routines))))))
 (setq idlwave-help-def-pos nil
 	  idlwave-help-do-struct-tag nil
 	  idlwave-help-do-class-struct-tag nil)
 (if (or struct-tag (stringp file))
 	(progn
 	  (setq in-buf ; structure-tag completion is always in current buffer
 		(if struct-tag
 		    idlwave-current-tags-buffer
 		  (idlwave-get-buffer-visiting file)))
 	  ;; see if file is in a visited buffer, insert those contents
 	  (if in-buf
 	      (progn
 		(setq file (buffer-file-name in-buf))
 		(erase-buffer)
-		(insert-buffer-substring in-buf)
+		(insert-buffer-substring in-buf))
-(goto-char (point-min)))
 	    (if (file-exists-p file) ;; otherwise just load the file
 		(progn
 		  (erase-buffer)
 		  (insert-file-contents file nil nil nil 'replace))
 	      (idlwave-help-error name type class keyword)))
 (setq idlwave-help-mode-line-indicator file)
 ;; Try to find a good place to display
 (setq def-pos
 	  ;; Find the class structure tag if that's what we're after
 	  (cond
 	   ;; Class structure tags: find the class or named structure
 	   ;; definition
 	   (class-struct-tag
 	    (save-excursion
 	      (setq class
 		    (if (string-match "[a-zA-Z0-9]\\(__\\)" name)
 			(substring name 0 (match-beginning 1))
 		      idlwave-current-tags-class))
 	      (and
 	       (idlwave-find-class-definition class nil real-class)
 	       (idlwave-find-struct-tag keyword))))
 	   ;; Generic structure tags: the structure definition
 	   ;; location within the file has been recorded in
 	   ;; `struct-tag'
 	   (struct-tag
 	    (save-excursion
 	      (and
 	       (integerp struct-tag)
 	       (goto-char struct-tag)
 	       (idlwave-find-struct-tag keyword))))
 	   ;; Just find the routine definition
 	   (t
 	    (if class-only (point-min)
 	      (idlwave-help-find-routine-definition name type class keyword))))
 	  idlwave-help-def-pos def-pos)
 (if (and idlwave-help-source-try-header
 	     (not (or struct-tag class-struct-tag)))
 	;; Check if we can find the header
 	(save-excursion
 	  (goto-char (or def-pos (point-max)))
 	  (setq header-pos (idlwave-help-find-in-doc-header
 			    name type class keyword 'exact)
 		idlwave-help-in-header header-pos)))
 (if (or header-pos def-pos)
 	(progn
 	  (if (boundp 'idlwave-help-min-frame-width)
 	      (setq idlwave-help-min-frame-width 80))
 	  (goto-char (or header-pos def-pos)))
 (idlwave-help-error name type class keyword))
 (defun idlwave-help-find-routine-definition (name type class keyword)
 "Find the definition of routine CLASS::NAME in current buffer.
 KEYWORD is ignored. Returns the point of match if successful, nil otherwise."
 (save-excursion
 (goto-char (point-max))
 (if (re-search-backward
 	 (concat "^[ \t]*"
 		 (if (eq type 'pro) "pro"
 		   (if (eq type 'fun) "function"
 		     "\\(pro\\|function\\)"))
 		 "[ \t]+"
 with spaces allowed between the keyword and the following dash or equal sign.
 If there is a match, we assume it is the keyword description."
 (let* ((case-fold-search t)
 	 (rname (if (stringp class)
 		    (concat
 		     "\\("
 		     ;; Traditional name or class::name
 		     "\\("
 		     "\\(" (regexp-quote (downcase class)) "::\\)?"
 		     (regexp-quote (downcase name))
 		     "\\>\\)"
 		     (concat
 		      "\\|"
 		      ;; class__define or just class
 		      (regexp-quote (downcase class)) "\\(__define\\)?")
 		     "\\)")
 		  (regexp-quote (downcase name))))
 	 ;; NAME tag plus the routine name.  The new version is from JD.
 	 (name-re (concat
 		   "\\(^;+\\*?[ \t]*"
 		   idlwave-help-doclib-name
 		   "\\([ \t]*:\\|[ \t]*$\\)[ \t]*\\(\n;+[ \t]*\\)*"
 		   rname
 		   "\\|"
 		      (concat
 		       "^;+[ \t]+"
 		       (regexp-quote (upcase keyword))
 		      "\\>")))
 	 dstart dend name-pos kwds-pos kwd-pos)
 (catch 'exit
 (save-excursion
 	(goto-char (point-min))
 	(while (and (setq dstart (re-search-forward idlwave-doclib-start nil t))
 		    (setq dend (re-search-forward idlwave-doclib-end nil t)))
 	  ;; found a routine header
 	  (goto-char dstart)
 	  (if (setq name-pos (re-search-forward name-re dend t))
 	      (progn
 		(if keyword
 		    ;; We do need a keyword
 		    (progn
 		      ;; Try to find a keyword section, but don't force it.
 		      (goto-char name-pos)
 (interactive "P")
 (if arg
 (idlwave-help-find-first-header nil)
 (setq idlwave-help-in-header nil)
 (idlwave-help-toggle-header-match-and-def arg 'top)))
 (defun idlwave-help-toggle-header-match-and-def (arg &optional top)
 (interactive "P")
 (let ((args idlwave-help-args)
 	pos)
 (if idlwave-help-in-header
 	(progn
 	  (setq idlwave-help-in-header nil)
 	  (setq pos idlwave-help-def-pos))
 ;; Try to display header
 (setq pos (apply 'idlwave-help-find-in-doc-header
 		       (if top
 			   (list (car args) (nth 1 args) (nth 2 args) nil)
 			 args)))
 (if pos
 	  (setq idlwave-help-in-header t)
 	(error "Cannot find doclib header for routine %s"
 	      (set (make-local-variable 'font-lock-defaults)
 		   idlwave-font-lock-defaults)
 	      (font-lock-fontify-buffer))
 	  (set-syntax-table syntax-table)))))
 (defun idlwave-help-error (name type class keyword)
 (error "Can't find help on %s%s %s"
 	 (or (and (or class name) (idlwave-make-full-name class name))
 	     "<unknown>")
 	 (if keyword (format ", keyword %s" (upcase keyword)) "")
 (defun idlwave-has-help (name type class)
 "Does this have help associated with it?"
 (let ((entry (idlwave-best-rinfo-assoc name type class (idlwave-routines))))
 (idlwave-entry-has-help entry)))
+;;----- Control the IDL Assistant, which shipped with IDL v6.2
+(defvar idlwave-help-assistant-process nil)
+(defvar idlwave-help-assistant-socket nil)
+;; The Windows version does not have a !DIR/bin/* set of front-end
+;; scripts, but instead only links directly to bin.x86.  As a result,
+;; we must pass the -profile argument as well.
+(defvar idlwave-help-assistant-command
+(if (memq system-type '(ms-dos windows-nt))
+"bin/bin.x86/idl_assistant"
+"bin/idl_assistant")
+"The command, rooted at idlwave-system-directory, which invokes the
+IDL assistant.")
+(defun idlwave-help-assistant-available ()
+(if idlwave-help-assistant-available
+(eq idlwave-help-assistant-available t)
+(setq idlwave-help-assistant-available
+	  (if (file-executable-p (idlwave-help-assistant-command))
+	      t
+	    'not-available))))
+(defun idlwave-help-assistant-command ()
+(expand-file-name idlwave-help-assistant-command (idlwave-sys-dir)))
+(defun idlwave-help-assistant-start (&optional link)
+"Start the IDL Assistant, loading LINK, if passed."
+(when (or (not idlwave-help-assistant-socket)
+	    (not (eq (process-status idlwave-help-assistant-socket) 'open)))
+(let* ((help-loc (idlwave-html-help-location))
+	   (command (idlwave-help-assistant-command))
+	   (extra-args
+	    (nconc
+	     (if (memq system-type '(ms-dos windows-nt))
+		 `("-profile" ,(expand-file-name "idl.adp" help-loc)))
+	     (if link
+		 `("-file" ,(expand-file-name link help-loc)))))
+	   port)
+(if idlwave-help-assistant-socket
+	  (delete-process idlwave-help-assistant-socket))
+(setq idlwave-help-assistant-process
+	    (apply 'start-process
+		   "IDL_ASSISTANT_PROC" nil command "-server" extra-args))
+(set-process-filter idlwave-help-assistant-process
+			  (lambda (proc string)
+			    (setq port (string-to-number string))))
+(unless (accept-process-output idlwave-help-assistant-process 15)
+	(error "Failed binding IDL_ASSISTANT socket"))
+(if (not port)
+	  (error "Unable to open IDL_ASSISTANT.")
+	(set-process-filter idlwave-help-assistant-process nil)
+	(setq idlwave-help-assistant-socket
+	      (open-network-stream "IDL_ASSISTANT_SOCK"
+				   nil "localhost" port))
+	(if (eq (process-status idlwave-help-assistant-socket) 'open)
+	    (process-send-string  idlwave-help-assistant-socket
+				  (concat "setHelpPath " help-loc "\n"))
+	  (idlwave-help-assistant-close)
+	  (error "Cannot communicate with IDL_ASSISTANT"))))))
+(defun idlwave-help-assistant-raise ()
+(idlwave-help-assistant-start)
+(process-send-string idlwave-help-assistant-socket "raise\n"))
+(defun idlwave-help-assistant-open-link (&optional link)
+;; Open a link (file name with anchor, no leading path) in the assistant.
+(if link
+(let ((file (expand-file-name link (idlwave-html-help-location))))
+	(idlwave-help-assistant-start link)
+	(process-send-string idlwave-help-assistant-socket
+			     (concat "openLink " file "\n"))
+	(string-match "\.html" link)
+	(process-send-string idlwave-help-assistant-socket
+			     (concat "searchIndexNoOpen "
+				     (substring link 0 (match-beginning 0))
+				     "\n")))
+(idlwave-help-assistant-raise)))
+(defun idlwave-help-assistant-close ()
+(when (and idlwave-help-assistant-process
+	     (eq (process-status idlwave-help-assistant-process) 'run))
+(when idlwave-help-assistant-socket
+(process-send-string idlwave-help-assistant-socket "quit\n")
+(delete-process idlwave-help-assistant-socket))
+(stop-process idlwave-help-assistant-process)
+(delete-process idlwave-help-assistant-process)
+(setq idlwave-help-assistant-socket nil
+	  idlwave-help-assistant-process nil)))
 (provide 'idlw-help)
 (provide 'idlwave-help)
 ;; arch-tag: d27b5505-59de-497f-ba3f-f199fd4fb911
 ;;; idlw-help.el ends here

Mercurial > emacs

comparison lisp/progmodes/idlw-help.el @ 69821:5baeec79c0cd