Ruby語言的官方解釋程序是使用C語言開發的,一般用C語言來編寫擴展。D語言和C語言是二進制兼容的,所以可以使用D語言編寫Ruby擴展。
一、移植C庫到D的一般過程
C使用頭文件來處理符號依賴,在D里面鏈接外部庫文件時,要使用extern (C)聲明來引入符號,這是一個轉換過程。
如何轉換一個C頭文件到D文件?D文檔的htomodule.html有詳盡說明。一般的轉換過程如下:
1、運行預處理程序處理掉頭文件里面的宏。
2、刪除經過預處理以后的多余信息。由于C的頭文件包含,每個頭文件經過預處理以后都會包含一些重復內容,我們需要剔除這部分內容,通過查找行號即可完成。
3、轉換相應聲明到D聲明,這一步可以使用一個c2h程序來完成。
注意預處理程序處理完畢以后,宏函數以及宏定義的常量會被去除,這可能不是你想要的,所以最好的辦法可能是手工轉換。
另一種調用是在D里面調用動態鏈接庫,這需要你使用implib工具從動態鏈接庫產生一個.lib導入庫文件,然后生成D聲明,再編譯鏈接即可。如果是在linux下使用共享庫,則只需要編寫D聲明文件,然后直接鏈接即可。
二、調用C庫
轉換完畢以后,就可以調用了。如果你只是要測試一下,就可以只聲明使用過的外部函數、變量即可。
例如我們要編寫Programming Ruby里面的一個Ruby Extension例子,相應的D代碼如下:
//
?test.d
module?test;
import?ruby;
extern
(C)
VALUE?t_init(VALUE?self)
{
??VALUE?arr?
=
?rb_ary_new();
??rb_iv_set(self,?
"
@arr
"
,?arr);
??
return
?self;
}
extern
(C)
VALUE?t_add(VALUE?self,?VALUE?anObject)
{
??VALUE?arr?
=
?rb_iv_get(self,?
"
@arr
"
);
??rb_ary_push(arr,?anObject);
??
return
?arr;
}
extern
(C){
VALUE?cTest;
alias?VALUE(
*
func_type)();
export?
void
?Init_Test()
{
??cTest?
=
?rb_define_class(
"
Test
"
,?rb_cObject);
??rb_define_method(cTest,?
"
initialize
"
,?cast(func_type)
&
t_init,?
0
);
??rb_define_method(cTest,?
"
add
"
,?cast(func_type)
&
t_add,?
1
);
}
}??
//
?extern(C)
和C代碼很相似。由于我們只使用了幾個外部函數、變量,所以只需要聲明這幾個符號即可:
//
?ruby.d
module?ruby;
extern
?(C){
????alias?
ulong
?VALUE;
????VALUE?rb_cObject;
????VALUE?rb_ary_new?();
????VALUE?rb_ary_push?(VALUE,?VALUE);
????VALUE?rb_iv_set?(VALUE,??
char
*
,?VALUE);
????VALUE?rb_iv_get?(VALUE,??
char
*
);
????VALUE?rb_define_class?(?
char
*
,VALUE);
????
void
?rb_define_method?(VALUE,?
char
*
,VALUE(
*
)(),
int
);
}
三、生成動態鏈接庫(Windows DLL)或共享庫(Linux so文件)
D語言在Windows上編寫DLL,除了要有D源文件以外,還要有DLL定義文件:
//
?test.def
LIBRARY?????????Test
DESCRIPTION?????
'
Test?written?in?D
'
EXETYPE??NT
CODE????????????PRELOAD?DISCARDABLE
DATA????????????PRELOAD?SINGLE
這是一個通用的格式,只是一些描述信息,因為D中可以使用export關鍵字導出符號,所以不需要在這里聲明導出函數,只有在編寫COM DLL時才會增加其它一些信息。
另外由于D語言要初始化GC以及其它一些信息,所以還需要在DllMain里面調用初始化及終止代碼。由于不同平臺的初始化過程不完全相同,這里我簡單封閉了一下不同平臺的初始化代碼:
//
?os/library.d
module?os.library;
extern
(C){
??
void
?gc_init();
??
void
?gc_term();
??version(Windows)?
void
?_minit();
??
void
?_moduleCtor();
??
void
?_moduleDtor();
??
void
?_moduleUnitTests();
??version(linux)?
void
?_STI_monitor_staticctor();
??version(linux)?
void
?_STI_critical_init();
??version(linux)?
void
?_STD_monitor_staticdtor();
??version(linux)?
void
?_STD_critical_term();
}
extern
(C)
void
?d_init()
{
??
//
?writefln("Start?init?D?runtime");
??version(linux)?_STI_monitor_staticctor();
??version(linux)?_STI_critical_init();
??gc_init();
??version(Windows)?_minit();
??_moduleCtor();
??_moduleUnitTests();
??
//
?writefln("init?finished");
}
extern
(C)
void
?d_fini()
{
??
//
?writefln("Start?term?D?runtime");
??_moduleDtor();
??gc_term();
??version(linux)?_STD_critical_term();
??version(linux)?_STD_monitor_staticdtor();
??
//
?writefln("term?finished");
}
現在可以為Windows編寫初始化及終止代碼:
//
?os/dll.d
module?os.dll;
private
?import?os.library;
private
?import?std.c.windows.windows;
HINSTANCE?g_hInst;
extern
?(Windows)
BOOL?DllMain(HINSTANCE?hInstance,?ULONG?ulReason,?LPVOID?pvReserved)
{
??
switch
?(ulReason)
??{
????
case
?DLL_PROCESS_ATTACH:
??????d_init();
??????
break
;
????
case
?DLL_PROCESS_DETACH:
??????d_fini();
??????
break
;
????
case
?DLL_THREAD_ATTACH:
????
case
?DLL_THREAD_DETACH:
??????
//
?Multiple?threads?not?supported?yet
??????
return
?
false
;
??}
??g_hInst
=
hInstance;
??
return
?
true
;
}
由于Linux共享庫并沒有標準的入口函數(或是我不知道它),這里使用gcc擴展的初始、終止代碼,不過是以C語言實現的:
//
?os/so.c
#include?
<
ruby.h
>
static
?
void
?so_init(
void
)?__attribute__((constructor));
static
?
void
?so_fini(
void
)?__attribute__((destructor));
extern
?
void
?d_init(
void
);
extern
?
void
?d_fini(
void
);
void
?so_init(
void
)
{
??d_init();
}
void
?so_fini(
void
)
{
??d_fini();
}
現在可以嘗試編譯鏈接,在Linux上編譯命令如下:
gcc?
-
o?os
/
so.o?
-
c?os
/
so.c?
-
I?
/
usr
/
lib
/
ruby
/
1.8
/
i686
-
linux?
gdc?
-
o?Test.so?test.d?os
/
so.o?ruby.d?
-
shared?
-
fPIC?
-
lruby
你可以在irb下測試:
require?
'
Test
'
test?
=
?Test.
new
test.add(
1
)
test.add(
2
)
test.add(
"
a
"
)
可以看到add總是返回一個array,與期望結果一致。
使用gdc是因為dmd在linux上無法生成共享庫。
在Windows上的編譯命令如下:
dmd?
-
oftest.dll?test.d?test.def?ruby18.lib?os
/
dll.d?os
/
library.d
ruby18.lib是使用implib從msvcrt-ruby18.dll導出的,這個編譯過程很順利,不過不幸的是它運行有一些問題,大概是一些初始值錯誤,我暫時還沒有找到原因。或許也應該嘗試一下gdc,不過我不知道如何從.DLL文件導出一個gdc支持的ELF格式的導入庫文件。
四、項目打算
打算建立一個rubyd項目,除了轉換ruby頭文件以外,還要作一些擴展,比如轉換D類到ruby類,這方面已有借鑒,比如dsource.org上的pyd項目。
由于以前在建立項目方面有過失敗經歷(asgard項目由于興趣轉移和其它原因比如語法丑陋等而未能進行),這次還是保守一些,先完成D聲明的轉換,我已經使用工具轉換了所有頭文件,不過正如前面所說,宏函數和宏常量都丟失了,所以需要重新手工轉換。
五、其它問題
1、如何從.DLL文件導出一個gdc支持的ELF格式的導入庫文件?如果你知道可以告訴我,先謝過了。
2、dmd生成可執行文件問題不大,生成動態鏈接庫或共享庫有很大缺陷,特別是不能生成共享庫,我可不想再找一個只能再Windows上正常運行的編譯器。如何讓它改進這些方面?
3、gdc使用dmd前端和gcc后端,應該會成熟一些,不過一般會比dmd前端版本稍低,而且gdc發布版本不是很頻繁,大概4-5個dmd版本才會有一個gdc版本(初略計算),所以一些新特性不能夠及時加入進來。