ruby-list

新井です。

RDのメソッドインデックスに関して自分の中で大体案が固まってき
ました。

  --- Class#method(arg1, arg2, ...)
      description...

という"---"によるDESCLISTを提案します。("---"は単なる例です。
Baseline下げすぎかなとも思うので)

ただし、既存のDESCLISTである ":" との違いは、

・エイリアスの表現が可能。

  --- Class#method1
  --- Class#method2
      description...

  (これは、":"にも欲しい)

・メソッド名部分だけをラベルと見倣す

  "---" の後のSTRINGLINEのうち空白または開き括弧"("までをラ
  ベルと見倣す。したがって、

  --- Class#method(arg1, arg2)

  に対するリファレンスは、((<Class#method>)) と書く。

  ラベル "Class#method" の部分に関してRDtoolのパーサは一切特
  別扱いしない。つまり、"Class"の部分がクラス名であることや
  "#"がインスタンスメソッドを表すことを意識しない。
  (rd2xxx-lib.rbは意識しても良い。rd2texi-lib.rbを作ったとき
  意識せざるを得ないので)

といった感じです。開き括弧"("は特別扱いしない方が制約が少な
くて良いかも知れません。その場合
  --- Class#method (arg1, arg2)
や、
  --- Class#method arg1, arg2

という書き方になります。結局最初の単語だけをラベルにした
DESCLISTです。Rubyのメソッドインデックスの実現はこれだけで十
分であると自分の中でほぼ結論付けました。(ただ、Texinfoに
変換することを考えると、もう少しありそう)

その代わり、
  クラスメソッド:       --- Class.method
  インスタンスメソッド: --- Class#method
  クラス定数:           --- Class::Const
  ネストしたクラスのメソッド:
                        --- Class1::Class2.method
  関数:                 --- function#method (または --- method)
  演算子形式のメソッド:
                        --- Class#[]=(arg1, arg2)
                        --- Class#+(arg)
  グローバル変数:       --- $var

などの*慣習*を提案します。

以上でとりあえず、現在執筆中Ruby/Tkのマニュアルは書けると思
います。(この辺が決まらないとこれ以上進まない)

以下、ちょっとしたRDに対する要望。

「WHITELINEはわかりにくい」

DESCLISTで、説明文の段落が複数あると間にWHITELINEを挿入しな
ければなりませんが、スペースだから見えないんです。これは、
DESCLISTを書きにくくしてしまうように思います。(私は行末の余
計な空白を消したくなる人間です^^;)

で、

・行頭の単体の";"または"#"もWHITELINEとして扱う

というのも提案します。これらの文字にこだわるのは、Verbatimで
rubyスクリプトを書いたときに

   require "hoge.rb"
;
   hogehoge = "hoge"
;
   p hogehoge

のように、WHITELINE文字があっても、そのまま切り出してrubyス
クリプトとして実行できるからです。

さらに、

・RDにコメントが欲しい

  行頭が"###"で始まる行をコメントとして扱うなんてのは？

以上言いたいこと言ってますが。いかがでしょうか？(って
ruby-talkに書かなきゃダメ？^^;)

最後にrdtool-0.5.2に対するパッチを付けます。
修正の順に
・[REQ] 行頭の;をWHITELINEにする
・[BUG] Verbatimの中にWHITELINEを入れると[BUG]と言われるバグの修正
・[REQ] 行頭の###をコメントにする
・[BUG] (('a')) ... (('b')) とすると 「a')) ... (('b」がVerbになる
です。("--- method"はまだ修正中。その前に意見を聞こうと思いまして)


diff -ru rdtool-0.5.2/rd/rdblockparser.ry rdtool-0.5.2.fix/rd/rdblockparser.ry
--- rdtool-0.5.2/rd/rdblockparser.ry	Sat Nov  6 16:42:10 1999
+++ rdtool-0.5.2.fix/rd/rdblockparser.ry	Sat Dec 25 03:18:17 1999
@@ -174,7 +174,7 @@
 	return :BLANKLINE
       end
     end
-  when /^\s+$/
+  when /^\s+$/, /^;\s*$/
     @src.shift if destructive
     @rylval = ":WHITELINE" if destructive
     return :WHITELINE
@@ -273,7 +273,9 @@
   indent = Regexp.quote($&)
   ret.push($')
   while line = src.shift
-    if /^#{indent}/ =~ line
+    if line == ":WHITELINE"
+      ret.push("\n")
+    elsif /^#{indent}/ =~ line
       ret.push($')
     else
       raise "[BUG]: probably Parser Error while cutting off.\n"
@@ -358,4 +360,4 @@
 
 module RD
 ---- driver
-end # end of module RD 
\ No newline at end of file
+end # end of module RD 
Only in rdtool-0.5.2.fix/rd: rdblockparser.tab.rb
diff -ru rdtool-0.5.2/rd/rdfmt.rb rdtool-0.5.2.fix/rd/rdfmt.rb
--- rdtool-0.5.2/rd/rdfmt.rb	Sat Nov  6 05:35:01 1999
+++ rdtool-0.5.2.fix/rd/rdfmt.rb	Sat Dec 25 00:14:31 1999
@@ -477,6 +477,8 @@
 	  when /^=begin/
 	  when /^=end/
 	    out.push("")
+	  when /^###/		# comment
+	    # do nothing
 	  else
 	    out.push(line)
 	  end
diff -ru rdtool-0.5.2/rd/rdinlineparser.ry rdtool-0.5.2.fix/rd/rdinlineparser.ry
--- rdtool-0.5.2/rd/rdinlineparser.ry	Sat Nov  6 16:42:10 1999
+++ rdtool-0.5.2.fix/rd/rdinlineparser.ry	Sat Dec 25 00:38:34 1999
@@ -146,7 +146,7 @@
       @tokenQueue.push(:VERB_OPEN)
       @valueQueue.push(VERB_OPEN)
       src[0,3] = ""
-      src =~ /^((?:.|\n)*) '\)\)/x or raise "RD parser error: unclosed verb."
+      src =~ /^((?:.|\n)*?) '\)\)/x or raise "RD parser error: unclosed verb."
       @tokenQueue.push(:STRING)
       @valueQueue.push($1)
       @tokenQueue.push(:VERB_CLOSE)
@@ -233,4 +233,4 @@
 
 module RD
 ---- driver
-end # end of module RD
\ No newline at end of file
+end # end of module RD

--
新井康司 (Koji Arai)

Thread

Prev Next

In This Thread

Prev Next

[#19075] [book] 誤植 ? — Yuji Irie <irie@...>

[#19079] reference of object — "Hideaki Takata" <hideakit@...3.dion.ne.jp>

[#19082] TermIO for ioctl — Shugo Maeda <shugo@...>

[#19086] iconv wrapper — nobu.nakada@...

[#19088] — nashiro <nashiro@...>

[#19114] Class::name or foo.name? — h-isikaw@...

[#19115] eRuby を題材にしたページ — TAKEUCHi Kahori <take-k@...>

[#19123] require で SEGV — ruby <g96p0935@...>

[#19124] Re: eRuby を題材にしたページ — TAKEUCHi Kahori <take-k@...>

[#19127] rand が同じ値を返す — とみたまさひろ <tommy@...>

[#19133] String#rindex for multi-byte chars — kjana@... (YANAGAWA Kazuhisa)

[#19139] 簡易プリプロセッサ epp 0.1 — SASAKI Shunsuke <ele@...17.odn.ne.jp>

[#19140] ruby は何かの略語？ — Noritsugu Nakamura <nnakamur@...>

[#19142] Win32OLE on NT — Masaki Suketa<CQN02273@...>

[#19143] [book] errata — Masaki Suketa<CQN02273@...>

[#19145] eRuby with Japanese text — Yamada Kenji <kyamada@...>

[#19146] Re: eRuby with Japanese text — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19151] ruby 本第 1 版第 2 刷での直し忘れ — Noritsugu Nakamura <nnakamur@...>

[#19154] Re: eRuby with Japanese text — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19155] Re: eRuby with Japanese text — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19163] RubyMgl 991205 — 中村暁史 Nakamura Akifumi <BXQ04723@...>

[#19165] how to get extended modules list — Dai <MAP2303@...>

[#19171] Re: eRuby を題材にしたページ — TAKEUCHi Kahori <take-k@...>

[#19174] eRuby の patch — Tadashige Morii <m_tada@...>

[#19182] ruby book. — Katsuya Tanaka <tanaka@...>

[#19184] Re: eRuby の patch — TAKEUCHi Kahori <take-k@...>

[#19190] — miyamo@... (Yukinobu 'Dr.GIL' MIYAMOTO)

[#19191] — miyamo@... (Yukinobu 'Dr.GIL' MIYAMOTO)

[#19193] Japanese Regular Expression — Hiroyuki KUROSAKI <noir@...>

[#19197] GC and IO on SunOS-4.1.4-JLE — kjana@... (YANAGAWA Kazuhisa)

[#19199] eRuby 中の <%, %> — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19202] ファイルへ追加書き込み — Ayanosuke <aya@...>

[#19211] Clipbord を Ruby で使うには？ — Itou-T15@...

[#19228] Ruby 1.4.3 — Yukihiro Matsumoto <matz@...>

[#19240] emacs の ruby モードについて — nakajima kengo<ringo@...>

[#19241] thread を使った socket について — yuuichi satoh <yuuichi.satoh@...>

[#19243] (無題) — matsumotoya <matsumotoya@...>

[#19246] 破壊的イテレータ？ — Hiroshi Saito <HiroshiSaito@...>

[#19249] ruby story ? — "Kikutani, Makoto" <kikutani@...>

[#19263] Re: eRuby 中の <%, %> — TAKEUCHi Kahori <take-k@...>

[#19265] Word matching — nobu.nakada@...

[#19283] Ruby 1.4.3 repacked — Yukihiro Matsumoto <matz@...>

[#19289] Free on Free — matz@... (Yukihiro Matsumoto)

[#19299] Re: eRuby 中の <%, %> — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19301] i've remembered another ruby — nobsun@...

[#19304] about -T option on ruby 1.4.2 — nakajima kengo<ringo@...>

[#19307] 年越しの一時休止の予約方法 — Itou-T15@...

[#19347] [ANNOUNCE: Ruby Who's Who] e-mail address — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[#19350] Re: オブジェクトの代入について — Toyofuku <toyofuku@...>

[#19353] Other languages. — ruby <g96p0935@...>

[#19384] — Teruyuki AIHARA <aihara@...>

[#19396] $<.gets and $<.eof — kjana@... (YANAGAWA Kazuhisa)

[#19399] 改行コード — Akihiro Yamauchi <aygoofy@...>

[#19404] [Book] born — OZAWA Sakuro <crouton@...>

[#19412] Review for Ruby Book — Hiroshi IGARASHI <igarashi@...>

[#19413] media watch — Noritsugu Nakamura <nnakamur@...>

[#19420] xtoolkit — Kazuhiro Yoshida <moriq.kazuhiro@...>

[#19430] parsedate.rb — YASUI Kentarow <kenyasui@...>

[#19434] Ruby/Tk Reference Manual (Draft 1999-12-12) — Koji Arai <JCA02266@...>

[#19441] 自動翻訳プロジェクト — matz@... (Yukihiro Matsumoto)

[#19442] ClipBoard I/O 対応 — Itou-T15@...

[#19444] 「 (」を使う時の正規表現について — yuuichi satoh <yuuichi.satoh@...>

[#19456] mod_ruby & eRuby — Wakou Aoyama <wakou@...>

[#19484] Ruby Application Archive — matz@... (Yukihiro Matsumoto)

[#19493] -X で coredump — "U.Nakamura" <usa@...>

[#19514] ruby-1.4.3.tar.gz — Akinori MUSHA aka knu <knu@...>

[#19525] localhost 内の交信のしくみ — Itou-T15@...

[#19533] Ｗｉｎｄｏｗｓ環境 — "Shigeo Kobayashi" <shigeo@...>

[#19534] スレッドを起動するのが遅い — yuuichi satoh <yuuichi.satoh@...>

[#19544] String#shift? — Kazuhiko Izawa <izawa@...>

[#19545] Re: localhost 内の交信のしくみ — "Masatoshi SEKI" <m_seki@...>

[#19546] Book Review — Noritsugu Nakamura <nnakamur@...>

[#19549] RubyRing — TAKEUCHi Kahori (竹内かほり) <take-k@...>

[#19552] RubyMidi 、とその今後 — 中村暁史 Nakamura Akifumi <BXQ04723@...>

[#19563] REQ: Regexp#source — Tomoyuki Kosimizu <greentea@...2.so-net.ne.jp>

[#19568] Re: mod_ruby & eRuby — TAKEUCHi Kahori <take-k@...>

[#19576] X application on gtk application — gotoken@... (GOTO Kentaro)

[#19578] ruby-list の過去ログの作り方 — Momotaro Nishiumi <momotaro@...>

[#19593] SMF class 0.3 — Tadayoshi Funaba <tadf@...>

[#19596] Re: build on alpha — Toyofuku <toyofuku@...>

[#19211] Clipbord を　 Ruby で使うには？ — Itou-T15@...

[#19862] GC in Thread::new — 土岐仁謙 <toki@...>

[#19931] Web 掲示板 — 堀川　久 <vzw00011@...>