ruby-dev

黒田拓です。
なかださん、お返事ありがとうございました。

Nobuyoshi Nakada さんは書きました:
> 基本的には、こういった機能追加は1.8ではなく1.9でしょう。

言われてみればそうでした。
頂いた助言を元にパッチを作り直したのですが、今回、パッチ元は1.9にしました。


> 細かいことをいうと、remove_unwanted_langがちょっとまどろっこしい
> かな。

修正、ありがとうございました。自分の書いたコードがえらくスッキリと変わっ
ていて驚きました。


> * lang: が視覚的な区切りとして認識しづらい

とりあえず:section:とかと同様に、:lang: を区切りにするようにしたのです
が、あまり変わらないですね。悩ましいところです。

他に、
>         if l.sub!(/^(\s*\#?).*\s*lang:\s*([a-z]{2})/n, '\1')
>           sl = $2
などとして「`:lang: ja'の前後に任意の文字を入れられる」とかも考えてみた
のですが、条件がゆるすぎるような気がして今回提出のパッチには入れていない
です。

後は使い方の問題にして、ドキュメントを書く際に言語指定の前に空行だけのコ
メント行を入れて目立たせるとかでしょうか。


> * 出力されたHTMLのcharsetがiso8859-1のまま
> * 異なるエンコーディングはどう扱うべきか
> といったあたりが疑問です。

まず、デフォルトのcharset指定をUTF-8に変更してみました。

そして、出力するcharsetに応じて、Kconvを使って変換するオプションを追加し
てみました。
起動時に
 * -K オプションが指定されていたらKconvを使って変換する
 * `-k euc' などとして変換元の文字コードを指定出来る
 * -kによる指定がない場合は、変換元文字コードにはKconv::AUTOを使う
という動作です。

 ~/$ rdoc -l ja -K -k euc -c Shift_jis
といった具合です。

他の言語がどう記述されるか見当がつかなかったので(本当に多言語なドキュメ
ントをソースに入れるならUTF-8を使うことになるのでしょうか)、僕の方ではと
りあえず日本語のみを念頭に考えています。


-- 
--------------------------------------------------
 黒田 拓(くろだ ひらく)
    hiraku@sapporo.email.ne.jp
    http://www.hinet.mydns.jp/~hiraku/
--------------------------------------------------

Attachments (1)

rdoc_i18n_1.9-r12874.patch (3.16 KB, text/x-diff)

diff -ur ruby1.9.orig/lib/rdoc/options.rb ruby1.9/lib/rdoc/options.rb
--- ruby1.9.orig/lib/rdoc/options.rb	2007-02-13 08:01:19.000000000 +0900
+++ ruby1.9/lib/rdoc/options.rb	2007-08-05 23:45:11.000000000 +0900
@@ -94,6 +94,12 @@
   # scan newer sources than the flag file if true.
   attr_reader :force_update
 
+  # Language of Document
+  attr_reader :lang
+  attr_reader :lang_strict
+  attr_reader :kcode
+  attr_reader :kconv
+
   module OptionList
 
     OPTION_LIST = [
@@ -238,6 +244,18 @@
         "name of the current file will be substituted;\n" +
         "if the URL doesn't contain a '\%s', the\n" +
         "filename will be appended to it." ],
+
+      [ "--lang",          "-l",   "language",
+        "Set language of document."],
+
+      [ "--lang-strict",   "-L",  nil,
+        "Use ONLY language-specified(or not specified) document."],
+
+      [ "--kconv", "-K", nil,
+	"Convert comment charset by kconv."],
+
+      [ "--kcode", "-k", "kcode",
+	"Set charset of comments in source file."],
     ]
 
     def OptionList.options
@@ -381,7 +399,7 @@
                  when /^E/i
                    'EUC-JP'
                  else
-                   'iso-8859-1'
+                   'UTF-8'
                  end
 
       accessors = []
@@ -409,6 +427,10 @@
         when "--template"      then @template      = arg
         when "--title"         then @title         = arg
         when "--webcvs"        then @webcvs        = arg
+        when "--lang"          then @lang          = arg
+        when "--lang-strict"   then @lang_strict   = true
+	when "--kcode"         then @kcode = arg
+	when "--kconv"         then @kconv = true
 
         when "--accessor" 
           arg.split(/,/).each do |accessor|
diff -ur ruby1.9.orig/lib/rdoc/parsers/parse_rb.rb ruby1.9/lib/rdoc/parsers/parse_rb.rb
--- ruby1.9.orig/lib/rdoc/parsers/parse_rb.rb	2007-02-13 08:01:19.000000000 +0900
+++ ruby1.9/lib/rdoc/parsers/parse_rb.rb	2007-08-05 23:45:11.000000000 +0900
@@ -2339,6 +2339,9 @@
           context.set_current_section(param, comment)
           comment.clear
           break 
+
+	when "lang"
+	  break
         else
           warn "Unrecognized directive '#{directive}'"
           break
@@ -2346,6 +2349,7 @@
       end
 
       remove_private_comments(comment)
+      remove_unwanted_lang(comment)
     end
 
     def remove_private_comments(comment)
@@ -2353,6 +2357,42 @@
       comment.sub!(/^#--.*/m, '')
     end
 
+    def remove_unwanted_lang(comment)
+      dl = @options.lang # Document Language
+      strict = @options.lang_strict
+      sl = nil # Section Language
+      r = []
+      comment.each_line do |l|
+	if l.sub!(/^(\s*\#?)\s*:lang:\s*([a-z]{2})(?=\s|$)/n, '\1')
+	  sl = $2
+	  r << l
+	elsif sl == dl or !(strict || (dl && sl))
+	  r << l
+	end
+      end
+
+      r = r.join
+      if @options.kconv
+	require "kconv"
+	oc, ic = [@options.charset, @options.kcode].map do |i|
+	  case i
+	  when /^s/i
+	    Kconv::SJIS
+	  when /^e/i
+	    Kconv::EUC
+	  when /^u/i
+	    Kconv::UTF8
+	  else
+	    nil
+	  end
+	end
+	oc = Kconv::UTF8 unless oc
+	ic = Kconv::AUTO unless ic
+	r = r.kconv(oc, ic)
+      end
+
+      comment.replace(r)
+    end
 
 
     def get_symbol_or_name

Thread

Prev Next

In This Thread

Prev Next

[#31320] Import RubyGems to Ruby 1.9 — "NAKAMURA, Hiroshi" <nakahiro@...>

[#31323] Bignum#to_s の Karatsuba 基数変換による高速化 — "Kenta Murata" <muraken@...>

[#31330] Rubyアソシエーション設立のご報告 — Shugo Maeda <shugo@...>

[#31333] Invalid error message by illegal regexp — KIMURA Koichi <kimura.koichi@...>

[#31344] IO.popen with an array in trunk — sheepman <sheepman@...>

[#31345] RDoc i18n化パッチ — KURODA Hiraku <hiraku@...>

[#31349] Array#[]=(pos, length, val) and Array#[]=(range, val) — sheepman <sheepman@...>

[#31351] set_trace_func NULL pointer given — eklerni <eklerni@...>

[#31356] nmake don't have $< macro — KIMURA Koichi <kimura.koichi@...>

[#31357] invalid string for Date.parse — Yukihiro Matsumoto <matz@...>

[#31360] infinite loop at peephole optimization — "Yusuke ENDOH" <mame@...>

[#31361] retry neglects signals — "Yusuke ENDOH" <mame@...>

[#31362] typo in enum.c — Kazuhiro NISHIYAMA <zn@...>

[#31371] simultaneous exceptions dump core — "Yusuke ENDOH" <mame@...>

[#31372] jump in rescue clause in eval dumps core — "Yusuke ENDOH" <mame@...>

[#31373] jump in ensure dumps core — "Yusuke ENDOH" <mame@...>

[#31374] ARGF.each_byte yields a string — Tanaka Akira <akr@...>

[#31376] Re: [ ruby-Bugs-9490 ] Date module, step method, infinite loop if +step+ is 0 should raise an exception? — Urabe Shyouhei <shyouhei@...>

[#31377] Re: [ ruby-Patches-11719 ] add a :passive option to open-uri's open method — Urabe Shyouhei <shyouhei@...>

[#31378] Re: [ ruby-Patches-11954 ] CGI::HTTP_STATUS is incomplete — Urabe Shyouhei <shyouhei@...>

[#31379] Re: [ ruby-Bugs-10646 ] Failure parsing dates returned by WIN32OLE — Urabe Shyouhei <shyouhei@...>

[#31380] Re: [ ruby-Bugs-1823 ] NUM2UINT and rb_num2ull do not rase RangeError for negative Fixnum — Urabe Shyouhei <shyouhei@...>

[#31397] File exists - /tmp/bootstraptest.tmpwd — Tanaka Akira <akr@...>

[#31403] Re: [ ruby-Bugs-3361 ] Ruby 1.8.4 parse errors — Urabe Shyouhei <shyouhei@...>

[#31404] negative allocation size in rb_f_sprintf — Tietew <tietew+ruby-dev@...>

[#31407] [BUG] Stack consistency error (sp: 11, bp: 12) — Tanaka Akira <akr@...>

[#31416] Dir.mktmpdir — Tanaka Akira <akr@...>

[#31417] Process.euid [BUG] Segmentation fault — Tanaka Akira <akr@...>

[#31420] method `method_missing' called on terminated object (0xb7cbd6dc) (NotImplementedError) — Tanaka Akira <akr@...>

[#31424] Re: [ruby-cvs:20177] Re: Ruby:r12931 (trunk): * io.c (argf_close): always close via method. — Nobuyoshi Nakada <nobu@...>

[#31434] LP64: -0x10000000000000001 << -0x80000001 — Tanaka Akira <akr@...>

[#31437] yield [0] to {|*,v|} — Tanaka Akira <akr@...>

[#31438] /bin/sh: BASERUBY@: command not found — Tanaka Akira <akr@...>

[#31439] typo in ChangeLog — Kazuhiro NISHIYAMA <zn@...>

[#31440] yield [1] to {|v,&b| p v } — Tanaka Akira <akr@...>

[#31448] Ruby's (new) Bizarre Operator(s) — Nobuyoshi Nakada <nobu@...>

[#31462] Dir.mktmpdir for 1.8 — Tanaka Akira <akr@...>

[#31464] lambda {|a| p a }.call(1,2) — Tanaka Akira <akr@...>

[#31470] nested fiber invocation — Yukihiro Matsumoto <matz@...>

[#31472] lambda {|&b|}.call(3) — Tanaka Akira <akr@...>

[#31473] setter of $! — SASADA Koichi <ko1@...>

[#31475] lambda {|(v0,v1),v2|}.call([1],2) — Tanaka Akira <akr@...>

[#31480] trunk/test/ruby/test_proc.rb:127 — SASADA Koichi <ko1@...>

[#31481] trunk/test/test_time.rb — SASADA Koichi <ko1@...>

[#31492] SEGV: def m() yield [] end; m(&lambda {|*v| p v}) — Tanaka Akira <akr@...>

[#31502] {|(a,a)|} — Tanaka Akira <akr@...>

[#31507] {|(a)|} assigns outer local variable — Tanaka Akira <akr@...>

[#31511] trunk/test/ruby/test_eval.rb — SASADA Koichi <ko1@...>

[#31522] a, a = 1, 2 — Tanaka Akira <akr@...>

[#31525] いくつかのバグ報告と提案(5点) — eklerni <eklerni@...>

[#31531] 多重代入の*とto_ary — eklerni <eklerni@...>

[#31539] strtod の精度 — Satoshi Nakagawa <snakagawa@...>

[#31547] duck typing — "NAKAMURA, Hiroshi" <nakahiro@...>

[#31561] ignore exception message — SASADA Koichi <ko1@...>

[#31566] test_set and test_hash — Tanaka Akira <akr@...>

[#31576] test/win32ole — SASADA Koichi <ko1@...>

[#31583] Fiber reviesed — SASADA Koichi <ko1@...>

[#31592] [BUG] iseq_compile_each: unknown node: NODE_METHOD — Tanaka Akira <akr@...>

[#31603] benchmark of loops — SASADA Koichi <ko1@...>

[#31609] catch without a tag argument — Tanaka Akira <akr@...>

[#31625] IO.sysdup2, IO.sysdup, IO.sysclose — Tanaka Akira <akr@...>

[#31643] Re: [ruby-list:43915] Re: Hashへの生成順は保障されないのか？ — SASADA Koichi <ko1@...>

[#31646] Re: [ruby-cvs:20498] Ruby:r13261 (trunk): * encoding.c: provide basic features for M17N. — Tanaka Akira <akr@...>

[#31650] ungetc — Tanaka Akira <akr@...>

[#31651] rb_enc_mbclen — Tanaka Akira <akr@...>

[#31652] test/ruby/ — SASADA Koichi <ko1@...>

[#31659] each_byte and break — Tanaka Akira <akr@...>

[#31661] String#inspectで無限ループ — akira yamada / やまだあきら <akira@...>

[#31663] return in rescue in while in eval dumps core — "Yusuke ENDOH" <mame@...>

[#31665] String#slice! — WATANABE Tetsuya <Tetsuya.WATANABE@...>

[#31666] IndexError in rindex — Nobuyoshi Nakada <nobu@...>

[#31669] Re: [ ruby-Bugs-11882 ] recursive invokation of garbage_collect() in dlptr_free() — Urabe Shyouhei <shyouhei@...>

[#31671] Array#slice! — Satoshi Nakagawa <snakagawa@...>

[#31672] -Kオプションとparser->encの関係 — akira yamada / やまだあきら <akira@...>

[#31674] flush_register_windowsの"ta 0x83" — akira yamada / やまだあきら <akira@...>

[#31678] optimize empty hash space — Tanaka Akira <akr@...>

[#31679] ruby_1_8_5 undefined reference to `_RSTRING_PTR' — Masaki Suketa <masaki.suketa@...>

[#31682] mkmf.rb:310:in `method_missing': undefined method `quote' for nil:NilClass — akira yamada / やまだあきら <akira@...>

[#31684] WindowsのUnicodeファイル名 — OJ <oj@24.am>

[#31687] instance variable as formal argument — "Yusuke ENDOH" <mame@...>

[#31351] set_trace_func　NULL pointer given — eklerni <eklerni@...>