XSUB.h、EXTERN.h、perl.h について

Question

◆状況
Ｃ言語＋Perlで作られている機能を、
Perlだけのソースに移行しようとしています。


◆困っていること
今まで、知らない言語を読む際、
ネットや本にある、関数一覧などから、
「そのプログラムで何をしようとしているか？」
を読み取れていたのですが、
Ｃ言語＋Perlにおける、下記の関数？？と思われるものなどについて、
全然、資料／情報が見つからず、困っています。

具体的には、

dXSARGS
Perl_croak
SvPV_nolen
XPUSHs 
PUTBACK

などです。
（恐らくは、EXTERN.h、perl.h、XSUB.h というヘッダファイルに定義されているのかも知れませんが。）
stdio.h　などにあるような、fopen関数だったり、fscanf関数などのようなものは、
いくらでもネット上／本に載っているのですが、上述のものについて、全然見つかりません、、

/***********************************/

また、includeファイルに、定数、構造体の定義、関数のプロトタイプ、マクロの定義、が記述されると認識していますが、
しかしながら、
ソース上に出てくる「Perl_croak」という箇所は、おそらく、Perl_croakという関数のように思われました。
と、すると、
includeファイルに、引数＆戻り値などのインターフェース仕様だけ書かれているのではなく、
Perl_croak関数が行う、「処理の実態」も、ヘッダファイルに記述されているということでしょうか？？


また、
dXSARGS という箇所については、戻り値を受け入れるような記述もなく、
dXSARGS;
と一行書かれているだけなのですが、関数ではなく、戻り値を必要としないサブルーチンということでしょうか？

/***********************************/

どなたか、資料／情報や、もしくは調べ方などをご存知の方がいらっしゃれば、
ご教授お願いできませんでしょうか？
些細な情報でも構いませんので、宜しくお願い致します。。

tatsu99 · Accepted Answer

perlの拡張モジュールをＣ言語で作成する場合に、
上記のEXTERN.h、perl.h、XSUB.hなどが必要になります。
私がＣ言語でperlの拡張モジュールを作ったのは、しばらく前のことなので、ずいぶん忘れており、的確な回答ができず、申し訳ないのですが、参照ＵＲＬのみ、添付しておきます。
perl日本語マニュアル
http://www.harukaze.net/~mishima/perl/man/
perlapi.1　Perl 5 の C 拡張のアプリケーションプログラミングインタフェース
http://www.harukaze.net/~mishima/perl/man/perlapi.1.html
perlguts.1　Perl の内部関数
http://www.harukaze.net/~mishima/perl/man/perlguts.1.html

http://perldoc.jp/docs/perl/5.8.8/
http://perldoc.jp/docs/perl/5.8.8/perlxs.pod
http://perldoc.jp/docs/perl/5.8.8/perlxstut.pod


http://argrath.ub32.org/perldocjp/5.10.0/
http://argrath.ub32.org/perldocjp/5.10.0/perlxs.html
http://argrath.ub32.org/perldocjp/5.10.0/perlxstut.html

sakusaker7 · Answer

質問者さんがあげられている

dXSARGS
Perl_croak
SvPV_nolen
XPUSHs
PUTBACK

ですが、perlapi.pod というドキュメントに当たれば簡単な解説がみつかります。
Perl_croakだけはcroakで探さないと見つかりませんが。

=item dXSARGS
X<dXSARGS>

Sets up stack and mark pointers for an XSUB, calling dSP and dMARK.
Sets up the C<ax> and C<items> variables by calling C<dAX> and C<dITEMS>.
This is usually handled automatically by C<xsubpp>.

dXSARGS;

=for hackers
Found in file XSUB.h

=item croak
X<croak>

This is the XSUB-writer's interface to Perl's C<die> function.
Normally call this function the same way you call the C C<printf>
function. Calling C<croak> returns control directly to Perl,
sidestepping the normal C order of execution. See C<warn>.

If you want to throw an exception object, assign the object to
C<$@> and then pass C<NULL> to croak():

errsv = get_sv("@", TRUE);
sv_setsv(errsv, exception_object);
croak(NULL);

voidcroak(const char* pat, ...)

=for hackers
Found in file util.c

=item SvPV_nolen
X<SvPV_nolen>

Returns a pointer to the string in the SV, or a stringified form of
the SV if the SV does not contain a string. The SV may cache the
stringified form becoming C<SvPOK>. Handles 'get' magic.

char*SvPV_nolen(SV* sv)

=for hackers
Found in file mathoms.c

=item XPUSHs
X<XPUSHs>

Push an SV onto the stack, extending the stack if necessary. Does not
handle 'set' magic. Does not use C<TARG>. See also C<XPUSHmortal>,
C<PUSHs> and C<PUSHmortal>.

voidXPUSHs(SV* sv)
=for hackers
Found in file pp.h

=item PUTBACK
X<PUTBACK>

Closing bracket for XSUB arguments. This is usually handled by C<xsubpp>.
See C<PUSHMARK> and L<perlcall> for other uses.

PUTBACK;

=for hackers
Found in file pp.h

なんのためにPerlで書き直そうとされてるのかわかりませんが、
仮にやるのであれば実装の詳細を調べて逐一置き換えるようなことではなく
引数と戻り値や処理の仕様から書き直すべきなんじゃないでしょうか。
この辺のマクロ類はPerlとCで書かれた拡張との引数のやり取りだとか
警告の出力のためのものですから、Pure Perlで書き直すために
必要なこととは思えないのですが。

XSUB.h、EXTERN.h、perl.h について

perlの拡張モジュールをＣ言語で作成する場合に、

質問者さんがあげられている

この回答への補足

関連するカテゴリからQ&Aを探す

デイリーランキングこのカテゴリの人気デイリーQ&Aランキング

マンスリーランキングこのカテゴリの人気マンスリーQ&Aランキング