;;; 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 Free Software Foundation
+
+;; Copyright (C) 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007
+;; Free Software Foundation, Inc.
;;
;; 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.1_em22
;; This file is part of GNU Emacs.
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
\f
+
;;; Code:
(defvar idlwave-help-browse-url-available nil
"Whether browse-url is available")
(defvar idlwave-html-link-sep
(if idlwave-html-help-pre-v6 "#" "#wp"))
+(defcustom idlwave-html-system-help-location "help/online_help/"
+ "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))
+ (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
-(Windows only) lives."
+ "The directory where the idl_html_help/ dir lives. Obsolete for IDL
+6.2 or later (see idlwave-html-system-help-location)."
:group 'idlwave-online-help
:type 'directory)
-(defcustom idlwave-help-use-hh nil
- "Whether to use the HTMLHelp viewer with idl.chm (Windows only)."
+(defvar idlwave-help-use-hh nil
+ "Obsolete variable.")
+
+(defcustom idlwave-help-use-assistant t
+ "Whether to use the IDL Assistant as the help browser."
:group 'idlwave-online-help
- :type '(choice :tag "use help viewer"
- (const :tag "<none>" nil)
- (const :tag "hh" 'hh)
- (const :tag "keyhh" 'keyhh)))
+ :type 'boolean)
(defcustom idlwave-help-browser-function browse-url-browser-function
"Function to use to display html help.
:group 'idlwave-online-help
:type 'string)
+(defvar browse-url-generic-args)
+
(defcustom idlwave-help-browser-generic-args
(if (boundp 'browse-url-generic-args)
browse-url-generic-args "")
(t (:weight bold)))
"Face for highlighting links into IDLWAVE online help."
:group 'idlwave-online-help)
-;; backward-compatibility alias
-(put 'idlwave-help-link-face 'face-alias 'idlwave-help-link)
(defvar idlwave-help-activate-links-aggressively nil
"Obsolete variable.")
(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)
- (> (length idlwave-html-help-location) 0)
- (file-directory-p idlwave-html-help-location)
- idlwave-html-help-location)
- (getenv "IDLWAVE_HELP_LOCATION")
- (and (memq system-type '(ms-dos windows-nt)) ; Base it on sysdir
- idlwave-help-use-hh
- (stringp idlwave-system-directory)
- (> (length idlwave-system-directory) 0)
- (file-directory-p idlwave-system-directory)
- (expand-file-name "HELP" idlwave-system-directory))))
+ (let ((syshelp-dir (expand-file-name
+ idlwave-html-system-help-location (idlwave-sys-dir)))
+ (help-dir (or (and (stringp idlwave-html-help-location)
+ (> (length idlwave-html-help-location) 0)
+ idlwave-html-help-location)
+ (getenv "IDLWAVE_HELP_LOCATION"))))
+ (if (and syshelp-dir (file-directory-p syshelp-dir))
+ syshelp-dir
+ (if help-dir
+ (progn
+ (setq help-dir (expand-file-name "idl_html_help" help-dir))
+ (if (file-directory-p help-dir) help-dir))))))
+
+(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 help-loc)
+ (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)
(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)
- idlwave-help-special-topic-words))
+ (st-ass (assoc-string this-word
+ idlwave-help-special-topic-words t))
(classtag (and (string-match "self\\." this-word)
(< beg (- end 4))))
(structtag (and (fboundp 'idlwave-complete-structure-tag)
(< beg (- end 4))))
module keyword cw mod1 mod2 mod3)
(if (or arg
- (and (not st-ass)
- (not classtag)
+ (and (not classtag)
(not structtag)
(not (member (string-to-char this-word) '(?! ?.)))))
;; Need the module information
(arg (setq mod1 module))
;; A special topic -- only system help
- (st-ass (setq mod1 (list (cdr st-ass))))
+ ((and st-ass (not (memq cw '(function-keyword procedure-keyword))))
+ (setq mod1 (list (cdr st-ass))))
;; A system variable -- only system help
((string-match
(if (eq link t)
(let ((entry (idlwave-best-rinfo-assoc name type class
(idlwave-routines) nil t)))
- (cond
- ;; Try keyword link
- ((and keyword
- (setq link (cdr (idlwave-entry-find-keyword entry keyword)))))
- ;; Default, regular entry link
- (t (setq link (idlwave-entry-has-help entry))))))
+ (if entry
+ (cond
+ ;; Try keyword link
+ ((and keyword
+ (setq link (cdr
+ (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
(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
- (error "browse-url is not available -- install it to use HTML help."))
- (if (and (memq system-type '(ms-dos windows-nt))
- idlwave-help-use-hh)
- (progn
- (setq browse-url-browser-function 'browse-url-generic
- full-link (concat (expand-file-name "idl.chm" help-loc)
- "::/"
- link))
- (if (memq 'keyhh idlwave-help-use-hh)
- (setq browse-url-generic-program "KEYHH"
- browse-url-generic-args '("-IDLWAVE"))
- (setq browse-url-generic-program "HH")))
- ;; Just a regular file name (+ anchor name)
- (unless (and (stringp help-loc)
- (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))))
+ ;; Just a regular file name (+ anchor name)
+ (unless (and (stringp help-loc)
+ (file-directory-p help-loc))
+ (error "Invalid help location."))
+ (setq full-link (browse-url-file-url (expand-file-name link help-loc)))
+
+ ;; Select the browser
+ (cond
+ (idlwave-help-use-assistant
+ (idlwave-help-assistant-open-link link))
+
+ ((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))))
+
+ (t (browse-url full-link)))))
;; A special help routine for source-level syntax help in files.
(defvar idlwave-help-fontify-source-code)
(if in-buf
(progn
(setq file (buffer-file-name in-buf))
- (erase-buffer)
- (insert-buffer in-buf))
+ (erase-buffer)
+ (insert-buffer-substring in-buf))
(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)))
+ (goto-char (point-min))
(if (and idlwave-help-fontify-source-code (not in-buf))
(idlwave-help-fontify)))
(idlwave-help-error name type class keyword))
(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.exe"
+ "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 full-link)
+ "Start the IDL Assistant, loading link FULL-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 full-link `("-file" ,full-link))))
+ 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)
+ (progn
+ (process-send-string idlwave-help-assistant-socket
+ (concat "setHelpPath " help-loc "\n"))
+ t)
+ (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.
+ (let ((help-loc (idlwave-html-help-location))
+ topic anchor file just-started exists full-link)
+
+ (if (string-match "\.html" link)
+ (setq topic (substring link 0 (match-beginning 0))
+ anchor (substring link (match-end 0)))
+ (error "Malformed help link."))
+
+ (setq file (expand-file-name (concat topic ".html") help-loc))
+ (if (file-exists-p file)
+ (setq exists t)
+ (setq file (expand-file-name
+ (concat (upcase topic) ".html") help-loc))
+ (setq exists (file-exists-p file)))
+
+ (setq full-link (concat file anchor)
+ just-started (idlwave-help-assistant-start (if exists full-link)))
+ (if exists
+ (progn
+ (if (not just-started)
+ (process-send-string idlwave-help-assistant-socket
+ (concat "openLink " full-link "\n")))
+ (process-send-string idlwave-help-assistant-socket
+ (concat "searchIndexNoOpen " topic "\n")))
+ (process-send-string idlwave-help-assistant-socket
+ (concat "searchIndexAndOpen " topic "\n"))))
+ (idlwave-help-assistant-raise))
+
+(defvar idlwave-help-assistant-help-with-topic-history nil
+ "The history of help topics selected with the minibuffer.")
+
+(defun idlwave-help-assistant-help-with-topic (&optional topic)
+ "Prompt for and provide help with TOPIC."
+ (interactive)
+ (let (list)
+ (unless topic
+ (idlwave-routines)
+ (setq list (append (mapcar (lambda (x)
+ (concat (nth 2 x) (car x)))
+ idlwave-system-routines)
+ (mapcar (lambda (x)
+ (concat "." (car x)))
+ idlwave-executive-commands-alist)
+ idlwave-system-class-info))
+ (setq topic
+ (idlwave-completing-read
+ "Help Topic: " list
+ nil nil nil
+ 'idlwave-help-assistant-help-with-topic-history)))
+ (if (and topic (not (string= topic "")))
+ (idlwave-help-assistant-open-link (concat topic ".html")))))
+
+(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)