supermegadoc.el

;;; supermegadoc.el --- launcher for erlang html documentation

;; Copyright (C) 2009  Aliaksey Kandratsenka

;; Author: Aliaksey Kandratsenka <alk@tut.by>
;; Keywords: convenience, docs

;; This program 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 of the License, or
;; (at your option) any later version.

;; This program 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 this program.  If not, see <http://www.gnu.org/licenses/>.

;;; Commentary:

;;

;;; Code:
(require 'ffap)

(defvar *supermegadoc-index-dir* (expand-file-name "~/.supermegadoc"))
(defvar *supermegadoc-bin-in-script-dir* (expand-file-name "supermegadoc" (file-name-directory (file-truename load-file-name))))
(defvar *supermegadoc-bin* nil)
(defvar *supermegadoc-errors-log* (expand-file-name "~/supermegadoc-errors.log"))
(defvar *supermegadoc-browse-url-function* 'w3m-browse-url)

(defun supermegadoc-grab-stdout (&rest call-process-args)
  (with-temp-buffer
    (unwind-protect (let ((status (apply #'call-process
                                         (car call-process-args)
                                         nil
                                         (list (current-buffer) *supermegadoc-errors-log*)
                                         nil
                                         (cdr call-process-args))))
                      (if (eql status 0)
                          (buffer-string)
                        (message "%s exited with status %s" (car call-process-args) status)
                        (save-excursion
                          (set-buffer "*Messages*")
                          (goto-char (point-max))
                          (insert-file-contents *supermegadoc-errors-log*))
                        nil))
      (condition-case nil
          (delete-file *supermegadoc-errors-log*)
        (error nil)))))

(defun supermegadoc-find-bin ()
  ;; first we consider variable if it's non-nil
  (or *supermegadoc-bin*
      ;; then we consider script adjacent to .el
      (let ((it *supermegadoc-bin-in-script-dir*))
        (when (file-exists-p it)
          it))
      ;; and if it doesn't exist we use PATH
      "supermegadoc"))

(defun supermegadoc-run (cdb-path &optional init-filter)
  (setq cdb-path (expand-file-name cdb-path *supermegadoc-index-dir*))
  (let ((rv (supermegadoc-grab-stdout (supermegadoc-find-bin)
                                      "--for-emacs"
                                      (concat "--init-filter=" (or init-filter (ffap-string-at-point)))
                                      cdb-path)))
    (and (not (string-equal rv ""))
         rv)))

(defun supermegadoc-html (cdb-path &optional init-filter)
  (let ((url (supermegadoc-run cdb-path init-filter)))
    (when url
      (let ((code `(,*supermegadoc-browse-url-function* ',url)))
        (eval code)))))

(defun supermegadoc-erlang ()
  (interactive)
  (let ((init-string (ffap-string-at-point)))
    (setq init-string (replace-regexp-in-string ":" "/" init-string))
    (supermegadoc-html "erdoc.cdb" init-string)))

(defun supermegadoc-ri ()
  (interactive)
  (let ((url (supermegadoc-run "ri.cdb")))
    (when url
      ;; eat initial "ri:"
      (let ((arg (substring url 3)))
        (if (ignore-errors (symbol-function 'yari))
            (yari arg)
          (ri arg))))))

(defun supermegadoc-devhelp ()
  (interactive)
  (supermegadoc-html "devhelp.cdb"))

(defun superwoman ()
  (interactive)
  (require 'woman)
  (let ((url (supermegadoc-run "man.cdb")))
    (when url
      ;; eat initial "man:"
      (let* ((man-path (substring url 4))
             (path (split-string man-path "/"))
             (man-args (concat (car path) " " (cadr path))))
          (man man-args)))))

(defun supergo ()
  (interactive)
  (let ((init-string (ffap-string-at-point)))
    (setq init-string (replace-regexp-in-string "\\." "/" init-string))
    (let ((value (supermegadoc-run "go.cdb" init-string)))
      (when value
        (godoc value)))
    ))

(provide 'supermegadoc)
;;; supermegadoc.el ends here