プログラミング言語SML#解説 4.0.0版

\,\langle

\rangle\,

: _import

\,\langle

cfunty

\rangle\,

19.21 静的インポート式: _import $\,\langle$ string $\rangle\,$ : $\,\langle$ cfunty $\rangle\,$

C関数を直接SML#関数として使用するための式である．構文の構成要素の意味は以下のとおりである．

•

$\,\langle$ string $\rangle\,$ ：C関数名．この名前が，リンク時にリンカによって外部名として参照される名前である．
•

$\,\langle$ cfunty $\rangle\,$ ：C関数の型の指定．以下の文法に従い，C関数の型を指定する．

C関数型： $\,\langle$ cfunty $\rangle\,$
$\,\langle$ cfunty $\rangle\,$	::=	$($ $\,\langle$ cfunattr $\rangle\,$ $)?$ $\,\langle$ argTyList $\rangle\,$ -> $\,\langle$ retTyOpt $\rangle\,$
$\,\langle$ argTyList $\rangle\,$	::=	( $\,\langle$ argTy $\rangle\,$ , $\ldots$ , $\,\langle$ argTy $\rangle\,$ $($ , $\,\langle$ varArgs $\rangle\,$ $)?$ )	(複数引数)
	$\|$	$\,\langle$ argTy $\rangle\,$	(引数がただ1つ)
	$\|$	()	(引数なし)
$\,\langle$ retTyOpt $\rangle\,$	::=	$\,\langle$ retTy $\rangle\,$
	$\|$	()	(Cのvoid型に対応)
コールバック関数型： $\,\langle$ argfunty $\rangle\,$
$\,\langle$ argfunty $\rangle\,$	::=	$($ $\,\langle$ cfunattr $\rangle\,$ $)?$ $\,\langle$ retTylist $\rangle\,$ -> $\,\langle$ argTyOpt $\rangle\,$
$\,\langle$ retTyList $\rangle\,$	::=	( $\,\langle$ retTy $\rangle\,$ , $\ldots$ , $\,\langle$ retTy $\rangle\,$ $($ , $\,\langle$ varRets $\rangle\,$ $)?$ )	(複数引数)
	$\|$	$\,\langle$ retTy $\rangle\,$	(引数がただ1つ)
	$\|$	()	(引数なし)
$\,\langle$ argTyOpt $\rangle\,$	::=	$\,\langle$ argTy $\rangle\,$
	$\|$	()	(Cのvoid型に対応)
相互運用型： $\,\langle$ interoperableTy $\rangle\,$
$\,\langle$ interoperableTy $\rangle\,$	::=	$($ $\,\langle$ tySeq $\rangle\,$ $)?$ $\,\langle$ longTycon $\rangle\,$	(Cと受け渡し可能な型に限る．以下に詳述)
SML#からCに渡す引数の型： $\,\langle$ argTy $\rangle\,$
$\,\langle$ argTy $\rangle\,$	::=	$\,\langle$ argTy $\rangle\,$ * $\cdots$ * $\,\langle$ argTy $\rangle\,$	(Cの構造体へのポインタ型に相当)
	$\|$	{ $\,\langle$ argTyRow $\rangle\,$ }	(Cの構造体へのポインタ型に相当)
	$\|$	$\,\langle$ tyvar $\rangle\,$	(boxedカインドを持つものに限る)
	$\|$	$\,\langle$ interoperableTy $\rangle\,$
	$\|$	$\,\langle$ argfunty $\rangle\,$	(コールバック関数引数型)
$\,\langle$ argTyRow $\rangle\,$	::=	$\,\langle$ lab $\rangle\,$ : $\,\langle$ argTy $\rangle\,$ $($ , $\,\langle$ argTyRow $\rangle\,$ $)?$	( $\,\langle$ lab $\rangle\,$ は $\,\langle$ decimal $\rangle\,$ で始まるものに限る)
CからSML#に渡される返り値の型： $\,\langle$ retTy $\rangle\,$
$\,\langle$ retTy $\rangle\,$	::=	$\,\langle$ interoperableTy $\rangle\,$
	$\|$	$\,\langle$ tyvar $\rangle\,$	(boxedカインドを持つものに限る)
可変長引数型指定： $\,\langle$ varArgs $\rangle\,$ および $\,\langle$ varRets $\rangle\,$
$\,\langle$ varArgs $\rangle\,$	::=	... ( $\,\langle$ argTy $\rangle\,$ , $\ldots$ , $\,\langle$ argTy $\rangle\,$ )
$\,\langle$ varRets $\rangle\,$	::=	... ( $\,\langle$ retTy $\rangle\,$ , $\ldots$ , $\,\langle$ retTy $\rangle\,$ )
C関数属性指定： $\,\langle$ cfunattr $\rangle\,$
$\,\langle$ cfunattr $\rangle\,$	::=	__attribute__(( $\,\langle$ attr $\rangle\,$ , $\ldots$ , $\,\langle$ attr $\rangle\,$ ))
$\,\langle$ att $\rangle\,$	::=	cdecl $\|$ stdcall $\|$ fastcc $\|$ pure $\|$ fast

C関数の型に現れる型名 $\,\langle$ interoperableTy $\rangle\,$ は，以下の2つの条件を全て満たさなければならない．

1.
$\,\langle$ interoperableTy $\rangle\,$ は以下のいずれかでなければならない．
- •
  
  相互運用可能な原子型： int, int8, int16, int64, word, word8, word16, word64, real, real32, char, または string.
- •
  
  Cポインタの型： codeptr, $\,\langle$ interoperableTy $\rangle\,$ ptr, または unit ptr.
- •
  
  多相Cポインタ型： $\,\langle$ tyvar $\rangle\,$ ptr (ただし $\,\langle$ tyvar $\rangle\,$ はboxedカインドまたはunboxedカインドを持つものに限る).
- •
  
  サイズ型： $\,\langle$ ty $\rangle\,$ size.
- •
  
  配列型： $\,\langle$ interoperableTy $\rangle\,$ array, $\,\langle$ interoperableTy $\rangle\,$ vector, または $\,\langle$ interoperableTy $\rangle\,$ ref.
- •
  
  多相配列型： $\,\langle$ tyvar $\rangle\,$ array, $\,\langle$ tyvar $\rangle\,$ vector, または $\,\langle$ tyvar $\rangle\,$ ref (ただし $\,\langle$ tyvar $\rangle\,$ はboxedカインドまたはunboxedカインドを持つものに限る).
- •
  
  type宣言で付けた，上記の型のいずれかの別名． $($ $\,\langle$ tySeq $\rangle\,$ $)?$ $\,\langle$ longTycon $\rangle\,$ を展開すると上記のいずれかにならなければならない．ただし， $\,\langle$ argTy $\rangle\,$ としての $\,\langle$ interoperableTy $\rangle\,$ に type宣言で付けた型の別名が来た場合に限り， $($ $\,\langle$ tySeq $\rangle\,$ $)?$ $\,\langle$ longTycon $\rangle\,$ を展開した結果が $\,\langle$ argTy $\rangle\,$ 相当の組型あるいはレコード型であっても良い．
2.

CからSML#に渡されたり，Cが書き換えたりする可能性のある値の型に，string型，array型，vector型，および ref型が現れてはならない．すなわち，これらの型は以下の箇所に現れてはならない．
- •
  
  $\,\langle$ retTy $\rangle\,$ としての $\,\langle$ interoperableTy $\rangle\,$
- •
  
  array，ref，およびptr型の型パラメタ

以上の条件を満たす $\,\langle$ interoperableTy $\rangle\,$ は，その型名から自然に類推されるCの型に相当する．対応を以下に示す．

$\,\langle$ interoperableTy $\rangle\,$	対応するCの型
intおよびその仲間	同じサイズの符号付き整数型
wordおよびその仲間	同じサイズの符号付き整数型
real	double
real32	float
char	char
string	const char *
codeptr	Cの関数へのポインタ型
$\tau$ ptr	$\tau$ へのポインタの型
unit ptr	void *または不完全型へのポインタ型
$\tau$ size	size_t
$\tau$ array	$\tau$ 型の配列の先頭を指すポインタ型
$\tau$ vector	$\tau$ 型のconst配列の先頭を指すポインタ型
$\tau$ ref	$\tau$ 型の要素数1の配列を指すポインタ型

SML#のintおよびwordは常に 32ビットサイズの整数であることに注意されたい．今日のほとんどのシステムでは SML#のintとCのintは対応するが， intが32ビットでないシステムではこれらは対応しない．

$\,\langle$ argTy $\rangle\,$ の $\,\langle$ argTy ${}_{1}$ $\rangle\,$ * $\cdots$ * $\,\langle$ argTy ${}_{n}$ $\rangle\,$ および { $\,\langle$ lab ${}_{1}$ $\rangle\,$ : $\,\langle$ argTy ${}_{1}$ $\rangle\,$ , $\cdots$ , $\,\langle$ lab ${}_{n}$ $\rangle\,$ : $\,\langle$ argTy ${}_{n}$ $\rangle\,$ }型は， $\,\langle$ argTy ${}_{1}$ $\rangle\,$ , $\cdots$ , $\,\langle$ argTy ${}_{n}$ $\rangle\,$ をラベルの $\,\langle$ decimal $\rangle\,$ の順番でメンバとして持つ const付き構造体型へのポインタに対応する．もし，全ての $\,\langle$ argTy ${}_{i}$ $\rangle\,$ が同じならば，要素数 $n$ の $\,\langle$ argTy ${}_{i}$ $\rangle\,$ のconst付き配列の先頭へのポインタにも対応する．

C関数がSML#から見てパラメタ多相的に働くとき，かつその場合に限り，C関数の引数および返り値の型として型変数を書いても良い．例えば，Cの恒等関数

    void *id(void *x) { return x; }

を以下のようにインポートしてもよい．

    val ’a#boxed id = _import "id" : ’a -> ’a

また，任意のポインタの値を表示するprintf関数を以下のようにインポートしてもよい．

    val ’a#boxed printPtr = _import "printf" : (string,...(’a)) -> int

C関数の型の前に記述する属性の意味は以下の通りである．

cdecl: ターゲットプラットフォーム標準のC関数呼び出し規約に従うC関数であることを表す．呼び出し規約に関する属性が指定されていない場合のデフォルトである．
stdcall: Windowsプラットフォームにおけるstdcall呼び出し規約に従うC関数であることを表す．
fastcc: LLVMが提供するfastcc呼び出し規約に従うC関数であることを表す．
pure: C関数がSML#から見て純粋な関数であることを表す．すなわち，この属性を持つC関数は，メモリの書き換えを行わず，かつ引数リストのみから返り値がただ1つに定まる． SML#コンパイラの最適化に影響を与える．
fast: C関数が非常に短い時間で終了することを表す．この属性を持つC関数は，コールバック関数を通じてSML#のコードを呼び出したり，スレッドの実行を中断してはならない． SML#コンパイラは，この属性を持つC関数に対して，より効率の良い呼び出しコードを生成する．ただし，この属性を持つC関数が長い時間を消費すると， GCに影響を与え，このC関数が終了するまでの間，全スレッドの実行が止まる可能性がある．

この式の型は， $\,\langle$ cfunty $\rangle\,$ で指定したC関数の型に対応する SML#の関数型である．対応の定義は以下の通りである．

C関数型	SML#関数型
( $\,\langle$ argTy $\rangle\,$ ${}_{1}$ , $\ldots$ , $\,\langle$ argTy $\rangle\,$ ${}_{n}$ $($ $\,\langle$ varArgs $\rangle\,$ $)?$ ) -> $\,\langle$ retTy $\rangle\,$	$\,\langle$ argTy $\rangle\,$ ${}_{1}$ * $\cdots$ * $\,\langle$ argTy $\rangle\,$ ${}_{n}$ $($ * $\,\langle$ varArgs $\rangle\,$ $)?$ -> $\,\langle$ retTy $\rangle\,$

$\,\langle$ argTyList $\rangle\,$ または $\,\langle$ retTyOpt $\rangle\,$ が()の場合は， unit型としてSML#の型に現れる． $\,\langle$ interoperableTy $\rangle\,$ ， $\,\langle$ tyvar $\rangle\,$ ，および $\,\langle$ * $\rangle\,$ はそのままSML#の型に現れる．この定義は，コールバック関数型 $\,\langle$ argfunty $\rangle\,$ についても同様である．

この式の値は， $\,\langle$ string $\rangle\,$ で指定されたC関数を呼び出す SML#の関数である． C関数型の指定が正しい限り，通常のSML#関数として使用できる．

19.21 静的インポート式: _import ⟨string⟩ : ⟨cfunty⟩

19.21 静的インポート式: _import $\,\langle$ string $\rangle\,$ : $\,\langle$ cfunty $\rangle\,$