README.EXT

.\" README.EXT -  -*- Text -*- created at: Mon Aug  7 16:45:54 JST 1995

This document explains how to make extention modules for Ruby.

1．Basic knowledge

In C, variables have types and data do not have types.  In contrast,
Ruby variables do not have static type and data themselves have
types.  So, data need to be converted across the languages.

Data in Ruby represented C type `VALUE'.  Each VALUE data have its
data-type.

To retrieve an C data from the VALUE, you need to:

 (1) Identify VALUE's data type
 (2) Convert VALUE into C data

Converting to wrong data type may cause serious promblems.


1.1 Data-types

Ruby interpreter has data-types as below:

	T_NIL		nil
	T_OBJECT	ordinaly object
	T_CLASS		class
	T_MODULE	module
	T_FLOAT		floating point number
	T_STRING	string
	T_REGEXP	regular expression
	T_ARRAY		array
	T_FIXNUM	Fixnum(31bit integer)
	T_HASH		assosiative array
	T_STRUCT	(Ruby) structure
	T_BIGNUM	multi precision integer
	T_TRUE		true
	T_FALSE		false
	T_DATA		data

Otherwise, there are several other types used internally:

	T_ICLASS
	T_MATCH
	T_VARMAP
	T_SCOPE
	T_NODE

Most of the types are represented by C structures.

1.2 Check Data Type of the VALUE

The macro TYPE() defined in ruby.h shows data-type of the VALUE.
TYPE() returns the constant number T_XXXX described above.  To handle
data-types, the code will be like:

  switch (TYPE(obj)) {
    case T_FIXNUM:
      /* process Fixnum */
      break;
    case T_STRING:
      /* process String */
      break;
    case T_ARRAY:
      /* process Array */
      break;
    default:
      /* raise exception */
      Fail("not valid value");
      break;
  }

There is the data-type check function.

  void Check_Type(VALUE value, int type)

It raises an exception, if the VALUE does not have the type specified.

There are faster check-macros for fixnums and nil.

  FIXNUM_P(obj)
  NIL_P(obj)

1.3 Convert VALUE into C data

The data for type T_NIL, T_FALSE, T_TRUE are nil, true, false
respectively.  They are singletons for the data type.

The T_FIXNUM data is the 31bit length fixed integer (63bit length on
some machines), which can be conver to the C integer by using
FIX2INT() macro.  There also be NUM2INT() which converts any Ruby
numbers into C integer.  The NUM2INT() macro includes type check, so
the exception will be raised if conversion failed.

Other data types have corresponding C structures, e.g. struct RArray
for T_ARRAY etc.  VALUE of the type which has corresponding structure
can be cast to retrieve the pointer to the struct.  The casting macro
RXXXX for each data type like RARRAY(obj).  see "ruby.h".

For example, `RSTRING(size)->len' is the way to get the size of the
Ruby String object.  The allocated region can be accessed by
`RSTRING(str)->ptr'.  For arrays, `RARRAY(ary)->len' and
`RARRAY(ary)->ptr' respectively.

Notice: Do not change the value of the structure directly, unless you
are responsible about the result.  It will be the cause of interesting
bugs.

1.4 Convert C data into VALUE

VALUEの実際の構造は

  * FIXNUMの場合

    1bit右シフトして，LSBを立てる．

  * その他のポインタの場合

    そのままVALUEにキャストする．

となっています．よって，LSBをチェックすればVALUEがFIXNUMかど
うかわかるわけです(ポインタのLSBが立っていないことを仮定して
いる)．

ですから，FIXNUM以外のRubyのオブジェクトの構造体は単にVALUE
にキャストするだけでVALUEに変換出来ます．ただし，任意の構造
体がVALUEにキャスト出来るわけではありません．キャストするの
はRubyの知っている構造体(ruby.hで定義されているstruct RXxxx
のもの)だけにしておいてください．

FIXNUMに関しては変換マクロを経由する必要があります．Cの整数
からVALUEに変換するマクロは以下のものがあります．必要に応じ
て使い分けてください．

  INT2FIX()	for intergers within 31bits.
  INT2NUM()	for arbitrary sized integer.

INT2NUM() converts integers into Bignums, if it is out of FIXNUM
range, but bit slower.

1.5 Manipulate Ruby data

As I already told, it is not recommended to modify object's internal
structure.  To manipulate objects, use functions supplied by Ruby
interpreter.  Useful functions are listed below (not all):

 String funtions

  rb_str_new(char *ptr, int len)

    Creates a new Ruby string.

  rb_str_new2(char *ptr)

    Creates a new Ruby string from C string.  This is equivalent to
    rb_str_new(ptr, strlen(ptr)).

  rb_str_cat(VALUE str, char *ptr, int len)

    Appends len bytes data from ptr to the Ruby string.

 Array functions

  rb_ary_new()

    Creates an array with no element.

  rb_ary_new2(int len)

    Creates an array with no element, with allocating internal buffer
    for len elements.

  rb_ary_new3(int n, ...)

    Creates an n-elements array from arguments.

  rb_ary_new4(int n, VALUE *elts)

    Creates an n-elements array from C array.

  rb_ary_push(VALUE ary, VALUE val)
  rb_ary_pop(VALUE ary)
  rb_ary_shift(VALUE ary)
  rb_ary_unshift(VALUE ary, VALUE val)
  rb_ary_entry(VALUE ary, int idx)

    Array operations.  The first argument to each functions must be an 
    array.  They may dump core if other types given.

2. Extend Ruby with C

原理的にRubyで書けることはCでも書けます．RubyそのものがCで記
述されているんですから，当然といえば当然なんですけど．ここで
はRubyの拡張に使うことが多いだろうと予測される機能を中心に紹
介します．

2.1 Add new features to Ruby

Rubyで提供されている関数を使えばRubyインタプリタに新しい機能
を追加することができます．Rubyでは以下の機能を追加する関数が
提供されています．

 * Classes, Modules
 * Methods, Singleton Methods
 * Constants

2.1.1 Class/module definition

To define class or module, use functions below:

  VALUE rb_define_class(char *name, VALUE super)
  VALUE rb_define_module(char *name)

These functions return the newly created class ot module.  You may
want to save this reference into the variable to use later.

2.1.2 Method/singleton method definition

To define methods or singleton methods, use functions below:

  void rb_define_method(VALUE class, char *name, 
		        VALUE (*func)(), int argc)

  void rb_define_singleton_method(VALUE object, char *name, 
			          VALUE (*func)(), int argc)

The `argc' represents the number of the arguments to the C function,
which must be less than 17.  But I believe you don't need that much. :-)

If `argc' is negative, it specifies calling sequence, not number of
the arguments.  

If argc is -1, the function will be called like:

  VALUE func(int argc, VALUE *argv, VALUE obj)

where argc is the actual number of arguments, argv is the C array of
the arguments, and obj is the receiver.

if argc is -2, the arguments are passed in Ruby array. The function
will be called like:

  VALUE func(VALUE obj, VALUE args)

where obj is the receiver, and args is the Ruby array containing
actual arguments.

There're two more functions to define method.  One is to define
private method:

  void rb_define_private_method(VALUE class, char *name, 
			        VALUE (*func)(), int argc)

The other is to define module function, which is private AND singleton
method of the module.  For example, sqrt is the module function
defined in Math module.  It can be call in the form like:

  Math.sqrt(4)

or

  include Math
  sqrt(4)

To define module function

  void rb_define_module_function(VALUE module, char *name, 
				 VALUE (*func)(), int argc)

Oh, in addition, function-like method, which is private method defined
in Kernel module, can be defined using:

  void rb_define_global_function(char *name, VALUE (*func)(), int argc)


2.1.3 Constant definition

We have 2 functions to define constants:

  void rb_define_const(VALUE class, char *name, VALUE val)
  void rb_define_global_const(char *name, VALUE val)

The former is to define constant under specified class/module.  The
latter is to define global constant.

2.2 Use Ruby features from C

There are several ways to invoke Ruby's features from C code.

2.2.1 Evaluate Ruby Program in String

Easiest way to call Ruby's function from C program is to evaluate the
string as Ruby program.  This function will do the job.

  VALUE rb_eval_string(char *str)

Evaluation is done under current context, thus current local variables
of the innermost method (which is defined by Ruby) can be accessed.

2.2.2 ID or Symbol

You can invoke methods directly, without parsing the string.  First I
need to explain about symbols (which data type is ID).  ID is the
integer number to represent Ruby's identifiers such as variable names.
It can be accessed from Ruby in the form like:

 :Identifier

You can get the symbol value from string within C code, by using

  rb_intern(char *name)

In addition, the symbols for one character operators (e.g +) is the
code for that character.

2.2.3 Invoke Ruby method from C

To invoke methods directly, you can use the function below

  VALUE rb_funcall(VALUE recv, ID mid, int argc, ...)

This function invokes the method of the recv, which name is specified
by the symbol mid.

2.2.4 Accessing the variables and constants

Cから関数を使って参照・更新できるのは，クラス定数，インスタ
ンス変数です．大域変数は一部のものはCの大域変数としてアクセ
スできます．ローカル変数を参照する方法は公開していません．

The functions to access/modify instance variables are below:

  VALUE rb_ivar_get(VALUE obj, ID id)
  VALUE rb_ivar_set(VALUE obj, ID id, VALUE val)

id must be the symbol, which can be retrieved by rb_intern().

To access the constants of the class/module:

  VALUE rb_const_get(VALUE obj, ID id)

See 2.1.3 for defining new constant.

3. Informatin sharing between Ruby and C

C言語とRubyの間で情報を共有する方法について解説します．

3.1 Ruby constant that Cから参照できるRubyの定数

Following Ruby constants can be referred from C.

  Qtrue
  Qfalse

Boolean values.  Qfalse is false in the C also (i.e. 0).

  Qnil

Ruby nil in C scope.

3.2 Global variables shared between C and Ruby

CとRubyで大域変数を使って情報を共有できます．共有できる大域
変数にはいくつかの種類があります．そのなかでもっとも良く使わ
れると思われるのはrb_define_variable()です．

  void rb_define_variable(char *name, VALUE *var)

この関数はRubyとCとで共有する大域変数を定義します．変数名が
`$'で始まらない時には自動的に追加されます．この変数の値を変
更すると自動的にRubyの対応する変数の値も変わります．

またRuby側からは更新できない変数もあります．このread onlyの
変数は以下の関数で定義します．

  void rb_define_readonly_variable(char *name, VALUE *var)

これら変数の他にhookをつけた大域変数を定義できます．hook付き
の大域変数は以下の関数を用いて定義します．hook付き大域変数の
値の参照や設定はhookで行う必要があります．

  void rb_define_hooked_variable(char *name, VALUE *var,
				 VALUE (*getter)(), VALUE (*setter)())

この関数はCの関数によってhookのつけられた大域変数を定義しま
す．変数が参照された時には関数getterが，変数に値がセットされ
た時には関数setterが呼ばれる．hookを指定しない場合はgetterや
setterに0を指定します．

# getterもsetterも0ならばrb_define_variable()と同じになる．

それから，Cの関数によって実現されるRubyの大域変数を定義する
関数があります．

  void rb_define_virtual_variable(char *name,
				  VALUE (*getter)(), VALUE (*setter)())

この関数によって定義されたRubyの大域変数が参照された時には
getterが，変数に値がセットされた時にはsetterが呼ばれます．

The prototypes of the getter and setter functions are as following:

  (*getter)(ID id, void *data, struct global_entry* entry);
  (*setter)(VALUE val, ID id, void *data, struct global_entry* entry);

3.3 Encapsulate C data into Ruby object

Cの世界で定義されたデータ(構造体)をRubyのオブジェクトとして
取り扱いたい場合がありえます．このような場合には，Dataという
RubyオブジェクトにCの構造体(へのポインタ)をくるむことでRuby
オブジェクトとして取り扱えるようになります．

Dataオブジェクトを生成して構造体をRubyオブジェクトにカプセル
化するためには，以下のマクロを使います．

  Data_Wrap_Struct(class,mark,free,ptr)

このマクロの戻り値は生成されたDataオブジェクトです．

classはこのDataオブジェクトのクラスです．ptrはカプセル化する
Cの構造体へのポインタです．markはこの構造体がRubyのオブジェ
クトへの参照がある時に使う関数です．そのような参照を含まない
時には0を指定します．

# そのような参照は勧められません．

freeはこの構造体がもう不要になった時に呼ばれる関数です．この
関数がガーベージコレクタから呼ばれます．

Cの構造体の割当とDataオブジェクトの生成を同時に行うマクロと
して以下のものが提供されています．

  Data_Make_Struct(class, type, mark, free, sval)

このマクロの戻り値は生成されたDataオブジェクトです．

class, mark, freeはData_Wrap_Structと同じ働きをします．type
は割り当てるC構造体の型です．割り当てられた構造体は変数sval
に代入されます．この変数の型は (type*) である必要があります．

Dataオブジェクトからポインタを取り出すのは以下のマクロを用い
ます．

  Data_Get_Struct(obj, type, sval)

Cの構造体へのポインタは変数svalに代入されます．

これらのDataの使い方はちょっと分かりにくいので，後で説明する
例題を参照してください．

4．Example - Create dbm module

ここまでの説明でとりあえず拡張ライブラリは作れるはずです．
Rubyのextディレクトリにすでに含まれているdbmモジュールを例に
して段階的に説明します．

(1) make the directory

  % mkdir ext/dbm

Make a directory for the extension library under ext directory.

(2) create MANIFEST file

  % cd ext/dbm
  % touch MANIFEST

There should be MANIFEST file in the directory for the extension
library.  Make empty file now.

(3) design the library

You need to design the library features, before making it.

(4) write C code.

拡張ライブラリ本体となるC言語のソースを書きます．C言語のソー
スがひとつの時には「モジュール名.c」を選ぶと良いでしょう．C
言語のソースが複数の場合には逆に「モジュール名.c」というファ
イル名は避ける必要があります．オブジェクトファイルとモジュー
ル生成時に中間的に生成される「モジュール名.o」というファイル
とが衝突するからです．

Rubyは拡張ライブラリをロードする時に「Init_モジュール名」と
いう関数を自動的に実行します．dbmモジュールの場合「Init_dbm」
です．この関数の中でクラス，モジュール，メソッド，定数などの
定義を行います．dbm.cから一部引用します．

--
Init_dbm()
{
    /* define DBM class */
    cDBM = rb_define_class("DBM", rb_cObject);
    /* DBM includes Enumerate module */
    rb_include_module(cDBM, rb_mEnumerable);

    /* DBM has class method open(): arguments are received as C array */
    rb_define_singleton_method(cDBM, "open", fdbm_s_open, -1);

    /* DBM instance method close(): no args */
    rb_define_method(cDBM, "close", fdbm_close, 0);
    /* DBM instance method []: 1 argument */
    rb_define_method(cDBM, "[]", fdbm_fetch, 1);
		:

}
--

DBMモジュールはdbmのデータと対応するオブジェクトになるはずで
すから，Cの世界のdbmをRubyの世界に取り込む必要があります．


dbm.cではData_Make_Structを以下のように使っています．

--
struct dbmdata {
    int  di_size;
    DBM *di_dbm;
};


obj = Data_Make_Struct(class,struct dbmdata,0,free_dbm,dbmp);
--

ここではdbmstruct構造体へのポインタをDataにカプセル化してい
ます．DBM*を直接カプセル化しないのはclose()した時の処理を考
えてのことです．

Dataオブジェクトからdbmstruct構造体のポインタを取り出すため
に以下のマクロを使っています．

--
#define GetDBM(obj, dbmp) {\
    Data_Get_Struct(obj, struct dbmdata, dbmp);\
    if (dbmp->di_dbm == 0) closed_dbm();\
}
--

ちょっと複雑なマクロですが，要するにdbmdata構造体のポインタ
の取り出しと，closeされているかどうかのチェックをまとめてい
るだけです．

DBMクラスにはたくさんメソッドがありますが，分類すると3種類の
引数の受け方があります．ひとつは引数の数が固定のもので，例と
してはdeleteメソッドがあります．deleteメソッドを実装している
fdbm_delete()はこのようになっています．

--
static VALUE
fdbm_delete(obj, keystr)
    VALUE obj, keystr;
{
	:
}
--

引数の数が固定のタイプは第1引数がself，第2引数以降がメソッド
の引数となります．

引数の数が不定のものはCの配列で受けるものとRubyの配列で受け
るものとがあります．dbmモジュールの中で，Cの配列で受けるもの
はDBMのクラスメソッドであるopen()です．これを実装している関
数fdbm_s_open()はこうなっています．

--
static VALUE
fdbm_s_open(argc, argv, class)
    int argc;
    VALUE *argv;
    VALUE class;
{
	:
    if (rb_scan_args(argc, argv, "11", &file, &vmode) == 1) {
	mode = 0666;		/* default value */
    }
	:
}
--

このタイプの関数は第1引数が与えられた引数の数，第2引数が与え
られた引数の入っている配列になります．selfは第3引数として与
えられます．

この配列で与えられた引数を解析するための関数がopen()でも使わ
れているrb_scan_args()です．第3引数に指定したフォーマットに
従い，第4変数以降に指定した変数に値を代入してくれます．この
フォーマットは，第1文字目が省略できない引数の数，第2文字目が
省略できる引数の数，第3文字目が対応する相手が無いあまりの引
数があるかどうかを示す"*"です．2文字目と3文字目は省略できま
す．dbm.cの例では，フォーマットは"11"ですから，引数は最低1つ
で，2つまで許されるという意味になります．省略されている時の
変数の値はnil(C言語のレベルではQnil)になります．

Rubyの配列で引数を受け取るものはindexesがあります．実装はこ
うです．

--
static VALUE
fdbm_indexes(obj, args)
    VALUE obj;
    struct RArray *args;
{
	:
}
--

第1引数はself，第2引数はRubyの配列です．ここではキャストを減
らすため struct RArray* で受けていますが，VALUEでも同じこと
です．

** Notice

GC should know about global variables which refers Ruby's objects, but
not exported to the Ruby world.  You need to protect them by

  void rb_global_variable(VALUE *var)

(5) prepare extconf.rb

もしディレクトリに「extconf.rb」というファイルが存在すれば，
make時に実行されます．なければ適当にMakefileが生成されます．

extconf.rbはモジュールのコンパイルに必要な条件のチェックなど
を行うことが目的です．extconf.rbの中では以下のRuby関数を使う
ことが出来ます．

  have_library(lib, func): ライブラリの存在チェック
  have_func(func): 関数の存在チェック
  have_header(header): ヘッダファイルの存在チェック
  create_makefile(target): Makefileの生成

以下の変数を使うことができます．

  $CFLAGS: コンパイル時に追加的に指定するフラグ(-Iなど)
  $LDFLAGS: リンク時に追加的に指定するフラグ(-Lなど)

モジュールをコンパイルする条件が揃わなず，そのモジュールはコ
ンパイルしない時にはcreate_makefileを呼ばなければMakefileは
生成されず，コンパイルも行われません．

(6) prepare depend (optional)

If the file named depend exists, Makefile will include that file to
check dependency.  You can make this file by invoking

 % gcc -MM *.c > depend

It's no harm.  Prepare it.

(7) MANIFESTファイルにファイル名を入れる

  % find * -type f -print > MANIFEST
  % vi MANIFEST

Append file names into MANIFEST.  The compilation scheme requires
MANIFEST only to be exist.  But, you'd better take this step to
distinguish required files.

(8) make

Rubyのディレクトリでmakeを実行するとMakefileを生成からmake，
必要によってはそのモジュールのRubyへのリンクまで自動的に実行
してくれます．extconf.rbを書き換えるなどしてMakefileの再生成
が必要な時はまたRubyディレクトリでmakeしてください．

(9) debug

You may need to rb_debug the module.  The modules can be linked 
statically by adding directory name in the ext/Setup file,
so that you can inspect the module by the debugger.

(10) done, now you have the extension library

You can do anything you want with your library.  The author of Ruby
will not claim any restriction about your code depending Ruby API.
Feel free to use, modify, distribute or sell your program.

Appendix A. Rubyのソースコードの分類

Rubyのソースはいくつかに分類することが出来ます．このうちクラ
スライブラリの部分は基本的に拡張ライブラリと同じ作り方になっ
ています．これらのソースは今までの説明でほとんど理解できると
思います．

ruby language core

  class.c
  error.c
  eval.c
  gc.c
  object.c
  parse.y
  variable.c

utility functions

  dln.c
  fnmatch.c
  glob.c
  regex.c
  st.c
  util.c

ruby interpreter implementation

  dmyext.c
  inits.c
  main.c
  ruby.c
  version.c

class library

  array.c
  bignum.c
  compar.c
  dir.c
  enum.c
  file.c
  hash.c
  io.c
  math.c
  numeric.c
  pack.c
  process.c
  random.c
  range.c
  re.c
  signal.c
  sprintf.c
  string.c
  struct.c
  time.c

Appendix B. Ruby extension API reference

C言語からRubyの機能を利用するAPIは以下の通りである．

** 型

 VALUE

Rubyオブジェクトを表現する型．必要に応じてキャストして用いる．
組み込み型を表現するCの型はruby.hに記述してあるRで始まる構造
体である．VALUE型をこれらにキャストするためにRで始まる構造体
名を全て大文字にした名前のマクロが用意されている．

** Variables and constants

 Qnil

const: nil object

 Qtrue

const: Qtrue object(default true value)

 Qfalse

const: Qfalse object

** C pointer wrapping

 Data_Wrap_Struct(VALUE class, void (*mark)(), void (*free)(), void *sval)

Cの任意のポインタをカプセル化したRubyオブジェクトを返す．こ
のポインタがRubyからアクセスされなくなった時，freeで指定した
関数が呼ばれる．また，このポインタの指すデータが他のRubyオブ
ジェクトを指している場合，markに指定する関数でマークする必要
がある．

 Data_Make_Struct(class, type, mark, free, sval)

type型のメモリをmallocし，変数svalに代入した後，それをカプセ
ル化したデータを返すマクロ．

 Data_Get_Struct(data, type, sval)

dataからtype型のポインタを取り出し変数svalに代入するマクロ．

** defining class/module

 VALUE rb_define_class(char *name, VALUE super)

Defines new Ruby class as subclass of super.

 VALUE rb_define_class_under(VALUE module, char *name, VALUE super)

Creates new Ruby class as subclass of super, under the module's
namespace.

 VALUE rb_define_module(char *name)

Defines new Ruby module.

 VALUE rb_define_module_under(VALUE module, char *name, VALUE super)

Defines new Ruby module, under the modules's namespace.

 void rb_include_module(VALUE class, VALUE module)

Includes module into class.  If class already includes it, just
ignore.

 void rb_extend_object(VALUE object, VALUE module)

Extend the object with module's attribute.

** Defining Global Variables

 void rb_define_variable(char *name, VALUE *var)

Defines a global variable which is shared between C and Ruby.  If name
contains the character which is not allowed to be part of the symbol,
it can't be seen from Ruby programs.

 void rb_define_readonly_variable(char *name, VALUE *var)

Defines a read-only global variable.  Works just like
rb_define_variable(), except defined variable is read-only.

 void rb_define_virtual_variable(char *name,
				VALUE (*getter)(), VALUE (*setter)())

Defines a virtual variable, whose behavior is defined by pair of C
functions.  The getter function is called when the variable is
referred. The setter function is called when the value is set to the
variable.  The prototype for getter/setter functions are:

	VALUE getter(ID id)
	void setter(VALUE val, ID id)

The getter function must return the value for the access.

 void rb_define_hooked_variable(char *name, VALUE *var,
				VALUE (*getter)(), VALUE (*setter)())

Defines hooked variable.  It's virtual variable with C variable.  The
getter is called as

	VALUE getter(ID id, VALUE *var)

returning new value.  The setter is called as

	void setter(VALUE val, ID id, VALUE *var)

GC requires to mark the C global variables which hold Ruby values.

 void rb_global_variable(VALUE *var)

Tells GC to protect these variables.

** Constant Definition

 void rb_define_const(VALUE klass, char *name, VALUE val)

Defines a new constant under the class/module.

 void rb_define_global_const(char *name, VALUE val)

Defines global contant.  This is just work as

     rb_define_const(cKernal, name, val)

** Method Definition

 rb_define_method(VALUE class, char *name, VALUE (*func)(), int argc)

Defines a method for the class.  func is the function pointer.  argc
is the number of arguments.  if argc is -1, the function will receive
3 arguments argc, argv, and self.  if argc is -2, the function will
receive 2 arguments, self and args, where args is the Ruby array of
the method arguments.

 rb_define_private_method(VALUE class, char *name, VALUE (*func)(), int argc)

Defines a private method for the class.  Arguments are same as
rb_define_method().

 rb_define_singleton_method(VALUE class, char *name, VALUE (*func)(), int argc)

Defines a singleton method.  Arguments are same as rb_define_method().

 rb_scan_args(int atgc, VALUE *argv, char *fmt, ...)

argc,argv形式で与えられた引数を分解する．fmtは必須引数の数, 
付加引数の数, 残りの引数があるかを指定する文字列で, "数字数
字*"という形式である． 2 番目の数字と"*"はそれぞれ省略可能で
ある．必須引数が一つもない場合は0を指定する．第3引数以降は変
数へのポインタで, 該当する要素がその変数に格納される．付加引
数に対応する引数が与えられていない場合は変数にQnilが代入され
る．

** Rubyメソッド呼び出し

 VALUE rb_funcall(VALUE recv, ID mid, int narg, ...)

Invokes the method.  To retrieve mid from method name, use rb_intern().

 VALUE rb_funcall2(VALUE recv, ID mid, int argc, VALUE *argv)

Invokes method, passing arguments by array of values.

 VALUE rb_eval_string(char *str)

Compiles and executes the string as Ruby program.

 ID rb_intern(char *name)

Returns ID corresponding the name.

 char *rb_id2name(ID id)

Returns the name corresponding ID.

 char *rb_class2name(VALUE class)

Returns the name of the class.

** Instance Variables

 VALUE rb_iv_get(VALUE obj, char *name)

Retrieve the value of the instance variable.  If the name is not
prefixed by `@', that variable shall be inaccessible from Ruby.

 VALUE rb_iv_set(VALUE obj, char *name, VALUE val)

Sets the value of the instance variable.

** Control Structure

 VALUE rb_iterate(VALUE (*func1)(), void *arg1, VALUE (*func2)(), void *arg2)

func2をブロックとして設定し, func1をイテレータとして呼ぶ． 
func1には arg1が引数として渡され, func2には第1引数にイテレー
タから与えられた値, 第2引数にarg2が渡される．
 
 VALUE rb_yield(VALUE val)

valを値としてイテレータブロックを呼び出す．

 VALUE rb_rescue(VALUE (*func1)(), void *arg1, VALUE (*func2)(), void *arg2)

関数func1をarg1を引数に呼び出す．func1の実行中に例外が発生し
た時には func2をarg2を引数として呼ぶ．戻り値は例外が発生しな
かった時はfunc1の戻り値, 例外が発生した時にはfunc2の戻り値で
ある．

 VALUE rb_ensure(VALUE (*func1)(), void *arg1, void (*func2)(), void *arg2)

関数func1をarg1を引数として実行し, 実行終了後(たとえ例外が発
生しても) func2をarg2を引数として実行する．戻り値はfunc1の戻
り値である(例外が発生した時は戻らない)．

** 例外・エラー

 void rb_warning(char *fmt, ...)

rb_verbose時に標準エラー出力に警告情報を表示する．引数はprintf()と同じ．

 void rb_raise(rb_eRuntimeError, char *fmt, ...)

例外を発生させる．引数はprintf()と同じ．

 void rb_fatal(char *fmt, ...)

致命的例外を発生させる．通常の例外処理は行なわれず, インター
プリタが終了する(ただしensureで指定されたコードは終了前に実
行される)．

 void rb_bug(char *fmt, ...)

インタープリタなどプログラムのバグでしか発生するはずのない状
況の時呼ぶ．インタープリタはコアダンプし直ちに終了する．例外
処理は一切行なわれない．

** Initialize and Starts the Interpreter

The embedding API are below (not needed for extension libraries):

 void ruby_init(int argc, char **argv, char **envp)

Initializes the interpreter.

 void ruby_run()

Starts execution of the interpreter.

 void ruby_script(char *name)

Specifies the name of the script ($0).

Appendix B. Functions Available in extconf.rb

extconf.rbの中では利用可能なコンパイル条件チェックの関数は以
下の通りである．

 have_library(lib, func)

Checks whether library which contains specified function exists.
Returns true if the library exists.

 have_func(func)

Checks whether func exists.  Returns true if the function exists.  To
check functions in the additional library, you need to check that
library first using have_library().

 have_header(header)

Checks for the header files.  Returns true if the header file exists.

 create_makefile(target)

Generates the Makefile for the extension library.  If you don't invoke
this method, the compilation will not be done.

/*
 * Local variables:
 * fill-column: 70
 * end:
 */