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

comparison lisp/progmodes/idlw-help.el @ 94672:0e2d838cfad2

Switch to recommended form of GPLv3 permissions notice. Delete trailing whitespace.

author	Glenn Morris <rgm@gnu.org>
date	Tue, 06 May 2008 07:14:39 +0000
parents	107ccd98fa12
children	a9dc0e7c3f2b

comparison

equal deleted inserted replaced

-:f3ab0c2464f5
+:0e2d838cfad2
 ;; Maintainer: J.D. Smith <jdsmith@as.arizona.edu>
 ;; Version: 6.1_em22
 ;; This file is part of GNU Emacs.
-;; This file is free software; you can redistribute it and/or modify
+;; 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 3, or (at your option)
+;; the Free Software Foundation, either version 3 of the License, or
-;; any later version.
+;; (at your option) any later version.
-;; This file is distributed in the hope that it will be useful,
+;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ;; GNU General Public License for more details.
 ;; 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
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
 ;;; Commentary:
 ;; The help link information for IDLWAVE's online help feature for
 ;; system routines is extracted automatically from the IDL
 ;; themselves are not distributable with Emacs, but are available,
 ;; along with new versions of IDLWAVE, documentation, and more
 ;; information, at:
 ;;
 ;;           http://idlwave.org
 ;;
 ;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
 ;;; Code:
 (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-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))
 nil
 "/usr/local/etc/")
 "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)
 (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 'boolean)
 :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 "")
 "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
 (set (make-local-variable 'idlwave-help-in-header) nil)
 (run-hooks 'idlwave-help-mode-hook))
 (defun idlwave-html-help-location ()
 "Return the help directory where HTML files are, or nil if that is unknown."
 (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)))
 	(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)))
 			  (< 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 classtag)
 		   (not structtag)
 		   (not (member (string-to-char this-word) '(?! ?.)))))
 	  ;; Need the module information
 	  (progn
 		       (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
 ((and st-ass (not (memq cw '(function-keyword procedure-keyword))))
 	(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)))
 	(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
 ((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)))
 	 (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))
 	    (if (file-exists-p file) ;; otherwise just load the file
 		(progn
 		  (erase-buffer)
 		  (insert-file-contents file nil nil nil 'replace))
 (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)) "")
 (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.")
 "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"))
 (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)
 				 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")

Mercurial > emacs

comparison lisp/progmodes/idlw-help.el @ 94672:0e2d838cfad2