wstp.h

wstp.h

WSTPのヘッダファイルである.

詳細

  • WSTPのC関数は,ファイルwstp.hの中で宣言される.このことは, 任意のWSTP互換プログラムのソースコードに含まれるべきである.
  • 次の特別な型はwstp.hの中で定義される:
  • WSLINKWSTPリンクオブジェクト (Wolfram言語のLinkObject に似ている)
    WSMARKWSTPの流れの中のマーク
    WSENVWSTPライブラリ環境
  • 次の定数はWSTPテンプレートファイルが処理されるときに設定される:
  • WSLINK stdlinkWSTPテンプレートで構築されたプログラムをWolframシステムに接続する標準リンク
    WSLINK stdenvWSTPテンプレートから構築されたプログラム内の標準WSTP環境
  • wstp.hで定義される関数はすべてC言語関数である. これらの関数は,適切なラッパーを使って他の言語から呼び出すことができる.
  • intを返すwstp.h内で定義されるすべての関数は,関数が成功すると非零の値を返す.それ以外の場合には0を返し,効果がない.
  • WSTPテンプレート(.tm ファイル)を使って設定されたプログラムでは,Wolframシステムへのリンクはstdlinkと呼ばれる.
  • wstp.hで定義されて,データをリンクに置く関数はすべて,データを保持するのに使われたメモリを解放しない.リンクからデータを得る関数は,データを保持するのにメモリを割り当てるかもしれない. リンクからデータを得る関数は,必要とするデータが使用できるようになるまで返さない.降伏関数を登録して,待っている間呼び出すことができる.