目次 TABLE OF CONTENTS
B::SV 若しくは B::AV, B::HV, B::CV オブジェクトを返す関数
Functions Returning B::SV, B::AV, B::HV, and B::CV objects
B::OP オブジェクトを返す関数及びopツリーの巡回
Functions Returning B::OP objects or for walking op trees
B - Perl コンパイラ B - The Perl Compiler
use B;
B モジュールは Perl プログラムに自分自身の体内を探るための
クラス群を提供します. Perl コンパイラの"バックエンド"の実装にも
このモジュールが使われています. 単にコンパイラの使い方であれば
このモジュールの知識を必要としません: ユーザから見える部分に
関しては O モジュールを参照してください. B モジュールは
新しいコンパイラバックエンドを書く人のためのモジュールです.
このドキュメントでは読み手がperlの内部構造, SV, OP, 内部
シンボルテーブル, プログラムの構文ツリーなどに相当詳しいことを
前提としています.
The B module supplies classes which allow a Perl program to delve
into its own innards. It is the module used to implement the
"backends" of the Perl compiler. Usage of the compiler does not
require knowledge of this module: see the O module for the
user-visible part. The B module is of use to those who want to
write new compiler backends. This documentation assumes that the
reader knows a fair amount about perl's internals including such
things as SVs, OPs and the internal symbol table and syntax tree
of a program.
B モジュールはPerlインタプリタの現在の状態を問い合わせる
ためのユーティリティ関数群を含んでいます. これらの関数の
多くは B::SV 及び B::OP クラス及びこれらの派生クラスのオブ
ジェクトを返します. これらのクラスはそれらの中でそれらの
内部状態に関して問い合わせるためのメソッドを定義しています.
The B module contains a set of utility functions for querying the
current state of the Perl interpreter; typically these functions
return objects from the B::SV and B::OP classes, or their derived
classes. These classes in turn define methods for querying the
resulting objects about their own internal state.
B モジュールは様々な関数をエクスポートします. いくつかは
簡単なユーティリティ関数ですが, それ以外は内部オブジェクトの
入り口となる"ハンドル" (initial "handle")を取得する方法を
提供します.
The B module exports a variety of functions: some are simple
utility functions, others provide a Perl program with a way to
get an initial "handle" on an internal object.
B::SV 若しくは B::AV, B::HV, B::CV オブジェクトを返す関数
Functions Returning B::SV, B::AV, B::HV, and B::CV objects
これらのクラスの階層図及び呼び出せるメソッドに関しては, 後述の "OVERVIEW OF CLASSES" 及び "SV-RELATED CLASSES" を参照してください. For descriptions of the class hierarchy of these objects and the methods that can be called on them, see below, "OVERVIEW OF CLASSES" and "SV-RELATED CLASSES".
Cでの変数sv_undefに対応するSVオブジェクトを返します.
Returns the SV object corresponding to the C variable sv_undef.
Cでの変数sv_yesに対応するSVオブジェクトを返します.
Returns the SV object corresponding to the C variable sv_yes.
Cでの変数sv_noに対応するSVオブジェクトを返します.
Returns the SV object corresponding to the C variable sv_no.
何らかの Perl の値へのリファレンスを受け取り, 参照されている値を
対応する B:OP もしくは B::SV クラス派生のオブジェクトに変換します.
main_root の様な関数は別として, これはperlの内部データ構造
の入り口となる"ハンドル"(initial "handle")を取得する主要な方法です.
ここから他のアクセスメソッドを使うことになります.
Takes a reference to any Perl value, and turns the referred-to value
into an object in the appropriate B::OP-derived or B::SV-derived
class. Apart from functions such as main_root, this is the primary
way to get an initial "handle" on an internal perl data structure
which can then be followed with the other access methods.
返されるオブジェクトはOPやSVが存在しているのと同じ間だけ有効です. 参照する構造が解放された後はそのオブジェクトを使わないでください. The returned object will only be valid as long as the underlying OPs and SVs continue to exist. Do not attempt to use the object after the underlying structures are freed.
Cでの変数amagic_generationに対応するSVオブジェクトを返します.
Returns the SV object corresponding to the C variable amagic_generation.
INIT ブロックを表現する AV オブジェクト(つまりB::AVクラスの オブジェクト)を返します. Returns the AV object (i.e. in class B::AV) representing INIT blocks.
CHECK ブロックを表現する AV オブジェクト(つまりB::AVクラスの オブジェクト)を返します. Returns the AV object (i.e. in class B::AV) representing CHECK blocks.
UNITCHECK ブロックを表現する AV オブジェクト(つまりB::AVクラスの オブジェクト)を返します. Returns the AV object (i.e. in class B::AV) representing UNITCHECK blocks.
BEGIN ブロックを表現する AV オブジェクト(つまりB::AVクラスの オブジェクト)を返します. Returns the AV object (i.e. in class B::AV) representing BEGIN blocks.
END ブロックを表現する AV オブジェクト(つまりB::AVクラスの オブジェクト)を返します. Returns the AV object (i.e. in class B::AV) representing END blocks.
グローバルcomppadlistの AV オブジェクト(つまりB::AVクラスの オブジェクト)を返します. Returns the AV object (i.e. in class B::AV) of the global comppadlist.
perl が ithreads でコンパイルされたときのみ. Only when perl was compiled with ithreads.
Perlプログラムのメイン部分に対応する(擬似的な)CVを返します. Return the (faked) CV corresponding to the main part of the Perl program.
SYMREF からシンボルテーブルを歩き始め, 各シンボル(B::GVオブジェクト) に着く度にMETHODを呼び出します. 巡回がパッケージシンボルに辿り 着いたときシンボル名を引数にRECURSEを呼び出し, 関数が真を返した 時にのみ再帰的にパッケージを進みます. Walk the symbol table starting at SYMREF and call METHOD on each symbol (a B::GV object) visited. When the walk reaches package symbols (such as "Foo::") it invokes RECURSE, passing in the symbol name, and only recurses into the package if that sub returns true.
PREFIX は巡回するSYMREFの名前です. PREFIX is the name of the SYMREF you're walking.
例えば: For example:
# Walk CGI's symbol table calling print_subs on each symbol.
# Recurse only into CGI::Util::
walksymtable(\%CGI::, 'print_subs', sub { $_[0] eq 'CGI::Util::' },
'CGI::');print_subs() は 自分で宣言した B::GV メソッドです. 後述の"B::GV Methods"を参照してください. print_subs() is a B::GV method you have declared. Also see "B::GV Methods", below.
B::OP オブジェクトを返す関数及びopツリーの巡回
Functions Returning B::OP objects or for walking op trees
これらのクラスの階層図及び呼び出せるメソッドに関しては, 後述の "OVERVIEW OF CLASSES" 及び "SV-RELATED CLASSES" を参照してください. For descriptions of the class hierarchy of these objects and the methods that can be called on them, see below, "OVERVIEW OF CLASSES" and "OP-RELATED CLASSES".
Perlプラグラムのメイン部分に当たるルートop(つまり適当な B::OP から 派生したクラスのオブジェクト)を返します. Returns the root op (i.e. an object in the appropriate B::OP-derived class) of the main part of the Perl program.
Perl プラグラムのメイン部分の始まるopを返します. Returns the starting op of the main part of the Perl program.
OP から構文ツリーを辿って各opでMETHODを呼び出します. ノードは子の
前に呼び出されます. walkoptree_debug(後述)がデバッグを有効に
するように呼び出されていたら, 各opでMETHODが呼び出される前に
walkoptree_debug が呼び出されます.
Does a tree-walk of the syntax tree based at OP and calls METHOD on
each op it visits. Each node is visited before its children. If
walkoptree_debug (see below) has been called to turn debugging on then
the method walkoptree_debug is called on each op before METHOD is
called.
現在の walkoptree のデバッグフラグを返します. もし任意の引数
DEBUG が0でなければ, デバッグフラグをその値に設定します.
デバッグフラグが何を行うのかは前述のwalkoptreeを参照してください.
Returns the current debugging flag for walkoptree. If the optional
DEBUG argument is non-zero, it sets the debugging flag to that. See
the description of walkoptree above for what the debugging flag
does.
op番号OPNUMのPP関数名(例えば "pp_add")を返します. Return the PP function name (e.g. "pp_add") of op number OPNUM.
文字列STRに対するperlが使うハッシュ値を "0x..." という形式の 文字列で返します. Returns a string in the form "0x..." representing the value of the internal hash function used by perl on string STR.
I を perl内部の I32 型にキャストします. Casts I to the internal I32 type used by that perl.
-c コマンドラインオプションと同じことをします. 明らかなことですが,
これは BEGIN ブロックの中でのみ有効であって, それ以外では遅すぎます.
Does the equivalent of the -c command-line option. Obviously, this
is only useful in a BEGIN block or else the flag is set too late.
Cソースコードで文字列として使えるようにダブルクオートで囲んだ バージョンのSTRを返します. Returns a double-quote-surrounded escaped version of STR which can be used as a string in C source code.
Perlソースコードで文字列として使えるようにダブルクオートで囲んだ バージョンのSTRを返します. Returns a double-quote-surrounded escaped version of STR which can be used as a string in Perl source code.
オブジェクトのクラスを, 最初の"::"の前に当たる部分を省いて返します.
Returns the class of an object without the part of the classname
preceding the first "::". This is used to turn "B::UNOP" into
"UNOP" for example.
スレッド対応でコンパイルされているperlで, 特殊なスレッド毎のthreadsv 変数のリストを返します. In a perl compiled for threads, this returns a list of the special per-thread threadsv variables.
my $op_type = $optype[$op_type_num];op タイプ番号からそのタイプ('COP' や 'BINOP')への簡単なマッピング. A simple mapping of the op type number to its type (like 'COP' or 'BINOP').
my $sv_name = $specialsv_name[$sv_index];'特別' ないくつかの SV タイプ. これらは B::SPECIAL として表現され, specialsv_list からの番号で参照されます. この配列は番号から SV の名前 ('Nullsv' や '&PL_sv_undef')へとマップします. Certain SV types are considered 'special'. They're represented by B::SPECIAL and are referred to by a number from the specialsv_list. This array maps that number back to the name of the SV (like 'Nullsv' or '&PL_sv_undef').
Perl の内部で SV 及び OP 情報 (PVIV, AV, HV, ..., OP, SVOP, UNOP,
...) を保持するために使われる C 構造体はクラス階層としてモデル化
されており, B モジュールからはそれらに対して真にクラス階層と
仕手のアクセスが提供されています. 他のオブジェクト(SV か OP の
一種)を参照する構造体フィールドは適切なクラスの Perl オブジェクト
として B モジュールによって表現されます.
The C structures used by Perl's internals to hold SV and OP
information (PVIV, AV, HV, ..., OP, SVOP, UNOP, ...) are modelled on a
class hierarchy and the B module gives access to them via a true
object hierarchy. Structure fields which point to other objects
(whether types of SV or types of OP) are represented by the B
module as Perl objects of the appropriate class.
B モジュールの大部分はこれらの構造体のフィールドにアクセス
するためのメソッドです.
The bulk of the B module is the methods for accessing fields of
these structures.
全てのアクセスは読み込み専用です. このモジュールでは内部の変更は できません. また, このモジュールによって生成される B::OP や B::SV のオブジェクトはそれの元となっているオブジェクトが 存在している間のみ有効です; これらの生成は元のオブジェクトの 参照カウンタの増加は行いません. 解放されたオブジェクトの フィールドへのアクセスは不可解な結果, 若しくはもっと悪い結果に なるでしょう. Note that all access is read-only. You cannot modify the internals by using this module. Also, note that the B::OP and B::SV objects created by this module are only valid for as long as the underlying objects exist; their creation doesn't increase the reference counts of the underlying objects. Trying to access the fields of a freed object will give incomprehensible results, or worse.
B::IV, B::NV, B::RV, B::PV, B::PVIV, B::PVNV, B::PVMG, B::BM (5.9.5 及びそれ以前), B::PVLV, B::AV, B::HV, B::CV, B::GV, B::FM, B::IO. これらのクラスは 同じような名前を持つ C 構造体への経路に相当します. 継承階層は 元になっている C "継承" に倣っています. 5.10.x ブランチ, (すなわち 5.10.0, 5.10.1 etc) では 次のようになります: B::IV, B::NV, B::RV, B::PV, B::PVIV, B::PVNV, B::PVMG, B::BM (5.9.5 and earlier), B::PVLV, B::AV, B::HV, B::CV, B::GV, B::FM, B::IO. These classes correspond in the obvious way to the underlying C structures of similar names. The inheritance hierarchy mimics the underlying C "inheritance". For the 5.10.x branch, (ie 5.10.0, 5.10.1 etc) this is:
B::SV
|
+------------+------------+------------+
| | | |
B::PV B::IV B::NV B::RV
\ / /
\ / /
B::PVIV /
\ /
\ /
\ /
B::PVNV
|
|
B::PVMG
|
+-----+-----+-----+-----+
| | | | |
B::AV B::GV B::HV B::CV B::IO
| |
| |
B::PVLV B::FM5.9.0 及びそれ以前では, PVLV は PVMG の直接のサブクラスであり, そして BM は別のタイプとして表現されていました, なので この図の下の部分は次のようになっていました. For 5.9.0 and earlier, PVLV is a direct subclass of PVMG, and BM is still present as a distinct type, so the base of this diagram is
|
|
B::PVMG
|
+------+-----+-----+-----+-----+-----+
| | | | | | |
B::PVLV B::BM B::AV B::GV B::HV B::CV B::IO
|
|
B::FM5.11.0 及びそれ以降では, B::RV は廃止され, リファレンスを格納するために IV が使われるようになり, 新しく B::REGEXP が導入されました, これは次の構造になります: For 5.11.0 and later, B::RV is abolished, and IVs can be used to store references, and a new type B::REGEXP is introduced, giving this structure:
B::SV
|
+------------+------------+
| | |
B::PV B::IV B::NV
\ / /
\ / /
B::PVIV /
\ /
\ /
\ /
B::PVNV
|
|
B::PVMG
|
+-------+-------+---+---+-------+-------+
| | | | | |
B::AV B::GV B::HV B::CV B::IO B::REGEXP
| |
| |
B::PVLV B::FM
アクセスメソッドはフィールドアクセスのための C マクロを元に対応
していますが, 大抵ついていた"クラス識別"前置句ははずされています
(Sv, Av, Hv, ...). 前置句はそれを外すとメソッド名がぶつかる時に
だけ残っています. 例えば GvREFCNT はその短縮形がスーパー
クラスのメソッド REFCNT (C 関数 SvREFCNT に対応) と
ぶつかるのでそのままになっています.
Access methods correspond to the underlying C macros for field access,
usually with the leading "class indication" prefix removed (Sv, Av,
Hv, ...). The leading prefix is only left in cases where its removal
would cause a clash in method name. For example, GvREFCNT stays
as-is since its abbreviation would clash with the "superclass" method
REFCNT (corresponding to the C function SvREFCNT).
この B::SV オブジェクトに対応する通常のスカラーへのリファレンスを 返します. 言い換えると, このメソッドは svref_2object() 関数の 逆関数です. このスカラーとそれが指し示すその他のデータは読み込み 専用と考えるべきです: これらへの変更は安全でも効果の保証も ありません. Returns a reference to the regular scalar corresponding to this B::SV object. In other words, this method is the inverse operation to the svref_2object() subroutine. This scalar and other data it points at should be considered read-only: modifying them is neither safe nor guaranteed to have a sensible effect.
IV の値を, 符号付き整数として処理して返します.
これは FLAGS & SVf_IVisUV の時に誤解を招きます.
恐らく int_value メソッドが欲しかったのではないでしょうか?
Returns the value of the IV, interpreted as
a signed integer. This will be misleading
if FLAGS & SVf_IVisUV. Perhaps you want the
int_value method instead?
IV の値を整数として返します. IV との違いは,
そこに格納されている値が符号付きなのか符号無しなのかに
関わらず正しい値を返す点です.
This method returns the value of the IV as an integer.
It differs from IV in that it returns the correct
value regardless of whether it's stored signed or
unsigned.
このメソッドは通常欲しくなるものです. これは構造体の 中の長さとオフセットの情報を使って文字列を構築します: 通常のスカラーのようにnull文字を含んでいたとしても Perl からみれる文字列を返します. This method is the one you usually want. It constructs a string using the length and offset information in the struct: for ordinary scalars it will return the string that you'd see from Perl, even if it contains null characters.
PV がリファレンスでなければ die() する点を除いて B::RV::RV と同じです. Same as B::RV::RV, except that it will die() if the PV isn't a reference.
このメソッドはそんなに便利でもありません. これは 構造体には null 終端している文字列が格納されていると 仮定し, 長さの情報は考えません. This method is less often useful. It assumes that the string stored in the struct is null-terminated, and disregards the length information.
これは padname 配列からレキシカル変数の名前をひろう必要 がある時には適切なメソッドです. レキシカル変数名は常に null 終端文字列で格納され, 長さのフィールド (SvCUR) は他の 目的で転用され, 信頼することが出来ません. It is the appropriate method to use if you need to get the name of a lexical variable from a padname array. Lexical variable names are always stored with a null terminator, and the length field (SvCUR) is overloaded for other purposes and can't be relied on here.
r-magic の時のみ有効で, 正規表現を生成した文字列を 返します. Only valid on r-magic, returns the string that generated the regexp.
r-magic 時に呼び出すと die() します. Will die() if called on r-magic.
r-magic の時のみ有効で, MAGIC に格納されている REGEX の整数値を 返します. Only valid on r-magic, returns the integer value of the REGEX stored in the MAGIC.
このメソッドは GV の GP フィールドが NULL の時に真を返します. This method returns TRUE if the GP field of the GV is NULL.
このメソッドはグロブの名前を返しますが, 名前の最初の文字が 制御文字の時には先に ^X へと変換します, つまり, *^G は "\cG" ではなく "^G" を返します. This method returns the name of the glob, but if the first character of the name is a control character, then it converts it to ^X first, so that *^G would return "^G" rather than "\cG".
これは変数の名前を表示したいときに便利です. もしコンパイル時
で, 存在するグロブのみに制限したいのであれば,
その結果は明白です, なぜなら ${"^G"} = 1 のようなコードは
2つの op - 文字列定数とデリファレンス (rv2gv) - にコンパイル
されるので, グロブは実行時に生成されるようになります.
It's useful if you want to print out the name of a variable.
If you restrict yourself to globs which exist at compile-time
then the result ought to be unambiguous, because code like
${"^G"} = 1 is compiled as two ops - a constant string and
a dereference (rv2gv) - so that the glob is created at runtime.
実行時にグロブに処理しているのであれば, *^G と *{"^G"} の 曖昧さを除去する必要があるため, 生の NAME メソッドを 使う必要があります. If you're working with globs at runtime, and need to disambiguate *^G from *{"^G"}, then you should use the raw NAME method.
引数を一つ ( 'stdin' | 'stdout' | 'stderr' ) を取って, もしオブジェクトの IoIFP が引数に渡された名前と等しいときに 真を返します(つまり, $io->IsSTD('stderr') は IoIFP($io) == PerlIO_stdin() の時に真になります). Takes one arguments ( 'stdin' | 'stdout' | 'stderr' ) and returns true if the IoIFP of the object is equal to the handle whose name was passed as argument ( i.e. $io->IsSTD('stderr') is true if IoIFP($io) == PerlIO_stdin() ).
ARRAY と似ていますが全ての要素のリストではなくただ1つの要素を
得るための添字を引数に取ります.
Like ARRAY, but takes an index as an argument to get only one element,
rather than a list of all of them.
このメソッドは Perl 5.8 で実行されるとき以外は廃止されています, そして Perl 5.9 においてはもはや提供されていません. This method is deprecated if running under Perl 5.8, and is no longer present if running under Perl 5.9
このメソッドは AV に関連するフラグを返します. Perl 5.9 ではこれらはメインの SV フラグに格納されているので このメソッドも提供されません. This method returns the AV specific flags. In Perl 5.9 these are now stored in with the main SV flags, so this method is no longer present.
定数関数の時に関数から返される SV を返します For constant subroutines, returns the constant SV returned by the subroutine. >>
Perl 5.9 で実行されているときには, RMROOT 情報はもはやハッシュに直接は格納されていないため このメソッドも提供されていません. This method is not present if running under Perl 5.9, as the PMROOT information is no longer stored directly in the hash.
B::OP, B::UNOP, B::BINOP, B::LOGOP, B::LISTOP, B::PMOP,
B::SVOP, B::PADOP, B::PVOP, B::LOOP, B::COP.
これらのクラスは似た名前のC構造体と対応しています. 疑似継承構造はCの"継承"に基を成します. These classes correspond in the obvious way to the underlying C structures of similar names. The inheritance hierarchy mimics the underlying C "inheritance":
B::OP
|
+---------------+--------+--------+-------+
| | | | |
B::UNOP B::SVOP B::PADOP B::COP B::PVOP
,' `-.
/ `--.
B::BINOP B::LOGOP
|
|
B::LISTOP
,' `.
/ \
B::LOOP B::PMOP
C構造体のフィールドにアクセスするときは, "クラス指示" 接頭辞("op_")
を取り除いたメソッドを使います.
Access methods correspond to the underlying C structre field names,
with the leading "class indication" prefix ("op_") removed.
これらのメソッドでは OP データ構造の似た名前のフィールドの値を
取得します. より詳細な情報は op.h の最初を参照してください.
These methods get the values of similarly named fields within the OP
data structure. See top of op.h for more info.
これはop名を文字列で返します(例: "add", "rv2av"). This returns the op name as a string (e.g. "add", "rv2av").
これは関数名を文字列で返します(例: "PL_ppaddr[OP_ADD]", "PL_ppaddr[OP_RV2AV]"). This returns the function name as a string (e.g. "PL_ppaddr[OP_ADD]", "PL_ppaddr[OP_RV2AV]").
これはopの説明をCのグローバルPL_op_desc配列から返します(例: "addition" "array deref"). This returns the op description from the global C PL_op_desc array (e.g. "addition" "array deref").
perl が ithreads サポートでコンパイルされているときのみ. Only when perl was compiled with ithreads.
Malcolm Beattie, mbeattie@sable.ox.ac.uk
山科 氷魚 (YAMASHINA Hio) <hio@hio.jp>原典: perl VERSION 5.8.9. 翻訳日: 2008-12-15. (2006-11-22, perl-5.8.8) Original distribution is perl VERSION 5.8.9. Translated at 2008-12-15. (2006-11-22, perl-5.8.8)