(require 'octave-mod)
(require 'info)
(defvar octave-help-files '("octave")
"List of info files with documentation for Octave.
Default is (\"octave\").")
(defvar octave-help-lookup-alist nil
"Alist of Octave index entries for lookup.")
(defvar octave-help-completion-alist nil
"Alist of Octave index entries for completion.
The entries are of the form (VAR . VAR), where VAR runs through all
different keys in `octave-help-lookup-alist'.")
(defun octave-help (key)
"Get help on Octave symbols from the Octave info files.
Look up KEY in the function, operator and variable indices of the files
specified by `octave-help-files'.
If KEY is not a string, prompt for it with completion."
(interactive
(list
(completing-read (format "Describe Octave symbol: ")
(octave-help-get-completion-alist)
nil t)))
(if (get-buffer "*info*")
(set-buffer "*info*"))
(if (zerop (length key))
(Info-find-node (car octave-help-files) "Top")
(let ((alist (copy-alist (octave-help-get-lookup-alist)))
entry matches)
(while (setq entry (car alist))
(if (string-match key (car entry))
(add-to-list 'matches entry))
(setq alist (cdr alist)))
(if matches
(progn
(setq Info-index-alternatives matches)
(Info-index-next 0))))))
(defun octave-help-get-lookup-alist ()
"Build the index lookup alist from all Octave info files.
The files specified by `octave-help-files' are searched."
(if octave-help-lookup-alist
()
(message "Building help lookup alist...")
(let ((files octave-help-files) file key node)
(save-window-excursion
(while files
(setq file (car files))
(Info-goto-node (concat "(" file ")"))
(condition-case nil
(progn
(Info-index "")
(while
(progn
(while (re-search-forward
"^\\* \\([^(:]+\\)[^:]*: *\\(.+\\)\\.$"
nil t)
(setq key (match-string 1)
node (concat "(" file ")" (match-string 2)))
(and (string-match "\\(.*\\>\\) *$" key)
(setq key (replace-match "\\1" t nil key)))
(add-to-list 'octave-help-lookup-alist
(list key
node
(concat (concat "(" file ")")
Info-current-node)
0)))
(and (setq node (Info-extract-pointer "next" t))
(string-match
(concat "\\(Function\\|Operator\\|Variable\\) "
"\\<Index\\>")
node)))
(Info-goto-node node)))
(error nil))
(setq files (cdr files)))))
(message "Building help lookup alist...done"))
octave-help-lookup-alist)
(defun octave-help-get-completion-alist ()
"Build the index completion alist from all Octave info files.
The files specified by `octave-help-files' are searched."
(if octave-help-completion-alist
()
(message "Building help completion alist...")
(let ((alist (octave-help-get-lookup-alist)) entry)
(while alist
(setq entry (car alist))
(add-to-list 'octave-help-completion-alist
(cons (car entry) (car entry)))
(setq alist (cdr alist))))
(message "Building help completion alist...done"))
octave-help-completion-alist)
(provide 'octave-hlp)