ruby-list

Ruby の関数/変数の解説を info から調べる Emacs Lisp を書いてみました。
ruby-mode で C-h f や C-h d とするだけです。
#このバインドもオブジェクト指向の考えかも。

動作報告をお待ちしています。このプログラムの使用によってみなさんのプロ
グラミング環境がより良くなれば幸いです。

;;; -*- Emacs-Lisp -*-
;;; $Id: ruby-info.el,v 1.1 1999/05/14 04:07:27 u Exp u $

;;; Author: Takashi Nishimoto <g96p0935@mse.waseda.ac.jp>
;;; Keywords: ruby info


;;; Commentary:

;; Ruby の関数や変数についての解説を表示するコマンドです。
;;
;; describe-function や describe-variable と良く似た動作をします。指定
;; された関数(変数)について Ruby 日本語マニュアル中で解説されている場
;; 合は、説明文字列を表示する代わりに Info の該当部分にジャンプします。
;;
;; 利用及び再配布の際は、GNU 一般公用許諾書の適当なバージョンにしたがっ
;; て下さい。
;;
;; この Emacs Lisp を使うには土屋さんの elisp-info.el も必要となります。
;; elisp-info.el の作者である土屋さんと Ruby の Info の作者である Koji
;; Arai さんにはとても感謝しています。
;;
;; 一次配布元
;;     ftp://ftp.misao.gr.jp/pub/tak/elisp/ruby-info.el
;;     http://www-nagao.kuee.kyoto-u.ac.jp/member/tsuchiya/elisp/elisp-info.el


;;; Install:

;; (1) Ruby 日本語マニュアルを Info で閲覧できるようにして下さい。
;;     Texinfo 形式のファイルは、
;; 
;;         ftp://ftp.netlab.co.jp/pub/lang/ruby/contrib/ruby-texi-1.2.tar.gz
;;
;;     などから入手可能です。すでに Info ファイルも入っています。
;;
;; (2) ruby-info.el と elisp-info.el を適当なディレクトリにコピーして
;;     下さい。
;;
;; (3) ruby-info-index.el を生成するために、M-x ruby-info-make-index 
;;     とするか、次のコマンドを実行して下さい。
;;
;;         mule -batch -l ~/.emacs -l ./ruby-info.el -f ruby-info-make-index
;;
;;     デフォルトでは Ruby 日本語マニュアルを対象として検索します。不
;;     要な Info がある場合や、対象となる Info を追加する場合は、
;;     ruby-info-list を変更して下さい。
;;
;; (4) 次の指定を ~/.emacs に加えて下さい。
;;
;; (autoload 'ruby-info-describe-function "ruby-info" "describe-function for ruby" t nil)
;; (autoload 'ruby-info-describe-variable "ruby-info" "describe-variable for ruby" t nil)
;; (add-hook 'ruby-mode-hook
;;           '(lambda ()
;;              (define-key ruby-mode-map "\C-hf" 'ruby-info-describe-function)
;;              (define-key ruby-mode-map "\C-hd" 'ruby-info-describe-function)
;;              (define-key ruby-mode-map "\C-hD" 'describe-function)
;;              (define-key ruby-mode-map "\C-hv" 'ruby-info-describe-variable)
;;              (define-key ruby-mode-map "\C-hV" 'describe-variable)))
;;
;;
;; Info は表示されるのに、表示される位置が間違っている場合は、関数(変
;; 数)の名前と Node の対応関係を記録している ruby-info-index.el を作
;; り直す必要があるので、M-x ruby-info-make-index を再実行して下さい。


;;; 依存関係の宣言

(provide 'ruby-info)
(require 'elisp-info)

(defvar ruby-info-list '("ruby.info") "*解説を検索する Ruby についての Info のリスト")

(defvar ruby-info-function-alist nil "Info で解説されている Ruby の関数の連想配列")

(defvar ruby-info-function-regexp nil "Info で解説されている Ruby の関数の正規表現")

(defvar ruby-info-variable-alist nil "Info で解説されている Ruby の変数の連想配列")

(defvar ruby-info-variable-regexp nil "Info で解説されている Ruby の変数の正規表現")

(defun ruby-info-read-string (regexp alist)
  "デフォルト値付き completing-read。ruby 専用。"
  (let* (( case-fold-search nil)
         (v (save-excursion
              (and (forward-word 1)
                   (re-search-backward regexp nil t)
                   (match-string 1))))
         (var (completing-read (if v (format "Show info (default %s): " v)
                                 (format "Show info: "))
                               alist nil t)))
    (if (equal var "") v var)))

(defun ruby-info-get-and-goto-node (elm alist)
  "関数名 (変数名) を Info で調べる。
ruby はオブジェクト指向言語のため、関数や変数は多重定義されている可能性がある。
そのときは見たいノードをユーザが選択する。"
  (let (elms node line)
    (catch 'found
      (while alist
        (if (string= elm (car (car alist)))
            (progn
              (while (progn
                       (setq elms (cons (car alist) elms)
                             alist (cdr alist))
                       (string= elm (car (car alist)))))
              (throw 'found elms)))
        (setq alist (cdr alist))))
    (setq elms (mapcar 'cdr elms))
    (if (= (length elms) 1)
        (setq node (car   (car elms))
              line (nth 1 (car elms)))
      (setq node (concat
                  "(ruby.info)"
                  (completing-read "node: "
                                   (mapcar
                                    (lambda (e)
                                      (list (substring (car e) 11)))
                                    elms)
                                   nil t nil nil))
            line (nth 1 (assoc node elms))))
    ;(message "node=%s line=%d" node line)
    (or (elisp-info-goto-node node line)
	(error "Can't find Info node: %s" elm))
    ))
    
(defun ruby-info-describe-function (function)
  "Display the info node of FUNCTION (string)"
  (interactive (list (progn
                       (require 'ruby-info-index)
                       (ruby-info-read-string ruby-info-function-regexp ruby-info-function-alist))))
  (ruby-info-get-and-goto-node function ruby-info-function-alist))

(defun ruby-info-describe-variable (variable)
  "Display the info node of VARIABLE (string)"
  (interactive (list (progn
                       (require 'ruby-info-index)
                     (ruby-info-read-string ruby-info-variable-regexp ruby-info-variable-alist))))
  (ruby-info-get-and-goto-node variable ruby-info-variable-alist))

;; ruby-info-describe-variable hack
(add-hook 'ruby-mode-hook
          (lambda ()
            (modify-syntax-entry ?$ "w" ruby-mode-syntax-table)))


(defun ruby-info-make-index () "\
Command to write list of functions and variables documented in elisp-jp to file.
Ruby Reference Manual で記述されている関数及び変数と Info の node との
対応関係の索引ファイル( ruby-info-index.el )を作るコマンド。

Non-interactive に実行された場合はカレントディレクトリに索引を作る。
Interactive に実行された場合は、ruby-info-index.el または 
elisp-info.el のあるディレクトリに作ろうとするが、ファイルが両方とも見
つからなかった場合はユーザーに入力を求める。
"
  (interactive)
  (let ((elisp-info-entry-regexp "^ +-.+\\(Method\\|Function\\|Variable\\)[^:]*: \\([^ \t\n]+\\)")
        (elisp-info-node-regexp "\^_\nFile: %s, +Node: +\\([^,\n\t]+\\)[,\n\t]")
        )
    (elisp-info-make-index-file "ruby-info" (if noninteractive default-directory) t)))


--
Takashi Nishimoto: g96p0935@mse.waseda.ac.jp
I love Emacs, zsh, and Linux!!
See ftp://ftp.misao.gr.jp/pub/tak/README
Key fingerprint = EE D7 1D 18 A9 42 C0 8A  63 E7 F2 AC 4D C7 83 6B

Thread

Prev Next

In This Thread

Prev Next

[#14116] Re: CVSup — Shugo Maeda <shugo@...>

[#14122] gdbm ext library for Ruby 1.3 — Hiroshi Igarashi <igarashi@...>

[#14124] RuBBS 0.1.0 — TADA Tadashi <sho@...>

[#14128] patch for GD-0.6.1 — Noritsugu Nakamura <nnakamur@...>

[#14129] patch for GD-0.6.1 No.2 — Noritsugu Nakamura <nnakamur@...>

[#14130] Re: pop3 via firewall — kikutani@...

[#14133] Thread safe eRuby — Yoshinori Toki <toki@...>

[#14136] — akendo@...3.rim.or.jp

[#14150] RE: Category(Re:Class is a Class.) — 助田 雅紀 <masaki.suketa@...>

[#14153] Re: Class is a Class. — 助田 雅紀 <masaki.suketa@...>

[#14168] SGmail run over IPv6 — a-shigi@... (A.Shigihara)

[#14169] SGmail run over IPv6 — a-shigi@... (A.Shigihara)

[#14175] UNIX USER 6/1999 — WATANABE Tetsuya <tetsu@...>

[#14178] standard mail library RFC — Minero Aoki <aamine@...>

[#14183] patch for GD-0.6.1 No.3 — Noritsugu Nakamura <nnakamur@...>

[#14185] GD Examples — Noritsugu Nakamura <nnakamur@...>

[#14201] Re: Subscribe confirmation request (ruby mailing list) — Yuichiro Orino <yuu_@...21.odn.ne.jp>

[#14202] はじめまして — Takashi Nishimoto <g96p0935@...>

[#14203] class def in class def — kikutani@...

[#14212] Re: Subscribe confirmation request (ruby mailing list) — 穴澤 康裕 <anazawa@...>

[#14220] Re: Subscribe confirmation request (ruby mailing list) — Akihiro Yamauchi <aygoofy@...>

[#14222] ruby/gtk 入門 — kikutani@...

[#14231] Re: Subscribe confirmation request (ruby mailing list) — Hideki Takehara <takehara@...>

[#14236] Sort for dictionary — akendo@...3.rim.or.jp

[#14242] Re: private inner class (Re: Re: class def in class def) — 助田 雅紀 <masaki.suketa@...>

[#14248] Re: private inner class (Re: Re: class def in class def) — 助田 雅紀 <masaki.suketa@...>

[#14257] hajimemasite — Koyama Hideo<fa8h-kym@...>

[#14281] Re: Subscribe confirmation request (ruby mailing list) — Shin-ichiro Kashiwagi <kashiwagi@...>

[#14282] What's |n| ? — Kohji IKEDA <kid@...>

[#14284] Module.new feature — Shin-ichiro Hara <sinara@...>

[#14292] RUBYLIB is necessary for 1.3 ? — kikutani@...

[#14304] ruby-info.el — Takashi Nishimoto <g96p0935@...>

[#14323] Segmentation Fault on ruby-1.2.5 for Win32(Cygwin) — "MIYOKAWA, Nobuyoshi" <nmiyo@...>

[#14332] ruby/gtk 0.17 — Dai <MAP2303@...>

[#14336] archive.rb — Takashi Nishimoto <g96p0935@...>

[#14341] sort animation on ruby/tk — "Date Ken" <ge6537@...>

[#14348] vec — WATANABE Hirofumi <watanabe@...>

[#14354] eRuby 0.0.1 — Shugo Maeda <shugo@...>

[#14359] Tk.getOpenFile and getSaveFile — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[#14371] regexp for backslash escaped strings — gotoken@... (GOTO Kentaro)

[#14379] Ruby as the First Language — Hideto Ishibashi <a1602hi@...>

[#14384] Ruby Conference in Chugoku — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[#14389] Re: Subscribe confirmation request (ruby mailing list) — Takanoli Kawase <kawase@...>

[#14390] Re: regexp for backslash escaped strings — Inaba Hiroto <inaba@...>

[#14398] shttpsrv — 中川 誠 <GHA03025@...>

[#14399] shttpsrv — 中川 誠 <GHA03025@...>

[#14402] mod_ruby & eRuby — Shugo Maeda <shugo@...>

[#14408] goo.rb — Kazunori Akaishi <akaishi@...>

[#14413] Re: goo.rb — Inaba Hiroto <inaba@...>

[#14417] はじめまして — Kenji Horikoshi <k-horix@...>

[#14428] sort — Koyama Hideo<fa8h-kym@...>

[#14441] ConditionVariable (thread.rb) — SEKI <m_seki@...>

[#14444] 正規表現の x オプション — Yoshiki Wada <wada@...>

[#14451] mold — gotoken@... (GOTO Kentaro)

[#14453] Re: Ruby Conference in Chugok u (Re: はじめまして) — 助田 雅紀 <masaki.suketa@...>

[#14455] Re: Ruby Conference in Chugok u (Re: はじめまして) — 助田 雅紀 <masaki.suketa@...>

[#14456] Re: Ruby as the First Language — Hideto Ishibashi <a1602hi@...>

[#14477] ちっちゃい Ruby — 中村暁史 <anakamur@...>

[#14481] count lines — kikutani@...

[#14489] Re: sort — 助田 雅紀 <masaki.suketa@...>

[#14506] Re: ちっちゃい Ruby — 中村暁史 <anakamur@...>

[#14513] Hater — cercine@... (Takashi Ikeda)

[#14516] RE: Hater — 助田 雅紀 <masaki.suketa@...>

[#14521] ruby の書き方 ? — goto@...

[#14559] Re:Hater — "Date Ken" <ge6537@...>

[#14586] Ruby, hardware description language — gotoken@... (GOTO Kentaro)

[#14597] TkAfter munched memory. — Yoshinari NOMURA <nom@...>

[#14602] ruby upload cgi program — ymaekawa@...

[#14626] in Ruby/Tk... — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[#14634] nkf(NKF::JIS, str) — gotoken@... (GOTO Kentaro)

[#14660] ビーでルビー — "Hisashi_Tokunaga" <kurage@...>

[#14662] magic parser — gotoken@... (GOTO Kentaro)

[#14667] [BUG] def foo; foo end; foo — "Takehiko Ueki" <takehiko@...>

[#14673] Re: [BUG] def foo; foo end; foo — "Takehiko Ueki" <takehiko@...>

[#14674] Re: [BUG] def foo; foo end; foo — "Takehiko Ueki" <takehiko@...>

[#14688] Re: [BUG] def foo; foo end; foo — "Takehiko Ueki" <takehiko@...>

[#14696] Ruby traps & tips — Akira Endo <akendo@...3.rim.or.jp>

[#14702] TkTextTag#ranges — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[ruby-list:14304] ruby-info.el

Thread

[#14150] RE: Category(Re:Class is a Class.) — 助田　雅紀 <masaki.suketa@...>

[#14153] Re: Class is a Class. — 助田　雅紀 <masaki.suketa@...>

[#14212] Re: Subscribe confirmation request (ruby mailing list) — 穴澤康裕 <anazawa@...>

[#14242] Re: private inner class (Re: Re: class def in class def) — 助田　雅紀 <masaki.suketa@...>

[#14248] Re: private inner class (Re: Re: class def in class def) — 助田　雅紀 <masaki.suketa@...>

[#14398] shttpsrv — 中川　誠 <GHA03025@...>

[#14399] shttpsrv — 中川　誠 <GHA03025@...>

[#14453] Re: Ruby Conference in Chugok u (Re: はじめまして) — 助田　雅紀 <masaki.suketa@...>

[#14455] Re: Ruby Conference in Chugok u (Re: はじめまして) — 助田　雅紀 <masaki.suketa@...>

[#14489] Re: sort — 助田　雅紀 <masaki.suketa@...>

[#14516] RE: Hater — 助田　雅紀 <masaki.suketa@...>