[ruby-dev:36131] Re: [ANN] Ruby 1.9.1仕様凍結

斎藤と申します。

まずは一拡張ライブラリの作者として「中身を丸出しにしないでインターフェースを
はっきりさせる」という方向性に賛成である、ということを言っておきたいです。

On Tue, 2 Sep 2008 22:06:55 +0900
"NARUSE, Yui" <[e-mail]> wrote:

> 成瀬です。
> 
> Yugui (Yuki Sonoda) wrote:
> >  * CレベルのAPIはruby-core/ruby-devでの事前相談なしに変更不可
> >    * include/ruby/*.hにあるすべての構造体、データ型、変数、関数、マクロ
> > はCレベルAPIと見なします。
> >    * 公開したくないものはinclude/ruby/*.hから移動させてください。
> 
> コミッタ側に向けての事前相談義務はよいと思うのですが、
> 公開 C API と宣言してしまうのは微妙かもしれません。

そうでしょうか。自分は「include/ruby以下は公開」というのが分かりやすく、
望ましい姿であると感じます。

> 例えば oniguruma.h は encoding.h が依存しているためにそこにあるのであって、
(snip)

こちらはよく分かってないのですが、

> また別の例ですと、RString 構造体のメンバを直接いじられても困ります。
> これをいじる時は RSTRING_PTR や RSTRING_LEN 等のマクロを使うものであって、
> RSTRING(str)->as.heap.len 等は非公開だと考えるべきでしょう。

ならば、非公開情報を保持しているRString自体を非公開にするのが筋ではないでしょうか。
まだまだ非公開にすべき・できる部分がありますが、とりあえず試作したパッチを末尾に
付けます。
# そういうお話ではない? > yuguiさん

> つまるところ、公開 C API のリストというかドキュメントというかが必要というか、
> README.EXT がそれな気がするので、拡張ライブラリを作る方はそのようにご留意ください。

拡張ライブラリを一度でも作ったことのある人間ならば、README.EXTが網羅的なもので
ないことは、火を見るより明らかでしょう。

「インストールされたヘッダファイル＝公開されたAPI」というごく当たり前の事が、Ruby
でも実現されることを望みます。そうすれば、APIのリストはヘッダファイルを見れば
分かります。文字通り、ソースがドキュメントです。


Index: include/ruby/ruby.h
===================================================================
--- include/ruby/ruby.h	(revision 19086)
+++ include/ruby/ruby.h	(working copy)
@@ -573,32 +573,14 @@
 #define ELTS_SHARED FL_USER2
 
 #define RSTRING_EMBED_LEN_MAX ((sizeof(VALUE)*3)/sizeof(char)-1)
-struct RString {
-    struct RBasic basic;
-    union {
-	struct {
-	    long len;
-	    char *ptr;
-	    union {
-		long capa;
-		VALUE shared;
-	    } aux;
-	} heap;
-	char ary[RSTRING_EMBED_LEN_MAX + 1];
-    } as;
-};
 #define RSTRING_NOEMBED FL_USER1
 #define RSTRING_EMBED_LEN_MASK (FL_USER2|FL_USER3|FL_USER4|FL_USER5|FL_USER6)
 #define RSTRING_EMBED_LEN_SHIFT (FL_USHIFT+2)
-#define RSTRING_LEN(str) \
-    (!(RBASIC(str)->flags & RSTRING_NOEMBED) ? \
-     (long)((RBASIC(str)->flags >> RSTRING_EMBED_LEN_SHIFT) & \
-            (RSTRING_EMBED_LEN_MASK >> RSTRING_EMBED_LEN_SHIFT)) : \
-     RSTRING(str)->as.heap.len)
-#define RSTRING_PTR(str) \
-    (!(RBASIC(str)->flags & RSTRING_NOEMBED) ? \
-     RSTRING(str)->as.ary : \
-     RSTRING(str)->as.heap.ptr)
+long RSTRING_LEN(VALUE str);
+char *RSTRING_PTR(VALUE str);
+/* for compatibility */
+#define RSTRING_LEN(str) RSTRING_LEN(str)
+#define RSTRING_PTR(str) RSTRING_PTR(str)
 #define RSTRING_END(str) (RSTRING_PTR(str)+RSTRING_LEN(str))
 
 struct RArray {
@@ -746,7 +728,6 @@
 #define RCLASS(obj)  (R_CAST(RClass)(obj))
 #define RMODULE(obj) RCLASS(obj)
 #define RFLOAT(obj)  (R_CAST(RFloat)(obj))
-#define RSTRING(obj) (R_CAST(RString)(obj))
 #define RREGEXP(obj) (R_CAST(RRegexp)(obj))
 #define RARRAY(obj)  (R_CAST(RArray)(obj))
 #define RHASH(obj)   (R_CAST(RHash)(obj))
Index: string.c
===================================================================
--- string.c	(revision 19086)
+++ string.c	(working copy)
@@ -14,6 +14,7 @@
 #include "ruby/ruby.h"
 #include "ruby/re.h"
 #include "ruby/encoding.h"
+#include "private.h"
 
 #define BEG(no) regs->beg[no]
 #define END(no) regs->end[no]
@@ -106,6 +107,23 @@
     }\
 } while (0)
 
+inline long
+RSTRING_LEN(VALUE str)
+{
+    return !(RBASIC(str)->flags & RSTRING_NOEMBED) ?
+        (long)((RBASIC(str)->flags >> RSTRING_EMBED_LEN_SHIFT) &
+               (RSTRING_EMBED_LEN_MASK >> RSTRING_EMBED_LEN_SHIFT)) :
+        RSTRING(str)->as.heap.len;
+}
+
+inline char *
+RSTRING_PTR(VALUE str)
+{
+    return !(RBASIC(str)->flags & RSTRING_NOEMBED) ?
+        RSTRING(str)->as.ary :
+        RSTRING(str)->as.heap.ptr;
+}
+
 #define is_ascii_string(str) (rb_enc_str_coderange(str) == ENC_CODERANGE_7BIT)
 #define is_broken_string(str) (rb_enc_str_coderange(str) == ENC_CODERANGE_BROKEN)
 
Index: gc.c
===================================================================
--- gc.c	(revision 19086)
+++ gc.c	(working copy)
@@ -20,6 +20,7 @@
 #include "eval_intern.h"
 #include "vm_core.h"
 #include "gc.h"
+#include "private.h"
 #include <stdio.h>
 #include <setjmp.h>
 #include <sys/types.h>
Index: parse.y
===================================================================
--- parse.y	(revision 19086)
+++ parse.y	(working copy)
@@ -21,6 +21,7 @@
 #include "ruby/encoding.h"
 #include "id.h"
 #include "regenc.h"
+#include "private.h"
 #include <stdio.h>
 #include <errno.h>
 #include <ctype.h>


--
斎藤ただし
# intern.h == internal というファイルの存在意義が分かってない