-*- buffer-read-only: t -*-

!!!!!!! DO NOT EDIT THIS FILE !!!!!!! This file is built by autodoc.pl extracting documentation from the C source files.

名前¶

perlapi - perl public API の自動生成ドキュメント

DESCRIPTION ¶

このファイルは embed.pl で生成された perl の公式な API のドキュメントです; 特にエクステンションの作者が使うかもしれない関数、マクロ、フラグ、変数の 一覧です。 ここに挙げられていないどの関数のインターフェースも予告なしに 変更されることがあります。 この理由により、エクステンションを書くときに proto.h に挙げられている関数を 盲目的に使うことは避けるべきです。

全ての Perl API グローバル変数は PL_ という接頭辞をつけて 参照しなければならないということに注意してください。 一部のマクロは以前のものとの互換性を確保していてはいますが、それは将来の リリースにおいては無効になるかもしれません。

Perl はもともとも US-ASCII (つまり番号が 0 - 127 の範囲の文字)のみを 扱うように書かれていました。 そして文書とコメントは、実際には 0 - 255 の範囲全体を意味しているときに、 未だに ASCII という用語を使っているかもしれません。

Perl は EBCDIC (perlebcdic 参照) または ASCII でコンパイルおよび 実行できます。 ほとんどの文書は(およびコードのコメントさえも) EBCDIC の可能性を 無視しています。 ほとんどあらゆる用途で違いは透過的です。 例えば、EBCDIC では、Unicode 文字列をエンコードするのに UTF-8 ではなく UTF-EBCDIC が使われ、この文書で utf8 (および関数名を含むこの名前の 変形) を参照している場所ではどこでも UTF-EBCDIC を意味します。 しかし文字の番号は ASCII, EBCDIC, UTF- エンコーディングで異なり、 UTF-EBCDIC でエンコードされた文字列は UTF-8 よりも多くのバイト数を 使うことがあります。

また、一部の EBCDIC マシンでは、US-ASCII (または Unicode の用語では Basic Latin) を操作すると文書化されている関数は実際には対応する US-ASCII の サブセットではなく、EBCDIC の範囲の 256 文字全てを操作することがあります。

以下のリストは大文字小文字を無視したアルファベット順です。

値を「ちょうだい」¶

GIMME

A backward-compatible version of GIMME_V which can only return G_SCALAR or G_ARRAY; in a void context, it returns G_SCALAR. Deprecated. Use GIMME_V instead.

G_SCALAR か G_ARRAY しか返さないような GIMME_V の、過去互換性の ためのものです; 無効コンテキストでは、これは G_SCALAR を返します。 廃止予定です。 代わりに GIMME_V を使ってください。

        U32     GIMME

GIMME_V

The XSUB-writer's equivalent to Perl's wantarray. Returns G_VOID, G_SCALAR or G_ARRAY for void, scalar or list context, respectively.

XSUB 作成者のための、Perl の wantarray に透過なものです。 G_VOID、G_SCALAR、G_ARRAY をそれぞれ、無効コンテキスト、スカラ コンテキスト、リストコンテキストのときに返します。

        U32     GIMME_V

G_ARRAY

Used to indicate list context. See GIMME_V, GIMME and perlcall.

リストコンテキストを示すために使われます。 GIMME_V、GIMME、perlcall を参照してください。

G_DISCARD

Indicates that arguments returned from a callback should be discarded. See perlcall.

コールバックから返される引数が破棄されるべきものであることを示します。 perlcall を参照してください。

G_EVAL

Used to force a Perl eval wrapper around a callback. See perlcall.

コールバックを Perl の eval で囲むのを強制するために使われます。 perlcall を参照してください。

G_NOARGS

Indicates that no arguments are being sent to a callback. See perlcall.

コールバックに渡す引数がないことを示します。 perlcall を参照してください。

G_SCALAR

Used to indicate scalar context. See GIMME_V, GIMME, and perlcall.

スカラコンテキストを示すのに使われます。 GIMME_V, GIMME, perlcall を参照してください。

G_VOID

Used to indicate void context. See GIMME_V and perlcall.

無効コンテキストを示すために使われます。 GIMME_V と perlcall を参照してください。

配列操作関数¶

AvFILL

Same as av_len(). Deprecated, use av_len() instead.

av_len() と同様です。 廃止予定なので、代わりに av_len() を使ってください。

        int     AvFILL(AV* av)

av_clear

Clears an array, making it empty. Does not free the memory used by the array itself.

配列をクリアし、空にします。 配列自身が使っているメモリの解放はしません。

        void    av_clear(AV *av)

av_create_and_push

Push an SV onto the end of the array, creating the array if necessary. A small internal helper function to remove a commonly duplicated idiom.

SV を配列の最後にプッシュします; もし必要なら配列を作ります。 一般的に複製された慣用句を削除するための小さい内部ヘルパーです。

NOTE: this function is experimental and may change or be removed without notice.

注意: この関数は実験的で、予告なしに変更あるいは削除されるかもしれません。

        void    av_create_and_push(AV **const avp, SV *const val)

av_create_and_unshift_one

Unshifts an SV onto the beginning of the array, creating the array if necessary. A small internal helper function to remove a commonly duplicated idiom.

SV を配列の最初に unshift します; もし必要なら配列を作ります。 一般的に複製された慣用句を削除するための小さい内部ヘルパーです。

NOTE: this function is experimental and may change or be removed without notice.

注意: この関数は実験的で、予告なしに変更あるいは削除されるかもしれません。

        SV**    av_create_and_unshift_one(AV **const avp, SV *const val)

av_delete

Deletes the element indexed by key from the array. Returns the deleted element. If flags equals G_DISCARD, the element is freed and null is returned.

配列から、添え字が key の要素を削除します。 削除された要素を返します。 もし flags が G_DISCARD なら、要素は解放されて NULL が返されます。

        SV*     av_delete(AV *av, I32 key, I32 flags)

av_exists

Returns true if the element indexed by key has been initialized.

添え字が key の要素が既に初期化されているなら真を返します。

This relies on the fact that uninitialized array elements are set to &PL_sv_undef.

これは、初期化されていない配列要素は &PL_sv_undef が セットされているという事実に依存しています。

        bool    av_exists(AV *av, I32 key)

av_extend

Pre-extend an array. The key is the index to which the array should be extended.

配列を事前拡張します。 key は、拡張された後の配列の添え字です。

        void    av_extend(AV *av, I32 key)

av_fetch

Returns the SV at the specified index in the array. The key is the index. If lval is set then the fetch will be part of a store. Check that the return value is non-null before dereferencing it to a SV*.

配列中の指定された添え字にある SV を返します。 key は添え字です。 lval がセットされている場合、フェッチはストアの一部となります。 戻り値の SV* に対して参照外しをする場合にそれがヌルでないかを チェックしてください。

See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied arrays.

この関数をどのように tie されたハッシュに使うかに関するさらなる情報は "Understanding the Magic of Tied Hashes and Arrays" in perlguts を 参照してください。

        SV**    av_fetch(AV *av, I32 key, I32 lval)

av_fill

Set the highest index in the array to the given number, equivalent to Perl's $#array = $fill;.

配列の最大の添え字を与えられた数値にセットします; Perl の $#array = $fill; と等価です。

The number of elements in the an array will be fill + 1 after av_fill() returns. If the array was previously shorter then the additional elements appended are set to PL_sv_undef. If the array was longer, then the excess elements are freed. av_fill(av, -1) is the same as av_clear(av).

av_fill() から返った後、配列の要素数は fill + 1 になります。 配列が以前より短くなった場合は、追加された要素は PL_sv_undef が セットされます。 配列がより長くなった場合は、超過した要素は解放されます。 av_fill(av, -1) は av_clear(av) と同じです。

        void    av_fill(AV *av, I32 fill)

av_len

Returns the highest index in the array. The number of elements in the array is av_len(av) + 1. Returns -1 if the array is empty.

配列中で最大の添え字を返します。 配列の要素数は av_len(av) + 1 です。 配列が空である場合には -1 を返します。

        I32     av_len(const AV *av)

av_make

Creates a new AV and populates it with a list of SVs. The SVs are copied into the array, so they may be freed after the call to av_make. The new AV will have a reference count of 1.

新しい AV を生成して、SV のリストで埋めます。 その SV は配列へとコピーされるので、av_make を呼び出した後で 解放することもできます。 新たな AV はその参照カウントとして 1 を持ちます。

        AV*     av_make(I32 size, SV **strp)

av_pop

Pops an SV off the end of the array. Returns &PL_sv_undef if the array is empty.

配列の最後にある SV をポップします。 配列が空である場合には &PL_sv_undef を返します。

        SV*     av_pop(AV *av)

av_push

Pushes an SV onto the end of the array. The array will grow automatically to accommodate the addition. Like av_store, this takes ownership of one reference count.

配列の末尾に SV をプッシュします。 追加されたものにあわせて、配列は自動的に大きくなります。 av_store と同様、一つの参照カウントの所有権を持ちます。

        void    av_push(AV *av, SV *val)

av_shift

Shifts an SV off the beginning of the array. Returns &PL_sv_undef if the array is empty.

配列の先頭にある SV をシフトして取り出します。 配列が空なら &PL_sv_undef を返します。

        SV*     av_shift(AV *av)

av_store

Stores an SV in an array. The array index is specified as key. The return value will be NULL if the operation failed or if the value did not need to be actually stored within the array (as in the case of tied arrays). Otherwise it can be dereferenced to get the original SV*. Note that the caller is responsible for suitably incrementing the reference count of val before the call, and decrementing it if the function returned NULL.

SV を配列に格納します。 配列の添え字は key で指定します。 戻り値は操作が失敗したり、(tie されている配列の場合のように)値を実際に 配列に格納する必要がないような場合には NULL になります。 さもなければ、取得したオリジナルの SV* の参照外しをすることができます。 呼び出し側は、呼び出しの前に val の参照カウントを適切にインクリメントし、 関数が NULL を返した場合には参照カウントをデクリメントする責任が あるということに注意してください。

See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied arrays.

この関数をどのように tie されたハッシュに使うかに関するさらなる情報は "Understanding the Magic of Tied Hashes and Arrays" in perlguts を 参照してください。

        SV**    av_store(AV *av, I32 key, SV *val)

av_undef

Undefines the array. Frees the memory used by the array itself.

配列を undefine します。 配列自身が使っていたメモリーを解放します。

        void    av_undef(AV *av)

av_unshift

Unshift the given number of undef values onto the beginning of the array. The array will grow automatically to accommodate the addition. You must then use av_store to assign values to these new elements.

配列の先頭に、与えられた数だけの undef 値を unsfhit します。 追加されたものにあわせて、配列は自動的に大きくなります。 追加された新しい要素に対して値を代入するには、この後で av_store を 使わなければなりません。

        void    av_unshift(AV *av, I32 num)

get_av

Returns the AV of the specified Perl array. flags are passed to gv_fetchpv. If GV_ADD is set and the Perl variable does not exist then it will be created. If flags is zero and the variable does not exist then NULL is returned.

指定された Perl 配列の AV を返します。 flags は gv_fetchpv に渡されます。 GV_ADD がセットされていて、指定された変数が存在していなければ、新たに 生成されます。 flags がゼロで、かつ、指定された変数がなかった場合には NULL が返されます。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        AV*     get_av(const char *name, I32 flags)

newAV

Creates a new AV. The reference count is set to 1.

新たな AV を生成します。 参照カウントは 1 に設定されます。

        AV*     newAV()

sortsv

Sort an array. Here is an example:

配列をソートします。 以下は例です:

    sortsv(AvARRAY(av), av_len(av)+1, Perl_sv_cmp_locale);

Currently this always uses mergesort. See sortsv_flags for a more flexible routine.

現在のところ、これは常にマージソートを使います。 さらに柔軟なルーチンのためには sortsv_flags を参照してください。

        void    sortsv(SV** array, size_t num_elts, SVCOMPARE_t cmp)

sortsv_flags

Sort an array, with various options.

様々なオプション付きで配列をソートします。

        void    sortsv_flags(SV** array, size_t num_elts, SVCOMPARE_t cmp, U32 flags)

コールバック関数¶

call_argv

Performs a callback to the specified Perl sub. See perlcall.

指定された Perl サブルーチンに対するコールバックを呼び出します。 perlcall を参照してください。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        I32     call_argv(const char* sub_name, I32 flags, char** argv)

call_method

Performs a callback to the specified Perl method. The blessed object must be on the stack. See perlcall.

指定された Perl サブルーチンに対するコールバックを呼び出します。 bless されたオブジェクトがスタック上になければなりません。 perlcall を参照してください。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        I32     call_method(const char* methname, I32 flags)

call_pv

Performs a callback to the specified Perl sub. See perlcall.

指定された Perl サブルーチンに対するコールバックを呼び出します。 perlcall を参照してください。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        I32     call_pv(const char* sub_name, I32 flags)

call_sv

Performs a callback to the Perl sub whose name is in the SV. See perlcall.

SV にある名前を持った Perl サブルーチンに対するコールバックを呼び出します。 perlcall を参照してください。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        I32     call_sv(SV* sv, VOL I32 flags)

ENTER

Opening bracket on a callback. See LEAVE and perlcall.

コールバックにあるブラケットを開きます。 LEAVE と perlcall を参照してください。

                ENTER;

eval_pv

Tells Perl to eval the given string and return an SV* result.

Perl に対して、与えられた文字列を eval してその結果をSV* に返すように 指示します。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        SV*     eval_pv(const char* p, I32 croak_on_error)

eval_sv

Tells Perl to eval the string in the SV.

Perl に対し、SV にある文字列を eval するように指示します。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        I32     eval_sv(SV* sv, I32 flags)

FREETMPS

Closing bracket for temporaries on a callback. See SAVETMPS and perlcall.

コールバックにある一時変数のためのブラケットを閉じます。 SAVETMPS と perlcall を参照してください。

                FREETMPS;

LEAVE

Closing bracket on a callback. See ENTER and perlcall.

コールバック上のブラケットを閉じます。 ENTER と perlcall を参照してください。

                LEAVE;

SAVETMPS

Opening bracket for temporaries on a callback. See FREETMPS and perlcall.

コールバックにある一時変数のためにブラケットを開けます。 FREETMPS と perlcall を参照してください。

                SAVETMPS;

文字クラス¶

isALNUM

Returns a boolean indicating whether the C char is a US-ASCII (Basic Latin) alphanumeric character (including underscore) or digit.

char が US-ASCII (Basic Latin) 英数字(下線を含む)、もしくは数字で あるかどうかを表わす真偽値を返します。

        bool    isALNUM(char ch)

isALPHA

Returns a boolean indicating whether the C char is a US-ASCII (Basic Latin) alphabetic character.

char が US-ASCII (Basic Latin) 英数字であるかどうかを表わす真偽値を 返します。

        bool    isALPHA(char ch)

isDIGIT

Returns a boolean indicating whether the C char is a US-ASCII (Basic Latin) digit.

char が US-ASCII (Basic Latin) 数字であるかどうかを表わす真偽値を 返します。

        bool    isDIGIT(char ch)

isLOWER

Returns a boolean indicating whether the C char is a US-ASCII (Basic Latin) lowercase character.

char が US-ASCII (Basic Latin) 小文字であるかどうかを表わす真偽値を 返します。

        bool    isLOWER(char ch)

isSPACE

Returns a boolean indicating whether the C char is a US-ASCII (Basic Latin) whitespace.

char が US-ASCII (Basic Latin) 空白であるかどうかを表わす真偽値を 返します。

        bool    isSPACE(char ch)

isUPPER

Returns a boolean indicating whether the C char is a US-ASCII (Basic Latin) uppercase character.

char が US-ASCII (Basic Latin) 大文字であるかどうかを表わす真偽値を 返します。

        bool    isUPPER(char ch)

toLOWER

Converts the specified character to lowercase. Characters outside the US-ASCII (Basic Latin) range are viewed as not having any case.

指定された文字を小文字に変換します。 US-ASCII (Basic Latin) の範囲の外側の文字は大文字小文字はないものとします。

        char    toLOWER(char ch)

toUPPER

Converts the specified character to uppercase. Characters outside the US-ASCII (Basic Latin) range are viewed as not having any case.

指定された文字を大文字に変換します。 US-ASCII (Basic Latin) の範囲の外側の文字は大文字小文字はないものとします。

        char    toUPPER(char ch)

インタプリタのクローン化¶

perl_clone

Create and return a new interpreter by cloning the current one.

現在のものをクローン化することによって新しいインタプリタを作成し、 それを返します。

perl_clone takes these flags as parameters:

perl_clone は以下のフラグを引数として受け取ります:

CLONEf_COPY_STACKS - is used to, well, copy the stacks also, without it we only clone the data and zero the stacks, with it we copy the stacks and the new perl interpreter is ready to run at the exact same point as the previous one. The pseudo-fork code uses COPY_STACKS while the threads->create doesn't.

CLONEf_COPY_STACKS - これは、つまり、スタックもコピーするために使います; これがない場合、データのみをクローンし、スタックはしません; これがある場合、スタックをコピーして、新しいインタプリタは以前のものと まったく同じ位置から実行する準備が出来ています。 疑似 fork コードは COPY_STACKS を使いますが、threads->create は使いません。

CLONEf_KEEP_PTR_TABLE perl_clone keeps a ptr_table with the pointer of the old variable as a key and the new variable as a value, this allows it to check if something has been cloned and not clone it again but rather just use the value and increase the refcount. If KEEP_PTR_TABLE is not set then perl_clone will kill the ptr_table using the function ptr_table_free(PL_ptr_table); PL_ptr_table = NULL;, reason to keep it around is if you want to dup some of your own variable who are outside the graph perl scans, example of this code is in threads.xs create

CLONEf_KEEP_PTR_TABLE perl_clone は、古い変数へのポインタをキーとして、新しい変数を値として ptr_table を保持します; これにより、何かがクローンされて、再び クローンされないけれども単に値を使って参照カウントを増やしているかを チェックできるようにします。 KEEP_PTR_TABLE がセットされていないと、perl_clone は ptr_table_free(PL_ptr_table); PL_ptr_table = NULL; を使って ptr_table を削除します; これを保持し続ける理由は、図示する perl が スキャンする外側の変数の一部を複製したい場合; このコードの例は threads.xs create にあります。

CLONEf_CLONE_HOST This is a win32 thing, it is ignored on unix, it tells perls win32host code (which is c++) to clone itself, this is needed on win32 if you want to run two threads at the same time, if you just want to do some stuff in a separate perl interpreter and then throw it away and return to the original one, you don't need to do anything.

CLONEf_CLONE_HOST これは win32 のもので、unix では無視されます; perl に、自身を クローンするのに(c++ である)win32host コードを知らせます; これは、 二つのスレッドを同時に実行したいなら、win32 で必要です; 単に何かを別々の perl インタプリタで実行したいなら、これは捨てて元のものを返します; 何もする 必要はありません。

        PerlInterpreter*        perl_clone(PerlInterpreter *proto_perl, UV flags)

CV 操作関数¶

CvSTASH

Returns the stash of the CV.

CV のスタッシュを返します。

        HV*     CvSTASH(CV* cv)

get_cv

Uses strlen to get the length of name, then calls get_cvn_flags.

name の長さを得るために strlen を使い、それから get_cvn_flags を 呼び出します。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        CV*     get_cv(const char* name, I32 flags)

get_cvn_flags

Returns the CV of the specified Perl subroutine. flags are passed to gv_fetchpvn_flags. If GV_ADD is set and the Perl subroutine does not exist then it will be declared (which has the same effect as saying sub name;). If GV_ADD is not set and the subroutine does not exist then NULL is returned.

指定された Perl サブルーチンの CV を返します。 flags は gv_fetchpvn_flags に渡されます。 GV_ADD がセットされ、Perl サブルーチンが存在しない場合は、これが 宣言されます(これは sub name; と同じ効果です)。 GV_ADD がセットされず、Perl サブルーチンが存在しない場合は、NULL が 返されます。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        CV*     get_cvn_flags(const char* name, STRLEN len, I32 flags)

組み込み関数¶

cv_undef

Clear out all the active components of a CV. This can happen either by an explicit undef &foo, or by the reference count going to zero. In the former case, we keep the CvOUTSIDE pointer, so that any anonymous children can still follow the full lexical scope chain.

CV の全ての有効な要素を片付けます。 これは明示的な undef &foo によってか、参照カウントが 0 になることによって 起こります。 前者の場合、CvOUTSIDE ポインタは維持するので、全ての無名の子は完全な レキシカルスコープチェーンに従ったままです。

        void    cv_undef(CV* cv)

load_module

Loads the module whose name is pointed to by the string part of name. Note that the actual module name, not its filename, should be given. Eg, "Foo::Bar" instead of "Foo/Bar.pm". flags can be any of PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, or PERL_LOADMOD_IMPORT_OPS (or 0 for no flags). ver, if specified, provides version semantics similar to use Foo::Bar VERSION. The optional trailing SV* arguments can be used to specify arguments to the module's import() method, similar to use Foo::Bar VERSION LIST. They must be terminated with a final NULL pointer. Note that this list can only be omitted when the PERL_LOADMOD_NOIMPORT flag has been used. Otherwise at least a single NULL pointer to designate the default import list is required.

name の文字列部で示された名前のモジュールを読み込みます。 ファイル名ではなく実際のモジュール名を指定することに注意してください; つまり、"Foo/Bar.pm" ではなく "Foo::Bar" です。 flags は PERL_LOADMOD_DENY, PERL_LOADMOD_NOIMPORT, PERL_LOADMOD_IMPORT_OPS の いずれか(あるいはフラグなしなら 0)です。 ver が指定されると、use Foo::Bar VERSION と同様のバージョン意味論を 提供します。 オプションで引き続く SV* 引数は、use Foo::Bar VERSION LIST と同様に、 モジュールの import() メソッドへの引数を指定するために使われます。 これらは最後の NULL ポインタで終端されていなければなりません。 このリストは PERL_LOADMOD_NOIMPORT フラグが使われている場合にのみ 省略できます。 さもなければ少なくともデフォルトインポートリストを指定するための単一の NULL ポインタが必要です。

        void    load_module(U32 flags, SV* name, SV* ver, ...)

nothreadhook

Stub that provides thread hook for perl_destruct when there are no threads.

スレッドがないときの perl_destruct のためのスレッドフックを提供する スタブです。

        int     nothreadhook()

perl_alloc

Allocates a new Perl interpreter. See perlembed.

新たなPerl インタプリタを割り付けます。 perlembed を参照してください。

        PerlInterpreter*        perl_alloc()

perl_construct

Initializes a new Perl interpreter. See perlembed.

新しいPerl インタプリタの初期化を行います。 perlembed を参照してください。

        void    perl_construct(PerlInterpreter *my_perl)

perl_destruct

Shuts down a Perl interpreter. See perlembed.

Perl インタプリタをシャットダウンします。 perlembed を参照してください。

        int     perl_destruct(PerlInterpreter *my_perl)

perl_free

Releases a Perl interpreter. See perlembed.

Perl インタプリタを解放します。 perlembed を参照してください。

        void    perl_free(PerlInterpreter *my_perl)

perl_parse

Tells a Perl interpreter to parse a Perl script. See perlembed.

Perl インタプリタに Perl スクリプトを解析するよう指示します。 perlembed を参照してください。

        int     perl_parse(PerlInterpreter *my_perl, XSINIT_t xsinit, int argc, char** argv, char** env)

perl_run

Tells a Perl interpreter to run. See perlembed.

Perl インタプリタに実行するよう指示します。 perlembed を参照してください。

        int     perl_run(PerlInterpreter *my_perl)

require_pv

Tells Perl to require the file named by the string argument. It is analogous to the Perl code eval "require '$file'". It's even implemented that way; consider using load_module instead.

文字列引数の名前のファイルを require するように Perl に伝えます。 Perl コード eval "require '$file'" に類似しています。 実際このように実装されています; 代わりに load_module を使うことを 考慮してください。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        void    require_pv(const char* pv)

ファイル dump.c の関数¶

pv_display

Similar to

以下と似ています:

  pv_escape(dsv,pv,cur,pvlim,PERL_PV_ESCAPE_QUOTE);

except that an additional "\0" will be appended to the string when len > cur and pv[cur] is "\0".

は、len > cur で pv[cur] が "\0" なら、文字列に追加の "\0" が 追加されることを想定します。

Note that the final string may be up to 7 chars longer than pvlim.

最終的な文字列は pvlim より最大 7 文字長くなる可能性があることに 注意してください。

        char*   pv_display(SV *dsv, const char *pv, STRLEN cur, STRLEN len, STRLEN pvlim)

pv_escape

Escapes at most the first "count" chars of pv and puts the results into dsv such that the size of the escaped string will not exceed "max" chars and will not contain any incomplete escape sequences.

多くても pv の最初の "count" 文字をエスケープして、エスケープされた文字列の サイズは "max" は "max" 文字を超えず、不完全なエスケープシーケンスが 含まれないような結果を dsv に入れます。

If flags contains PERL_PV_ESCAPE_QUOTE then any double quotes in the string will also be escaped.

flags に PERL_PV_ESCAPE_QUOTE が含まれているなら、文字列中のダブルクォートも エスケープされます。

Normally the SV will be cleared before the escaped string is prepared, but when PERL_PV_ESCAPE_NOCLEAR is set this will not occur.

通常は SV はエスケープされた文字列が準備される前にクリアされますが、 PERL_PV_ESCAPE_NOCLEAR がセットされているとこれは起こりません。

If PERL_PV_ESCAPE_UNI is set then the input string is treated as Unicode, if PERL_PV_ESCAPE_UNI_DETECT is set then the input string is scanned using is_utf8_string() to determine if it is Unicode.

PERL_PV_ESCAPE_UNI がセットされているなら入力文字列は Unicode として 扱われます。 PERL_PV_ESCAPE_UNI_DETECT がセットされているなら入力文字列は Unicode かどうか 決定するために is_utf8_string() を使ってスキャンされます。

If PERL_PV_ESCAPE_ALL is set then all input chars will be output using \x01F1 style escapes, otherwise only chars above 255 will be escaped using this style, other non printable chars will use octal or common escaped patterns like \n. If PERL_PV_ESCAPE_NOBACKSLASH then all chars below 255 will be treated as printable and will be output as literals.

PERL_PV_ESCAPE_ALL がセットされていると、全ての入力文字は \x01F1 形式の エスケープを使って出力され、さもなければ 255 を超える文字のみがこの形式で エスケープされ、その他の表示できない文字は 8 進数か \n のような一般的な エスケープパターンを使います。 PERL_PV_ESCAPE_NOBACKSLASH なら、255 以下の全ての文字は表示可能として 扱われてリテラルとして出力されます。

If PERL_PV_ESCAPE_FIRSTCHAR is set then only the first char of the string will be escaped, regardles of max. If the string is utf8 and the chars value is >255 then it will be returned as a plain hex sequence. Thus the output will either be a single char, an octal escape sequence, a special escape like \n or a 3 or more digit hex value.

PERL_PV_ESCAPE_FIRSTCHAR がセットされると、max に関わらず文字列の最初の 文字だけがエスケープされます。 文字列が utf8 で文字の値が >255 なら、普通の 16 進シーケンスとして 返されます。 従って出力は単一の文字、8 進エスケープシーケンス、\n のような 特殊エスケープ、3 桁以上の 16 進数のいずれかです。

If PERL_PV_ESCAPE_RE is set then the escape char used will be a '%' and not a '\\'. This is because regexes very often contain backslashed sequences, whereas '%' is not a particularly common character in patterns.

PERL_PV_ESCAPE_RE が設定されると、使われるエスケープ文字は '\\' ではなく '%' になります。 これは正規表現がとてもしばしばバックスラッシュ並びを含んでいて、一方 '%' は パターン中で特に一般的な文字というわけではないからです。

Returns a pointer to the escaped text as held by dsv.

dsv によって保持されている、エスケープされたテキストへのポインタを返します。

        char*   pv_escape(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, STRLEN * const escaped, const U32 flags)

pv_pretty

Converts a string into something presentable, handling escaping via pv_escape() and supporting quoting and ellipses.

文字列を何か表現可能なものに変換します; pv_escape() によるエスケープを扱い、 クォートと省略に対応しています。

If the PERL_PV_PRETTY_QUOTE flag is set then the result will be double quoted with any double quotes in the string escaped. Otherwise if the PERL_PV_PRETTY_LTGT flag is set then the result be wrapped in angle brackets.

PERL_PV_PRETTY_QUOTE フラグがセットされると、文字列中のダブルクォートが エスケープされて、全体がダブルクォートで囲まれます。 さもなければ、PERL_PV_PRETTY_LTGT がセットされていれば結果は山かっこで 囲まれます。

If the PERL_PV_PRETTY_ELLIPSES flag is set and not all characters in string were output then an ellipsis ... will be appended to the string. Note that this happens AFTER it has been quoted.

PERL_PV_PRETTY_ELLIPSES がセットされて、文字列中の全ての文字が 出力されないときは、省略記号 ... が文字列に追加されます。 これはクォートされた「後」に起きることに注意してください。

If start_color is non-null then it will be inserted after the opening quote (if there is one) but before the escaped text. If end_color is non-null then it will be inserted after the escaped text but before any quotes or ellipses.

start_color が非 NULL なら、(もしあれば) 開きクォートの後、エスケープされた テキストの前に挿入されます。 end_color が非 NULL なら、エスケープされたテキストの後、クォートや 省略記号の前に挿入されます。

Returns a pointer to the prettified text as held by dsv.

dsv によって保持されている、飾り付けられたテキストへのポインタを返します。

        char*   pv_pretty(SV *dsv, char const * const str, const STRLEN count, const STRLEN max, char const * const start_color, char const * const end_color, const U32 flags)

ファイル mathoms.c の関数¶

gv_fetchmethod

See gv_fetchmethod_autoload.

gv_fetchmethod_autoload を参照してください。

        GV*     gv_fetchmethod(HV* stash, const char* name)

pack_cat

The engine implementing pack() Perl function. Note: parameters next_in_list and flags are not used. This call should not be used; use packlist instead.

Perl 関数 pack() を実装しているエンジンです。 注意: 引数 next_in_list と flags は使われません。 この呼び出しは使うべきではなりません; 代わりに packlist を使ってください。

        void    pack_cat(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist, SV ***next_in_list, U32 flags)

sv_2pvbyte_nolen

Return a pointer to the byte-encoded representation of the SV. May cause the SV to be downgraded from UTF-8 as a side-effect.

SV のバイトエンコードされた表現へのポインタを返します。 副作用として、SV が UTF-8 から降格するかもしれません。

Usually accessed via the SvPVbyte_nolen macro.

通常は SvPVbyte_nolen マクロ経由でアクセスします。

        char*   sv_2pvbyte_nolen(SV* sv)

sv_2pvutf8_nolen

Return a pointer to the UTF-8-encoded representation of the SV. May cause the SV to be upgraded to UTF-8 as a side-effect.

SV の UTF-8 エンコードされた表現へのポインタを返します。 副作用として、SV が UTF-8 へ昇格するかもしれません。

Usually accessed via the SvPVutf8_nolen macro.

通常は SvPVutf8_nolen マクロ経由でアクセスします。

        char*   sv_2pvutf8_nolen(SV* sv)

sv_2pv_nolen

Like sv_2pv(), but doesn't return the length too. You should usually use the macro wrapper SvPV_nolen(sv) instead.

sv_2pv() と同様ですが、長さも返しません。 普通は代わりにマクロラッパー SvPV_nolen(sv) を使うべきです。

        char*   sv_2pv_nolen(SV* sv)

sv_catpvn_mg

Like sv_catpvn, but also handles 'set' magic.

sv_catpvn に似ていますが、'set' magic もハンドルします。

        void    sv_catpvn_mg(SV *sv, const char *ptr, STRLEN len)

sv_catsv_mg

Like sv_catsv, but also handles 'set' magic.

sv_catsv に似ていますが、'set' magic もハンドルします。

        void    sv_catsv_mg(SV *dsv, SV *ssv)

sv_force_normal

Undo various types of fakery on an SV: if the PV is a shared string, make a private copy; if we're a ref, stop refing; if we're a glob, downgrade to an xpvmg. See also sv_force_normal_flags.

SV への様々な種類のごまかしを巻き戻します; PV が共有文字列なら、 プライベートなコピーを作ります; リファレンスなら、リファレンスを止めます; グロブなら、xpvmg に降格します。 sv_force_normal_flags も参照してください。

        void    sv_force_normal(SV *sv)

sv_iv

A private implementation of the SvIVx macro for compilers which can't cope with complex macro expressions. Always use the macro instead.

複雑なマクロ式を扱えないコンパイラのための、SvIVx マクロの プライベート実装です。 代わりに、常にマクロを使ってください。

        IV      sv_iv(SV* sv)

sv_nolocking

Dummy routine which "locks" an SV when there is no locking module present. Exists to avoid test for a NULL function pointer and because it could potentially warn under some level of strict-ness.

ロックモジュールがないときに SV を「ロックする」ダミールーチンです。 NULL 関数をテストして、あるレベルでの strict での潜在的な警告を 回避するために存在します。

"Superseded" by sv_nosharing().

sv_nosharing() で「置き換え」られました。

        void    sv_nolocking(SV *sv)

sv_nounlocking

Dummy routine which "unlocks" an SV when there is no locking module present. Exists to avoid test for a NULL function pointer and because it could potentially warn under some level of strict-ness.

ロックモジュールがないときに SV を「アンロックする」ダミールーチンです。 NULL 関数をテストして、あるレベルでの strict での潜在的な警告を 回避するために存在します。

"Superseded" by sv_nosharing().

sv_nosharing() で「置き換え」られました。

        void    sv_nounlocking(SV *sv)

sv_nv

A private implementation of the SvNVx macro for compilers which can't cope with complex macro expressions. Always use the macro instead.

複雑なマクロ式を扱えないコンパイラのための、SvNVx マクロの プライベート実装です。 代わりに、常にマクロを使ってください。

        NV      sv_nv(SV* sv)

sv_pv

Use the SvPV_nolen macro instead

代わりに SvPV_nolen マクロを使ってください。

        char*   sv_pv(SV *sv)

sv_pvbyte

Use SvPVbyte_nolen instead.

代わりに SvPVbyte_nolen マクロを使ってください。

        char*   sv_pvbyte(SV *sv)

sv_pvbyten

A private implementation of the SvPVbyte macro for compilers which can't cope with complex macro expressions. Always use the macro instead.

複雑なマクロ式を扱えないコンパイラのための、SvPVbyte マクロの プライベート実装です。 代わりに、常にマクロを使ってください。

        char*   sv_pvbyten(SV *sv, STRLEN *lp)

sv_pvn

A private implementation of the SvPV macro for compilers which can't cope with complex macro expressions. Always use the macro instead.

複雑なマクロ式を扱えないコンパイラのための、SvPV マクロの プライベート実装です。 代わりに、常にマクロを使ってください。

        char*   sv_pvn(SV *sv, STRLEN *lp)

sv_pvutf8

Use the SvPVutf8_nolen macro instead

代わりに SvPVutf8_nolen マクロを使ってください。

        char*   sv_pvutf8(SV *sv)

sv_pvutf8n

A private implementation of the SvPVutf8 macro for compilers which can't cope with complex macro expressions. Always use the macro instead.

複雑なマクロ式を扱えないコンパイラのための、SvPVutf8 マクロの プライベート実装です。 代わりに、常にマクロを使ってください。

        char*   sv_pvutf8n(SV *sv, STRLEN *lp)

sv_taint

Taint an SV. Use SvTAINTED_on instead.

SV を汚染します。 代わりに SvTAINTED_on を使ってください。

        void    sv_taint(SV* sv)

sv_unref

Unsets the RV status of the SV, and decrements the reference count of whatever was being referenced by the RV. This can almost be thought of as a reversal of newSVrv. This is sv_unref_flags with the flag being zero. See SvROK_off.

SV の RV ステータスをアンセットし、RV によって参照されているものの 参照カウントを減じます。 これは newSVrv の反転したものであると考えられます。 これは、flag がゼロのときの sv_unref_flags です。 SvROK_off を参照してください。

        void    sv_unref(SV* sv)

sv_usepvn

Tells an SV to use ptr to find its string value. Implemented by calling sv_usepvn_flags with flags of 0, hence does not handle 'set' magic. See sv_usepvn_flags.

自身の文字列値を得るのに ptr を使うように SV に指示します。 flags を 0 にして sv_usepvn_flags を呼び出すことで実装されているので、 'set' magic をハンドルしません。 sv_usepvn_mg を参照してください。

        void    sv_usepvn(SV* sv, char* ptr, STRLEN len)

sv_usepvn_mg

Like sv_usepvn, but also handles 'set' magic.

sv_usepvn に似ていますが、'set' magic をハンドルします。

        void    sv_usepvn_mg(SV *sv, char *ptr, STRLEN len)

sv_uv

A private implementation of the SvUVx macro for compilers which can't cope with complex macro expressions. Always use the macro instead.

複雑なマクロ式を扱えないコンパイラのための、SvUVx マクロの プライベート実装です。 代わりに、常にマクロを使ってください。

        UV      sv_uv(SV* sv)

unpack_str

The engine implementing unpack() Perl function. Note: parameters strbeg, new_s and ocnt are not used. This call should not be used, use unpackstring instead.

Perl 関数 unpack() を実装しているエンジンです。 注意: 引数 strbeg, new_s, ocnt は使われません。 この呼び出しは使うべきではなりません; 代わりに unpackstring を 使ってください。

        I32     unpack_str(const char *pat, const char *patend, const char *s, const char *strbeg, const char *strend, char **new_s, I32 ocnt, U32 flags)

Functions in file perl.h¶

PERL_SYS_INIT

Provides system-specific tune up of the C runtime environment necessary to run Perl interpreters. This should be called only once, before creating any Perl interpreters.

Perl インタプリタを実行するのに必要な C ランタイム環境のシステム固有の 調整を提供します。 これは一度だけ、Perl インタプリタが作成される前に呼び出されるべきです。

        void    PERL_SYS_INIT(int argc, char** argv)

PERL_SYS_INIT3

Provides system-specific tune up of the C runtime environment necessary to run Perl interpreters. This should be called only once, before creating any Perl interpreters.

Perl インタプリタを実行するのに必要な C ランタイム環境のシステム固有の 調整を提供します。 これは一度だけ、Perl インタプリタが作成される前に呼び出されるべきです。

        void    PERL_SYS_INIT3(int argc, char** argv, char** env)

PERL_SYS_TERM

Provides system-specific clean up of the C runtime environment after running Perl interpreters. This should be called only once, after freeing any remaining Perl interpreters.

Perl インタプリタを実行するのに必要な C ランタイム環境のシステム固有の 調整を提供します。 これは一度だけ、Perl インタプリタが作成される前に呼び出されるべきです。

        void    PERL_SYS_TERM()

ファイル pp_ctl.c の関数¶

find_runcv

Locate the CV corresponding to the currently executing sub or eval. If db_seqp is non_null, skip CVs that are in the DB package and populate *db_seqp with the cop sequence number at the point that the DB:: code was entered. (allows debuggers to eval in the scope of the breakpoint rather than in the scope of the debugger itself).

現在実行しているサブルーチンや eval に対応する CV の場所を調べます。 db_seqp が非 null なら、DB パッケージの CV は飛ばして、 *db_seqp を、DB:: コードが入った時点での cop シーケンス番号にします。 (デバッガが、デバッガ自身のスコープではなく、ブレークポイントのスコープで eval できるようにします)。

        CV*     find_runcv(U32 *db_seqp)

ファイル pp_pack.c の関数¶

packlist

The engine implementing pack() Perl function.

Perl 関数 pack() を実装しているエンジンです。

        void    packlist(SV *cat, const char *pat, const char *patend, SV **beglist, SV **endlist)

unpackstring

The engine implementing unpack() Perl function. unpackstring puts the extracted list items on the stack and returns the number of elements. Issue PUTBACK before and SPAGAIN after the call to this function.

Perl 関数 unpack() を実装しているエンジンです。 unpackstring は展開されたリスト要素をスタックに設定して、要素数を 返します。 この関数を呼ぶ前には PUTBACK を、呼んだ後には SPAGAIN を 使ってください。

        I32     unpackstring(const char *pat, const char *patend, const char *s, const char *strend, U32 flags)

GV 関数¶

GvSV

Return the SV from the GV.

GV から SV を返します。

        SV*     GvSV(GV* gv)

gv_const_sv

If gv is a typeglob whose subroutine entry is a constant sub eligible for inlining, or gv is a placeholder reference that would be promoted to such a typeglob, then returns the value returned by the sub. Otherwise, returns NULL.

gv がサブルーチンエントリがインライン化可能な定数サブルーチンである 型グロブであるか、gv がそのような型グロブに昇格するリファレンスの プレースホルダの場合、そのサブルーチンから返される値を返します。 さもなければ NULL を返します。

        SV*     gv_const_sv(GV* gv)

gv_fetchmeth

Returns the glob with the given name and a defined subroutine or NULL. The glob lives in the given stash, or in the stashes accessible via @ISA and UNIVERSAL::.

与えられた name と、定義されたサブルーチンか NULL を使ったグロブを 返します。 このグロブは、与えられた stash か、@ISA や UNIVERSAL:: を通じて アクセスできるスタッシュにあります。

The argument level should be either 0 or -1. If level==0, as a side-effect creates a glob with the given name in the given stash which in the case of success contains an alias for the subroutine, and sets up caching info for this glob.

引数 level は 0 か -1 であるべきです。 level==0 の場合、副作用として(サブルーチンに対するエイリアスを 含むことに成功した場合に)与えられた stash にある name に対する glob を生成し、さらにこの glob に対するキャッシュ情報のセットアップを 行います。

This function grants "SUPER" token as a postfix of the stash name. The GV returned from gv_fetchmeth may be a method cache entry, which is not visible to Perl code. So when calling call_sv, you should not use the GV directly; instead, you should use the method's CV, which can be obtained from the GV with the GvCV macro.

この関数はスタッシュ名のポストフィックスとして、トークン "SUPER" を 受け付けます。 gv_fetchmeth から返された GV は、Perl プログラムからは参照することの できないような、メソッドキャッシュのエントリである可能性があります。 このため、perl_call_sv を呼び出したとき、GV を直接 使うべきではありません; その代わりに、GV に対して GvCV マクロを使って 得ることのできる、メソッドの CV を使うべきです。

        GV*     gv_fetchmeth(HV* stash, const char* name, STRLEN len, I32 level)

gv_fetchmethod_autoload

Returns the glob which contains the subroutine to call to invoke the method on the stash. In fact in the presence of autoloading this may be the glob for "AUTOLOAD". In this case the corresponding variable $AUTOLOAD is already setup.

stash にあるメソッドを起動するために呼び出すサブルーチンを含むグロブを 返します。 事実、オートローディングの直前でこれは "AUTOLOAD" に対するグロブとなる 可能性があります。 その場合、$AUTOLOAD に対応する変数が既にセットアップされています。

The third parameter of gv_fetchmethod_autoload determines whether AUTOLOAD lookup is performed if the given method is not present: non-zero means yes, look for AUTOLOAD; zero means no, don't look for AUTOLOAD. Calling gv_fetchmethod is equivalent to calling gv_fetchmethod_autoload with a non-zero autoload parameter.

gv_fetchmethod_autoload の第三引数は、与えられたメソッドが 存在していなかった場合に AUTLOAD のルックアップをするかしないかを決定します; ゼロでないときは AUTOLOAD の検索を行い、ゼロのときには行いません。 gv_fetchmethod の呼び出しは gv_fetchmethod_autoload に ゼロでない autoload パラメーターを渡したときと等価です。

These functions grant "SUPER" token as a prefix of the method name. Note that if you want to keep the returned glob for a long time, you need to check for it being "AUTOLOAD", since at the later time the call may load a different subroutine due to $AUTOLOAD changing its value. Use the glob created via a side effect to do this.

これらの関数は、トークン "SUPER" をメソッド名の接頭辞として許します。 返された glob を長い間保存しておきたいのなら、"AUTOLOAD" の存在を チェックする必要があるということに注意してください。 これは、後での呼び出しが $AUTOALOD の値が変化したことによって、異なる サブルーチンをロードしてしまうかもしれないからです。

These functions have the same side-effects and as gv_fetchmeth with level==0. name should be writable if contains ':' or ' ''. The warning against passing the GV returned by gv_fetchmeth to call_sv apply equally to these functions.

これらの関数は、gv_fetchmeth に level==0 を渡したときと同じ副作用を 持っています。 name は、その内容に ':' か '\'' が含まれている場合には書き込み 可能であるべきです。 gv_fetchmeth から返された GV を call_sv に渡したことに対する警告は、 これらの関数についても同じく適用されます。

        GV*     gv_fetchmethod_autoload(HV* stash, const char* name, I32 autoload)

gv_fetchmeth_autoload

Same as gv_fetchmeth(), but looks for autoloaded subroutines too. Returns a glob for the subroutine.

gv_fetchmeth() と同じですが、オートロードされたサブルーチンも探します。 サブルーチンのグロブを返します。

For an autoloaded subroutine without a GV, will create a GV even if level < 0. For an autoloaded subroutine without a stub, GvCV() of the result may be zero.

GV なしのオートロードされたサブルーチンのために、level < 0 でも GV を 作成します。 スタブのないオートロードされたサブルーチンのために、結果の GvCV() は ゼロかもしれません。

        GV*     gv_fetchmeth_autoload(HV* stash, const char* name, STRLEN len, I32 level)

gv_stashpv

Returns a pointer to the stash for a specified package. Uses strlen to determine the length of name, then calls gv_stashpvn().

指定されたパッケージに対するスタッシュへのポインタを返します。 name の長さを決定するために strlen を使い、それから gv_stashpvn() を呼び出します。

        HV*     gv_stashpv(const char* name, I32 flags)

gv_stashpvn

Returns a pointer to the stash for a specified package. The namelen parameter indicates the length of the name, in bytes. flags is passed to gv_fetchpvn_flags(), so if set to GV_ADD then the package will be created if it does not already exist. If the package does not exist and flags is 0 (or any other setting that does not create packages) then NULL is returned.

指定されたパッケージに対するスタッシュへのポインタを返します。 namelen 引数は name の長さをバイトで示します。 flags は gv_fetchpvn_flags() に渡されるので、GV_ADD を設定すると パッケージが既に存在していない場合は作成されます。 パッケージが存在しておらず、 flags が 0 (またはパッケージを作成しない その他の値)の場合は NULL が返されます。

        HV*     gv_stashpvn(const char* name, U32 namelen, I32 flags)

gv_stashpvs

Like gv_stashpvn, but takes a literal string instead of a string/length pair.

gv_stashpvn と同様ですが、文字列/長さの組ではなく、リテラルな文字列を 取ります。

        HV*     gv_stashpvs(const char* name, I32 create)

gv_stashsv

Returns a pointer to the stash for a specified package. See gv_stashpvn.

指定されたパッケージに対するスタッシュへのポインタを返します。 gv_stashpvn を参照してください。

        HV*     gv_stashsv(SV* sv, I32 flags)

便利な値¶

Nullav

Null AV pointer.

AVのヌルポインタ。

Nullch

Null character pointer.

文字のヌルポインタ。

Nullcv

Null CV pointer.

CVのヌルポインタ。

Nullhv

Null HV pointer.

HVのヌルポインタ。

Nullsv

Null SV pointer.

SVのヌルポインタ。

ハッシュ操作関数¶

get_hv

Returns the HV of the specified Perl hash. flags are passed to gv_fetchpv. If GV_ADD is set and the Perl variable does not exist then it will be created. If flags is zero and the variable does not exist then NULL is returned.

指定された Perl ハッシュの HV を返します。 flags は gv_fetchpv に渡されます。 GV_ADD がセットされていて、指定された変数が存在していなければ、新たに 生成されます。 flags がゼロで、かつ、指定された変数がなかった場合には NULL が返されます。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        HV*     get_hv(const char *name, I32 flags)

HEf_SVKEY

This flag, used in the length slot of hash entries and magic structures, specifies the structure contains an SV* pointer where a char* pointer is to be expected. (For information only--not to be used).

このフラグは、ハッシュエントリの length slot や magic structures で使われ、 char* ポインタであることを期待されている SV* ポインタを含む構造体を 指定します。 (情報のみ -- 使われません)。

HeHASH

Returns the computed hash stored in the hash entry.

ハッシュエントリに格納されている計算済みハッシュを返します。

        U32     HeHASH(HE* he)

HeKEY

Returns the actual pointer stored in the key slot of the hash entry. The pointer may be either char* or SV*, depending on the value of HeKLEN(). Can be assigned to. The HePV() or HeSVKEY() macros are usually preferable for finding the value of a key.

ハッシュエントリのキー スロットにあるポインタを返します。 このポインタは char* か SV* のいずれかで、これは HeKLEN() の 値に依存します。 これは代入することができます。 HePV() や HeSVKEY() といったマクロはキーの値を検索するために、 通常望ましいものです。

        void*   HeKEY(HE* he)

HeKLEN

If this is negative, and amounts to HEf_SVKEY, it indicates the entry holds an SV* key. Otherwise, holds the actual length of the key. Can be assigned to. The HePV() macro is usually preferable for finding key lengths.

これが負であり、かつ HEf_SVKEY に等しければ、エントリが SV* キーを 保持していることを示します。 そうでなければ、これはキーの実際の長さを保持しています。 これは代入することができます。 マクロ HePV() はキーの長さを検出するのに、通常望ましいものです。

        STRLEN  HeKLEN(HE* he)

HePV

Returns the key slot of the hash entry as a char* value, doing any necessary dereferencing of possibly SV* keys. The length of the string is placed in len (this is a macro, so do not use &len). If you do not care about what the length of the key is, you may use the global variable PL_na, though this is rather less efficient than using a local variable. Remember though, that hash keys in perl are free to contain embedded nulls, so using strlen() or similar is not a good way to find the length of hash keys. This is very similar to the SvPV() macro described elsewhere in this document. See also HeUTF8.

char * としてのハッシュエントリのキースロットを返し、SV* キーで 必要となるような参照外しなどを行います。 文字列の長さは len に置かれます(これはマクロなので、&len を 使ってはいけません)。 キーの長さがどうなのかを気にしないのであれば、グローバル変数 PL_na を 使うことができますが、これはローカル変数を使うよりも非効率的です。 しかし忘れないで欲しいのは、そういった perl におけるハッシュのキーは 埋め込まれているヌル文字に対して自由であり、そのため strlen() などを使って ハッシュキーの長さを調べるのは良い方法ではないということです。 これは他の場所で説明している SvPV() マクロについても同様です。 HeUTF8 も参照してください。

If you are using HePV to get values to pass to newSVpvn() to create a new SV, you should consider using newSVhek(HeKEY_hek(he)) as it is more efficient.

新しい SV を作るために newSVpvn() に渡すための値を得るのに HePV を 使っている場合、より効率的な newSVhek(HeKEY_hek(he)) を使うことを 考慮するべきです。

        char*   HePV(HE* he, STRLEN len)

HeSVKEY

Returns the key as an SV*, or NULL if the hash entry does not contain an SV* key.

SV* としてのキー、もしくはハッシュエントリに SV* キーがない場合には NULL を返します。

        SV*     HeSVKEY(HE* he)

HeSVKEY_force

Returns the key as an SV*. Will create and return a temporary mortal SV* if the hash entry contains only a char* key.

SV* としてのキーを返します。 ハッシュエントリに char* キーしかない場合には、一時的な揮発性 SV* が 生成されて返されます。

        SV*     HeSVKEY_force(HE* he)

HeSVKEY_set

Sets the key to a given SV*, taking care to set the appropriate flags to indicate the presence of an SV* key, and returns the same SV*.

与えられた SV* にキーをセットし、SV* キーの存在を表わす適切な フラグを注意深くセットし、同じ SV* を返します。

        SV*     HeSVKEY_set(HE* he, SV* sv)

HeUTF8

Returns whether the char * value returned by HePV is encoded in UTF-8, doing any necessary dereferencing of possibly SV* keys. The value returned will be 0 or non-0, not necessarily 1 (or even a value with any low bits set), so do not blindly assign this to a bool variable, as bool may be a typedef for char.

Returns whether the char * value returned by HePV is encoded in UTF-8, doing any necessary dereferencing of possibly SV* keys. 返される値は 0 または非 0 で、1 である必要(あるいは最下位ビットが設定されている 必要すら)はないので、これを盲目的に bool 変数に代入 しないでください; bool は char への typedef かもしれないからです。

        char*   HeUTF8(HE* he, STRLEN len)

HeVAL

Returns the value slot (type SV*) stored in the hash entry.

ハッシュエントリに格納されている(型 SV* の)値スロットを返します。

        SV*     HeVAL(HE* he)

HvNAME

Returns the package name of a stash, or NULL if stash isn't a stash. See SvSTASH, CvSTASH.

スタッシュのパッケージ名を返します; stash がスタッシュでない場合は NULL を返します。 SvSTASH, CvSTASH を参照してください。

        char*   HvNAME(HV* stash)

hv_assert

Check that a hash is in an internally consistent state.

ハッシュが内部的に一貫した状態であるかを調べます。

        void    hv_assert(HV *hv)

hv_clear

Clears a hash, making it empty.

ハッシュをクリアし、空にします。

        void    hv_clear(HV* hv)

hv_clear_placeholders

Clears any placeholders from a hash. If a restricted hash has any of its keys marked as readonly and the key is subsequently deleted, the key is not actually deleted but is marked by assigning it a value of &PL_sv_placeholder. This tags it so it will be ignored by future operations such as iterating over the hash, but will still allow the hash to have a value reassigned to the key at some future point. This function clears any such placeholder keys from the hash. See Hash::Util::lock_keys() for an example of its use.

ハッシュからのプレースホルダをクリアします。 制限ハッシュに読み込み専用とマークされたキーがあって、その後キーが 削除されると、キーは実際には削除されず、&PL_sv_placeholder の値を 代入することでマークされます。 これはハッシュの反復のようなその後の操作では無視されるようになりますが、 将来の時点でキーに再代入されることで値を持てるようになっています。 この関数はこのようなハッシュからのプレースホルダキーをクリアします。 この使用例は Hash::Util::lock_keys() を参照してください。

        void    hv_clear_placeholders(HV *hv)

hv_delete

Deletes a key/value pair in the hash. The value SV is removed from the hash and returned to the caller. The klen is the length of the key. The flags value will normally be zero; if set to G_DISCARD then NULL will be returned.

ハッシュにあるキー/値のペアを削除します。 値 SV はハッシュから取り除かれて、呼び出し元に返されます。 klen はキーの長さです。 flags の値は通常はゼロとなります; これに G_DISCARD をセットした場合には NULL が返されます。

        SV*     hv_delete(HV *hv, const char *key, I32 klen, I32 flags)

hv_delete_ent

Deletes a key/value pair in the hash. The value SV is removed from the hash and returned to the caller. The flags value will normally be zero; if set to G_DISCARD then NULL will be returned. hash can be a valid precomputed hash value, or 0 to ask for it to be computed.

ハッシュにあるキー/値のペアを削除します。 値 SV はハッシュから取り除かれて、呼び出し元に返されます。 flags の値は通常はゼロとなります; これに G_DISCARD をセットした場合には NULL が返されます。 hash はあらかじめ計算されたハッシュ値を置きますが、計算結果を 問い合わせるには 0 とします。

        SV*     hv_delete_ent(HV *hv, SV *keysv, I32 flags, U32 hash)

hv_exists

Returns a boolean indicating whether the specified hash key exists. The klen is the length of the key.

指定されたハッシュキーが存在するかどうかを表わす真偽値を返します。 klen はキーの長さです。

        bool    hv_exists(HV *hv, const char *key, I32 klen)

hv_exists_ent

Returns a boolean indicating whether the specified hash key exists. hash can be a valid precomputed hash value, or 0 to ask for it to be computed.

指定されたハッシュキーが存在するかどうかを表わす真偽値を返します。 hash はあらかじめ計算されたハッシュ値を置きますが、計算結果を 問い合わせるには 0 とします。

        bool    hv_exists_ent(HV *hv, SV *keysv, U32 hash)

hv_fetch

Returns the SV which corresponds to the specified key in the hash. The klen is the length of the key. If lval is set then the fetch will be part of a store. Check that the return value is non-null before dereferencing it to an SV*.

指定されたキーに対応する、ハッシュ中の SV を返します。 klen はキーの長さです。 lval がセットされている場合、フェッチはストアの一部となります。 戻り値 SV* の参照外しをする前に、それがヌルでないことを チェックしてください。

See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.

この関数をどのように tie されたハッシュに使うかに関するさらなる情報は "Understanding the Magic of Tied Hashes and Arrays" in perlguts を 参照してください。

        SV**    hv_fetch(HV *hv, const char *key, I32 klen, I32 lval)

hv_fetchs

Like hv_fetch, but takes a literal string instead of a string/length pair.

hv_fetch と同様ですが、文字列/長さの組ではなく、リテラルな文字列を 取ります。

        SV**    hv_fetchs(HV* tb, const char* key, I32 lval)

hv_fetch_ent

Returns the hash entry which corresponds to the specified key in the hash. hash must be a valid precomputed hash number for the given key, or 0 if you want the function to compute it. IF lval is set then the fetch will be part of a store. Make sure the return value is non-null before accessing it. The return value when tb is a tied hash is a pointer to a static location, so be sure to make a copy of the structure if you need to store it somewhere.

指定されたキーに対応する、ハッシュ中のハッシュエントリを返します。 hash は、key に対する正当な計算済みハッシュ値でなければなりません; もしくは、この関数にハッシュ値を計算させたいのであればここに 0 を置きます。 lval がセットされていると、フェッチはストアの一部分となります。 tb が tie されているハッシュの場合の戻り値は静的な位置 (static location)へのポインタです。 したがって、何かを格納する必要があるのなら、その構造体のコピーを 取るようにしてください。

See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.

この関数をどのように tie されたハッシュに使うかに関するさらなる情報は "Understanding the Magic of Tied Hashes and Arrays" in perlguts を 参照してください。

        HE*     hv_fetch_ent(HV *hv, SV *keysv, I32 lval, U32 hash)

hv_iterinit

Prepares a starting point to traverse a hash table. Returns the number of keys in the hash (i.e. the same as HvKEYS(tb)). The return value is currently only meaningful for hashes without tie magic.

ハッシュテーブルをたどるための開始点を準備します。 ハッシュの中に存在しているキーの数を返します(HvKEYS(tb) と同じです)。 この戻り値は現状では tie magic なしのハッシュに対してのみ意味があります。

NOTE: Before version 5.004_65, hv_iterinit used to return the number of hash buckets that happen to be in use. If you still need that esoteric value, you can get it through the macro HvFILL(tb).

注意: 5.004_65 より前のバージョンでは、hv_iterinit は使用中の ハッシュバケツの数を返すのに使われていました。 もしあなたがそのような値を必要としているのなら、HvFILL(tb) という マクロを使って得ることができます。

        I32     hv_iterinit(HV *hv)

hv_iterkey

Returns the key from the current position of the hash iterator. See hv_iterinit.

ハッシュイテレーターの現在位置からキーを返します。 hv_iterinit を参照してください。

        char*   hv_iterkey(HE* entry, I32* retlen)

hv_iterkeysv

Returns the key as an SV* from the current position of the hash iterator. The return value will always be a mortal copy of the key. Also see hv_iterinit.

ハッシュイテレーターの現在位置から、SV* としてキーを返します。 この戻り値は常にキーの揮発性コピーとなります。 hv_iterinit を参照してください。

        SV*     hv_iterkeysv(HE* entry)

hv_iternext

Returns entries from a hash iterator. See hv_iterinit.

ハッシュ反復子からエントリを返します。 hv_iterinit を参照してください。

You may call hv_delete or hv_delete_ent on the hash entry that the iterator currently points to, without losing your place or invalidating your iterator. Note that in this case the current entry is deleted from the hash with your iterator holding the last reference to it. Your iterator is flagged to free the entry on the next call to hv_iternext, so you must not discard your iterator immediately else the entry will leak - call hv_iternext to trigger the resource deallocation.

反復子が位置を失ったり無効になったりすることなく、反復子が現在指している ハッシュエントリに対して hv_delete または hv_delete_ent を 呼び出すことができます。 この場合現在のエントリは、これへの最後の参照を保持している反復子の ハッシュから削除されることに注意してください。 反復子は次の hv_iternext の呼び出しでエントリが解放されるようにマークが 付けられるので、すぐに反復子を捨ててはいけません; さもなければエントリは リークします; リソースの割り当て解除を引き起こすには hv_iternext を 呼び出してください。

        HE*     hv_iternext(HV *hv)

hv_iternextsv

Performs an hv_iternext, hv_iterkey, and hv_iterval in one operation.

一つの操作で hv_iternext、hv_iterkey、hv_iterval を 呼び出します。

        SV*     hv_iternextsv(HV *hv, char **key, I32 *retlen)

hv_iternext_flags

Returns entries from a hash iterator. See hv_iterinit and hv_iternext. The flags value will normally be zero; if HV_ITERNEXT_WANTPLACEHOLDERS is set the placeholders keys (for restricted hashes) will be returned in addition to normal keys. By default placeholders are automatically skipped over. Currently a placeholder is implemented with a value that is &Perl_sv_placeholder. Note that the implementation of placeholders and restricted hashes may change, and the implementation currently is insufficiently abstracted for any change to be tidy.

ハッシュ反復子からエントリを返します。 hv_iterinit と hv_iternext を参照してください。 flags の値は普通はゼロです; HV_ITERNEXT_WANTPLACEHOLDERS が セットされていると、(制限ハッシュのための) プレースホルダキーは通常のキーに 追加して返されます。 デフォルトではプレースホルダは自動的に飛ばされます。 現在のところプレースホルダは &Perl_sv_placeholder の値として 実装されています。 プレースホルダと制限ハッシュの実装は変更されるかも知れず、現在の実装は 整理するための変更には抽象化が不十分であることに注意してください。

NOTE: this function is experimental and may change or be removed without notice.

注意: この関数は実験的で、予告なしに変更あるいは削除されるかもしれません。

        HE*     hv_iternext_flags(HV *hv, I32 flags)

hv_iterval

Returns the value from the current position of the hash iterator. See hv_iterkey.

ハッシュ反復子の現在位置から値を返します。 hv_iterkey を参照してください。

        SV*     hv_iterval(HV *hv, HE *entry)

hv_magic

Adds magic to a hash. See sv_magic.

ハッシュに magic を付加します。 sv_magic を参照してください。

        void    hv_magic(HV *hv, GV *gv, int how)

hv_scalar

Evaluates the hash in scalar context and returns the result. Handles magic when the hash is tied.

ハッシュをスカラコンテキストで評価して、結果を返します。 ハッシュが tie された場合は magic を扱います。

        SV*     hv_scalar(HV *hv)

hv_store

Stores an SV in a hash. The hash key is specified as key and klen is the length of the key. The hash parameter is the precomputed hash value; if it is zero then Perl will compute it. The return value will be NULL if the operation failed or if the value did not need to be actually stored within the hash (as in the case of tied hashes). Otherwise it can be dereferenced to get the original SV*. Note that the caller is responsible for suitably incrementing the reference count of val before the call, and decrementing it if the function returned NULL. Effectively a successful hv_store takes ownership of one reference to val. This is usually what you want; a newly created SV has a reference count of one, so if all your code does is create SVs then store them in a hash, hv_store will own the only reference to the new SV, and your code doesn't need to do anything further to tidy up. hv_store is not implemented as a call to hv_store_ent, and does not create a temporary SV for the key, so if your key data is not already in SV form then use hv_store in preference to hv_store_ent.

ハッシュに SV を格納します。 そのハッシュキーは key で指定され、klen はキーの長さです。 hash パラメーターはあらかじめ計算したハッシュ値です; 0 にすると Perl がこれを計算します。 戻り値は、操作が失敗したり(tie されているハッシュのように)ハッシュに 実際に値を格納する必要のない場合には NULL になります。 さもなければ、取得したオリジナルの SV* の参照外しをすることができます。 呼び出し側は、呼び出しの前に val の参照カウントを適切にインクリメントし、 関数が NULL を返した場合には参照カウントをデクリメントする責任が あるということに注意してください。 事実上成功した hv_store は val へのリファレンスを取得します。 これは通常あなたの求めているものです; 新しく作られた SV は参照カウント 1 を 持つので、あなたのコードがすることが SV を作成してハッシュを 保管することだけなら、hv_store は新しい SV へのリファレンスだけを所有し、 あなたのコードは整理のためにさらなる何かをする必要はありません。 hv_store は hv_store_ent の呼び出しとして実装されておらず、キーのための 一時的な SV を作成しないので、キーデータがすでに SV 形式に なっているのでなければ、hv_store_ent よりも hv_store を使ってください。

See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.

この関数をどのように tie されたハッシュに使うかに関するさらなる情報は "Understanding the Magic of Tied Hashes and Arrays" in perlguts を 参照してください。

        SV**    hv_store(HV *hv, const char *key, I32 klen, SV *val, U32 hash)

hv_stores

Like hv_store, but takes a literal string instead of a string/length pair and omits the hash parameter.

hv_store と同様ですが、文字列/長さの組ではなく、リテラルな文字列を 取り、ハッシュパラメータを除外します。

        SV**    hv_stores(HV* tb, const char* key, NULLOK SV* val)

hv_store_ent

Stores val in a hash. The hash key is specified as key. The hash parameter is the precomputed hash value; if it is zero then Perl will compute it. The return value is the new hash entry so created. It will be NULL if the operation failed or if the value did not need to be actually stored within the hash (as in the case of tied hashes). Otherwise the contents of the return value can be accessed using the He? macros described here. Note that the caller is responsible for suitably incrementing the reference count of val before the call, and decrementing it if the function returned NULL. Effectively a successful hv_store_ent takes ownership of one reference to val. This is usually what you want; a newly created SV has a reference count of one, so if all your code does is create SVs then store them in a hash, hv_store will own the only reference to the new SV, and your code doesn't need to do anything further to tidy up. Note that hv_store_ent only reads the key; unlike val it does not take ownership of it, so maintaining the correct reference count on key is entirely the caller's responsibility. hv_store is not implemented as a call to hv_store_ent, and does not create a temporary SV for the key, so if your key data is not already in SV form then use hv_store in preference to hv_store_ent.

val をハッシュに格納します。 ハッシュキーは key で指定します。 hash パラメーターはあらかじめ計算したハッシュ値です; 0 にすると Perl がこれを計算します。 戻り値は生成された新しいハッシュエントリです。 操作が失敗したり、(tie されているハッシュのように)ハッシュに実際に値を 格納する必要のない場合には NULL になります。 そうでない場合には、戻り値の内容に He? マクロを使ってアクセスすることが 可能です。 呼び出し側は、呼び出しの前に val の参照カウントを適切にインクリメントし、 関数が NULL を返した場合には参照カウントをデクリメントする責任が あるということに注意してください。 事実上成功した hv_store_ent は val へのリファレンスを取得します。 これは通常あなたの求めているものです; 新しく作られた SV は参照カウント 1 を 持つので、あなたのコードがすることが SV を作成してハッシュを 保管することだけなら、hv_store は新しい SV へのリファレンスだけを所有し、 あなたのコードは整理のためにさらなる何かをする必要はありません。 hv_store_ent は key だけを読み込むことに注意してください; val と違って 所有権を取らないので、key の参照カウントを正しく保守するのは全て 呼び出し側に責任があります。 hv_store は hv_store_ent の呼び出しとして実装されておらず、キーのための 一時的な SV を作成しないので、キーデータがすでに SV 形式に なっているのでなければ、hv_store_ent よりも hv_store を使ってください。

See "Understanding the Magic of Tied Hashes and Arrays" in perlguts for more information on how to use this function on tied hashes.

この関数をどのように tie されたハッシュに使うかに関するさらなる情報は "Understanding the Magic of Tied Hashes and Arrays" in perlguts を 参照してください。

        HE*     hv_store_ent(HV *hv, SV *key, SV *val, U32 hash)

hv_undef

Undefines the hash.

ハッシュを undefine します。

        void    hv_undef(HV *hv)

newHV

Creates a new HV. The reference count is set to 1.

新たな HV を生成します。 参照カウントは 1 に設定されます。

        HV*     newHV()

マジカル関数¶

mg_clear

Clear something magical that the SV represents. See sv_magic.

SV が表わしている magical をクリアします。 sv_magic を参照してください。

        int     mg_clear(SV* sv)

mg_copy

Copies the magic from one SV to another. See sv_magic.

ある SV から別の SV へ magic をコピーします。 sv_magic を参照してください。

        int     mg_copy(SV *sv, SV *nsv, const char *key, I32 klen)

mg_find

Finds the magic pointer for type matching the SV. See sv_magic.

type にマッチする SV への magic ポインタを検索します。 sv_magic を参照してください。

        MAGIC*  mg_find(const SV* sv, int type)

mg_free

Free any magic storage used by the SV. See sv_magic.

SV が使用しているすべての magic storage を解放します。 sv_magic を参照してください。

        int     mg_free(SV* sv)

mg_get

Do magic after a value is retrieved from the SV. See sv_magic.

SV から値を取得した後で magic を行います。 sv_magic を参照してください。

        int     mg_get(SV* sv)

mg_length

Report on the SV's length. See sv_magic.

SV の長さを報告します。 sv_magic を参照してください。

        U32     mg_length(SV* sv)

mg_magical

Turns on the magical status of an SV. See sv_magic.

SV の magical status をオンにします。 sv_magic を参照してください。

        void    mg_magical(SV* sv)

mg_set

Do magic after a value is assigned to the SV. See sv_magic.

SV に値を代入した後で magic を行います。 sv_magic を参照してください。

        int     mg_set(SV* sv)

SvGETMAGIC

Invokes mg_get on an SV if it has 'get' magic. This macro evaluates its argument more than once.

SV が 'get' magic を有している場合には mg_get を起動します。 このマクロは二回以上引数を評価します。

        void    SvGETMAGIC(SV* sv)

SvLOCK

Arranges for a mutual exclusion lock to be obtained on sv if a suitable module has been loaded.

適切なモジュールが読み込まれていれば、sv を得るための相互排他ロックを 準備します。

        void    SvLOCK(SV* sv)

SvSETMAGIC

Invokes mg_set on an SV if it has 'set' magic. This macro evaluates its argument more than once.

SV が 'set' magic を持っている場合に、その SV に対して mg_set を 起動します。 このマクロは二回以上引数を評価します。

        void    SvSETMAGIC(SV* sv)

SvSetMagicSV

Like SvSetSV, but does any set magic required afterwards.

SvSetSV と同様ですが、後で set magic が必要です。

        void    SvSetMagicSV(SV* dsb, SV* ssv)

SvSetMagicSV_nosteal

Like SvSetSV_nosteal, but does any set magic required afterwards.

SvSetSV_nosteal と同様ですが、後で set magic が必要です。

        void    SvSetMagicSV_nosteal(SV* dsv, SV* ssv)

SvSetSV

Calls sv_setsv if dsv is not the same as ssv. May evaluate arguments more than once.

dsv が ssv と等しくなかったときに sv_setsv を呼び出します。 引数は二回以上評価される可能性があります。

        void    SvSetSV(SV* dsb, SV* ssv)

SvSetSV_nosteal

Calls a non-destructive version of sv_setsv if dsv is not the same as ssv. May evaluate arguments more than once.

dsv と ssv が等しくなかったときに呼び出される、非破壊的バージョンの sv_setsv を呼び出します。 引数は二回以上評価される可能性があります。

        void    SvSetSV_nosteal(SV* dsv, SV* ssv)

SvSHARE

Arranges for sv to be shared between threads if a suitable module has been loaded.

適切なモジュールが読み込まれていれば、sv をスレッド間で共有するための 準備をします。

        void    SvSHARE(SV* sv)

SvUNLOCK

Releases a mutual exclusion lock on sv if a suitable module has been loaded.

適切なモジュールが読み込まれていれば、sv の相互排他ロックを解放します。

        void    SvUNLOCK(SV* sv)

メモリ管理¶

Copy

The XSUB-writer's interface to the C memcpy function. The src is the source, dest is the destination, nitems is the number of items, and type is the type. May fail on overlapping copies. See also Move.

C の memcpy 関数に対する XSUB 作成者のためのインターフェースです。 src は転送元、dest は転送先、nitems はアイテムの数、type は アイテムの型です。 領域がオーバーラップしているコピーの場合は失敗します。 Move を参照してください。

        void    Copy(void* src, void* dest, int nitems, type)

CopyD

Like Copy but returns dest. Useful for encouraging compilers to tail-call optimise.

Copy と同様ですが、dest を返します。 末尾呼び出し最適化を行うコンパイラで便利です。

        void *  CopyD(void* src, void* dest, int nitems, type)

Move

The XSUB-writer's interface to the C memmove function. The src is the source, dest is the destination, nitems is the number of items, and type is the type. Can do overlapping moves. See also Copy.

C の memmove 関数に対する XSUB 作成者のためのインターフェースです。 src は転送元、dest は転送先、nitems はアイテムの数、type は アイテムの型です。 オーバーラップした移動も可能です。 Copy を参照してください。

        void    Move(void* src, void* dest, int nitems, type)

MoveD

Like Move but returns dest. Useful for encouraging compilers to tail-call optimise.

Move と同様ですが、dest を返します。 末尾呼び出し最適化を行うコンパイラで便利です。

        void *  MoveD(void* src, void* dest, int nitems, type)

Newx

The XSUB-writer's interface to the C malloc function.

XSUB 作成者のための malloc 関数のインターフェースです。

In 5.9.3, Newx() and friends replace the older New() API, and drops the first parameter, x, a debug aid which allowed callers to identify themselves. This aid has been superseded by a new build option, PERL_MEM_LOG (see "PERL_MEM_LOG" in perlhack). The older API is still there for use in XS modules supporting older perls.

5.9.3 から、Newx() とその同類は古い New() API を置き換え、呼び出し側が 自分自身を識別できるようにデバッグの助けをするための最初の引数 x が なくなりました。 この助けは新しいビルドオプション PERL_MEM_LOG ("PERL_MEM_LOG" in perlhack 参照) で置き換えられました。 古い API は、古い perl に対応している XS モジュールが使えるように まだ存在しています。

        void    Newx(void* ptr, int nitems, type)

Newxc

The XSUB-writer's interface to the C malloc function, with cast. See also Newx.

C の malloc 関数に対する XSUB 作成者のためのキャスト付き インターフェースです。 Newx も参照してください。

        void    Newxc(void* ptr, int nitems, type, cast)

Newxz

The XSUB-writer's interface to the C malloc function. The allocated memory is zeroed with memzero. See also Newx.

XSUB 作成者のための malloc 関数のインターフェースです。 割り付けられた領域は memzero によってゼロで埋められます。 Newx も参照してください。

        void    Newxz(void* ptr, int nitems, type)

Poison

PoisonWith(0xEF) for catching access to freed memory.

解放されたメモリへのアクセスを捕捉するための PoisonWith(0xEF) です。

        void    Poison(void* dest, int nitems, type)

PoisonFree

PoisonWith(0xEF) for catching access to freed memory.

解放されたメモリへのアクセスを捕捉するための PoisonWith(0xEF) です。

        void    PoisonFree(void* dest, int nitems, type)

PoisonNew

PoisonWith(0xAB) for catching access to allocated but uninitialized memory.

割り当てられたけれども未初期化のメモリへのアクセスを捕捉するための PoisonWith(0xAB)。

        void    PoisonNew(void* dest, int nitems, type)

PoisonWith

Fill up memory with a byte pattern (a byte repeated over and over again) that hopefully catches attempts to access uninitialized memory.

うまくいけば未初期化メモリへのアクセスを捕捉するためにメモリを (あるバイトが繰り返される)バイトパターンで埋めます。

        void    PoisonWith(void* dest, int nitems, type, U8 byte)

Renew

The XSUB-writer's interface to the C realloc function.

C の realloc 関数に対する XSUB 作成者のためのインターフェースです。

        void    Renew(void* ptr, int nitems, type)

Renewc

The XSUB-writer's interface to the C realloc function, with cast.

キャスト付きの、C の realloc 関数に対する XSUB 作成者のための インターフェースです。

        void    Renewc(void* ptr, int nitems, type, cast)

Safefree

The XSUB-writer's interface to the C free function.

C の free 関数に対する XSUB 作成者のためのインターフェースです。

        void    Safefree(void* ptr)

savepv

Perl's version of strdup(). Returns a pointer to a newly allocated string which is a duplicate of pv. The size of the string is determined by strlen(). The memory allocated for the new string can be freed with the Safefree() function.

Perl 版の strdup()。 pv の複製である、新しく割り当てられた文字列へのポインタを返します。 文字列のサイズは strlen() によって決定されます。 新しい文字列のために割り当てられたメモリは Safefree() 関数で解放できます。

        char*   savepv(const char* pv)

savepvn

Perl's version of what strndup() would be if it existed. Returns a pointer to a newly allocated string which is a duplicate of the first len bytes from pv, plus a trailing NUL byte. The memory allocated for the new string can be freed with the Safefree() function.

もしあれば strndup() が行うことの Perl 版。 pv から len バイトの複製に加えて末尾の NUL バイトからなる、新しく 割り当てられた文字列へのポインタを返します。 新しい文字列のために割り当てられたメモリは Safefree() 関数で解放できます。

        char*   savepvn(const char* pv, I32 len)

savepvs

Like savepvn, but takes a literal string instead of a string/length pair.

savepvn と同様ですが、文字列/長さの組ではなく、リテラルな文字列を 取ります。

        char*   savepvs(const char* s)

savesharedpv

A version of savepv() which allocates the duplicate string in memory which is shared between threads.

スレッド間で共有しているメモリで複製された文字列を割り当てるバージョンの savepv()。

        char*   savesharedpv(const char* pv)

savesharedpvn

A version of savepvn() which allocates the duplicate string in memory which is shared between threads. (With the specific difference that a NULL pointer is not acceptable)

スレッド間で共有したメモリに複製した文字列を割り当てるバージョンの savepvn() です。 (NULL ポインタを受け付けないという違いもあります)

        char*   savesharedpvn(const char *const pv, const STRLEN len)

savesvpv

A version of savepv()/savepvn() which gets the string to duplicate from the passed in SV using SvPV()

SvPV() を使った SV で渡されたものから複製した文字列を取得するバージョンの savepv()/savepvn() です。

        char*   savesvpv(SV* sv)

StructCopy

This is an architecture-independent macro to copy one structure to another.

これはある構造体をもう一つにコピーするためのアーキテクチャに依存しない マクロです。

        void    StructCopy(type src, type dest, type)

Zero

The XSUB-writer's interface to the C memzero function. The dest is the destination, nitems is the number of items, and type is the type.

C の memzero 関数に対する XSUB 作成者のためのインターフェースです。 dest は対象となる場所、nitems はアイテムの数、type は アイテムの型です。

        void    Zero(void* dest, int nitems, type)

ZeroD

Like Zero but returns dest. Useful for encouraging compilers to tail-call optimise.

Zero と同様ですが、dest を返します。 末尾呼び出し最適化を行うコンパイラで便利です。

        void *  ZeroD(void* dest, int nitems, type)

その他の関数¶

fbm_compile

Analyses the string in order to make fast searches on it using fbm_instr() -- the Boyer-Moore algorithm.

Boyer-Moore アルゴリズムを使った fbm_instr() による高速検索が できるようにするために文字列を解析します。

        void    fbm_compile(SV* sv, U32 flags)

fbm_instr

Returns the location of the SV in the string delimited by str and strend. It returns NULL if the string can't be found. The sv does not have to be fbm_compiled, but the search will not be as fast then.

str と strend によって区切られる文字列中にある SV の位置を返します。 文字列が見つからなかった場合には NULL を返します。 sv は fbm_compile されている必要はありませんが、その場合にはある場合に 比べると検索速度は遅くなります。

        char*   fbm_instr(unsigned char* big, unsigned char* bigend, SV* littlestr, U32 flags)

form

Takes a sprintf-style format pattern and conventional (non-SV) arguments and returns the formatted string.

sprintf 形式のフォーマットパターンと形式的な (非 SV) 引数を取って、 フォーマットされた文字列を返します。

    (char *) Perl_form(pTHX_ const char* pat, ...)

can be used any place a string (char *) is required:

は文字列 (char *) が必要なあらゆる場所で使えます:

    char * s = Perl_form("%d.%d",major,minor);

Uses a single private buffer so if you want to format several strings you must explicitly copy the earlier strings away (and free the copies when you are done).

単一のプライベートなバッファを使うので、いくつかの文字列を フォーマットしたいなら、以前の文字列を明示的にコピーしなければなりません (そして使い終わったらコピーを解放しなければなりません)。

        char*   form(const char* pat, ...)

getcwd_sv

Fill the sv with current working directory

sv をカレントワーキングディレクトリで埋めます

        int     getcwd_sv(SV* sv)

my_snprintf

The C library snprintf functionality, if available and standards-compliant (uses vsnprintf, actually). However, if the vsnprintf is not available, will unfortunately use the unsafe vsprintf which can overrun the buffer (there is an overrun check, but that may be too late). Consider using sv_vcatpvf instead, or getting vsnprintf.

利用可能で標準に準拠していれば、C ライブラリの snprintf の機能です (実際には vsnprintf を使います)。 しかし、vsnprintf が利用不可能なら、残念ながらバッファをオーバーランする 可能性のある安全でない vsprintf を使います (オーバーランチェックは ありますが、遅すぎるかもしれません)。 代わりに sv_vcatpvf を使うか、vsnprintf を使うことを考慮してください。

        int     my_snprintf(char *buffer, const Size_t len, const char *format, ...)

my_sprintf

The C library sprintf, wrapped if necessary, to ensure that it will return the length of the string written to the buffer. Only rare pre-ANSI systems need the wrapper function - usually this is a direct call to sprintf.

バッファに書き込んだ文字列の長さが確実に返されるように、もし必要なら ラップされた、C ライブラリの sprintf です。 稀な ANSI 以前のシステムのみがラッパー関数を必要とします - 通常はこれは直接 sprintf を呼び出します。

        int     my_sprintf(char *buffer, const char *pat, ...)

my_vsnprintf

The C library vsnprintf if available and standards-compliant. However, if if the vsnprintf is not available, will unfortunately use the unsafe vsprintf which can overrun the buffer (there is an overrun check, but that may be too late). Consider using sv_vcatpvf instead, or getting vsnprintf.

利用可能で標準に準拠していれば、C ライブラリの snprintf です。 しかし、vsnprintf が利用不可能なら、残念ながらバッファをオーバーランする 可能性のある安全でない vsprintf を使います (オーバーランチェックは ありますが、遅すぎるかもしれません)。 代わりに sv_vcatpvf を使うか、vsnprintf を使うことを考慮してください。

        int     my_vsnprintf(char *buffer, const Size_t len, const char *format, va_list ap)

new_version

Returns a new version object based on the passed in SV:

SV で渡されたものを基として新しいバージョンオブジェクトを返します:

    SV *sv = new_version(SV *ver);

Does not alter the passed in ver SV. See "upg_version" if you want to upgrade the SV.

渡された ver SV は変更されません。 SV を昇格したいなら "upg_version" を参照してください。

        SV*     new_version(SV *ver)

scan_version

Returns a pointer to the next character after the parsed version string, as well as upgrading the passed in SV to an RV.

バージョン文字列をパースした後の次の文字へのポインタを返します; また、SV に 渡されたものを RV に昇格させます。

Function must be called with an already existing SV like

関数は以下のように、既に存在する SV と共に呼び出されなければなりません

    sv = newSV(0);
    s = scan_version(s, SV *sv, bool qv);

Performs some preprocessing to the string to ensure that it has the correct characteristics of a version. Flags the object if it contains an underscore (which denotes this is an alpha version). The boolean qv denotes that the version should be interpreted as if it had multiple decimals, even if it doesn't.

バージョンとして正しい特性を持つように文字列に前処理を行います。 下線が含まれている(これがαバージョンであることを示します)なら、 オブジェクトにマークを付けます。 真偽値 qv は、たとえそうではなくても、バージョンに複数の小数点が 含まれているかのように解釈するべきであることを示します。

        const char*     scan_version(const char *s, SV *rv, bool qv)

strEQ

Test two strings to see if they are equal. Returns true or false.

二つの文字列が等しいかどうかを検査します。 真か偽を返します。

        bool    strEQ(char* s1, char* s2)

strGE

Test two strings to see if the first, s1, is greater than or equal to the second, s2. Returns true or false.

二つの文字列を、s1 が s2 よりも大きい、もしくは両者が等しいかどうかの 検査をします。 真か偽を返します。

        bool    strGE(char* s1, char* s2)

strGT

Test two strings to see if the first, s1, is greater than the second, s2. Returns true or false.

二つの文字列を、s1 が s2 よりも大きいかどうかの検査をします。 真か偽を返します。

        bool    strGT(char* s1, char* s2)

strLE

Test two strings to see if the first, s1, is less than or equal to the second, s2. Returns true or false.

二つの文字列を、s1 が s2 よりも小さい、もしくは両者が等しいか どうかの検査をします。 真か偽を返します。

        bool    strLE(char* s1, char* s2)

strLT

Test two strings to see if the first, s1, is less than the second, s2. Returns true or false.

二つの文字列を、s1 が s2 よりも小さいかどうかの検査をします。 真か偽を返します。

        bool    strLT(char* s1, char* s2)

strNE

Test two strings to see if they are different. Returns true or false.

二つの文字列が異なるかどうかを検査します。 真か偽を返します。

        bool    strNE(char* s1, char* s2)

strnEQ

Test two strings to see if they are equal. The len parameter indicates the number of bytes to compare. Returns true or false. (A wrapper for strncmp).

二つの文字列が等しいかどうかを検査します。 パラメーター len は、比較を行うバイト数を指定します。 真か偽を返します。 (strncmp へのラッパーです)

        bool    strnEQ(char* s1, char* s2, STRLEN len)

strnNE

Test two strings to see if they are different. The len parameter indicates the number of bytes to compare. Returns true or false. (A wrapper for strncmp).

二つの文字列が異なるかどうかを検査します。 パラメーター len は、比較を行うバイト数を指定します。 真か偽を返します。 (strncmp へのラッパーです)

        bool    strnNE(char* s1, char* s2, STRLEN len)

sv_destroyable

Dummy routine which reports that object can be destroyed when there is no sharing module present. It ignores its single SV argument, and returns 'true'. Exists to avoid test for a NULL function pointer and because it could potentially warn under some level of strict-ness.

共有モジュールがないときにオブジェクトを破壊可能であると報告するダミー ルーチンです。 これは SV 引数を無視して、真を返します。 NULL 関数をテストして、あるレベルでの strict での潜在的な警告を 回避するために存在します。

        bool    sv_destroyable(SV *sv)

sv_nosharing

Dummy routine which "shares" an SV when there is no sharing module present. Or "locks" it. Or "unlocks" it. In other words, ignores its single SV argument. Exists to avoid test for a NULL function pointer and because it could potentially warn under some level of strict-ness.

共有モジュールがないときに SV を「共有する」ダミールーチンです。 あるいは「ロックします」。 あるいは「アンロックします」。 言い換えると、単一の SV 引数を無視します。 NULL 関数をテストして、あるレベルでの strict での潜在的な警告を 回避するために存在します。

        void    sv_nosharing(SV *sv)

upg_version

In-place upgrade of the supplied SV to a version object.

SV をバージョンオブジェクトにその場で昇格します。

    SV *sv = upg_version(SV *sv, bool qv);

Returns a pointer to the upgraded SV. Set the boolean qv if you want to force this SV to be interpreted as an "extended" version.

昇格された SV へのポインタを返します。 この SV が「拡張」版として解釈されることを強制したいなら、真偽値 qv を セットします。

        SV*     upg_version(SV *ver, bool qv)

vcmp

Version object aware cmp. Both operands must already have been converted into version objects.

バージョンオブジェクトを認識する cmp。 両方のオペランドは既にバージョンオブジェクトに 変換されていなければなりません。

        int     vcmp(SV *lhv, SV *rhv)

vnormal

Accepts a version object and returns the normalized string representation. Call like:

バージョンオブジェクトを受け付けて正規化された文字列表現を返します。 以下のように呼び出します:

    sv = vnormal(rv);

NOTE: you can pass either the object directly or the SV contained within the RV.

注意: オブジェクトを直接と、RV に含まれている SV のどちらでも渡せます。

        SV*     vnormal(SV *vs)

vnumify

Accepts a version object and returns the normalized floating point representation. Call like:

バージョンオブジェクトを受け付けて正規化された浮動小数点表現を返します。 以下のように呼び出します:

    sv = vnumify(rv);

NOTE: you can pass either the object directly or the SV contained within the RV.

注意: オブジェクトを直接と、RV に含まれている SV のどちらでも渡せます。

        SV*     vnumify(SV *vs)

vstringify

In order to maintain maximum compatibility with earlier versions of Perl, this function will return either the floating point notation or the multiple dotted notation, depending on whether the original version contained 1 or more dots, respectively

以前のバージョンの Perl との最大限の互換性を維持するために、この関数は 元のバージョンにドットが一つだけか複数あるかに依存して、浮動小数点表記か 複数ドット表記のどちらかを返します。

        SV*     vstringify(SV *vs)

vverify

Validates that the SV contains a valid version object.

SV が正当なバージョンオブジェクトを含んでいるかを検証します。

    bool vverify(SV *vobj);

Note that it only confirms the bare minimum structure (so as not to get confused by derived classes which may contain additional hash entries):

これは生の最小限の構造体だけを確認することに注意してください (従って 追加のハッシュエントリを含んでいるかもしれない派生クラスによって 混乱しません):

        bool    vverify(SV *vs)

MRO 関数¶

mro_get_linear_isa

Returns either mro_get_linear_isa_c3 or mro_get_linear_isa_dfs for the given stash, dependant upon which MRO is in effect for that stash. The return value is a read-only AV*.

このスタッシュに対して MRO が有効かどうかに依存して、スタッシュに対する mro_get_linear_isa_c3 か mro_get_linear_isa_dfs のどちらかを 返します。 返り値は読み込み専用の AV* です。

You are responsible for SvREFCNT_inc() on the return value if you plan to store it anywhere semi-permanently (otherwise it might be deleted out from under you the next time the cache is invalidated).

半永久的にどこかにこれを保管する計画がある場合、返り値に対する SvREFCNT_inc() に対して責任があります。 (さもなければ、次回キャッシュが無効化されるときに削除されるかもしれません)。

        AV*     mro_get_linear_isa(HV* stash)

mro_method_changed_in

Invalidates method caching on any child classes of the given stash, so that they might notice the changes in this one.

スタッシュの全ての子クラスのメソッドキャッシュを無効にして、これによる 変更が通知されます。

Ideally, all instances of PL_sub_generation++ in perl source outside of mro.c should be replaced by calls to this.

理想的には、mro.c の外側の perl ソースの PL_sub_generation++ の全ての 実体はこれへの呼び出しで置き換えられるべきです。

Perl automatically handles most of the common ways a method might be redefined. However, there are a few ways you could change a method in a stash without the cache code noticing, in which case you need to call this method afterwards:

Perl はメソッドが再定義されるかもしれない一般的な方法のほとんどを自動的に 扱います。 しかしキャッシュコードが気付くことなくスタッシュのメソッドを変更する いくつかの方法があります; この場合後でこのメソッドを呼び出す必要があります:

1) Directly manipulating the stash HV entries from XS code.

1) XS コードからスタッシュ HV エントリを直接操作する。

2) Assigning a reference to a readonly scalar constant into a stash entry in order to create a constant subroutine (like constant.pm does).

2) 読み込み専用スカラ定数へのリファレンスを、(constant.pm がしているように) 定数サブルーチンを作成するためにスタッシュエントリに代入する。

This same method is available from pure perl via, mro::method_changed_in(classname).

同じメソッドはピュア perl から mro::method_changed_in(classname) 経由で 利用可能です。

        void    mro_method_changed_in(HV* stash)

多重呼び出し関数¶

dMULTICALL

Declare local variables for a multicall. See "Lightweight Callbacks" in perlcall.

多重呼び出しのための局所変数を宣言します。 "Lightweight Callbacks" in perlcall を参照してください。

                dMULTICALL;

MULTICALL

Make a lightweight callback. See "Lightweight Callbacks" in perlcall.

軽量コールバックを作ります。 "Lightweight Callbacks" in perlcall を参照してください。

                MULTICALL;

POP_MULTICALL

Closing bracket for a lightweight callback. See "Lightweight Callbacks" in perlcall.

軽量コールバックのための大かっこを閉じます。 "Lightweight Callbacks" in perlcall を参照してください。

                POP_MULTICALL;

PUSH_MULTICALL

Opening bracket for a lightweight callback. See "Lightweight Callbacks" in perlcall.

軽量コールバックのための大かっこを開きます。 "Lightweight Callbacks" in perlcall を参照してください。

                PUSH_MULTICALL;

数値関数¶

grok_bin

converts a string representing a binary number to numeric form.

2 進数を表現した文字列を数値形式に変換します。

On entry start and *len give the string to scan, *flags gives conversion flags, and result should be NULL or a pointer to an NV. The scan stops at the end of the string, or the first invalid character. Unless PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering an invalid character will also trigger a warning. On return *len is set to the length of the scanned string, and *flags gives output flags.

エントリ start と *len はスキャンする文字列を指定し、*flags は 変換フラグ、result は NULL か NV へのポインタです。 スキャンは文字列の末尾か、最初の不正な文字で停止します。 *flags に PERL_SCAN_SILENT_ILLDIGIT がセットされていなければ、不正な 文字に遭遇すると警告も引き起こされます。 返るときに、*len はスキャンした文字列の長さにセットされ、 *flags は出力フラグになります。

If the value is <= UV_MAX it is returned as a UV, the output flags are clear, and nothing is written to *result. If the value is > UV_MAX grok_bin returns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags, and writes the value to *result (or the value is discarded if result is NULL).

値が <= UV_MAX なら、出力フラグがクリアされ、*result に何も書かない UV として返されます。 値が > UV_MAX なら、grok_bin は出力フラグに PERL_SCAN_GREATER_THAN_UV_MAX をセットし、値を *result に書き込んで、 UV_MAX を返します (あるいは result が NULL なら値は捨てられます)。

The binary number may optionally be prefixed with "0b" or "b" unless PERL_SCAN_DISALLOW_PREFIX is set in *flags on entry. If PERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the binary number may use '_' characters to separate digits.

エントリの *flags に PERL_SCAN_DISALLOW_PREFIX が セットされていなければ、2 進数にオプションとして "0b" または "b" を 前置できます。 *flags で PERL_SCAN_ALLOW_UNDERSCORES がセットされていると、2 進数で 数値を区切るのに '_' 文字が使えます。

        UV      grok_bin(const char* start, STRLEN* len_p, I32* flags, NV *result)

grok_hex

converts a string representing a hex number to numeric form.

16 進数を表現した文字列を数値形式に変換します。

On entry start and *len give the string to scan, *flags gives conversion flags, and result should be NULL or a pointer to an NV. The scan stops at the end of the string, or the first invalid character. Unless PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering an invalid character will also trigger a warning. On return *len is set to the length of the scanned string, and *flags gives output flags.

エントリ start と *len はスキャンする文字列を指定し、*flags は 変換フラグ、result は NULL か NV へのポインタです。 スキャンは文字列の末尾か、最初の不正な文字で停止します。 *flags に PERL_SCAN_SILENT_ILLDIGIT がセットされていなければ、不正な 文字に遭遇すると警告も引き起こされます。 返るときに、*len はスキャンした文字列の長さにセットされ、 *flags は出力フラグになります。

If the value is <= UV_MAX it is returned as a UV, the output flags are clear, and nothing is written to *result. If the value is > UV_MAX grok_hex returns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags, and writes the value to *result (or the value is discarded if result is NULL).

値が <= UV_MAX なら、出力フラグがクリアされ、*result に何も書かない UV として返されます。 値が > UV_MAX なら、grok_hex は出力フラグに PERL_SCAN_GREATER_THAN_UV_MAX をセットし、値を *result に書き込んで、 UV_MAX を返します (あるいは result が NULL なら値は捨てられます)。

The hex number may optionally be prefixed with "0x" or "x" unless PERL_SCAN_DISALLOW_PREFIX is set in *flags on entry. If PERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the hex number may use '_' characters to separate digits.

エントリの *flags に PERL_SCAN_DISALLOW_PREFIX が セットされていなければ、16 進数にオプションとして "0x" または "x" を 前置できます。 *flags で PERL_SCAN_ALLOW_UNDERSCORES がセットされていると、2 進数で 数値を区切るのに '_' 文字が使えます。

        UV      grok_hex(const char* start, STRLEN* len_p, I32* flags, NV *result)

grok_number

Recognise (or not) a number. The type of the number is returned (0 if unrecognised), otherwise it is a bit-ORed combination of IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT, IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN (defined in perl.h).

数値を認識します(またはしません)。 数値の型(認識されなかった場合は 0)が返され、さもなければ (perl.h に定義されている) IS_NUMBER_IN_UV, IS_NUMBER_GREATER_THAN_UV_MAX, IS_NUMBER_NOT_INT, IS_NUMBER_NEG, IS_NUMBER_INFINITY, IS_NUMBER_NAN を ビット単位で OR したものです。

If the value of the number can fit an in UV, it is returned in the *valuep IS_NUMBER_IN_UV will be set to indicate that *valuep is valid, IS_NUMBER_IN_UV will never be set unless *valuep is valid, but *valuep may have been assigned to during processing even though IS_NUMBER_IN_UV is not set on return. If valuep is NULL, IS_NUMBER_IN_UV will be set for the same cases as when valuep is non-NULL, but no actual assignment (or SEGV) will occur.

数値の値が UV に収まるなら、*valuep に返され、*valuep が有効であることを 示すために IS_NUMBER_IN_UV がセットされます; *valuep が有効でなければ IS_NUMBER_IN_UV がセットされることはありませんが、返る時点で IS_NUMBER_IN_UV がセットされていないとしても、処理中に *valuep に値が 代入されるかもしれません。 valuep が NULL なら、valuep が非 NULL の場合と同様に IS_NUMBER_IN_UV が セットされますが、実際の代入(または SEGV)は起こりません。

IS_NUMBER_NOT_INT will be set with IS_NUMBER_IN_UV if trailing decimals were seen (in which case *valuep gives the true value truncated to an integer), and IS_NUMBER_NEG if the number is negative (in which case *valuep holds the absolute value). IS_NUMBER_IN_UV is not set if e notation was used or the number is larger than a UV.

引き続く数字がある(この場合 *valuep には整数に切り詰められた真の値が入ります) の場合、IS_NUMBER_NOT_INT が IS_NUMBER_IN_UV と共にセットされ、値が負数 (この場合 *value には絶対値が入ります)の場合、IS_NUMBER_NEG が セットされます。 e 記法が使われたり数値が UV よりも大きいなら、IS_NUMBER_IN_UV は セットされません。

        int     grok_number(const char *pv, STRLEN len, UV *valuep)

grok_numeric_radix

Scan and skip for a numeric decimal separator (radix).

小数点をスキャンして、読み飛ばします。

        bool    grok_numeric_radix(const char **sp, const char *send)

grok_oct

converts a string representing an octal number to numeric form.

8 進数を表現した文字列を数値形式に変換します。

On entry start and *len give the string to scan, *flags gives conversion flags, and result should be NULL or a pointer to an NV. The scan stops at the end of the string, or the first invalid character. Unless PERL_SCAN_SILENT_ILLDIGIT is set in *flags, encountering an invalid character will also trigger a warning. On return *len is set to the length of the scanned string, and *flags gives output flags.

エントリ start と *len はスキャンする文字列を指定し、*flags は 変換フラグ、result は NULL か NV へのポインタです。 スキャンは文字列の末尾か、最初の不正な文字で停止します。 *flags に PERL_SCAN_SILENT_ILLDIGIT がセットされていなければ、不正な 文字に遭遇すると警告も引き起こされます。 返るときに、*len はスキャンした文字列の長さにセットされ、 *flags は出力フラグになります。

If the value is <= UV_MAX it is returned as a UV, the output flags are clear, and nothing is written to *result. If the value is > UV_MAX grok_oct returns UV_MAX, sets PERL_SCAN_GREATER_THAN_UV_MAX in the output flags, and writes the value to *result (or the value is discarded if result is NULL).

値が <= UV_MAX なら、出力フラグがクリアされ、*result に何も書かない UV として返されます。 値が > UV_MAX なら、grok_oct は出力フラグに PERL_SCAN_GREATER_THAN_UV_MAX をセットし、値を *result に書き込んで、 UV_MAX を返します (あるいは result が NULL なら値は捨てられます)。

If PERL_SCAN_ALLOW_UNDERSCORES is set in *flags then the octal number may use '_' characters to separate digits.

*flags で PERL_SCAN_ALLOW_UNDERSCORES が設定されると、8 進数は 数値を区切るのに '_' 文字を使えます。

        UV      grok_oct(const char* start, STRLEN* len_p, I32* flags, NV *result)

Perl_signbit

Return a non-zero integer if the sign bit on an NV is set, and 0 if it is not.

もし NV の符号ビットがセットされていれば非 0 の整数を、そうでなければ 0 を返します。

If Configure detects this system has a signbit() that will work with our NVs, then we just use it via the #define in perl.h. Otherwise, fall back on this implementation. As a first pass, this gets everything right except -0.0. Alas, catching -0.0 is the main use for this function, so this is not too helpful yet. Still, at least we have the scaffolding in place to support other systems, should that prove useful.

Configure は、このシステムの NV に動作する signbit() が持っていることを 検出します。 それから単にこれを perl.h の #define 経由で使います。 さもなければ、この実装にフォールバックします。 第 1 パスとして、これは -0.0 以外の全てを取ります。 悲しいかな、-0.0 の捕捉はこの関数の主な使用法なので、これはまだあまり 役には立ちません。 それでも、少なくとも便利であるとわかる他のシステムに対応する足場になります。

Configure notes: This function is called 'Perl_signbit' instead of a plain 'signbit' because it is easy to imagine a system having a signbit() function or macro that doesn't happen to work with our particular choice of NVs. We shouldn't just re-#define signbit as Perl_signbit and expect the standard system headers to be happy. Also, this is a no-context function (no pTHX_) because Perl_signbit() is usually re-#defined in perl.h as a simple macro call to the system's signbit(). Users should just always call Perl_signbit().

Configure の注意: この関数は、単なる 'signbit' ではなく 'Perl_signbit' と 呼ばれます; なぜなら たまたま NV の特定の選択で動作しない signbit() 関数やマクロを持つシステムを 想像するのは容易だからです。 単に signbit を Perl_signbit と再 #define して、標準システムヘッダがうまく 動くことを想定するべきではありません。 また、これは(pTHX_ なしの)コンテキストなし関数はありません; なぜなら Perl_signbit() は通常 perl.h でシステムの signbit() への単純なマクロ 呼び出しに再 #defined されるからです。 ユーザーは単に常に Perl_signbit() を呼び出してください。

NOTE: this function is experimental and may change or be removed without notice.

注意: この関数は実験的で、予告なしに変更あるいは削除されるかもしれません。

        int     Perl_signbit(NV f)

scan_bin

For backwards compatibility. Use grok_bin instead.

後方互換性のためのものです。 代わりに grok_bin を使ってください。

        NV      scan_bin(const char* start, STRLEN len, STRLEN* retlen)

scan_hex

For backwards compatibility. Use grok_hex instead.

後方互換性のためのものです。 代わりに grok_hex を使ってください。

        NV      scan_hex(const char* start, STRLEN len, STRLEN* retlen)

scan_oct

For backwards compatibility. Use grok_oct instead.

後方互換性のためのものです。 代わりに grok_oct を使ってください。

        NV      scan_oct(const char* start, STRLEN len, STRLEN* retlen)

演算木操作関数¶

cv_const_sv

If cv is a constant sub eligible for inlining. returns the constant value returned by the sub. Otherwise, returns NULL.

cv がインライン化可能な定数サブルーチンなら、サブルーチンから返される 定数値を返します。 さもなければ NULL を返します。

Constant subs can be created with newCONSTSUB or as described in "Constant Functions" in perlsub.

定数サブルーチンは newCONSTSUB か、"Constant Functions" in perlsub で 記述されている方法で作成されます。

        SV*     cv_const_sv(CV* cv)

newCONSTSUB

Creates a constant sub equivalent to Perl sub FOO () { 123 } which is eligible for inlining at compile-time.

Perl での sub FOO () { 123 } と等価な定数サブルーチンを生成します。

        CV*     newCONSTSUB(HV* stash, const char* name, SV* sv)

newXS

Used by xsubpp to hook up XSUBs as Perl subs. filename needs to be static storage, as it is used directly as CvFILE(), without a copy being made.

Perl サブルーチンのように XSUB をフックするために xsubpp が使います。 filename は静的なストレージである必要があります; なぜならこれはコピーされることなく直接 CvFILE() で使われるからです。

パッドデータ構造体¶

pad_sv

Get the value at offset po in the current pad. Use macro PAD_SV instead of calling this function directly.

現在のパッドのオフセット po の値を返します。 この関数を直接呼び出さずにマクロ PAD_SV を使ってください。

        SV*     pad_sv(PADOFFSET po)

インタプリタ単位変数¶

PL_modglobal

PL_modglobal is a general purpose, interpreter global HV for use by extensions that need to keep information on a per-interpreter basis. In a pinch, it can also be used as a symbol table for extensions to share data among each other. It is a good idea to use keys prefixed by the package name of the extension that owns the data.

PL_modglobal は、汎用の、インタプリタグローバルの HV で、 インタプリタ毎の情報を保持するような エクステンションによって使われるものです。 場合によっては、データの共有をおこなうために エクステンションのシンボルテーブルとして使うことも可能です。 エクステンションのパッケージ名を、エクステンション固有のデータの名前の 接頭辞として使うのは良い考えです。

        HV*     PL_modglobal

PL_na

A convenience variable which is typically used with SvPV when one doesn't care about the length of the string. It is usually more efficient to either declare a local variable and use that instead or to use the SvPV_nolen macro.

文字列の長さについて考慮しないような場合の SvPV と共に使われるような 変数です。 通常はローカル変数を宣言してそれを使うか、 SvPV_nolen マクロを使った方が効率が良いです。

        STRLEN  PL_na

PL_sv_no

This is the false SV. See PL_sv_yes. Always refer to this as &PL_sv_no.

これは false の SV です。 PL_sv_yes を参照してください。 常に &PL_sv_no として参照してください。

        SV      PL_sv_no

PL_sv_undef

This is the undef SV. Always refer to this as &PL_sv_undef.

これは undef SV です。 常に &PL_sv_undef として参照してください。

        SV      PL_sv_undef

PL_sv_yes

This is the true SV. See PL_sv_no. Always refer to this as &PL_sv_yes.

これは true SV です。 PL_sv_no を参照してくさい。 これは常に &PL_sv_yes として参照してください。

        SV      PL_sv_yes

正規表現関数¶

SvRX

Convenience macro to get the REGEXP from a SV. This is approximately equivalent to the following snippet:

SV から REGEXP を得るための便利なマクロです。 これはほぼ以下のコード片と等価です:

    if (SvMAGICAL(sv))
        mg_get(sv);
    if (SvROK(sv) &&
        (tmpsv = (SV*)SvRV(sv)) &&
        SvTYPE(tmpsv) == SVt_PVMG &&
        (tmpmg = mg_find(tmpsv, PERL_MAGIC_qr)))
    {
        return (REGEXP *)tmpmg->mg_obj;
    }

NULL will be returned if a REGEXP* is not found.

もし REGEXP* が見つからなければ NULL を返します。

        REGEXP *        SvRX(SV *sv)

SvRXOK

Returns a boolean indicating whether the SV contains qr magic (PERL_MAGIC_qr).

SV が qr magic (PERL_MAGIC_qr) を含んでいるかどうかを示す真偽値を返します。

If you want to do something with the REGEXP* later use SvRX instead and check for NULL.

後で REGEXP* で何かをしたいなら、代わりに SvRX を使って、NULL を チェックしてください。

        bool    SvRXOK(SV* sv)

単純な例外処理マクロ¶

dXCPT

Set up necessary local variables for exception handling. See "Exception Handling" in perlguts.

例外処理のために必要なローカル変数を設定します。 "Exception Handling" in perlguts を参照してください。

                dXCPT;

XCPT_CATCH

Introduces a catch block. See "Exception Handling" in perlguts.

catch ブロックを導入します。 "Exception Handling" in perlguts を参照してください。

XCPT_RETHROW

Rethrows a previously caught exception. See "Exception Handling" in perlguts.

以前に捕捉した例外を再 throw します。 "Exception Handling" in perlguts を参照してください。

                XCPT_RETHROW;

XCPT_TRY_END

Ends a try block. See "Exception Handling" in perlguts.

try ブロックを終了します。 "Exception Handling" in perlguts を参照してください。

XCPT_TRY_START

Starts a try block. See "Exception Handling" in perlguts.

try ブロックを開始します。 "Exception Handling" in perlguts を参照してください。

スタック操作マクロ¶

dMARK

Declare a stack marker variable, mark, for the XSUB. See MARK and dORIGMARK.

スタックマーカー変数 mark を XSUB のために宣言します。 MARK と dORIGMARK を参照してください。

                dMARK;

dORIGMARK

Saves the original stack mark for the XSUB. See ORIGMARK.

XSUB のためのオリジナルのスタックマークを保存します。 ORIGMARK を参照してください。

                dORIGMARK;

dSP

Declares a local copy of perl's stack pointer for the XSUB, available via the SP macro. See SP.

マクロ SP を使ってアクセス可能な XSUB のためのスタックポインタのローカルな コピーを宣言します。 SP を参照してください。

                dSP;

EXTEND

Used to extend the argument stack for an XSUB's return values. Once used, guarantees that there is room for at least nitems to be pushed onto the stack.

XSUB の戻り値のために引数スタックを拡張するのに使われます。 一度使うと、少なくとも nitems をスタックにプッシュするだけの空きが 出来ます。

        void    EXTEND(SP, int nitems)

MARK

Stack marker variable for the XSUB. See dMARK.

XSUB に対するスタックマーカーの変数です。 dMARK を参照してください。

mPUSHi

Push an integer onto the stack. The stack must have room for this element. Does not use TARG. See also PUSHi, mXPUSHi and XPUSHi.

整数をスタックにプッシュします。 スタックにはこの要素を収めるだけの空きがなければなりません。 TARG を使いません。 PUSHi, mXPUSHi, XPUSHi も参照してください。

        void    mPUSHi(IV iv)

mPUSHn

Push a double onto the stack. The stack must have room for this element. Does not use TARG. See also PUSHn, mXPUSHn and XPUSHn.

倍精度実数をスタックにプッシュします。 スタックにはこの要素を収めるだけの空きがなければなりません。 'set' magic をハンドルします。 TARG を使いません。 PUSHn, mXPUSHn, XPUSHn も参照してください。

        void    mPUSHn(NV nv)

mPUSHp

Push a string onto the stack. The stack must have room for this element. The len indicates the length of the string. Does not use TARG. See also PUSHp, mXPUSHp and XPUSHp.

文字列をスタックにプッシュします。 スタックにはこの要素を収めるだけの空きがなければなりません。 len は文字列の長さを示します。 TARG を使いません。 PUSHp, mXPUSHp, XPUSHp も参照してください。

        void    mPUSHp(char* str, STRLEN len)

mPUSHs

Push an SV onto the stack and mortalizes the SV. The stack must have room for this element. Does not use TARG. See also PUSHs and mXPUSHs.

SV をスタックにプッシュして SV を揮発化します。 スタックはこの要素を納めるだけの空きがなければなりません。 TARG を使いません。 PUSHs と mXPUSHs も参照してください。

        void    mPUSHs(SV* sv)

mPUSHu

Push an unsigned integer onto the stack. The stack must have room for this element. Does not use TARG. See also PUSHu, mXPUSHu and XPUSHu.

符号なし整数をスタックにプッシュします。 スタックにはこの要素を収めるだけの空きがなければなりません。 TARG を使いません。 PUSHu, mXPUSHu, XPUSHu も参照してください。

        void    mPUSHu(UV uv)

mXPUSHi

Push an integer onto the stack, extending the stack if necessary. Does not use TARG. See also XPUSHi, mPUSHi and PUSHi.

整数をスタックにプッシュし、必要があればスタックを拡張します。 TARG を使いません。 XPUSHi, mPUSHi, PUSHi も参照してください。

        void    mXPUSHi(IV iv)

mXPUSHn

Push a double onto the stack, extending the stack if necessary. Does not use TARG. See also XPUSHn, mPUSHn and PUSHn.

倍精度数値をスタックにプッシュし、必要があればスタックを拡張します。 TARG を使いません。 XPUSHn, mPUSHn, PUSHn も参照してください。

        void    mXPUSHn(NV nv)

mXPUSHp

Push a string onto the stack, extending the stack if necessary. The len indicates the length of the string. Does not use TARG. See also XPUSHp, mPUSHp and PUSHp.

文字列をスタックにプッシュし、必要があればスタックを拡張します。 len は文字列の長さを示します。 TARG を使いません。 XPUSHp, mPUSHp, PUSHp も参照してください。

        void    mXPUSHp(char* str, STRLEN len)

mXPUSHs

Push an SV onto the stack, extending the stack if necessary and mortalizes the SV. Does not use TARG. See also XPUSHs and mPUSHs.

必要があればスタックを拡張し、SV をスタックにプッシュして、SV を 揮発化します。 TARG を使いません。 XPUSHs と mPUSHs も参照してください。

        void    mXPUSHs(SV* sv)

mXPUSHu

Push an unsigned integer onto the stack, extending the stack if necessary. Does not use TARG. See also XPUSHu, mPUSHu and PUSHu.

符号なし整数をスタックにプッシュし、必要があればスタックを拡張します。 'set' magic をハンドルします。 TARG を使いません。 XPUSHu, mPUSHu, PUSHu も参照してください。

        void    mXPUSHu(UV uv)

ORIGMARK

The original stack mark for the XSUB. See dORIGMARK.

XSUB のためのオリジナルスタックマークです。 dORIGMARK を参照してください。

POPi

Pops an integer off the stack.

スタックから整数をポップします。

        IV      POPi

POPl

Pops a long off the stack.

スタックから long をポップします。

        long    POPl

POPn

Pops a double off the stack.

スタックから倍精度実数をポップします。

        NV      POPn

POPp

Pops a string off the stack. Deprecated. New code should use POPpx.

スタックから文字列をポップします。 廃止予定です。 新しいコードは POPpx を使うべきです。

        char*   POPp

POPpbytex

Pops a string off the stack which must consist of bytes i.e. characters < 256.

バイト列で構成されていなければならない(つまり文字 < 256 な)文字列を スタックからポップします。

        char*   POPpbytex

POPpx

Pops a string off the stack.

スタックから文字列をポップします。

        char*   POPpx

POPs

Pops an SV off the stack.

スタックから SV をポップします。

        SV*     POPs

PUSHi

Push an integer onto the stack. The stack must have room for this element. Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be called to declare it. Do not call multiple TARG-oriented macros to return lists from XSUB's - see mPUSHi instead. See also XPUSHi and mXPUSHi.

整数をスタックにプッシュします。 スタックにはこの要素を収めるだけの空きがなければなりません。 'set' magic をハンドルします。 TARG を使うので、これを宣言するために dTARGET または dXSTARG が 呼び出されるべきです。 XSUB からリストを返すために複数回 TARG 指向のマクロを 呼び出さないでください - 代わりに mPUSHi を参照してください。 XPUSHi と mXPUSHi も参照してください。

        void    PUSHi(IV iv)

PUSHMARK

Opening bracket for arguments on a callback. See PUTBACK and perlcall.

コールバックにある引数のためのブラケットを開きます。 PUTBACK と perlcall を参照してください。

        void    PUSHMARK(SP)

PUSHmortal

Push a new mortal SV onto the stack. The stack must have room for this element. Does not use TARG. See also PUSHs, XPUSHmortal and XPUSHs.

新しい揮発性の SV をスタックにプッシュします。 スタックにはこの要素を収めるだけの空きがなければなりません。 TARG を使いません。 PUSHs, XPUSHmortal, XPUSHs も参照してください。

        void    PUSHmortal()

PUSHn

Push a double onto the stack. The stack must have room for this element. Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be called to declare it. Do not call multiple TARG-oriented macros to return lists from XSUB's - see mPUSHn instead. See also XPUSHn and mXPUSHn.

倍精度実数をスタックにプッシュします。 スタックにはこの要素を収めるだけの空きがなければなりません。 'set' magic をハンドルします。 TARG を使うので、これを宣言するために dTARGET または dXSTARG が 呼び出されるべきです。 XSUB からリストを返すために複数回 TARG 指向のマクロを 呼び出さないでください - 代わりに mPUSHn を参照してください。 XPUSHn と mXPUSHn も参照してください。

        void    PUSHn(NV nv)

PUSHp

Push a string onto the stack. The stack must have room for this element. The len indicates the length of the string. Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be called to declare it. Do not call multiple TARG-oriented macros to return lists from XSUB's - see mPUSHp instead. See also XPUSHp and mXPUSHp.

文字列をスタックにプッシュします。 スタックにはこの要素を収めるだけの空きがなければなりません。 len は文字列の長さを示します。 'set' magic をハンドルします。 TARG を使うので、これを宣言するために dTARGET または dXSTARG が 呼び出されるべきです。 XSUB からリストを返すために複数回 TARG 指向のマクロを 呼び出さないでください - 代わりに mPUSHp を参照してください。 XPUSHp と mXPUSHp も参照してください。

        void    PUSHp(char* str, STRLEN len)

PUSHs

Push an SV onto the stack. The stack must have room for this element. Does not handle 'set' magic. Does not use TARG. See also PUSHmortal, XPUSHs and XPUSHmortal.

SV をスタックへプッシュします。 スタックにはこの要素を収めるだけの空きがなければなりません。 'set' magic をハンドルしません。 TARG を使いません。 PUSHmortal, XPUSHs, XPUSHmortal も参照してください。

        void    PUSHs(SV* sv)

PUSHu

Push an unsigned integer onto the stack. The stack must have room for this element. Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be called to declare it. Do not call multiple TARG-oriented macros to return lists from XSUB's - see mPUSHu instead. See also XPUSHu and mXPUSHu.

符号なし整数をスタックにプッシュします。 スタックにはこの要素を収めるだけの空きがなければなりません。 'set' magic をハンドルします。 TARG を使うので、これを宣言するために dTARGET または dXSTARG が 呼び出されるべきです。 XSUB からリストを返すために複数回 TARG 指向のマクロを 呼び出さないでください - 代わりに mPUSHu を参照してください。 XPUSHu と mXPUSHu も参照してください。

        void    PUSHu(UV uv)

PUTBACK

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

XSUB 引数のためのブラケットを閉じます。 これは通常、xsubpp によって扱われます。 他の使い方については PUSHMARKと perlcall を参照してください。

                PUTBACK;

SP

Stack pointer. This is usually handled by xsubpp. See dSP and SPAGAIN.

スタックポインタです。 これは通常、xsubpp によって扱われます。 dSP と SPAGAIN を参照してください。

SPAGAIN

Refetch the stack pointer. Used after a callback. See perlcall.

スタックポインタの再フェッチします。 コールバックの後で使われます。 perlcall を参照してください。

                SPAGAIN;

XPUSHi

Push an integer onto the stack, extending the stack if necessary. Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be called to declare it. Do not call multiple TARG-oriented macros to return lists from XSUB's - see mXPUSHi instead. See also PUSHi and mPUSHi.

整数をスタックにプッシュし、必要があればスタックを拡張します。 'set' magic をハンドルします。 TARG を使うので、これを宣言するために dTARGET または dXSTARG が 呼び出されるべきです。 XSUB からリストを返すために複数回 TARG 指向のマクロを 呼び出さないでください - 代わりに mXPUSHi を参照してください。 PUSHi と mPUSHi も参照してください。

        void    XPUSHi(IV iv)

XPUSHmortal

Push a new mortal SV onto the stack, extending the stack if necessary. Does not use TARG. See also XPUSHs, PUSHmortal and PUSHs.

必要ならスタックを拡張して、新しく揮発性の SV をスタックにプッシュします。 TARG を使いません。 XPUSHs, PUSHmortal, PUSHs も参照してください。

        void    XPUSHmortal()

XPUSHn

Push a double onto the stack, extending the stack if necessary. Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be called to declare it. Do not call multiple TARG-oriented macros to return lists from XSUB's - see mXPUSHn instead. See also PUSHn and mPUSHn.

倍精度数値をスタックにプッシュし、必要があればスタックを拡張します。 'set' magic をハンドルします。 TARG を使うので、これを宣言するために dTARGET または dXSTARG が 呼び出されるべきです。 XSUB からリストを返すために複数回 TARG 指向のマクロを 呼び出さないでください - 代わりに mXPUSHn を参照してください。 PUSHn と mPUSHn も参照してください。

        void    XPUSHn(NV nv)

XPUSHp

Push a string onto the stack, extending the stack if necessary. The len indicates the length of the string. Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be called to declare it. Do not call multiple TARG-oriented macros to return lists from XSUB's - see mXPUSHp instead. See also PUSHp and mPUSHp.

文字列をスタックにプッシュし、必要があればスタックを拡張します。 len は文字列の長さを示します。 'set' magic をハンドルします。 TARG を使うので、これを宣言するために dTARGET または dXSTARG が 呼び出されるべきです。 XSUB からリストを返すために複数回 TARG 指向のマクロを 呼び出さないでください - 代わりに mXPUSHp を参照してください。 PUSHp と mPUSHp も参照してください。

        void    XPUSHp(char* str, STRLEN len)

XPUSHs

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

SV をスタックにプッシュし、必要があればスタックを拡張します。 'set' magic をハンドルしません。 TARG を使いません。 XPUSHmortal, PUSHs, PUSHmortal も参照してください。

        void    XPUSHs(SV* sv)

XPUSHu

Push an unsigned integer onto the stack, extending the stack if necessary. Handles 'set' magic. Uses TARG, so dTARGET or dXSTARG should be called to declare it. Do not call multiple TARG-oriented macros to return lists from XSUB's - see mXPUSHu instead. See also PUSHu and mPUSHu.

符号なし整数をスタックにプッシュし、必要があればスタックを拡張します。 'set' magic をハンドルします。 TARG を使うので、これを宣言するために dTARGET または dXSTARG が 呼び出されるべきです。 XSUB からリストを返すために複数回 TARG 指向のマクロを 呼び出さないでください - 代わりに mXPUSHu を参照してください。 PUSHu と mPUSHu も参照してください。

        void    XPUSHu(UV uv)

XSRETURN

Return from XSUB, indicating number of items on the stack. This is usually handled by xsubpp.

XSUB から戻され、スタックにあるアイテムの数を示します。 これは通常、xsubpp によって扱われます。

        void    XSRETURN(int nitems)

XSRETURN_EMPTY

Return an empty list from an XSUB immediately.

XSUB から即座に空リストを返します。

                XSRETURN_EMPTY;

XSRETURN_IV

Return an integer from an XSUB immediately. Uses XST_mIV.

XSUB から即座に整数を返します。 XST_mIV を使います。

        void    XSRETURN_IV(IV iv)

XSRETURN_NO

Return &PL_sv_no from an XSUB immediately. Uses XST_mNO.

XSUB から即座に &PL_sv_no を返します。 XST_mNO を使います。

                XSRETURN_NO;

XSRETURN_NV

Return a double from an XSUB immediately. Uses XST_mNV.

XSUB から即座に倍精度数値を返します。 XST_mNV を使います。

        void    XSRETURN_NV(NV nv)

XSRETURN_PV

Return a copy of a string from an XSUB immediately. Uses XST_mPV.

XSUB から即座に文字列のコピーを返します。 XST_mPV を使います。

        void    XSRETURN_PV(char* str)

XSRETURN_UNDEF

Return &PL_sv_undef from an XSUB immediately. Uses XST_mUNDEF.

XSUB から即座に &PL_sv_undef を返します。 XST_mUNDEF を使います。

                XSRETURN_UNDEF;

XSRETURN_UV

Return an integer from an XSUB immediately. Uses XST_mUV.

XSUB から即座に整数を返します。 XST_mUV を使います。

        void    XSRETURN_UV(IV uv)

XSRETURN_YES

Return &PL_sv_yes from an XSUB immediately. Uses XST_mYES.

XSUB から即座に &PL_sv_yes を返します。 XST_mYES を使います。

                XSRETURN_YES;

XST_mIV

Place an integer into the specified position pos on the stack. The value is stored in a new mortal SV.

整数値をスタックの pos で指定される場所に置きます。 その値は新しい揮発性 SV (mortal SV) に格納されます。

        void    XST_mIV(int pos, IV iv)

XST_mNO

Place &PL_sv_no into the specified position pos on the stack.

&PL_sv_no をスタックの pos で指定される場所に置きます。

        void    XST_mNO(int pos)

XST_mNV

Place a double into the specified position pos on the stack. The value is stored in a new mortal SV.

倍精度数値をスタックの pos で指定される場所に置きます。 その値は新しい揮発性 SV (mortal SV) に格納されます。

        void    XST_mNV(int pos, NV nv)

XST_mPV

Place a copy of a string into the specified position pos on the stack. The value is stored in a new mortal SV.

文字列のコピーをスタックの pos で指定される場所に置きます。 その値は新しい揮発性 SV (mortal SV) に格納されます。

        void    XST_mPV(int pos, char* str)

XST_mUNDEF

Place &PL_sv_undef into the specified position pos on the stack.

&PL_sv_undef をスタックの pos で指定される場所に置きます。

        void    XST_mUNDEF(int pos)

XST_mYES

Place &PL_sv_yes into the specified position pos on the stack.

&PL_sv_yes をスタックの pos で指定される場所に置きます。

        void    XST_mYES(int pos)

SV フラグ¶

svtype

An enum of flags for Perl types. These are found in the file sv.h in the svtype enum. Test these flags with the SvTYPE macro.

Perl の型のためのフラグの列挙です。 sv.h というファイル中の svtype という列挙にあります。 これらのフラグは、SvTYPE というマクロを使って検査を行います。

SVt_IV

Integer type flag for scalars. See svtype.

スカラに対する整数型。 svtype を参照してください。

SVt_NV

Double type flag for scalars. See svtype.

スカラに対する倍精度の型フラグ。 svtype を参照してください。

SVt_PV

Pointer type flag for scalars. See svtype.

スカラに対するポインタ型。 svtype を参照してください。

SVt_PVAV

Type flag for arrays. See svtype.

配列に対する型フラグ。 svtype を参照してください。

SVt_PVCV

Type flag for code refs. See svtype.

コードリファレンスのための型フラグ。 svtype を参照してください。

SVt_PVHV

Type flag for hashes. See svtype.

ハッシュに対する型フラグ。 svtype を参照してください。

SVt_PVMG

Type flag for blessed scalars. See svtype.

blessされたスカラに対する型フラグ。 svtype を参照してください。

SV 操作関数¶

croak_xs_usage

A specialised variant of croak() for emitting the usage message for xsubs

xsubs のための使用法メッセージを出力するために専門化された croak()

    croak_xs_usage(cv, "eee_yow");

works out the package name and subroutine name from cv, and then calls croak(). Hence if cv is &ouch::awk, it would call croak as:

cv からパッケージ名とサブルーチン名を取り出して、croak() を 呼び出します。 従って cv が &ouch::awk なら、croak を以下のようにして呼び出します:

    Perl_croak(aTHX_ "Usage %s::%s(%s)", "ouch" "awk", "eee_yow");

        void    croak_xs_usage(const CV *const cv, const char *const params)

get_sv

Returns the SV of the specified Perl scalar. flags are passed to gv_fetchpv. If GV_ADD is set and the Perl variable does not exist then it will be created. If flags is zero and the variable does not exist then NULL is returned.

指定された Perl スカラの SV を返します。 flags は gv_fetchpv に渡されます。 GV_ADD がセットされていて、指定された変数が存在していなければ、新たに 生成されます。 flags がゼロで、かつ、指定された変数がなかった場合には NULL が返されます。

NOTE: the perl_ form of this function is deprecated.

注意: この関数の perl_ の形は廃止予定です。

        SV*     get_sv(const char *name, I32 flags)

newRV_inc

Creates an RV wrapper for an SV. The reference count for the original SV is incremented.

SV に対する RV ラッパーを生成します。 元の SV の参照カウントはインクリメントされます。

        SV*     newRV_inc(SV* sv)

newSVpvn_utf8

Creates a new SV and copies a string into it. If utf8 is true, calls SvUTF8_on on the new SV. Implemented as a wrapper around newSVpvn_flags.

新しい SV を作成して文字列をこれにコピーします。 utf8 が真なら、新しい SV に対して SvUTF8_on を呼び出します。 newSVpvn_flags へのラッパとして実装されています。

        SV*     newSVpvn_utf8(NULLOK const char* s, STRLEN len, U32 utf8)

SvCUR

Returns the length of the string which is in the SV. See SvLEN.

SV にある文字列の長さを返します。 SvLEN を参照してください。

        STRLEN  SvCUR(SV* sv)

SvCUR_set

Set the current length of the string which is in the SV. See SvCUR and SvIV_set.

SV にある文字列の現在の長さを設定します。 SvCUR を参照してください。

        void    SvCUR_set(SV* sv, STRLEN len)

SvEND

Returns a pointer to the last character in the string which is in the SV. See SvCUR. Access the character as *(SvEND(sv)).

SV にある文字列の終端のキャラクタへのポインタを返します。 SvCUR を参照してください。 文字へは *(SvEND(sv)) としてアクセスします。

        char*   SvEND(SV* sv)

SvGAMAGIC

Returns true if the SV has get magic or overloading. If either is true then the scalar is active data, and has the potential to return a new value every time it is accessed. Hence you must be careful to only read it once per user logical operation and work with that returned value. If neither is true then the scalar's value cannot change unless written to.

SV が get magic かオーバーロードであれば真を返します。 どちらかが真なら、スカラはアクティブなデータで、アクセスされる度に新しい値を 返す可能性があります。 従って、ユーザーの論理的な操作につき一回だけ読み込んで、返された値に対して 作業をするように注意しなければなりません。 どちらも真でなければ、書き込まれるまでスカラの値は変更できません。

        U32     SvGAMAGIC(SV* sv)

SvGROW

Expands the character buffer in the SV so that it has room for the indicated number of bytes (remember to reserve space for an extra trailing NUL character). Calls sv_grow to perform the expansion if necessary. Returns a pointer to the character buffer.

指定されたバイト数だけの空間があるように SV にある文字バッファを拡張します (予約分の空間は NUL 文字で埋められることを思い出してください)。 必要であれば、拡張のために sv_grow を呼び出します。 文字バッファへのポインタを返します。

        char *  SvGROW(SV* sv, STRLEN len)

SvIOK

Returns a U32 value indicating whether the SV contains an integer.

SV が整数を含んでいるかどうかを表わす U32 値を返します。

        U32     SvIOK(SV* sv)

SvIOKp

Returns a U32 value indicating whether the SV contains an integer. Checks the private setting. Use SvIOK instead.

SV が整数を含んでいるかどうかを表わす U32 値を返します。 private な設定を検査します。 代わりに SvIOK を使ってください。

        U32     SvIOKp(SV* sv)

SvIOK_notUV

Returns a boolean indicating whether the SV contains a signed integer.

SV が符号付き整数を含んでいるかどうかを示す真偽値を返します。

        bool    SvIOK_notUV(SV* sv)

SvIOK_off

Unsets the IV status of an SV.

SV の IV ステータスをアンセットします。

        void    SvIOK_off(SV* sv)

SvIOK_on

Tells an SV that it is an integer.

SV に対し、その SV が整数であるように指示します。

        void    SvIOK_on(SV* sv)

SvIOK_only

Tells an SV that it is an integer and disables all other OK bits.

SV に対し、その SV が整数であり、他の OK ビットをすべてディセーブルに するように指示します。

        void    SvIOK_only(SV* sv)

SvIOK_only_UV

Tells and SV that it is an unsigned integer and disables all other OK bits.

SV に対し、その SV が符号なし整数であり、他の OK ビットをすべてディセーブルに するように指示します。

        void    SvIOK_only_UV(SV* sv)

SvIOK_UV

Returns a boolean indicating whether the SV contains an unsigned integer.

SV が符号なし整数を含んでいるかどうかを示す真偽値を返します。

        bool    SvIOK_UV(SV* sv)

SvIsCOW

Returns a boolean indicating whether the SV is Copy-On-Write. (either shared hash key scalars, or full Copy On Write scalars if 5.9.0 is configured for COW)

SV がコピーオンライトかどうかを示す真偽値を返します。 (共有ハッシュキースカラか、5.9.0 がコピーオンライト用に設定されていれば 完全なコピーオンライトスカラのどちらかです)

        bool    SvIsCOW(SV* sv)

SvIsCOW_shared_hash

Returns a boolean indicating whether the SV is Copy-On-Write shared hash key scalar.

SV が Copy-On-Write 共有ハッシュキースカラかどうかを示す真偽値を返します。

        bool    SvIsCOW_shared_hash(SV* sv)

SvIV

Coerces the given SV to an integer and returns it. See SvIVx for a version which guarantees to evaluate sv only once.

SV を強制的に整数に変換し、それを返します。 sv を一度だけ評価することが保証されているバージョンについては SvIVx を 参照してください。

        IV      SvIV(SV* sv)

SvIVX

Returns the raw value in the SV's IV slot, without checks or conversions. Only use when you are sure SvIOK is true. See also SvIV().

SV の IV スロットの生の値を、チェックや変換なしに返します。 SvIOK が真であることを確認した後にのみ使えます。 SvIV() も参照してください。

        IV      SvIVX(SV* sv)

SvIVx

Coerces the given SV to an integer and returns it. Guarantees to evaluate sv only once. Only use this if sv is an expression with side effects, otherwise use the more efficient SvIV.

SV を強制的に整数に変換し、それを返します。 sv を一度だけ評価することを保証します。 sv が副作用のある式の時にのみこれを使ってください; さもなければより 効率的な SvIV を使ってください。

        IV      SvIVx(SV* sv)

SvIV_nomg

Like SvIV but doesn't process magic.

SvIV と同様ですが、magic を処理しません。

        IV      SvIV_nomg(SV* sv)

SvIV_set

Set the value of the IV pointer in sv to val. It is possible to perform the same function of this macro with an lvalue assignment to SvIVX. With future Perls, however, it will be more efficient to use SvIV_set instead of the lvalue assignment to SvIVX.

sv の IV ポインタの値を val にセットします。 SvIVX への左辺値代入によってこのマクロと同じ機能を行うことが可能です。 しかし、将来の Perl では、SvIVX への左辺値代入の代わりに、SvIV_set を 使う方がより効率的になります。

        void    SvIV_set(SV* sv, IV val)

SvLEN

Returns the size of the string buffer in the SV, not including any part attributable to SvOOK. See SvCUR.

(SvOOK に起因する部分を含まない)SV にある文字列バッファのサイズを返します。 SvCUR を参照してください。

        STRLEN  SvLEN(SV* sv)

SvLEN_set

Set the actual length of the string which is in the SV. See SvIV_set.

SV に含まれている文字列の実際の長さを設定します。 SvIV_set を参照してください。

        void    SvLEN_set(SV* sv, STRLEN len)

SvMAGIC_set

Set the value of the MAGIC pointer in sv to val. See SvIV_set.

sv の MAGIC ポインタの値を val にセットします。 SvIV_set を参照してください。

        void    SvMAGIC_set(SV* sv, MAGIC* val)

SvNIOK

Returns a U32 value indicating whether the SV contains a number, integer or double.

SV が数値、つまり整数値か倍精度実数値を含んでいるかどうかを表わす U32 値を返します。

        U32     SvNIOK(SV* sv)

SvNIOKp

Returns a U32 value indicating whether the SV contains a number, integer or double. Checks the private setting. Use SvNIOK instead.

SV が数値、つまり整数値か倍精度実数値を含んでいるかどうかを表わす U32 値を返します。 private な設定を検査します。 代わりに SvNIOK を使ってください。

        U32     SvNIOKp(SV* sv)

SvNIOK_off

Unsets the NV/IV status of an SV.

SV の NT/IV ステータスをアンセットします。

        void    SvNIOK_off(SV* sv)

SvNOK

Returns a U32 value indicating whether the SV contains a double.

SV が倍精度実数値を含んでいるかどうかを示す U32 値を返します。

        U32     SvNOK(SV* sv)

SvNOKp

Returns a U32 value indicating whether the SV contains a double. Checks the private setting. Use SvNOK instead.

SV が倍精度実数値を含んでいるかどうかを示す U32 値を返します。 private な設定を検査します。 代わりに SvNOK を使ってください。

        U32     SvNOKp(SV* sv)

SvNOK_off

Unsets the NV status of an SV.

SV にある NT ステータスをアンセットします。

        void    SvNOK_off(SV* sv)

SvNOK_on

Tells an SV that it is a double.

SV に対して、自分が倍精度実数であることを指示します。

        void    SvNOK_on(SV* sv)

SvNOK_only

Tells an SV that it is a double and disables all other OK bits.

SV に対し、その SV が倍精度実数であり、その他の OK フラグをディセーブルに するよう指示します。

        void    SvNOK_only(SV* sv)

SvNV

Coerce the given SV to a double and return it. See SvNVx for a version which guarantees to evaluate sv only once.

SV を強制的に倍精度数値に変換し、それを返します。 sv を一度しか評価されないことが保証されているバージョンについては SvNVx を参照してください。

        NV      SvNV(SV* sv)

SvNVX

Returns the raw value in the SV's NV slot, without checks or conversions. Only use when you are sure SvNOK is true. See also SvNV().

SV の NV スロットの生の値を、チェックや変換なしに返します。 SvNOK が真であると分かっているときにだけ使ってください。 SvNV() も参照してください。

        NV      SvNVX(SV* sv)

SvNVx

Coerces the given SV to a double and returns it. Guarantees to evaluate sv only once. Only use this if sv is an expression with side effects, otherwise use the more efficient SvNV.

SV を強制的に倍精度数値に変換し、それを返します。 sv を一度だけ評価することを保証します。 sv が副作用のある式の時にのみこれを使ってください; さもなければ より効率的な SvNV を使ってください。

        NV      SvNVx(SV* sv)

SvNV_set

Set the value of the NV pointer in sv to val. See SvIV_set.

sv の NV ポインタの値を val にセットします。 SvIV_set を参照してください。

        void    SvNV_set(SV* sv, NV val)

SvOK

Returns a U32 value indicating whether the value is defined. This is only meaningful for scalars.

値が定義されているかどうかを示す U32 値を返します。 これはスカラでのみ意味があります。

        U32     SvOK(SV* sv)

SvOOK

Returns a U32 indicating whether the SvIVX is a valid offset value for the SvPVX. This hack is used internally to speed up removal of characters from the beginning of a SvPV. When SvOOK is true, then the start of the allocated string buffer is really (SvPVX - SvIVX).

SvIVX が SvPVX に対する正しいオフセット値であるかどうかを示す U32 値を 返します。 この hack は SvPV の先頭から文字を取り除くスピードを向上するために内部的に 使われます。 SvOOK が真であるとき、割り当てられた文字列バッファの開始点は (SvPVX - SvIVX)となります。

        U32     SvOOK(SV* sv)

SvPOK

Returns a U32 value indicating whether the SV contains a character string.

SV が文字文字列を保持しているかどうかの U32 値を返します。

        U32     SvPOK(SV* sv)

SvPOKp

Returns a U32 value indicating whether the SV contains a character string. Checks the private setting. Use SvPOK instead.

SV が文字文字列を保持しているかどうかの U32 値を返します。 private な設定を検査します。 代わりに SvPOK を使ってください。

        U32     SvPOKp(SV* sv)

SvPOK_off

Unsets the PV status of an SV.

SV の PV ステータスをアンセットします。

        void    SvPOK_off(SV* sv)

SvPOK_on

Tells an SV that it is a string.

SV に対して、自分が文字列であることを指示します。

        void    SvPOK_on(SV* sv)

SvPOK_only

Tells an SV that it is a string and disables all other OK bits. Will also turn off the UTF-8 status.

SV に対し、その SV が文字列であり、他の OK ビットをすべてディセーブルに するように指示します。 また、UTF-8 ステータスをオフにします。

        void    SvPOK_only(SV* sv)

SvPOK_only_UTF8

Tells an SV that it is a string and disables all other OK bits, and leaves the UTF-8 status as it was.

SV に対し、その SV が文字列であり、他の OK ビットをディセーブルに して、UTF-8 ステータスがそのままにするように指示します。

        void    SvPOK_only_UTF8(SV* sv)

SvPV

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 version becoming SvPOK. Handles 'get' magic. See also SvPVx for a version which guarantees to evaluate sv only once.

SV にある文字列へのポインタか、SVが文字列を保持していない場合には SV の文字列化形式を返します。 SV は SvPOK になった文字列化バージョンをキャッシュするかもしれません。 'get' magic をハンドルします。 sv が一度しか評価されないことが保証されているバージョンについては SvPVx も参照してください。

        char*   SvPV(SV* sv, STRLEN len)

SvPVbyte

Like SvPV, but converts sv to byte representation first if necessary.

SvPV と同様ですが、もし必要ならまず sv をバイト表現に変換します。

        char*   SvPVbyte(SV* sv, STRLEN len)

SvPVbytex

Like SvPV, but converts sv to byte representation first if necessary. Guarantees to evaluate sv only once; use the more efficient SvPVbyte otherwise.

SvPV と同様ですが、もし必要ならまず sv をバイト表現に変換します。 sv を 1 度だけ評価することを保証します; さもなければより効率のよい SvPVbyte を使ってください。

        char*   SvPVbytex(SV* sv, STRLEN len)

SvPVbytex_force

Like SvPV_force, but converts sv to byte representation first if necessary. Guarantees to evaluate sv only once; use the more efficient SvPVbyte_force otherwise.

SvPV_force と同様ですが、もし必要ならまず sv をバイト表現に変換します。 sv を 1 度だけ評価することを保証します; さもなければより効率のよい SvPVbyte_force を使ってください。

        char*   SvPVbytex_force(SV* sv, STRLEN len)

SvPVbyte_force

Like SvPV_force, but converts sv to byte representation first if necessary.

SvPV_force と同様ですが、もし必要ならまず sv をバイト表現に変換します。

        char*   SvPVbyte_force(SV* sv, STRLEN len)

SvPVbyte_nolen

Like SvPV_nolen, but converts sv to byte representation first if necessary.

SvPV_nolen と同様ですが、もし必要ならまず sv をバイト表現に変換します。

        char*   SvPVbyte_nolen(SV* sv)

SvPVutf8

Like SvPV, but converts sv to utf8 first if necessary.

SvPV と同様ですが、もし必要ならまず sv を utf8 に変換します。

        char*   SvPVutf8(SV* sv, STRLEN len)

SvPVutf8x

Like SvPV, but converts sv to utf8 first if necessary. Guarantees to evaluate sv only once; use the more efficient SvPVutf8 otherwise.

SvPV と同様ですが、もし必要ならまず sv を utf8 に変換します。 sv を 1 度だけ評価することを保証します; さもなければより効率のよい SvPVutf8 を使ってください。

        char*   SvPVutf8x(SV* sv, STRLEN len)

SvPVutf8x_force

Like SvPV_force, but converts sv to utf8 first if necessary. Guarantees to evaluate sv only once; use the more efficient SvPVutf8_force otherwise.

SvPV_force と同様ですが、もし必要ならまず sv を utf8 に変換します。 sv を 1 度だけ評価することを保証します; さもなければより効率のよい SvPVutf8_force を使ってください。

        char*   SvPVutf8x_force(SV* sv, STRLEN len)

SvPVutf8_force

Like SvPV_force, but converts sv to utf8 first if necessary.

SvPV_force と同様ですが、もし必要ならまず sv を utf8 に変換します。

        char*   SvPVutf8_force(SV* sv, STRLEN len)

SvPVutf8_nolen

Like SvPV_nolen, but converts sv to utf8 first if necessary.

SvPV_nolen と同様ですが、もし必要ならまず sv を utf8 に変換します。

        char*   SvPVutf8_nolen(SV* sv)

SvPVX

Returns a pointer to the physical string in the SV. The SV must contain a string.

SV にある物理文字列へのポインタを返します。 SV は文字列を保持していなければなりません。

        char*   SvPVX(SV* sv)

SvPVx

A version of SvPV which guarantees to evaluate sv only once. Only use this if sv is an expression with side effects, otherwise use the more efficient SvPVX.

sv を一度だけ評価することを保証するバージョンの SvPV です。 sv が副作用のある式の時にのみこれを使ってください; さもなければ より効率的な SvPVV を使ってください。

        char*   SvPVx(SV* sv, STRLEN len)

SvPV_force

Like SvPV but will force the SV into containing just a string (SvPOK_only). You want force if you are going to update the SvPVX directly.

SvPV と同様ですが、SV が単に文字列(SvPOK_only)を含むことを強制します。 SvPVX を直接更新したい場合には強制したいでしょう。

        char*   SvPV_force(SV* sv, STRLEN len)

SvPV_force_nomg

Like SvPV but will force the SV into containing just a string (SvPOK_only). You want force if you are going to update the SvPVX directly. Doesn't process magic.

SvPV と同様ですが、SV が単に文字列(SvPOK_only)を含むことを強制します。 SvPVX を直接更新したい場合には強制したいでしょう。 magic を処理しません。

        char*   SvPV_force_nomg(SV* sv, STRLEN len)

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 SvPOK. Handles 'get' magic.

SV にある文字列へのポインタか、SVが文字列を保持していない場合には SV の文字列化形式を返します。 SV は SvPOK になった文字列化形式をキャッシュするかもしれません。 'get' magic をハンドルします。

        char*   SvPV_nolen(SV* sv)

SvPV_nomg

Like SvPV but doesn't process magic.

SvPV と同様ですが、magic を処理しません。

        char*   SvPV_nomg(SV* sv, STRLEN len)

SvPV_set

Set the value of the PV pointer in sv to val. See SvIV_set.

sv の PV ポインタの値を val にセットします。 SvIV_set を参照してください。

        void    SvPV_set(SV* sv, char* val)

SvREFCNT

Returns the value of the object's reference count.

オブジェクトの参照カウントの値を返します。

        U32     SvREFCNT(SV* sv)

SvREFCNT_dec

Decrements the reference count of the given SV.

SV で与えられたものの参照カウントを減じます。

        void    SvREFCNT_dec(SV* sv)

SvREFCNT_inc

Increments the reference count of the given SV.

SV で与えられたものの参照カウントを増やします。

All of the following SvREFCNT_inc* macros are optimized versions of SvREFCNT_inc, and can be replaced with SvREFCNT_inc.

以下の SvREFCNT_inc* マクロ全ては SvREFCNT_inc の最適化バージョンで、 SvREFCNT_inc に置き換えられます。

        SV*     SvREFCNT_inc(SV* sv)

SvREFCNT_inc_NN

Same as SvREFCNT_inc, but can only be used if you know sv is not NULL. Since we don't have to check the NULLness, it's faster and smaller.

SvREFCNT_inc と同じですが、sv が NULL ではないと分かっている場合にのみ 使えます。 NULL かどうかをチェックする必要がないので、より速くより小さいです。

        SV*     SvREFCNT_inc_NN(SV* sv)

SvREFCNT_inc_simple

Same as SvREFCNT_inc, but can only be used with expressions without side effects. Since we don't have to store a temporary value, it's faster.

SvREFCNT_inc と同じですが、式に副作用がない場合にのみ使えます。 一時的な値を保管する必要がないので、より速いです。

        SV*     SvREFCNT_inc_simple(SV* sv)

SvREFCNT_inc_simple_NN

Same as SvREFCNT_inc_simple, but can only be used if you know sv is not NULL. Since we don't have to check the NULLness, it's faster and smaller.

SvREFCNT_inc_simple と同じですが、sv が NULL ではないと分かっている 場合にのみ使えます。 NULL かどうかをチェックする必要がないので、より速くより小さいです。

        SV*     SvREFCNT_inc_simple_NN(SV* sv)

SvREFCNT_inc_simple_void

Same as SvREFCNT_inc_simple, but can only be used if you don't need the return value. The macro doesn't need to return a meaningful value.

SvREFCNT_inc_simple と同じですが、返り値が不要な場合にのみ使えます。 このマクロは意味のある値を返す必要はありません。

        void    SvREFCNT_inc_simple_void(SV* sv)

SvREFCNT_inc_simple_void_NN

Same as SvREFCNT_inc, but can only be used if you don't need the return value, and you know that sv is not NULL. The macro doesn't need to return a meaningful value, or check for NULLness, so it's smaller and faster.

SvREFCNT_inc と同じですが、返り値が不要で、sv が NULL ではないと 分かっている場合にのみ使えます。 このマクロは意味のある値を返す必要が無く、NULL をチェックする必要もないので、 より速くより小さいです。

        void    SvREFCNT_inc_simple_void_NN(SV* sv)

SvREFCNT_inc_void

Same as SvREFCNT_inc, but can only be used if you don't need the return value. The macro doesn't need to return a meaningful value.

SvREFCNT_inc と同じですが、返り値が不要な場合にのみ使えます。 このマクロは意味のある値を返す必要はありません。

        void    SvREFCNT_inc_void(SV* sv)

SvREFCNT_inc_void_NN

Same as SvREFCNT_inc, but can only be used if you don't need the return value, and you know that sv is not NULL. The macro doesn't need to return a meaningful value, or check for NULLness, so it's smaller and faster.

SvREFCNT_inc と同じですが、返り値が不要で、sv が NULL ではないと 分かっている場合にのみ使えます。 このマクロは意味のある値を返す必要が無く、NULL をチェックする必要もないので、 より速くより小さいです。

        void    SvREFCNT_inc_void_NN(SV* sv)

SvROK

Tests if the SV is an RV.

SV が RV であるかを検査します。

        U32     SvROK(SV* sv)

SvROK_off

Unsets the RV status of an SV.

SV の RV ステータスをリセットします。

        void    SvROK_off(SV* sv)

SvROK_on

Tells an SV that it is an RV.

SV に、自分が RV であると指示します。

        void    SvROK_on(SV* sv)

SvRV

Dereferences an RV to return the SV.

SV を返すために RV を参照はずしします。

        SV*     SvRV(SV* sv)

SvRV_set

Set the value of the RV pointer in sv to val. See SvIV_set.

sv の RV ポインタの値を val にセットします。 SvIV_set を参照してください。

        void    SvRV_set(SV* sv, SV* val)

SvSTASH

Returns the stash of the SV.

SV のスタッシュを返します。

        HV*     SvSTASH(SV* sv)

SvSTASH_set

Set the value of the STASH pointer in sv to val. See SvIV_set.

sv の STASH ポインタの値を val にセットします。 SvIV_set を参照してください。

        void    SvSTASH_set(SV* sv, HV* val)

SvTAINT

Taints an SV if tainting is enabled.

汚染検査が有効なときに SV を汚染検査します。

        void    SvTAINT(SV* sv)

SvTAINTED

Checks to see if an SV is tainted. Returns TRUE if it is, FALSE if not.

SV が汚染されているかどうかをチェックします。 汚染されていれば TRUE を、そうでなければ FALSE を返します。

        bool    SvTAINTED(SV* sv)

SvTAINTED_off

Untaints an SV. Be very careful with this routine, as it short-circuits some of Perl's fundamental security features. XS module authors should not use this function unless they fully understand all the implications of unconditionally untainting the value. Untainting should be done in the standard perl fashion, via a carefully crafted regexp, rather than directly untainting variables.

SV を汚染除去します。 Perl の基本的セキュリティ機構と同様 このルーチンを使うときは特に注意してください。 XS モジュールの作者は、汚染除去について良く理解しない限りは この関数を使うべきではありません。 perl 標準のやり方では直接変数の汚染除去するのではなく、 注意深く構築された正規表現を使って汚染除去が行われます。

        void    SvTAINTED_off(SV* sv)

SvTAINTED_on

Marks an SV as tainted if tainting is enabled.

汚染チェックが有効な場合、汚染されているという印を SV につけます。

        void    SvTAINTED_on(SV* sv)

SvTRUE

Returns a boolean indicating whether Perl would evaluate the SV as true or false. See SvOK() for a defined/undefined test. Does not handle 'get' magic.

Perl が SV を真と評価するか偽と評価するかを示す真偽値を返します。 定義/未定義のテストには SvOK() を参照してください。 'set' magic をハンドルしません。

        bool    SvTRUE(SV* sv)

SvTYPE

Returns the type of the SV. See svtype.

SV の型を返します。 svtype を参照してください。

        svtype  SvTYPE(SV* sv)

SvUOK

Returns a boolean indicating whether the SV contains an unsigned integer.

SV が符号なし整数を含んでいるかどうかを示す真偽値を返します。

        bool    SvUOK(SV* sv)

SvUPGRADE

Used to upgrade an SV to a more complex form. Uses sv_upgrade to perform the upgrade if necessary. See svtype.

SV をより複雑なフォームにするために使われます。 必要であればアップグレードのために sv_upgrade を使用します。 svtype を参照してください。

        void    SvUPGRADE(SV* sv, svtype type)

SvUTF8

Returns a U32 value indicating whether the SV contains UTF-8 encoded data. Call this after SvPV() in case any call to string overloading updates the internal flag.

SV が UTF-8 エンコードされたデータを含んでいるかどうかを示す U32 値を 返します。 オーバーロードが内部フラグを更新する文字列に対して呼び出すときは SvPV() の後にこれを呼び出してください。

        U32     SvUTF8(SV* sv)

SvUTF8_off

Unsets the UTF-8 status of an SV.

SV の UTF-8 状態をリセットします。

        void    SvUTF8_off(SV *sv)

SvUTF8_on

Turn on the UTF-8 status of an SV (the data is not changed, just the flag). Do not use frivolously.

SV の UTF-8 状態をオンにします (データは変更されません; フラグだけです)。 軽率に使わないでください。

        void    SvUTF8_on(SV *sv)

SvUV

Coerces the given SV to an unsigned integer and returns it. See SvUVx for a version which guarantees to evaluate sv only once.

SV を強制的に符号なし整数に変換し、それを返します。 sv が 1 度だけ評価されることを保証しているバージョンについては SvUVx を参照してください。

        UV      SvUV(SV* sv)

SvUVX

Returns the raw value in the SV's UV slot, without checks or conversions. Only use when you are sure SvIOK is true. See also SvUV().

SV の UV スロットの生の値を、チェックや変換なしに返します。 SvIOK が真であることを確認した後にのみ使えます。 SvUV() も参照してください。

        UV      SvUVX(SV* sv)

SvUVx

Coerces the given SV to an unsigned integer and returns it. Guarantees to sv only once. Only use this if sv is an expression with side effects, otherwise use the more efficient SvUV.

SV を強制的に符号なし整数に変換し、それを返します。 sv を一度だけ評価することを保証します。 sv が副作用のある式の時にのみこれを使ってください; さもなければ より効率的な SvUV を使ってください。

        UV      SvUVx(SV* sv)

SvUV_nomg

Like SvUV but doesn't process magic.

SvUV と同様ですが、magic を処理しません。

        UV      SvUV_nomg(SV* sv)

SvUV_set

Set the value of the UV pointer in sv to val. See SvIV_set.

sv の UV ポインタの値を val にセットします。 SvIV_set を参照してください。

        void    SvUV_set(SV* sv, UV val)

SvVOK

Returns a boolean indicating whether the SV contains a v-string.

SV がv-文字列を含んでいるかどうかを示す真偽値を返します。

        bool    SvVOK(SV* sv)

sv_catpvn_nomg

Like sv_catpvn but doesn't process magic.

sv_catpvn と同様ですが、magic を処理しません。

        void    sv_catpvn_nomg(SV* sv, const char* ptr, STRLEN len)

sv_catsv_nomg

Like sv_catsv but doesn't process magic.

sv_catsv と同様ですが、magic を処理しません。

        void    sv_catsv_nomg(SV* dsv, SV* ssv)

sv_derived_from

Returns a boolean indicating whether the SV is derived from the specified class at the C level. To check derivation at the Perl level, call isa() as a normal Perl method.

C のレベルで SV が指定したクラスから派生したものであるかどうかを示す 真偽値を返します。 Perl レベルの派生をチェックするには、通常の Perl メソッドとして isa() を 呼び出してください。

        bool    sv_derived_from(SV* sv, const char* name)

sv_does

Returns a boolean indicating whether the SV performs a specific, named role. The SV can be a Perl object or the name of a Perl class.

SV が特定の名前付きのロールを行うかどうかを示す真偽値を返します。 SV は Perl オブジェクトか Perl クラスの名前です。

        bool    sv_does(SV* sv, const char* name)

sv_report_used

Dump the contents of all SVs not yet freed. (Debugging aid).

開放されていない全ての SV の内容をダンプします。 (デバッグの助けとなります)。

        void    sv_report_used()

sv_setsv_nomg

Like sv_setsv but doesn't process magic.

sv_setsv と同様ですが、magic を処理しません。

        void    sv_setsv_nomg(SV* dsv, SV* ssv)

sv_utf8_upgrade_nomg

Like sv_utf8_upgrade, but doesn't do magic on sv

sv_utf8_upgrade と同様ですが sv にマジックを適用しません。

        STRLEN  sv_utf8_upgrade_nomg(NN SV *sv)

SV ボディ割り当て¶

looks_like_number

Test if the content of an SV looks like a number (or is a number). Inf and Infinity are treated as numbers (so will not issue a non-numeric warning), even if your atof() doesn't grok them.

SV の内容が数値のようにみなせるか(あるいは数値であるか)を検査します。 たとえ atof() が認識しなくても、Inf と Infinity は数値として 扱われます(従って非数値警告は発生しません)。

        I32     looks_like_number(SV* sv)

newRV_noinc

Creates an RV wrapper for an SV. The reference count for the original SV is not incremented.

SV に対する RV ラッパーを生成します。 元の SV の参照カウントはインクリメント されません。

        SV*     newRV_noinc(SV* sv)

newSV

Creates a new SV. A non-zero len parameter indicates the number of bytes of preallocated string space the SV should have. An extra byte for a trailing NUL is also reserved. (SvPOK is not set for the SV even if string space is allocated.) The reference count for the new SV is set to 1.

新たな SV を生成します。 非ゼロの len パラメーターは SV が持つべき割り当てずみ文字列空間の大きさを 示します。 余分な空間には NUL が埋められ、予約されます。 (SvPOK は文字列が割り当てられていたとしても SV をセットしません。) 新しい SV の参照カウントは 1 に設定されます。

In 5.9.3, newSV() replaces the older NEWSV() API, and drops the first parameter, x, a debug aid which allowed callers to identify themselves. This aid has been superseded by a new build option, PERL_MEM_LOG (see "PERL_MEM_LOG" in perlhack). The older API is still there for use in XS modules supporting older perls.

5.9.3 で、newSV() は古い NEWSV() API を置き換え、呼び出し側が自分自身を 識別できるようにデバッグの助けをするための最初の引数 x がなくなりました。 この助けは新しいビルドオプション PERL_MEM_LOG ("PERL_MEM_LOG" in perlhack 参照) で置き換えられました。 古い API は、古い perl に対応している XS モジュールが使えるように まだ存在しています。

        SV*     newSV(STRLEN len)

newSVhek

Creates a new SV from the hash key structure. It will generate scalars that point to the shared string table where possible. Returns a new (undefined) SV if the hek is NULL.

ハッシュキー構造体から新しい SV を作成します。 可能なら共有文字列テーブルを指しているスカラを生成します。 hek が NULL なら、新しい(未定義値の) SV を返します。

        SV*     newSVhek(const HEK *hek)

newSViv

Creates a new SV and copies an integer into it. The reference count for the SV is set to 1.

新たな SV を生成し、整数値をそこにコピーします。 SV の参照カウントは 1 に設定されます。

        SV*     newSViv(IV i)

newSVnv

Creates a new SV and copies a floating point value into it. The reference count for the SV is set to 1.

新たな SV を生成し、不動小数点数値をそこにコピーします。 SV の参照カウントは 1 に設定されます。

        SV*     newSVnv(NV n)

newSVpv

Creates a new SV and copies a string into it. The reference count for the SV is set to 1. If len is zero, Perl will compute the length using strlen(). For efficiency, consider using newSVpvn instead.

新たな SV を生成し、文字列をそこにコピーします。 SV の参照カウントは 1 に設定されます。 len がゼロの場合、Perl が strlen() を使って長さを計算します。 効率のために、代わりに newSVpvn を使うことを考慮してください。

        SV*     newSVpv(const char* s, STRLEN len)

newSVpvf

Creates a new SV and initializes it with the string formatted like sprintf.

新たな SV を生成し、sprintf のような文字列書式によって初期化します。

        SV*     newSVpvf(const char* pat, ...)

newSVpvn

Creates a new SV and copies a string into it. The reference count for the SV is set to 1. Note that if len is zero, Perl will create a zero length string. You are responsible for ensuring that the source string is at least len bytes long. If the s argument is NULL the new SV will be undefined.

新たな SV を生成し、文字列をそこにコピーします。 SV の参照カウントは 1 に設定されます。 len がゼロであった場合には長さゼロの文字列が生成されることに 注意してください。 ソース文字列が少なくとも len の長さがあることを保証する責任があります。 s 引数が NULL なら 新しい SV は未定義値です。

        SV*     newSVpvn(const char* s, STRLEN len)

newSVpvn_flags

Creates a new SV and copies a string into it. The reference count for the SV is set to 1. Note that if len is zero, Perl will create a zero length string. You are responsible for ensuring that the source string is at least len bytes long. If the s argument is NULL the new SV will be undefined. Currently the only flag bits accepted are SVf_UTF8 and SVs_TEMP. If SVs_TEMP is set, then sv2mortal() is called on the result before returning. If SVf_UTF8 is set, then it will be set on the new SV. newSVpvn_utf8() is a convenience wrapper for this function, defined as

新しい SV を作成して文字列をコピーします。 SV の参照カウントは 1 に設定されます。 len が 0 の場合、Perl は長さ 0 の文字列を作成することに 注意してください。 呼び出し側は元の文字列が少なくともlen バイトの長さがあることを保証する 責任があります。 s 引数が NULL なら、新しい SV は未定義値です。 現在のところ受け入れられるフラグビットは SVf_UTF8 と SVs_TEMP のみです。 SVs_TEMP が設定されると、結果を返す前に sv2mortal() が呼び出されます。 SVf_UTF8 が設定されると、新しい SV に設定されます。 newSVpvn_utf8() はこの関数のための便利なラッパで、以下のように 定義されています

    #define newSVpvn_utf8(s, len, u)                    \
        newSVpvn_flags((s), (len), (u) ? SVf_UTF8 : 0)

        SV*     newSVpvn_flags(const char* s, STRLEN len, U32 flags)

newSVpvn_share

Creates a new SV with its SvPVX_const pointing to a shared string in the string table. If the string does not already exist in the table, it is created first. Turns on READONLY and FAKE. If the hash parameter is non-zero, that value is used; otherwise the hash is computed. The string's hash can be later be retrieved from the SV with the SvSHARED_HASH() macro. The idea here is that as the string table is used for shared hash keys these strings will have SvPVX_const == HeKEY and hash lookup will avoid string compare.

SvPVX_const が文字列テーブルの共有文字列を指している新しい SV を作成します。 文字列がまだテーブルに存在していないなら、まず作成されます。 READONLY と FAKE を有効にします。 hash 引数が非ゼロなら、その値が使われます; さもなければハッシュは 計算されます。 文字列のハッシュは、後で SvSHARED_HASH() マクロで SV から取得できます。 ここでの考え方は、文字列テーブルは共有ハッシュキーのために使われるので、 これらの文字列は SvPVX_const == HeKEY であって、ハッシュの検索は 文字列比較を防ぐと言うことです。

        SV*     newSVpvn_share(const char* s, I32 len, U32 hash)

newSVpvs

Like newSVpvn, but takes a literal string instead of a string/length pair.

newSVpvn と同様ですが、文字列/長さの組ではなく、リテラルな文字列を 取ります。

        SV*     newSVpvs(const char* s)

newSVpvs_flags

Like newSVpvn_flags, but takes a literal string instead of a string/length pair.

newSVpvn_flags と同様ですが、文字列/長さの組ではなくリテラルな文字列を 取ります。

        SV*     newSVpvs_flags(const char* s, U32 flags)

newSVpvs_share

Like newSVpvn_share, but takes a literal string instead of a string/length pair and omits the hash parameter.

newSVpvn_share と同様ですが、文字列/長さの組ではなく、リテラルな文字列を 取り、ハッシュパラメータを除外します。

        SV*     newSVpvs_share(const char* s)

newSVrv

Creates a new SV for the RV, rv, to point to. If rv is not an RV then it will be upgraded to one. If classname is non-null then the new SV will be blessed in the specified package. The new SV is returned and its reference count is 1.

SV を指し示す RV の rv に対する新たな SV を生成します。 rv が RV でない場合には、それは RV に昇格します。 classname がヌルでない場合には、生成された SV は指定されたパッケージに bless されます。 参照カウントが 1 に設定された SV が返されます。

        SV*     newSVrv(SV* rv, const char* classname)

newSVsv

Creates a new SV which is an exact duplicate of the original SV. (Uses sv_setsv).

元の SV を正確に複製した SV を生成します。 (sv_setsv を使います)。

        SV*     newSVsv(SV* old)

newSVuv

Creates a new SV and copies an unsigned integer into it. The reference count for the SV is set to 1.

新しい SV を作成して、そこに符号なし整数をコピーします。 SV の参照カウントは 1 に設定されます。

        SV*     newSVuv(UV u)

newSV_type

Creates a new SV, of the type specified. The reference count for the new SV is set to 1.

指定された型の新しい SV を作成します。 新しい SV の参照カウントは 1 に設定されます。

        SV*     newSV_type(svtype type)

sv_2bool

This function is only called on magical items, and is only used by sv_true() or its macro equivalent.

この関数は magical なアイテムからのみ呼び出され、sv_true() や等価な マクロからのみ使われます。

        bool    sv_2bool(SV* sv)

sv_2cv

Using various gambits, try to get a CV from an SV; in addition, try if possible to set *st and *gvp to the stash and GV associated with it. The flags in lref are passed to sv_fetchsv.

様々な作戦を使って、SV から CV を得ようとします; さらに、もし可能なら、 *st と *gvp に、それと関連づけられているスタッシュと GV に セットしようとします。 lref のフラグは sv_fetchsv に渡されます。

        CV*     sv_2cv(SV* sv, HV** st, GV** gvp, I32 lref)

sv_2io

Using various gambits, try to get an IO from an SV: the IO slot if its a GV; or the recursive result if we're an RV; or the IO slot of the symbol named after the PV if we're a string.

様々な作戦を使って、SV から CV を得ようとします; GV なら IO スロット; RV なら再帰した結果; 文字列なら PV の後のシンボル名の IO スロットです。

        IO*     sv_2io(SV* sv)

sv_2iv_flags

Return the integer value of an SV, doing any necessary string conversion. If flags includes SV_GMAGIC, does an mg_get() first. Normally used via the SvIV(sv) and SvIVx(sv) macros.

必要な文字列変換を行って、SV の整数値を返します。 フラグに SV_GMAGIC が含まれていると、最初に mg_get() を行います。 通常は SvIV(sv) と SvIVx(sv) マクロ経由で使われます。

        IV      sv_2iv_flags(SV* sv, I32 flags)

sv_2mortal

Marks an existing SV as mortal. The SV will be destroyed "soon", either by an explicit call to FREETMPS, or by an implicit call at places such as statement boundaries. SvTEMP() is turned on which means that the SV's string buffer can be "stolen" if this SV is copied. See also sv_newmortal and sv_mortalcopy.

SV を揮発性にします。 SV は FREETMPS の明示的な呼び出しか、文の境界のような場所での暗黙の 呼び出しによって「すぐに」破壊されます。 この SV がコピーされると、SvTEMP() は SV の文字列バッファが「盗まれた」ことを 示すために音になります。 sv_newmortal と sv_mortalcopy も参照してください。

        SV*     sv_2mortal(SV* sv)

sv_2nv

Return the num value of an SV, doing any necessary string or integer conversion, magic etc. Normally used via the SvNV(sv) and SvNVx(sv) macros.

必要な文字列変換や整数変換、magic などを行って、SV の数値を返します。 通常は SvNV(sv) と SvNVx(sv) のマクロ経由で使います。

        NV      sv_2nv(SV* sv)

sv_2pvbyte

Return a pointer to the byte-encoded representation of the SV, and set *lp to its length. May cause the SV to be downgraded from UTF-8 as a side-effect.

SV のバイトエンコードされた表現へのポインタを返し、その長さを *lp に セットします。 副作用として、SV が UTF-8 から降格するかもしれません。

Usually accessed via the SvPVbyte macro.

普通は SvPVbyte マクロ経由でアクセスされます。

        char*   sv_2pvbyte(SV* sv, STRLEN* lp)

sv_2pvutf8

Return a pointer to the UTF-8-encoded representation of the SV, and set *lp to its length. May cause the SV to be upgraded to UTF-8 as a side-effect.

SV の UTF-8 エンコードされた表現へのポインタを返し、その長さを *lp に セットします。 副作用として、SV が UTF-8 へ昇格するかもしれません。

Usually accessed via the SvPVutf8 macro.

普通は SvPVutf8 マクロ経由でアクセスされます。

        char*   sv_2pvutf8(SV* sv, STRLEN* lp)

sv_2pv_flags

Returns a pointer to the string value of an SV, and sets *lp to its length. If flags includes SV_GMAGIC, does an mg_get() first. Coerces sv to a string if necessary. Normally invoked via the SvPV_flags macro. sv_2pv() and sv_2pv_nomg usually end up here too.

SV の文字列値へのポインタを返し、*lp にその長さをセットします。 フラグに SV_GMAGIC が含まれていると、最初に mg_get() を行います。 必要なら sv を文字列に強制します。 通常は SvPV_flags マクロ経由で起動されます。 sv_2pv() と sv_2pv_nomg も普通はここで終わります。

        char*   sv_2pv_flags(SV* sv, STRLEN* lp, I32 flags)

sv_2uv_flags

Return the unsigned integer value of an SV, doing any necessary string conversion. If flags includes SV_GMAGIC, does an mg_get() first. Normally used via the SvUV(sv) and SvUVx(sv) macros.

必要な文字列変換を行って、SV の符号なし整数値を返します。 フラグに SV_GMAGIC が含まれていると、最初に mg_get() を行います。 通常は SvUV(sv) と SvUVx(sv) マクロ経由で使われます。

        UV      sv_2uv_flags(SV* sv, I32 flags)

sv_backoff

Remove any string offset. You should normally use the SvOOK_off macro wrapper instead.

文字列オフセットを取り除きます。 通常は代わりに SvOOK_off マクロラッパーを使うべきです。

        int     sv_backoff(SV* sv)

sv_bless

Blesses an SV into a specified package. The SV must be an RV. The package must be designated by its stash (see gv_stashpv()). The reference count of the SV is unaffected.

SV を指定したパッケージに bless します。 SV は RV でなければなりません。 パッケージは、そのスタッシュ(gv_stashpv() 参照)によって 指示されていなければなりません。 SV の参照カウントは影響を受けません。

        SV*     sv_bless(SV* sv, HV* stash)

sv_catpv

Concatenates the string onto the end of the string which is in the SV. If the SV has the UTF-8 status set, then the bytes appended should be valid UTF-8. Handles 'get' magic, but not 'set' magic. See sv_catpv_mg.

文字列を、SV にある文字列の終端に連結します。 SV の UTF-8 ステータスが設定されているなら、追加されるバイト列は妥当な UTF-8 であるべきです。 'get' magic をハンドルしますが、'set' magic はハンドルしません。 sv_catpv_mg を参照してください。

        void    sv_catpv(SV* sv, const char* ptr)

sv_catpvf

Processes its arguments like sprintf and appends the formatted output to an SV. If the appended data contains "wide" characters (including, but not limited to, SVs with a UTF-8 PV formatted with %s, and characters >255 formatted with %c), the original SV might get upgraded to UTF-8. Handles 'get' magic, but not 'set' magic. See sv_catpvf_mg. If the original SV was UTF-8, the pattern should be valid UTF-8; if the original SV was bytes, the pattern should be too.

引数を sprintf のように処理し、SV にその結果を追加します。 追加するデータに「ワイド」文字(%s でフォーマットされた UTF-8 PV や %c でフォーマットされた >255 の文字の SV を含みますが、それに 限定されません)が含まれている場合、元の SV は UTF-8 に 昇格されるかもしれません。 'get' magic をハンドルしますが、'set' magic はハンドルしません。 sv_catpvf_mg を参照してください。 元の SV が UTF-8 なら、パターンは妥当な UTF-8 であるべきです; 元の SV が バイト列なら、パターンもそうあるべきです。

        void    sv_catpvf(SV* sv, const char* pat, ...)

sv_catpvf_mg

Like sv_catpvf, but also handles 'set' magic.

sv_catpvf と同様ですが、'set' magic もハンドルします。

        void    sv_catpvf_mg(SV *sv, const char* pat, ...)

sv_catpvn

Concatenates the string onto the end of the string which is in the SV. The len indicates number of bytes to copy. If the SV has the UTF-8 status set, then the bytes appended should be valid UTF-8. Handles 'get' magic, but not 'set' magic. See sv_catpvn_mg.

文字列を、SV にある文字列の終端に連結します。 len はコピーするバイト数を示します。 SV の UTF-8 ステータスが設定されているなら、追加されるバイト列は妥当な UTF-8 であるべきです。 'get' magic をハンドルしますが、'set' magic はハンドルしません。 sv_catpvn_mg を参照してください。

        void    sv_catpvn(SV *dsv, const char *sstr, STRLEN len)

sv_catpvn_flags

Concatenates the string onto the end of the string which is in the SV. The len indicates number of bytes to copy. If the SV has the UTF-8 status set, then the bytes appended should be valid UTF-8. If flags has SV_GMAGIC bit set, will mg_get on dsv if appropriate, else not. sv_catpvn and sv_catpvn_nomg are implemented in terms of this function.

文字列を、SV にある文字列の終端に連結します。 len はコピーするバイト数を示します。 SV の UTF-8 ステータスが設定されているなら、追加されるバイト列は妥当な UTF-8 であるべきです。 flags の SV_GMAGIC ビットがセットされていると、適切なら dsv に mg_get し、さもなければしません。 sv_catpvn と sv_catpvn_nomg はこの関数に関して実装されています。

        void    sv_catpvn_flags(SV *dstr, const char *sstr, STRLEN len, I32 flags)

sv_catpvs

Like sv_catpvn, but takes a literal string instead of a string/length pair.

sv_catpvn と同様ですが、文字列/長さの組ではなく、リテラルな文字列を 取ります。

        void    sv_catpvs(SV* sv, const char* s)

sv_catpv_mg

Like sv_catpv, but also handles 'set' magic.

sv_catpv と同様ですが、'set' magic もハンドルします。

        void    sv_catpv_mg(SV *sv, const char *ptr)

sv_catsv

Concatenates the string from SV ssv onto the end of the string in SV dsv. Modifies dsv but not ssv. Handles 'get' magic, but not 'set' magic. See sv_catsv_mg.

SV ssv にある文字列を、SV dsv にある文字列の終端へ連結します。 dsv を変更しますが ssv は変更しません。 'get' magic をハンドルしますが、'set' magic はハンドルしません。 sv_catsv_mg を参照してください。

        void    sv_catsv(SV *dstr, SV *sstr)

sv_catsv_flags

Concatenates the string from SV ssv onto the end of the string in SV dsv. Modifies dsv but not ssv. If flags has SV_GMAGIC bit set, will mg_get on the SVs if appropriate, else not. sv_catsv and sv_catsv_nomg are implemented in terms of this function.

SV ssv にある文字列を、SV dsv にある文字列の終端へ連結します。 dsv を変更しますが ssv は変更しません。 flags の SV_GMAGIC ビットがセットされていると、適切なら SV に mg_get し、さもなければしません。 sv_catsv と sv_catsv_nomg はこの関数に関して実装されています。

        void    sv_catsv_flags(SV* dsv, SV* ssv, I32 flags)

sv_chop

Efficient removal of characters from the beginning of the string buffer. SvPOK(sv) must be true and the ptr must be a pointer to somewhere inside the string buffer. The ptr becomes the first character of the adjusted string. Uses the "OOK hack". Beware: after this function returns, ptr and SvPVX_const(sv) may no longer refer to the same chunk of data.

文字列バッファの先頭から文字を効率的に削除します。 SvPOK(sv) が真でなければならず、ptr は文字列バッファの 内側のどこかを指し示すポインタでなければなりません。 ptr は調整後の文字列の先頭となります。 "OOK hack" を使います。 注意: この関数から返った後、ptr と SvPVX_const(sv) はもはや同じデータの 塊を参照していません。

        void    sv_chop(SV* sv, const char* ptr)

sv_clear

Clear an SV: call any destructors, free up any memory used by the body, and free the body itself. The SV's head is not freed, although its type is set to all 1's so that it won't inadvertently be assumed to be live during global destruction etc. This function should only be called when REFCNT is zero. Most of the time you'll want to call sv_free() (or its macro wrapper SvREFCNT_dec) instead.

SV をクリアします: デストラクタを呼び出し、ボディで使われたメモリを解放し、 ボディ自身を解放します。 SV のヘッダは解放 されません が、 its type is set to all 1's so that it won't inadvertently be assumed to be live during global destruction etc. この関数は REFCNT がゼロになったときにのみ呼び出されるべきです。 ほとんどの場合 sv_free() (またはそのマクロラッパー SvREFCNT_dec) を 呼び出したいでしょう。

        void    sv_clear(SV* sv)

sv_cmp

Compares the strings in two SVs. Returns -1, 0, or 1 indicating whether the string in sv1 is less than, equal to, or greater than the string in sv2. Is UTF-8 and 'use bytes' aware, handles get magic, and will coerce its args to strings if necessary. See also sv_cmp_locale.

二つの SV にある文字列を比較します。 sv1 が sv2 より小さいときには -1 を、両者が等しいときには 0 を、 sv1 が sv2 より大きいときには 1 を返します。 UTF-8 と 'use bytes' を認識し、get magic をハンドルし、必要なら引数を 文字列に強制します。 sv_cmp_locale も参照してください。

        I32     sv_cmp(SV* sv1, SV* sv2)

sv_cmp_locale

Compares the strings in two SVs in a locale-aware manner. Is UTF-8 and 'use bytes' aware, handles get magic, and will coerce its args to strings if necessary. See also sv_cmp.

二つの SV の文字列をロケールを認識するような形で比較します。 UTF-8 と 'use bytes' が有効で、get magic を扱い、必要なら引数を文字列に 強制します。 sv_cmp も参照してください。

        I32     sv_cmp_locale(SV* sv1, SV* sv2)

sv_collxfrm

Add Collate Transform magic to an SV if it doesn't already have it.

まだなければ、照合変換 magic を SV に追加します。

Any scalar variable may carry PERL_MAGIC_collxfrm magic that contains the scalar data of the variable, but transformed to such a format that a normal memory comparison can be used to compare the data according to the locale settings.

任意のスカラ値は変数のスカラデータを含む PERL_MAGIC_collxfrm magic を 保持しているかもしれませんが、ロケール設定に従った比較に通常のメモリ比較が 使えるようなフォーマットに変換されます。

        char*   sv_collxfrm(SV* sv, STRLEN* nxp)

sv_copypv

Copies a stringified representation of the source SV into the destination SV. Automatically performs any necessary mg_get and coercion of numeric values into strings. Guaranteed to preserve UTF8 flag even from overloaded objects. Similar in nature to sv_2pv[_flags] but operates directly on an SV instead of just the string. Mostly uses sv_2pv_flags to do its work, except when that would lose the UTF-8'ness of the PV.

ソース SV の文字列化表現をデスティネーション SV にコピーします。 必要な mg_get と数値から文字列への強制を自動的に行います。 オーバーロードされたオブジェクトからであっても UTF8 フラグが 保存されることを保証します。 事実上 sv_2pv[_flags] と似ていますが、単なる文字列ではなく SV に対して 直接操作します。 この作業を行うためにほとんどは sv_2pv_flags フラグを使います; 例外は PV の UTF-8 性が失われるときです。

        void    sv_copypv(SV* dsv, SV* ssv)

sv_dec

Auto-decrement of the value in the SV, doing string to numeric conversion if necessary. Handles 'get' magic.

SV にある値の自動デクリメントを行います; 必要なら文字列から数値への変換を 行います。 'get' magic をハンドルします。

        void    sv_dec(SV* sv)

sv_eq

Returns a boolean indicating whether the strings in the two SVs are identical. Is UTF-8 and 'use bytes' aware, handles get magic, and will coerce its args to strings if necessary.

二つの SV にある文字列が同一のものであるかどうかをあらわす真偽値を 返します。 UTF-8 と 'use bytes' を認識し、get magic をハンドルし、必要なら引数を 文字列に強制します。

        I32     sv_eq(SV* sv1, SV* sv2)

sv_force_normal_flags

Undo various types of fakery on an SV: if the PV is a shared string, make a private copy; if we're a ref, stop refing; if we're a glob, downgrade to an xpvmg; if we're a copy-on-write scalar, this is the on-write time when we do the copy, and is also used locally. If SV_COW_DROP_PV is set then a copy-on-write scalar drops its PV buffer (if any) and becomes SvPOK_off rather than making a copy. (Used where this scalar is about to be set to some other value.) In addition, the flags parameter gets passed to sv_unref_flags() when unrefing. sv_force_normal calls this function with flags set to 0.

SV に対する様々な種類のごまかしを元に戻します: PV が共有文字列なら、プライベートなコピーを作ります; 参照しているなら 参照を止めます; グロブなら、xpvmg に降格します; コピーオンライト スカラなら、コピーは書き込み時に行われ、ローカルに使われます。 SV_COW_DROP_PV がセットされているなら、コピーオンライトスカラは (もしあれば)PV バッファを落として、コピーを作る代わりに SvPOK_off に なります。 (このスカラが何か他の値にセットされようとした場所で使われます。) さらに、参照を止めるときに sv_unref_flags() に flags 引数が 渡されます。 sv_force_normal は flags に 0 をセットしてこの関数を呼び出します。

        void    sv_force_normal_flags(SV *sv, U32 flags)

sv_free

Decrement an SV's reference count, and if it drops to zero, call sv_clear to invoke destructors and free up any memory used by the body; finally, deallocate the SV's head itself. Normally called via a wrapper macro SvREFCNT_dec.

SV の参照カウントをデクリメントして、ゼロになったら、デストラクタを起動して ボディによって使われているメモリを解放するために sv_clear を呼び出します; 最後に、SV のヘッド地震を割り当て解除します。 通常はラッパーマクロ SvREFCNT_dec 経由で呼び出されます。

        void    sv_free(SV* sv)

sv_gets

Get a line from the filehandle and store it into the SV, optionally appending to the currently-stored string.

ファイルハンドルから 1 行読み込んで SV に保管し、オプションで既に 保管されている文字列に追記します。

        char*   sv_gets(SV* sv, PerlIO* fp, I32 append)

sv_grow

Expands the character buffer in the SV. If necessary, uses sv_unref and upgrades the SV to SVt_PV. Returns a pointer to the character buffer. Use the SvGROW wrapper instead.

SV にある文字バッファを拡張します。 もし必要なら、sv_unref を使用して、SV を SVt_PV へ昇格します。 文字バッファへのポインタを返します。 代わりに SvGROW ラッパーを使用してください。

        char*   sv_grow(SV* sv, STRLEN newlen)

sv_inc

Auto-increment of the value in the SV, doing string to numeric conversion if necessary. Handles 'get' magic.

SV にある値の自動インクリメントを行います; もし必要なら、文字列から数値への変換を行います。 'get' magic をハンドルします。

        void    sv_inc(SV* sv)

sv_insert

Inserts a string at the specified offset/length within the SV. Similar to the Perl substr() function. Handles get magic.

文字列を、SV 中の指定されたオフセット/長さの位置に挿入します。 Perl の substr() 関数と同様のものです。 get magic をハンドルします。

        void    sv_insert(SV *bigstr, STRLEN offset, STRLEN len, const char *little, STRLEN littlelen)

sv_insert_flags

Same as sv_insert, but the extra flags are passed the SvPV_force_flags that applies to bigstr.

sv_insert と同様ですが追加の flags が bigstr に適用される SvPV_force_flags に渡されます。

        void    sv_insert_flags(SV *const bigstr, const STRLEN offset, const STRLEN len, const char *const little, const STRLEN littlelen, const U32 flags)

sv_isa

Returns a boolean indicating whether the SV is blessed into the specified class. This does not check for subtypes; use sv_derived_from to verify an inheritance relationship.

SV が指定したクラスに bless されているかどうかを表わす真偽値を 返します。 これは、subtype をどのようにチェックするかを知らないので、 継承関係に確認するのに sv_derived_from を使います。

        int     sv_isa(SV* sv, const char* name)

sv_isobject

Returns a boolean indicating whether the SV is an RV pointing to a blessed object. If the SV is not an RV, or if the object is not blessed, then this will return false.

SV が、bless されているオブジェクトを指す RV であるかどうかを表わす 真偽値を返します。 SV が RV でない場合、もしくはオブジェクトが bless されていない場合にはこれは false を返します。

        int     sv_isobject(SV* sv)

sv_len

Returns the length of the string in the SV. Handles magic and type coercion. See also SvCUR, which gives raw access to the xpv_cur slot.

SV にある文字列の長さを返します。 magic と型強制をハンドルします。 xpv_cur スロットへの生アクセスを提供する SvCUR も参照してください。

        STRLEN  sv_len(SV* sv)

sv_len_utf8

Returns the number of characters in the string in an SV, counting wide UTF-8 bytes as a single character. Handles magic and type coercion.

SV にある文字列の文字数を返します; ワイド UTF-8 バイトは一文字として 数えます。 magic と型強制をハンドルします。

        STRLEN  sv_len_utf8(SV* sv)

sv_magic

Adds magic to an SV. First upgrades sv to type SVt_PVMG if necessary, then adds a new magic item of type how to the head of the magic list.

SV に magic を追加します。 必要ならまず sv を型 SVt_PVMG に昇格して、それから magic リストの 先頭に型 how の新しい magic アイテムを追加します。

See sv_magicext (which sv_magic now calls) for a description of the handling of the name and namlen arguments.

name と namlen 引数の扱いに関する記述については (sv_magic が 呼び出す) sv_magicext を参照してください。

You need to use sv_magicext to add magic to SvREADONLY SVs and also to add more than one instance of the same 'how'.

SvREADONLY SV に magic を追加したり同じ 'how' の複数の実体を追加するには sv_magicext を使う必要があります。

        void    sv_magic(SV* sv, SV* obj, int how, const char* name, I32 namlen)

sv_magicext

Adds magic to an SV, upgrading it if necessary. Applies the supplied vtable and returns a pointer to the magic added.

SV に magic を追加して、必要なら昇格させます。 提供された vtable を適用して、追加した magic へのポインタを返します。

Note that sv_magicext will allow things that sv_magic will not. In particular, you can add magic to SvREADONLY SVs, and add more than one instance of the same 'how'.

sv_magicext は、sv_magic が出来ないことが出来ると言うことに 注意してください。 特に、SvREADONLY SV に magic を追加したり、同じ 'how' の複数の実体を 追加したりできます。

If namlen is greater than zero then a savepvn copy of name is stored, if namlen is zero then name is stored as-is and - as another special case - if (name && namlen == HEf_SVKEY) then name is assumed to contain an SV* and is stored as-is with its REFCNT incremented.

namlen がゼロ以上なら、savepvn に name の コピー が保管されます; namlen がゼロなら name はそのまま保管されて - もう一つの特殊な 場合として - (name && namlen == HEf_SVKEY) なら name は SV* を 含んでいるものと仮定されて、その REFCNT をインクリメントして、そのまま 保管されます。

(This is now used as a subroutine by sv_magic.)

(これは今では sv_magic によってサブルーチンとして使われます。)

        MAGIC * sv_magicext(SV* sv, SV* obj, int how, const MGVTBL *vtbl, const char* name, I32 namlen)

sv_mortalcopy

Creates a new SV which is a copy of the original SV (using sv_setsv). The new SV is marked as mortal. It will be destroyed "soon", either by an explicit call to FREETMPS, or by an implicit call at places such as statement boundaries. See also sv_newmortal and sv_2mortal.

(sv_setsv を使って)元の SV のコピーである、新しい SV を生成します。 生成された SV は揮発性である目印が付けられます。 これは FREETMPS の明示的な呼び出しか、文の境界のような場所での暗黙の 呼び出しによって「すぐに」破壊されます。 sv_newmortal と sv_2mortal も参照してください。

        SV*     sv_mortalcopy(SV* oldsv)

sv_newmortal

Creates a new null SV which is mortal. The reference count of the SV is set to 1. It will be destroyed "soon", either by an explicit call to FREETMPS, or by an implicit call at places such as statement boundaries. See also sv_mortalcopy and sv_2mortal.

揮発性である新たな null SV を生成します。 新たに作られた SV の参照カウントは 1 に設定されます。 これは FREETMPS の明示的な呼び出しか、文の境界のような場所での暗黙の 呼び出しによって「すぐに」破壊されます。 sv_mortalcopy と sv_2mortal も参照してください。

        SV*     sv_newmortal()

sv_newref

Increment an SV's reference count. Use the SvREFCNT_inc() wrapper instead.

SV の参照カウントをインクリメントします。 代わりに SvREFCNT_inc() ラッパーを使ってください。

        SV*     sv_newref(SV* sv)

sv_pos_b2u

Converts the value pointed to by offsetp from a count of bytes from the start of the string, to a count of the equivalent number of UTF-8 chars. Handles magic and type coercion.

文字列の先頭からバイト数で offsetp 離れたところから、UTF-8 文字として等価な 数の分だけ変換します。 magic と型強制をハンドルします。

        void    sv_pos_b2u(SV* sv, I32* offsetp)

sv_pos_u2b

Converts the value pointed to by offsetp from a count of UTF-8 chars from the start of the string, to a count of the equivalent number of bytes; if lenp is non-zero, it does the same to lenp, but this time starting from the offset, rather than from the start of the string. Handles magic and type coercion.

文字列の先頭から UTF-8 の文字数で offsetp 離れたところから、 等価なバイト数の分だけのところまでの値を変換します; lenp が非ゼロなら、これは lenp と同じですが、この場合は文字列の 先頭からではなく offset から始めます。 magic と型強制をハンドルします。

        void    sv_pos_u2b(SV* sv, I32* offsetp, I32* lenp)

sv_pvbyten_force

The backend for the SvPVbytex_force macro. Always use the macro instead.

SvPVbytex_force マクロのバックエンドです。 代わりに、常にマクロを使ってください。

        char*   sv_pvbyten_force(SV* sv, STRLEN* lp)

sv_pvn_force

Get a sensible string out of the SV somehow. A private implementation of the SvPV_force macro for compilers which can't cope with complex macro expressions. Always use the macro instead.

SV から何か識別できる文字列を取り出します。 複雑なマクロ式を扱えないコンパイラのための、SvPV_force マクロの プライベート実装です。 代わりに、常にマクロを使ってください。

        char*   sv_pvn_force(SV* sv, STRLEN* lp)

sv_pvn_force_flags

Get a sensible string out of the SV somehow. If flags has SV_GMAGIC bit set, will mg_get on sv if appropriate, else not. sv_pvn_force and sv_pvn_force_nomg are implemented in terms of this function. You normally want to use the various wrapper macros instead: see SvPV_force and SvPV_force_nomg

SV から何か識別できる文字列を取り出します。 flags の SV_GMAGIC ビットがセットされていると、適切なら sv に mg_get し、さもなければしません。 sv_pvn_force と sv_pvn_force_nomg はこの関数に関して実装されています。 通常は代わりに様々なラッパーマクロを使いたいでしょう: SvPV_force と SvPV_force_nomg を参照してください。

        char*   sv_pvn_force_flags(SV* sv, STRLEN* lp, I32 flags)

sv_pvutf8n_force

The backend for the SvPVutf8x_force macro. Always use the macro instead.

SvPVutf8x_force マクロのバックエンドです。 代わりに、常にマクロを使ってください。

        char*   sv_pvutf8n_force(SV* sv, STRLEN* lp)

sv_reftype

Returns a string describing what the SV is a reference to.

SV がリファレンスしているものを記述した文字列を返します。

        const char*     sv_reftype(const SV* sv, int ob)

sv_replace

Make the first argument a copy of the second, then delete the original. The target SV physically takes over ownership of the body of the source SV and inherits its flags; however, the target keeps any magic it owns, and any magic in the source is discarded. Note that this is a rather specialist SV copying operation; most of the time you'll want to use sv_setsv or one of its many macro front-ends.

最初の引数を二つ目の引数のコピーにして、元のデータを削除します。 ターゲット SV は物理的にソース SV のボディの所有権を受け取って、フラグを 継承します; しかし、ターゲットは magic を保持したままで、ソースの magic は 捨てられます。 これは特殊な SV コピー操作であることに注意してください; ほとんどの場合 sv_setsv か多くのこれのマクロフロントエンドを使いたいでしょう。

        void    sv_replace(SV* sv, SV* nsv)

sv_reset

Underlying implementation for the reset Perl function. Note that the perl-level function is vaguely deprecated.

reset Perl 関数の基礎となる実装です。 perl レベルの関数は漠然と廃止予定であることに注意してください。

        void    sv_reset(const char* s, HV* stash)

sv_rvweaken

Weaken a reference: set the SvWEAKREF flag on this RV; give the referred-to SV PERL_MAGIC_backref magic if it hasn't already; and push a back-reference to this RV onto the array of backreferences associated with that magic. If the RV is magical, set magic will be called after the RV is cleared.

参照を弱めます: この RV の SvWEAKREF フラグをセットします; まだなければ 参照されている SB に PERL_MAGIC_backref magic を与えます; そしてこの RV への後方参照を magic と関連づけられた後方参照の配列に プッシュします。 RV がマジカルなら、set magic は RV がクリアした後呼び出されます。

        SV*     sv_rvweaken(SV *sv)

sv_setiv

Copies an integer into the given SV, upgrading first if necessary. Does not handle 'set' magic. See also sv_setiv_mg.

整数を与えられた SV へコピーします; 必要なら最初に昇格します。 'set' magic をハンドルしません。 sv_setiv_mg も参照してください。

        void    sv_setiv(SV* sv, IV num)

sv_setiv_mg

Like sv_setiv, but also handles 'set' magic.

sv_setiv と同様ですが、'set' magic をハンドルします。

        void    sv_setiv_mg(SV *sv, IV i)

sv_setnv

Copies a double into the given SV, upgrading first if necessary. Does not handle 'set' magic. See also sv_setnv_mg.

倍精度浮動小数点数を与えられた SV へコピーします; 必要なら最初に昇格します。 'set' magic をハンドルしません。 sv_setnv_mg も参照してください。

        void    sv_setnv(SV* sv, NV num)

sv_setnv_mg

Like sv_setnv, but also handles 'set' magic.

sv_setnv と同様ですが、'set' magic をハンドルします。

        void    sv_setnv_mg(SV *sv, NV num)

sv_setpv

Copies a string into an SV. The string must be null-terminated. Does not handle 'set' magic. See sv_setpv_mg.

文字列を SV へコピーします。 文字列は null で終端されていなければなりません。 'set' magic をハンドルしません。 sv_setpv_mg を参照してください。

        void    sv_setpv(SV* sv, const char* ptr)

sv_setpvf

Works like sv_catpvf but copies the text into the SV instead of appending it. Does not handle 'set' magic. See sv_setpvf_mg.

sv_catpvf のように動作しますが、SV にテキストを追加するのではなく コピーします。 'set' magic をハンドルしません。 sv_setpvf_mg を参照してください。

        void    sv_setpvf(SV* sv, const char* pat, ...)

sv_setpvf_mg

Like sv_setpvf, but also handles 'set' magic.

sv_setpvf と同様ですが、'set' magic をハンドルします。

        void    sv_setpvf_mg(SV *sv, const char* pat, ...)

sv_setpviv

Copies an integer into the given SV, also updating its string value. Does not handle 'set' magic. See sv_setpviv_mg.

整数値を与えられた SV をコピーし、同様にその文字列値を更新します。 'set' magic をハンドルしません。 sv_setpviv_mg を参照してください。

        void    sv_setpviv(SV* sv, IV num)

sv_setpviv_mg

Like sv_setpviv, but also handles 'set' magic.

sv_setpviv と同様ですが、'set' magic をハンドルします。

        void    sv_setpviv_mg(SV *sv, IV iv)

sv_setpvn

Copies a string into an SV. The len parameter indicates the number of bytes to be copied. If the ptr argument is NULL the SV will become undefined. Does not handle 'set' magic. See sv_setpvn_mg.

文字列を SV へコピーします。 パラメーター len はコピーされるバイト数を指示します。 ptr 引数が NULL なら SV は未定義値になります。 'set' magic をハンドルしません。 sv_setpvn_mg を参照してください。

        void    sv_setpvn(SV* sv, const char* ptr, STRLEN len)

sv_setpvn_mg

Like sv_setpvn, but also handles 'set' magic.

sv_setpvn と同様ですが、'set' magic をハンドルします。

        void    sv_setpvn_mg(SV *sv, const char *ptr, STRLEN len)

sv_setpvs

Like sv_setpvn, but takes a literal string instead of a string/length pair.

sv_setpvn と同様ですが、文字列/長さの組ではなく、リテラルな文字列を 取ります。

        void    sv_setpvs(SV* sv, const char* s)

sv_setpv_mg

Like sv_setpv, but also handles 'set' magic.

sv_setpv と同様ですが、'set' magic をハンドルします。

        void    sv_setpv_mg(SV *sv, const char *ptr)

sv_setref_iv

Copies an integer into a new SV, optionally blessing the SV. The rv argument will be upgraded to an RV. That RV will be modified to point to the new SV. The classname argument indicates the package for the blessing. Set classname to NULL to avoid the blessing. The new SV will have a reference count of 1, and the RV will be returned.

整数値を、bless することもできる新たな SV へコピーします。 引数 rv は RV へと昇格します。 この RV は新たな SV を指し示すように変更されます。 引数 classname は bless するパッケージを指示するものです。 bless をしないためには、classname に NULL をセットします。 新しい SV の参照カウントは 1 となり、RV が返されます。

        SV*     sv_setref_iv(SV* rv, const char* classname, IV iv)

sv_setref_nv

Copies a double into a new SV, optionally blessing the SV. The rv argument will be upgraded to an RV. That RV will be modified to point to the new SV. The classname argument indicates the package for the blessing. Set classname to NULL to avoid the blessing. The new SV will have a reference count of 1, and the RV will be returned.

倍精度実数値を、bless することもできる新たな SV へコピーします。 引数 rv は RV へと昇格します。 この RV は新たな SV を指し示すように変更されます。 引数 classname は bless するパッケージを指示するものです。 bless をしないためには、classname に NULL をセットします。 新しい SV の参照カウントは 1 となり、RV が返されます。

        SV*     sv_setref_nv(SV* rv, const char* classname, NV nv)

sv_setref_pv

Copies a pointer into a new SV, optionally blessing the SV. The rv argument will be upgraded to an RV. That RV will be modified to point to the new SV. If the pv argument is NULL then PL_sv_undef will be placed into the SV. The classname argument indicates the package for the blessing. Set classname to NULL to avoid the blessing. The new SV will have a reference count of 1, and the RV will be returned.

ポインタを、bless することもできる新たな SV へコピーします。 引数 rv は RV へと昇格します。 この RV は新たな SV を指し示すように変更されます。 引数 pv が NULL であれば、PL_sv_undef が新たな SV に格納されます。 引数 classname は bless するパッケージを指示するものです。 bless をしないためには、classname に NULL をセットします。 新しい SV の参照カウントは 1 となり、RV が返されます。

Do not use with other Perl types such as HV, AV, SV, CV, because those objects will become corrupted by the pointer copy process.

HV, AV, SV, CV のような Perl の他の type を使わないようにしてください; これは、そういったオブジェクトにポインタのコピー処理を 行うことでおかしくなってしまうからです。

Note that sv_setref_pvn copies the string while this copies the pointer.

sv_setref_pvn は、このポインタのコピーではなく文字列を コピーしているということに注意してください。

        SV*     sv_setref_pv(SV* rv, const char* classname, void* pv)

sv_setref_pvn

Copies a string into a new SV, optionally blessing the SV. The length of the string must be specified with n. The rv argument will be upgraded to an RV. That RV will be modified to point to the new SV. The classname argument indicates the package for the blessing. Set classname to NULL to avoid the blessing. The new SV will have a reference count of 1, and the RV will be returned.

文字列を、bless することもできる新たな SV へコピーします。 文字列の長さを n で指定しなければなりません。 引数 rv は RV へと昇格します。 この RV は新たな SV を指し示すように変更されます。 引数 classname は bless するパッケージを指示するものです。 bless をしないためには、classname に NULL をセットします。 新しい SV の参照カウントは 1 となり、RV が返されます。

Note that sv_setref_pv copies the pointer while this copies the string.

sv_setref_pv は、文字列をコピーするのではなくポインタを コピーするということに注意してください。

        SV*     sv_setref_pvn(SV* rv, const char* classname, const char* pv, STRLEN n)

sv_setref_uv

Copies an unsigned integer into a new SV, optionally blessing the SV. The rv argument will be upgraded to an RV. That RV will be modified to point to the new SV. The classname argument indicates the package for the blessing. Set classname to NULL to avoid the blessing. The new SV will have a reference count of 1, and the RV will be returned.

整数値を、bless することもできる新たな SV へコピーします。 引数 rv は RV へと昇格します。 この RV は新たな SV を指し示すように変更されます。 引数 classname は bless するパッケージを指示するものです。 bless をしないためには、classname に NULL をセットします。 新しい SV の参照カウントは 1 となり、RV が返されます。

        SV*     sv_setref_uv(SV* rv, const char* classname, UV uv)

sv_setsv

Copies the contents of the source SV ssv into the destination SV dsv. The source SV may be destroyed if it is mortal, so don't use this function if the source SV needs to be reused. Does not handle 'set' magic. Loosely speaking, it performs a copy-by-value, obliterating any previous content of the destination.

送り元の SV ssv の内容を、送り先の SV dsv にコピーします。 送り元の SV は、それが揮発性であった場合には破壊されるかもしれません; 従ってソース SV を再利用する必要がある場合にはこの関数は使わないでください。 'set' magic をハンドルしません。 大まかに言うと、送り先の以前の内容を消して、値としてのコピーを行います。

You probably want to use one of the assortment of wrappers, such as SvSetSV, SvSetSV_nosteal, SvSetMagicSV and SvSetMagicSV_nosteal.

おそらく SvSetSV, SvSetSV_nosteal, SvSetMagicSV, SvSetMagicSV_nosteal のようなラッパーの一つを使いたいでしょう。

        void    sv_setsv(SV *dstr, SV *sstr)

sv_setsv_flags

Copies the contents of the source SV ssv into the destination SV dsv. The source SV may be destroyed if it is mortal, so don't use this function if the source SV needs to be reused. Does not handle 'set' magic. Loosely speaking, it performs a copy-by-value, obliterating any previous content of the destination. If the flags parameter has the SV_GMAGIC bit set, will mg_get on ssv if appropriate, else not. If the flags parameter has the NOSTEAL bit set then the buffers of temps will not be stolen. <sv_setsv> and sv_setsv_nomg are implemented in terms of this function.

送り元の SV ssv の内容を、送り先の SV dsv にコピーします。 送り元の SV は、それが揮発性であった場合には破壊されるかもしれません; 従って ソース SV を再利用する必要がある場合にはこの関数は使わないでください 'set' magic をハンドルしません。 大まかに言うと、送り先の以前の内容を消して、値としてのコピーを行います。 flags の SV_GMAGIC ビットがセットされていると、適切なら ssv に mg_get し、さもなければしません。 flags 引数の NOSTEAL ビットがセットされているなら、temps の バッファは盗まれません。 <sv_setsv> と sv_setsv_nomg はこの関数に関して実装されています。

You probably want to use one of the assortment of wrappers, such as SvSetSV, SvSetSV_nosteal, SvSetMagicSV and SvSetMagicSV_nosteal.

おそらく SvSetSV, SvSetSV_nosteal, SvSetMagicSV, SvSetMagicSV_nosteal のようなラッパーの一つを使いたいでしょう。

This is the primary function for copying scalars, and most other copy-ish functions and macros use this underneath.

これはスカラをコピーする基本的な関数で、その他のほとんどのコピー的な 関数とマクロは基礎としてこれを使っています。

        void    sv_setsv_flags(SV *dstr, SV *sstr, I32 flags)

sv_setsv_mg

Like sv_setsv, but also handles 'set' magic.

sv_setsv と同様ですが、'set' magic をハンドルします。

        void    sv_setsv_mg(SV *dstr, SV *sstr)

sv_setuv

Copies an unsigned integer into the given SV, upgrading first if necessary. Does not handle 'set' magic. See also sv_setuv_mg.

符号なし整数を与えられた SV へコピーします; 必要ならまず昇格します。 'set' magic をハンドルしません。 sv_setuv_mg も参照してください。

        void    sv_setuv(SV* sv, UV num)

sv_setuv_mg

Like sv_setuv, but also handles 'set' magic.

sv_setsv と同様ですが、'set' magic をハンドルします。

        void    sv_setuv_mg(SV *sv, UV u)

sv_tainted

Test an SV for taintedness. Use SvTAINTED instead.

SV の汚染を調べます。 代わりに SvTAINTED を使ってください。

        bool    sv_tainted(SV* sv)

sv_true

Returns true if the SV has a true value by Perl's rules. Use the SvTRUE macro instead, which may call sv_true() or may instead use an in-line version.

SV が Perl の規則で真の値を持っていれば真を返します。 sv_true() を呼び出すかも知れないし代わりにインライン版を使うかも知れない SvTRUE マクロを代わりに使ってください。

        I32     sv_true(SV *sv)

sv_unmagic

Removes all magic of type type from an SV.

SV から type 型の全ての magic を取り除きます。

        int     sv_unmagic(SV* sv, int type)

sv_unref_flags

Unsets the RV status of the SV, and decrements the reference count of whatever was being referenced by the RV. This can almost be thought of as a reversal of newSVrv. The cflags argument can contain SV_IMMEDIATE_UNREF to force the reference count to be decremented (otherwise the decrementing is conditional on the reference count being different from one or the reference being a readonly SV). See SvROK_off.

SV の RV ステータスをアンセットし、RV によって参照されているものの 参照カウントを減じます。 これは newSVrv の反転したものであると考えられます。 cflags 引数は、参照カウントをデクリメントすることを強制するために SV_IMMEDIATE_UNREF を含むことができます (さもなければデクリメントは参照カウントが 1 ではないか、読み込み専用 SV を 参照しているという条件で行われます)。 SvROK_off を参照してください。

        void    sv_unref_flags(SV *ref, U32 flags)

sv_untaint

Untaint an SV. Use SvTAINTED_off instead.

SV を被汚染化します。 代わりに SvTAINTED_off を使ってください。

        void    sv_untaint(SV* sv)

sv_upgrade

Upgrade an SV to a more complex form. Generally adds a new body type to the SV, then copies across as much information as possible from the old body. You generally want to use the SvUPGRADE macro wrapper. See also svtype.

SV をより複雑な形式へと昇格させます。 一般的に新しいボディ型を SV に追加して、古いボディから出来るだけ多くの情報を コピーします。 一般的には SvUPGRADE マクロラッパーを使いたいでしょう。 svtype も参照してください。

        void    sv_upgrade(SV* sv, svtype new_type)

sv_usepvn_flags

Tells an SV to use ptr to find its string value. Normally the string is stored inside the SV but sv_usepvn allows the SV to use an outside string. The ptr should point to memory that was allocated by malloc. The string length, len, must be supplied. By default this function will realloc (i.e. move) the memory pointed to by ptr, so that pointer should not be freed or used by the programmer after giving it to sv_usepvn, and neither should any pointers from "behind" that pointer (e.g. ptr + 1) be used.

自身の文字列値を得るのに ptr を使うように SV に指示します。 通常文字列は SV の内側に保管されますが、sv_usepvn によって SV が外側の 文字列を使えるようにできます。 ptr は malloc によって割り当てられたメモリを指しているべきです。 文字列の長さ len を指定しなければなりません。 デフォルトではこの関数は ptr で指されているメモリを realloc (つまり移動) するので、ポインタは sv_usepvn に与えられた後で解放されたりプログラマによって 使われたりするべきではありませんし、このポインタの「背後」(例えば ptr + 1) からのポインタを使うべきではありません。

If flags & SV_SMAGIC is true, will call SvSETMAGIC. If flags & SV_HAS_TRAILING_NUL is true, then ptr[len] must be NUL, and the realloc will be skipped. (i.e. the buffer is actually at least 1 byte longer than len, and already meets the requirements for storing in SvPVX)

flags & SV_SMAGIC が真なら、SvSETMAGIC を呼び出します。 flags & SV_HAS_TRAILING_NUL が真なら、ptr[len] は NUL で なければならず、realloc はスキップされます。 (つまりバッファは実際には少なくとも len より 1 バイト長く、既に SvPVX を保管する条件を満たしています。)

        void    sv_usepvn_flags(SV* sv, char* ptr, STRLEN len, U32 flags)

sv_utf8_decode

If the PV of the SV is an octet sequence in UTF-8 and contains a multiple-byte character, the SvUTF8 flag is turned on so that it looks like a character. If the PV contains only single-byte characters, the SvUTF8 flag stays being off. Scans PV for validity and returns false if the PV is invalid UTF-8.

SV の PV が UTF-8 のオクテット並びで複数バイト文字を含んでいるなら、 文字のように見えるように SvUTF8 フラグがオンになります。 PV が単一バイト文字だけを含んでいるなら、SvUTF8 フラグはオフのママです。 PV の妥当性をスキャンして、PV が妥当な UTF-8 ではないなら偽を返します。

NOTE: this function is experimental and may change or be removed without notice.

注意: この関数は実験的で、予告なしに変更あるいは削除されるかもしれません。

        bool    sv_utf8_decode(SV *sv)

sv_utf8_downgrade

Attempts to convert the PV of an SV from characters to bytes. If the PV contains a character that cannot fit in a byte, this conversion will fail; in this case, either returns false or, if fail_ok is not true, croaks.

SV の PV を文字からバイトに変換しようとします。 PV にバイトに収まらない文字が含まれているなら、この変換は失敗します; この場合、偽を返すか、fail_ok が真でないなら、croak します。

This is not as a general purpose Unicode to byte encoding interface: use the Encode extension for that.

これは汎用の Unicode からバイトエンコーディングへのインターフェースでは ありません: そのような目的には Encode エクステンションを使ってください。

NOTE: this function is experimental and may change or be removed without notice.

注意: この関数は実験的で、予告なしに変更あるいは削除されるかもしれません。

        bool    sv_utf8_downgrade(SV *sv, bool fail_ok)

sv_utf8_encode

Converts the PV of an SV to UTF-8, but then turns the SvUTF8 flag off so that it looks like octets again.

SV の PV を UTF-8 に変換しますが、再びオクテットのように見えるように SvUTF8 フラグをオフにします。

        void    sv_utf8_encode(SV *sv)

sv_utf8_upgrade

Converts the PV of an SV to its UTF-8-encoded form. Forces the SV to string form if it is not already. Will mg_get on sv if appropriate. Always sets the SvUTF8 flag to avoid future validity checks even if the whole string is the same in UTF-8 as not. Returns the number of bytes in the converted string

SV の PV を UTF-8 エンコードされた形式に変換します。 もしまだ行われていなければ、SV を文字列形式に強制します。 例え文字列全体が UTF-8 で同じでも、将来の正当性チェックを 避けるために、常に SvUTF8 フラグがセットされます。 変換した文字列のバイト数を返します。

This is not as a general purpose byte encoding to Unicode interface: use the Encode extension for that.

これは汎用のバイトエンコーディングから Unicode へのインターフェースでは ありません: そのような目的には Encode エクステンションを使ってください。

        STRLEN  sv_utf8_upgrade(SV *sv)

sv_utf8_upgrade_flags

Converts the PV of an SV to its UTF-8-encoded form. Forces the SV to string form if it is not already. Always sets the SvUTF8 flag to avoid future validity checks even if all the bytes are invariant in UTF-8. If flags has SV_GMAGIC bit set, will mg_get on sv if appropriate, else not. Returns the number of bytes in the converted string sv_utf8_upgrade and sv_utf8_upgrade_nomg are implemented in terms of this function.

SV の PV を UTF-8 エンコードされた形式に変換します。 もしまだ行われていなければ、SV を文字列形式に強制します。 例え全てのバイトが UTF-8 と変わらなくても、将来の正当性チェックを 避けるために、常に SvUTF8 フラグがセットされます。 flags の SV_GMAGIC ビットがセットされていると、適切なら sv に mg_get し、さもなければしません。 変換した文字列のバイト数を返します。 sv_utf8_upgrade と sv_utf8_upgrade_nomg はこの関数に関して 実装されています。

This is not as a general purpose byte encoding to Unicode interface: use the Encode extension for that.

これは汎用のバイトエンコーディングから Unicode へのインターフェースでは ありません: そのような目的には Encode エクステンションを使ってください。

        STRLEN  sv_utf8_upgrade_flags(SV *sv, I32 flags)

sv_utf8_upgrade_nomg

Like sv_utf8_upgrade, but doesn't do magic on sv

sv_utf8_upgrade と同様ですが、sv に対してマジックを実行しません。

        STRLEN  sv_utf8_upgrade_nomg(SV *sv)

sv_vcatpvf

Processes its arguments like vsprintf and appends the formatted output to an SV. Does not handle 'set' magic. See sv_vcatpvf_mg.

引数を vsprintf のように処理してフォーマットした出力を SV に追加します。 'set' magic をハンドルしません。 sv_vcatpvf_mg を参照してください。

Usually used via its frontend sv_catpvf.

普通はフロントエンドである sv_catpvf 経由で使われます。

        void    sv_vcatpvf(SV* sv, const char* pat, va_list* args)

sv_vcatpvfn

Processes its arguments like vsprintf and appends the formatted output to an SV. Uses an array of SVs if the C style variable argument list is missing (NULL). When running with taint checks enabled, indicates via maybe_tainted if results are untrustworthy (often due to the use of locales).

引数を vsprintf のように処理してフォーマットした出力を SV に追加します。 C スタイルの変数引数リストがない(NULL)場合には Sv の配列を使用します。 汚染チェックが有効の状態で実行すると、(しばしばロケールの使用によって 結果が信頼できないものなら、maybe_tainted 経由で示します。

Usually used via one of its frontends sv_vcatpvf and sv_vcatpvf_mg.

普通はフロントエンドである sv_vcatpvf や sv_vcatpvf_mg 経由で 使われます。

        void    sv_vcatpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)

sv_vcatpvf_mg

Like sv_vcatpvf, but also handles 'set' magic.

sv_vcatpvf と同様ですが、'set' magic をハンドルします。

Usually used via its frontend sv_catpvf_mg.

普通はフロントエンドである sv_catpvf_mg 経由で使われます。

        void    sv_vcatpvf_mg(SV* sv, const char* pat, va_list* args)

sv_vsetpvf

Works like sv_vcatpvf but copies the text into the SV instead of appending it. Does not handle 'set' magic. See sv_vsetpvf_mg.

sv_vcatpvf と同様に動作しますが、追加するのではなく SV にテキストを コピーします。 'set' magic をハンドルしません。 sv_vsetpvf_mg を参照してください。

Usually used via its frontend sv_setpvf.

普通はフロントエンドである sv_setpvf 経由で使われます。

        void    sv_vsetpvf(SV* sv, const char* pat, va_list* args)

sv_vsetpvfn

Works like sv_vcatpvfn but copies the text into the SV instead of appending it.

vatpvfn のように動作しますが、SV にテキストを追加するのではなく コピーします。

Usually used via one of its frontends sv_vsetpvf and sv_vsetpvf_mg.

普通はフロントエンドである sv_vsetpvf や sv_vsetpvf_mg 経由で 使われます。

        void    sv_vsetpvfn(SV* sv, const char* pat, STRLEN patlen, va_list* args, SV** svargs, I32 svmax, bool *maybe_tainted)

sv_vsetpvf_mg

Like sv_vsetpvf, but also handles 'set' magic.

sv_vsetpvf と同様ですが、'set' magic をハンドルします。

Usually used via its frontend sv_setpvf_mg.

普通はフロントエンドである sv_setpvf_mg 経由で使われます。

        void    sv_vsetpvf_mg(SV* sv, const char* pat, va_list* args)

Unicode 対応¶

bytes_from_utf8

Converts a string s of length len from UTF-8 into native byte encoding. Unlike utf8_to_bytes but like bytes_to_utf8, returns a pointer to the newly-created string, and updates len to contain the new length. Returns the original string if no conversion occurs, len is unchanged. Do nothing if is_utf8 points to 0. Sets is_utf8 to 0 if s is converted or consisted entirely of characters that are invariant in utf8 (i.e., US-ASCII on non-EBCDIC machines).

長さ len の文字列 s を UTF-8 からネイティブなバイトエンコーディングに 変換します。 utf8_to_bytes と異なりますが bytes_to_utf8 と同様、 新しく作成された文字列へのポインタを返し、len を新しい長さで更新します。 変換が行われなければ元の文字列を返し、len は変更されません。 is_utf8 が 0 を指しているなら何もしません。 s が変換されたか、utf8 でも変わらない文字だけで構成されているなら (つまり非 EBCDIC マシンでの US-ASCII なら) is_utf8 を 0 にセットします。

NOTE: this function is experimental and may change or be removed without notice.

注意: この関数は実験的で、予告なしに変更あるいは削除されるかもしれません。

        U8*     bytes_from_utf8(const U8 *s, STRLEN *len, bool *is_utf8)

bytes_to_utf8

Converts a string s of length len from the native encoding into UTF-8. Returns a pointer to the newly-created string, and sets len to reflect the new length.

長さ len の文字列 s を、ネイティブなエンコーディングから UTF-8 エンコーディングに変換します。 新しく作成された文字列へのポインタを返し、len に新しい長さを 反映させます。

A NUL character will be written after the end of the string.

文字列の末尾に NUL 文字が書かれます。

If you want to convert to UTF-8 from encodings other than the native (Latin1 or EBCDIC), see sv_recode_to_utf8().

ネイティブ以外のエンコーディング (Latin1 または EBCDIC) から UTF-8 に 変換したいなら、sv_recode_to_utf8() を参照してください。

NOTE: this function is experimental and may change or be removed without notice.

注意: この関数は実験的で、予告なしに変更あるいは削除されるかもしれません。

        U8*     bytes_to_utf8(const U8 *s, STRLEN *len)

ibcmp_utf8

Return true if the strings s1 and s2 differ case-insensitively, false if not (if they are equal case-insensitively). If u1 is true, the string s1 is assumed to be in UTF-8-encoded Unicode. If u2 is true, the string s2 is assumed to be in UTF-8-encoded Unicode. If u1 or u2 are false, the respective string is assumed to be in native 8-bit encoding.

文字列 s1 と s2 が大文字小文字を無視しても違いがあれば真を返し、 さもなければ (大文字小文字を無視して同じなら) 偽を返します。 u1 が真なら、文字列 s1 は UTF-8 エンコードされた Unicode であると 仮定されます。 u2 が真なら、文字列 s2 は UTF-8 エンコードされた Unicode であると 仮定されます。 u1 か u2 が偽なら、対応する文字列はネイティブな 8 ビットエンコーディングで あると仮定されます。

If the pe1 and pe2 are non-NULL, the scanning pointers will be copied in there (they will point at the beginning of the next character). If the pointers behind pe1 or pe2 are non-NULL, they are the end pointers beyond which scanning will not continue under any circumstances. If the byte lengths l1 and l2 are non-zero, s1+l1 and s2+l2 will be used as goal end pointers that will also stop the scan, and which qualify towards defining a successful match: all the scans that define an explicit length must reach their goal pointers for a match to succeed).

pe1 と pe2 が非 NULL なら、スキャンポインタはここにコピーされます (これらは next 文字の先頭を指します)。 pe1 または pe2 の背後のポインタが非 NULL なら、これらはどのような場合でも スキャンが継続されないエンドポインタです。 バイト長 l1 と l2 が非ゼロなら、s1+l1 と s2+l2 がスキャンを停止して 成功したマッチングを定義するための条件となるゴール端ポインタとして 使われます: 明示的な長さを定義した全てのスキャンはマッチングが 成功するためにゴールポインタに到達しなければなりません)。

For case-insensitiveness, the "casefolding" of Unicode is used instead of upper/lowercasing both the characters, see http://www.unicode.org/unicode/reports/tr21/ (Case Mappings).

大文字小文字の虫に関して、Unicode の「畳み込み化」は文字の大文字化/小文字化の 両方の代わりに使われます; http://www.unicode.org/unicode/reports/tr21/ (Case Mappings) を 参照してください。

        I32     ibcmp_utf8(const char *s1, char **pe1, UV l1, bool u1, const char *s2, char **pe2, UV l2, bool u2)

is_utf8_char

Tests if some arbitrary number of bytes begins in a valid UTF-8 character. Note that an INVARIANT (i.e. ASCII on non-EBCDIC machines) character is a valid UTF-8 character. The actual number of bytes in the UTF-8 character will be returned if it is valid, otherwise 0.

任意の数のバイト列が妥当な UTF-8 文字から始まるかどうかをテストします。 INVARIANT (つまり 非 EBCDIC マシンでは ASCII) は妥当な UTF-8 文字であることに 注意してください。 妥当であれば UTF-8 文字の実際のバイト数が返され、さもなければ 0 が 返されます。

        STRLEN  is_utf8_char(const U8 *s)

is_utf8_string

Returns true if first len bytes of the given string form a valid UTF-8 string, false otherwise. Note that 'a valid UTF-8 string' does not mean 'a string that contains code points above 0x7F encoded in UTF-8' because a valid ASCII string is a valid UTF-8 string.

文字列の最初の len バイトが妥当な UTF-8 文字列なら真を返し、さもなければ 偽を返します。 「妥当な UTF-8 文字列」は「UTF-8 でエンコードされた、0x7F を超える符号位置の 文字を含む文字列」という意味ではないことに注意してください; なぜなら 妥当な ASCII 文字列は妥当な UTF-8 文字列だからです。

See also is_utf8_string_loclen() and is_utf8_string_loc().

is_utf8_string_loclen() と is_utf8_string_loc() も参照してください。

        bool    is_utf8_string(const U8 *s, STRLEN len)

is_utf8_string_loc

Like is_utf8_string() but stores the location of the failure (in the case of "utf8ness failure") or the location s+len (in the case of "utf8ness success") in the ep.

is_utf8_string() と同様ですが、ep に、(「utf8 失敗」の場合)失敗した 位置を、(「utf8 成功」の場合) s+len の位置を保管します。

See also is_utf8_string_loclen() and is_utf8_string().

is_utf8_string_loclen() と is_utf8_string() も参照してください。

        bool    is_utf8_string_loc(const U8 *s, STRLEN len, const U8 **p)

is_utf8_string_loclen

Like is_utf8_string() but stores the location of the failure (in the case of "utf8ness failure") or the location s+len (in the case of "utf8ness success") in the ep, and the number of UTF-8 encoded characters in the el.

is_utf8_string() と同様ですが、ep に、(「utf8 失敗」の場合)失敗した 位置を、(「utf8 成功」の場合) s+len の位置を保管し、UTF-8 エンコードされた 文字の数を el に保管します。

See also is_utf8_string_loc() and is_utf8_string().

is_utf8_string_loc() と is_utf8_string() も参照してください。

        bool    is_utf8_string_loclen(const U8 *s, STRLEN len, const U8 **ep, STRLEN *el)

pv_uni_display

Build to the scalar dsv a displayable version of the string spv, length len, the displayable version being at most pvlim bytes long (if longer, the rest is truncated and "..." will be appended).

スカラ dsv を文字列 spv 長さ len の表示可能なバージョンに構築します; 表示可能なバージョンは最大でも pvlim バイトの長さです (もしより長ければ、 残りは切り詰められて "..." が追加されます)。

The flags argument can have UNI_DISPLAY_ISPRINT set to display isPRINT()able characters as themselves, UNI_DISPLAY_BACKSLASH to display the \\[nrfta\\] as the backslashed versions (like '\n') (UNI_DISPLAY_BACKSLASH is preferred over UNI_DISPLAY_ISPRINT for \\). UNI_DISPLAY_QQ (and its alias UNI_DISPLAY_REGEX) have both UNI_DISPLAY_BACKSLASH and UNI_DISPLAY_ISPRINT turned on.

flags 引数には、isPRINT() 可能な文字をそのまま表示する UNI_DISPLAY_ISPRINT、 \\[nrfta\\] を ('\n' のように) バックスラッシュ版として表示する UNI_DISPLAY_BACKSLASH を含むことができます (UNI_DISPLAY_BACKSLASH は \\ に関して UNI_DISPLAY_ISPRINT より優先されます)。 UNI_DISPLAY_QQ (およびその別名である UNI_DISPLAY_REGEX) は UNI_DISPLAY_BACKSLASH と UNI_DISPLAY_ISPRINT の両方をオンにします。

The pointer to the PV of the dsv is returned.

dsv の PV へのポインタが返されます。

        char*   pv_uni_display(SV *dsv, const U8 *spv, STRLEN len, STRLEN pvlim, UV flags)

sv_cat_decode

The encoding is assumed to be an Encode object, the PV of the ssv is assumed to be octets in that encoding and decoding the input starts from the position which (PV + *offset) pointed to. The dsv will be concatenated the decoded UTF-8 string from ssv. Decoding will terminate when the string tstr appears in decoding output or the input ends on the PV of the ssv. The value which the offset points will be modified to the last input position on the ssv.

encoding は Encode オブジェクトであると仮定して、また ssv の PV は そのエンコーディングのオクテットであると仮定して、入力のデコードは (PV + *offset) が指す位置から開始されます。 dsv は ssv からデコードされた UTF-8 文字列と連結されます。 デコードは文字列 str がデコード出力に現れるか、ssv の PV の入力が 終わったときに終了します。 オフセットが指す値は ssv の最後の入力位置によって修正されます。

Returns TRUE if the terminator was found, else returns FALSE.

終端子が見付かれば TRUE を、さもなければ FALSE を返します。

        bool    sv_cat_decode(SV* dsv, SV *encoding, SV *ssv, int *offset, char* tstr, int tlen)

sv_recode_to_utf8

The encoding is assumed to be an Encode object, on entry the PV of the sv is assumed to be octets in that encoding, and the sv will be converted into Unicode (and UTF-8).

encoding は Encode オブジェクトであると仮定して、また sv の PV のエントリは そのエンコーディングのオクテットであると仮定して、sv を Unicode (と UTF-8) に 変換します。

If the sv already is UTF-8 (or if it is not POK), or if the encoding is not a reference, nothing is done to the sv. If the encoding is not an Encode::XS Encoding object, bad things will happen. (See lib/encoding.pm and Encode).

sv が既に UTF-8 なら(または POK でなければ)、あるいは encoding が リファレンスでなければ、sv に対して何もしません。 encoding が Encode::XS エンコーディングオブジェクトでなければ、 悪いことが起こります。 (lib/encoding.pm と Encode を参照してください)。

The PV of the sv is returned.

sv の PV が返されます。

        char*   sv_recode_to_utf8(SV* sv, SV *encoding)

sv_uni_display

Build to the scalar dsv a displayable version of the scalar sv, the displayable version being at most pvlim bytes long (if longer, the rest is truncated and "..." will be appended).

スカラ dsv をスカラ sv の表示可能なバージョンに構築します; 表示可能な バージョンは最大でも pvlim バイトの長さです (もしより長ければ、残りは 切り詰められて "..." が追加されます)。

The flags argument is as in pv_uni_display().

flags 引数は pv_uni_display() と同様です。

The pointer to the PV of the dsv is returned.

dsv の PV へのポインタが返されます。

        char*   sv_uni_display(SV *dsv, SV *ssv, STRLEN pvlim, UV flags)

to_utf8_case

The "p" contains the pointer to the UTF-8 string encoding the character that is being converted.

"p" は、変換された UTF-8 文字列エンコーディングの文字へのポインタを 含みます。

The "ustrp" is a pointer to the character buffer to put the conversion result to. The "lenp" is a pointer to the length of the result.

"ustrp" は変換結果を入れた文字バッファへのポインタです。 "lenp" は結果の長さへのポインタです。

The "swashp" is a pointer to the swash to use.

"swashp" は使う swash へのポインタです。

Both the special and normal mappings are stored lib/unicore/To/Foo.pl, and loaded by SWASHNEW, using lib/utf8_heavy.pl. The special (usually, but not always, a multicharacter mapping), is tried first.

特殊と通常の両方のマッピングは lib/unicore/To/Foo.pl に保管され、 lib/utf8_heavy.pl を使って SWASHNEW によって読み込まれます。 特殊(普通は複数文字マッピングですが常にそうというわけではありません)を 先に試します。

The "special" is a string like "utf8::ToSpecLower", which means the hash %utf8::ToSpecLower. The access to the hash is through Perl_to_utf8_case().

「特殊」とは、ハッシュ %utf8::ToSpecLower を意味する "utf8::ToSpecLower" のような文字列です。 ハッシュへのアクセスは Perl_to_utf8_case() を通します。

The "normal" is a string like "ToLower" which means the swash %utf8::ToLower.

「通常」とは、swash %utf8::ToLower を意味する "ToLower" のような文字列です。

        UV      to_utf8_case(const U8 *p, U8* ustrp, STRLEN *lenp, SV **swashp, const char *normal, const char *special)

to_utf8_fold

Convert the UTF-8 encoded character at p to its foldcase version and store that in UTF-8 in ustrp and its length in bytes in lenp. Note that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the foldcase version may be longer than the original character (up to three characters).

p にある UTF-8 エンコードされた文字を畳み込み文字版に変換して、UTF-8 エンコードしたものを ustrp に、そのバイト数を lenp に保管します。 畳み込み文字版は元の文字より(最大 3 文字)長くなるかも知れないので、ustrp は 少なくとも UTF8_MAXBYTES_CASE+1 バイト必要であることに注意してください。

The first character of the foldcased version is returned (but note, as explained above, that there may be more.)

最初の文字の畳み込み文字版が返されます(しかし、上述の通り、もっとあるかも しれません。)

        UV      to_utf8_fold(const U8 *p, U8* ustrp, STRLEN *lenp)

to_utf8_lower

Convert the UTF-8 encoded character at p to its lowercase version and store that in UTF-8 in ustrp and its length in bytes in lenp. Note that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the lowercase version may be longer than the original character.

p にある UTF-8 エンコードされた文字を小文字版に変換して、UTF-8 エンコードしたものを ustrp に、そのバイト数を lenp に保管します。 小文字版は元の文字より長くなるかも知れないので、ustrp は少なくとも UTF8_MAXBYTES_CASE+1 バイト必要であることに注意してください。

The first character of the lowercased version is returned (but note, as explained above, that there may be more.)

最初の文字の小文字版が返されます(しかし、上述の通り、もっとあるかも しれません。)

        UV      to_utf8_lower(const U8 *p, U8* ustrp, STRLEN *lenp)

to_utf8_title

Convert the UTF-8 encoded character at p to its titlecase version and store that in UTF-8 in ustrp and its length in bytes in lenp. Note that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the titlecase version may be longer than the original character.

p にある UTF-8 エンコードされた文字をタイトル文字版に変換して、UTF-8 エンコードしたものを ustrp に、そのバイト数を lenp に保管します。 タイトル文字版は元の文字より長くなるかも知れないので、ustrp は少なくとも UTF8_MAXBYTES_CASE+1 バイト必要であることに注意してください。

The first character of the titlecased version is returned (but note, as explained above, that there may be more.)

最初の文字のタイトル文字版が返されます(しかし、上述の通り、もっとあるかも しれません。)

        UV      to_utf8_title(const U8 *p, U8* ustrp, STRLEN *lenp)

to_utf8_upper

Convert the UTF-8 encoded character at p to its uppercase version and store that in UTF-8 in ustrp and its length in bytes in lenp. Note that the ustrp needs to be at least UTF8_MAXBYTES_CASE+1 bytes since the uppercase version may be longer than the original character.

p にある UTF-8 エンコードされた文字を大文字版に変換して、UTF-8 エンコードしたものを ustrp に、そのバイト数を lenp に保管します。 小文字版は元の文字より長くなるかも知れないので、ustrp は少なくとも UTF8_MAXBYTES_CASE+1 バイト必要であることに注意してください。

The first character of the uppercased version is returned (but note, as explained above, that there may be more.)

最初の文字の大文字版が返されます(しかし、上述の通り、もっとあるかも しれません。)

        UV      to_utf8_upper(const U8 *p, U8* ustrp, STRLEN *lenp)

utf8n_to_uvchr

flags

flags

Returns the native character value of the first character in the string s which is assumed to be in UTF-8 encoding; retlen will be set to the length, in bytes, of that character.

UTF-8 エンコーディングされていると仮定されている文字列 s の最初の文字の ネイティブな符号位置を返します; retlen にはその文字のバイト数が セットされます。

Allows length and flags to be passed to low level routine.

長さとフラグは低レベルルーチンに渡されることを許しています。

        UV      utf8n_to_uvchr(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)

utf8n_to_uvuni

Bottom level UTF-8 decode routine. Returns the Unicode code point value of the first character in the string s which is assumed to be in UTF-8 encoding and no longer than curlen; retlen will be set to the length, in bytes, of that character.

最低レベルの UTF-8 デコードルーチンです。 UTF-8 エンコーディングされていて curlen より長くはないと仮定されている 文字列 s の最初の文字のUnicode 符号位置を返します; retlen には その文字のバイト数がセットされます。

If s does not point to a well-formed UTF-8 character, the behaviour is dependent on the value of flags: if it contains UTF8_CHECK_ONLY, it is assumed that the caller will raise a warning, and this function will silently just set retlen to -1 and return zero. If the flags does not contain UTF8_CHECK_ONLY, warnings about malformations will be given, retlen will be set to the expected length of the UTF-8 character in bytes, and zero will be returned.

s が整形された UTF-8 文字を指していない場合、振る舞いは flags の値に 依存します: UTF8_CHECK_ONLY を含んでいれば、呼び出し側が警告を発生させて、 この関数は暗黙に retlen を -1 にセットしてゼロを返すことを仮定します。 flags に UTF8_CHECK_ONLY が含まれていなければ、不正な文字に関する警告が 与えられ、retlen は想定される UTF-8 文字のバイト数がセットされ、ゼロが 返されます。

The flags can also contain various flags to allow deviations from the strict UTF-8 encoding (see utf8.h).

flags は、厳密な UTF-8 エンコーディングからの逸脱を認める様々なフラグを 含めることもできます (utf8.h を参照してください)。

Most code should use utf8_to_uvchr() rather than call this directly.

ほとんどのコードではこれを直接呼び出さずに utf8_to_uvchr() を使うべきです。

        UV      utf8n_to_uvuni(const U8 *s, STRLEN curlen, STRLEN *retlen, U32 flags)

utf8_distance

Returns the number of UTF-8 characters between the UTF-8 pointers a and b.

UTF-8 ポインタ a と b の間の UTF-8 文字の数を返します。

WARNING: use only if you *know* that the pointers point inside the same UTF-8 buffer.

警告: ポインタが同じ UTF-8 バッファの中を指していることを「知っている」 場合にのみ使ってください。

        IV      utf8_distance(const U8 *a, const U8 *b)

utf8_hop

Return the UTF-8 pointer s displaced by off characters, either forward or backward.

前または後ろに off 文字だけずらした UTF-8 ポインタ s を返します。

WARNING: do not use the following unless you *know* off is within the UTF-8 data pointed to by s *and* that on entry s is aligned on the first byte of character or just after the last byte of a character.

警告: off が s で指されている UTF-8 データの内側であることと、 エントリ s が文字の最初のバイトか文字の最後のバイトの直後に 位置合わせされているということが「分かっている」場合以外は 使わないでください。

        U8*     utf8_hop(const U8 *s, I32 off)

utf8_length

Return the length of the UTF-8 char encoded string s in characters. Stops at e (inclusive). If e < s or if the scan would end up past e, croaks.

UTF-8 文字エンコードされた文字列 s の文字数を返します。 e で停止します(これも含みます)。 e < s であったり、スキャンが e を超えて停止すると、croak します。

        STRLEN  utf8_length(const U8* s, const U8 *e)

utf8_to_bytes

Converts a string s of length len from UTF-8 into native byte encoding. Unlike bytes_to_utf8, this over-writes the original string, and updates len to contain the new length. Returns zero on failure, setting len to -1.

長さ len の文字列 s を UTF-8 からネイティブなバイトエンコーディングに 変換します。 bytes_to_utf8 と違って、これは元の文字列を上書きし、新しい長さで len を 更新します。 失敗時にはゼロを返し、len に -1 をセットします。

If you need a copy of the string, see bytes_from_utf8.

文字列のコピーが必要なら、bytes_from_utf8 を参照してください。

NOTE: this function is experimental and may change or be removed without notice.

注意: この関数は実験的で、予告なしに変更あるいは削除されるかもしれません。

        U8*     utf8_to_bytes(U8 *s, STRLEN *len)

utf8_to_uvchr

Returns the native character value of the first character in the string s which is assumed to be in UTF-8 encoding; retlen will be set to the length, in bytes, of that character.

UTF-8 エンコーディングされていると仮定されている文字列 s の最初の文字の ネイティブな符号位置を返します; retlen にはその文字のバイト数が セットされます。

If s does not point to a well-formed UTF-8 character, zero is returned and retlen is set, if possible, to -1.

s が整形された UTF-8 文字を指していない場合、ゼロが返され、もし可能なら retlen は -1 がセットされます。

        UV      utf8_to_uvchr(const U8 *s, STRLEN *retlen)

utf8_to_uvuni

Returns the Unicode code point of the first character in the string s which is assumed to be in UTF-8 encoding; retlen will be set to the length, in bytes, of that character.

UTF-8 エンコーディングされていると仮定されている文字列 s の最初の文字の Unicode 符号位置を返します; retlen にはその文字のバイト数が セットされます。

This function should only be used when the returned UV is considered an index into the Unicode semantic tables (e.g. swashes).

この関数は、返された UV が Unicode 意味論テーブル (つまり swash) への インデックスとして考えられる場合にのみ使われるべきです。

If s does not point to a well-formed UTF-8 character, zero is returned and retlen is set, if possible, to -1.

s が整形された UTF-8 文字を指していない場合、ゼロが返され、もし可能なら retlen は -1 がセットされます。

        UV      utf8_to_uvuni(const U8 *s, STRLEN *retlen)

uvchr_to_utf8

Adds the UTF-8 representation of the Native codepoint uv to the end of the string d; d should be have at least UTF8_MAXBYTES+1 free bytes available. The return value is the pointer to the byte after the end of the new character. In other words,

ネイティブ符号位置 uv の UTF-8 表現を文字列 d の末尾に追加します; d は少なくとも UTF8_MAXBYTES+1 バイトの空きが必要です。 返り値は新しい文字の末尾の次のバイトへのポインタです。 言い換えると:

    d = uvchr_to_utf8(d, uv);

is the recommended wide native character-aware way of saying

が、ネイティブな文字を認識した形で以下のようなことをするときの推奨する 方法です:

    *(d++) = uv;

        U8*     uvchr_to_utf8(U8 *d, UV uv)

uvuni_to_utf8_flags

Adds the UTF-8 representation of the Unicode codepoint uv to the end of the string d; d should be have at least UTF8_MAXBYTES+1 free bytes available. The return value is the pointer to the byte after the end of the new character. In other words,

Unicode 符号位置 uv の UTF-8 表現を文字列 d の末尾に追加します; d は少なくとも UTF8_MAXBYTES+1 バイトの空きが必要です。 返り値は新しい文字の末尾の次のバイトへのポインタです。 言い換えると:

    d = uvuni_to_utf8_flags(d, uv, flags);

or, in most cases,

または、ほとんどの場合では、

    d = uvuni_to_utf8(d, uv);

(which is equivalent to)

(これは以下と等価です)

    d = uvuni_to_utf8_flags(d, uv, 0);

is the recommended Unicode-aware way of saying

というのものが、以下のようなものの Unicode を考慮に入れた方法として 推奨されます。

    *(d++) = uv;

        U8*     uvuni_to_utf8_flags(U8 *d, UV uv, UV flags)

Variables created by xsubpp and xsubpp internal functions¶

(xsubpp および xsubpp 内部関数で作成された変数)

ax

Variable which is setup by xsubpp to indicate the stack base offset, used by the ST, XSprePUSH and XSRETURN macros. The dMARK macro must be called prior to setup the MARK variable.

ST, XSprePUSH, XSRETURN マクロによって使われるスタックベース オフセットを示すために xsubpp によってセットアップされる変数。 dMARK マクロは MARK 変数をセットアップする前に 呼び出されなければなりません。

        I32     ax

CLASS

Variable which is setup by xsubpp to indicate the class name for a C++ XS constructor. This is always a char*. See THIS.

xsubpp によってセットアップされる、C++ の XS コンストラクターに 対するクラス名を表わす変数です。 これは常に char* です。 THIS を参照してください。

        char*   CLASS

dAX

Sets up the ax variable. This is usually handled automatically by xsubpp by calling dXSARGS.

ax 変数をセットアップします。 これは普通 dXSARGS を呼び出すことで xsubpp によって自動的に 扱われます。

                dAX;

dAXMARK

Sets up the ax variable and stack marker variable mark. This is usually handled automatically by xsubpp by calling dXSARGS.

ax 変数とスタックマーカー変数 mark をセットアップします。 これは普通 dXSARGS を呼び出すことで xsubpp によって自動的に 扱われます。

                dAXMARK;

dITEMS

Sets up the items variable. This is usually handled automatically by xsubpp by calling dXSARGS.

items 変数をセットアップします。 これは普通 dXSARGS を呼び出すことで xsubpp によって自動的に 扱われます。

                dITEMS;

dUNDERBAR

Sets up the padoff_du variable for an XSUB that wishes to use UNDERBAR.

UNDERBAR を使いたい XSUB のために padoff_du 変数をセットアップします。

                dUNDERBAR;

dXSARGS

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

XSUB のために、スタックポインタとマークポインタをセットアップし、 dSP と dMARK を呼び出します。 dAX と dITEMS を呼び出すことで変数 ax と items を セットアップします。 これは通常、xsubpp によって自動的に扱われます。

                dXSARGS;

dXSI32

Sets up the ix variable for an XSUB which has aliases. This is usually handled automatically by xsubpp.

エイリアスを持つ XSUB のために変数 ix をセットアップします。 これは通常、xsubpp によって自動的に扱われます。

                dXSI32;

items

Variable which is setup by xsubpp to indicate the number of items on the stack. See "Variable-length Parameter Lists" in perlxs.

xsubpp によりセットアップされ、スタックにあるアイテムの数を表わす 変数です。 "Variable-length Parameter Lists" in perlxs を参照してください。

        I32     items

ix

Variable which is setup by xsubpp to indicate which of an XSUB's aliases was used to invoke it. See "The ALIAS: Keyword" in perlxs.

xsubpp によりセットアップされ、それを起動するのに使われた XSUB の エイリアスを表わす変数です。 "The ALIAS: Keyword" in perlxs を参照してください。

        I32     ix

newXSproto

Used by xsubpp to hook up XSUBs as Perl subs. Adds Perl prototypes to the subs.

Perl サブルーチンのように XSUB をフックするために xsubpp が使います。 サブルーチンに対して Perl のプロトタイプを追加します。

RETVAL

Variable which is setup by xsubpp to hold the return value for an XSUB. This is always the proper type for the XSUB. See "The RETVAL Variable" in perlxs.

xsubpp によってセットアップされ、XSUB の戻り値を保持する変数です。 これは、常に XSUB にとって正しい型になります。 "The RETVAL Variable" in perlxs を参照してください。

        (whatever)      RETVAL

ST

Used to access elements on the XSUB's stack.

XSUB のスタック上にある要素にアクセスするために使われます。

        SV*     ST(int ix)

THIS

Variable which is setup by xsubpp to designate the object in a C++ XSUB. This is always the proper type for the C++ object. See CLASS and "Using XS With C++" in perlxs.

C++ の XSUB におけるオブジェクトを指定する、xsubpp によって設定される 変数です。 これは常に C++ オブジェクトとして適切な型です。 CLASS および "Using XS With C++" in perlxs を参照してください。

        (whatever)      THIS

UNDERBAR

The SV* corresponding to the $_ variable. Works even if there is a lexical $_ in scope.

$_ 変数に対応する SV*。 たとえスコープ内にレキシカルな $_ があっても動作します。

XS

Macro to declare an XSUB and its C parameter list. This is handled by xsubpp.

XSUB とその C のパラメーターリストを宣言するためのマクロです。 これは xsubpp によって扱われます。

XS_VERSION

The version identifier for an XS module. This is usually handled automatically by ExtUtils::MakeMaker. See XS_VERSION_BOOTCHECK.

XS モジュールに対するバージョン識別子。 これは通常、ExtUtils::MakeMaker によって自動的に使われます。 XS_VERSION_BOOTCHECK を参照してください。

XS_VERSION_BOOTCHECK

Macro to verify that a PM module's $VERSION variable matches the XS module's XS_VERSION variable. This is usually handled automatically by xsubpp. See "The VERSIONCHECK: Keyword" in perlxs.

PM モジュールのバージョン変数と、XS モジュールの XS_VERSION 変数とが マッチするかを検査するためのマクロです。 これは通常、xsubpp によって自動的に扱われます。 "The VERSIONCHECK: Keyword" in perlxs を参照してください。

                XS_VERSION_BOOTCHECK;

警告と die¶

croak

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

Perl の die 関数に対する XSUB 作成者のためのインターフェースです。 この関数は C の関数 printf と同じように呼び出します。 croak の呼び出しは制御を直ちに Perl に返し、通常の C の実行順序を 回避します。 warn を参照してください。

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

例外オブジェクトを投げたいなら、オブジェクトを $@ に代入してから、 croak() に NULL を渡します:

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

        void    croak(const char* pat, ...)

warn

This is the XSUB-writer's interface to Perl's warn function. Call this function the same way you call the C printf function. See croak.

これは XSUB 作成者のための、Perl の warn 関数に対するインターフェースです。 この関数は C の関数 printf と同じように呼び出します。 croak() を参照してください。

        void    warn(const char* pat, ...)

作者¶

1997 年 5 月まで、このドキュメントは Jeff Okamoto <[email protected]> によって管理されていました。 今では Perl 自身の一部として管理されています。

Dean Roehrich, Malcolm Beattie, Andreas Koenig, Paul Hudson, Ilya Zakharevich, Paul Marquess, Neil Bowers, Matthew Green, Tim Bunce, Spider Boardman, Ulrich Pfeifer, Stephen McCamant, Gurusamy Sarathy から多くの助力と提案を受けました。

元の API 一覧は Dean Roehrich <[email protected]> によるものです。

Benjamin Stuhl によって、ソースのコメントから自動生成するように 更新されました。

SEE ALSO¶

perlguts(1), perlxs(1), perlxstut(1), perlintern(1)