名前¶

perlclassguts - feature 'class' とクラス構文の動作の内部

説明¶

この文書は、perl インタプリタが feature 'class' の構文と 全体的な振る舞いを実装する方法についての詳細な情報を提供します。 これは、機能の使用方法に関するエンドユーザガイドとして 意図されたものではありません。 それについては、perlclass を参照してください。

読者は一般的に perl インタプリタの内部全体に親しんでいると想定されています。 これらの詳細のより一般的な概要については、perlguts も参照してください。

データの保管先¶

クラス¶

クラスは基本的にパッケージであり、非クラスパッケージとまったく 同じ方法で補助構造を持つ HV としてシンボルテーブルに存在します。 HvSTASH_IS_CLASS() マクロが真を返すという事実によって、 非クラスパッケージと区別されます。

クラスであることに関する追加情報は、スタッシュに付加された struct xpvhv_aux 構造体の以下のフィールドに格納されます:

    HV          *xhv_class_superclass;
    CV          *xhv_class_initfields_cv;
    AV          *xhv_class_adjust_blocks;
    PADNAMELIST *xhv_class_fields;
    PADOFFSET    xhv_class_next_fieldix;
    HV          *xhv_class_param_map;

• xhv_class_superclass will be NULL for a class with no superclass. It will point directly to the stash of the parent class if one has been set with the :isa() class attribute.

  スーパークラスのないクラスの場合、xhv_class_superclass は NULL になります。 :isa() クラス属性で親クラスが設定されている場合は、 親クラスのスタッシュを直接指します。

• xhv_class_initfields_cv will contain a CV * pointing to a function to be invoked as part of the constructor of this class or any subclass thereof. This CV is responsible for initializing all the fields defined by this class for a new instance. This CV will be an anonymous real function - i.e. while it has no name and no GV, it is not a protosub and may be directly invoked.

  xhv_class_initfields_cv には、このクラスまたはその任意のサブクラスの コンストラクタの一部として呼び出される関数を指す CV * が含まれます。 この CV は、新しい実体に対してこのクラスによって定義された すべてのフィールドを初期化する責任があります。 この CV は匿名の実関数になります - つまり、名前も GV もありませんが、 protosub ではなく、直接呼び出すことができます。

• xhv_class_adjust_blocks may point to an AV containing CV pointers to each of the ADJUST blocks defined on the class. If the class has a superclass, this array will additionally contain duplicate pointers of the CVs of its parent class. The AV is created lazily the first time an element is pushed to it; it is valid for there not to be one, and this pointer will be NULL in that case.

  xhv_class_adjust_blocks は、クラスで定義された各 ADJUST ブロックへの CV ポインタを含む AV を指す場合があります。 クラスにスーパークラスがある場合、この配列には親クラスの CV の 重複ポインタが追加で含まれます。 AV は、要素が最初にこれにプッシュされたときに遅延的に作られます; これが存在しない場合は正当であり、この場合、このポインタは NULL に なります。

  The CVs are stored directly, not via RVs. Each CV will be an anonymous real function.

  CV は RV 経由ではなく直接保存されます。 各 CV は匿名の実関数になります。

• xhv_class_fields will point to a PADNAMELIST containing PADNAMEs, each being one defined field of the class. They are stored in order of declaration. Note however, that the index into this array will not necessarily be equal to the fieldix of each field, because in the case of a subclass, the array will begin at zero but the index of the first field in it will be non-zero if its parent class contains any fields at all.

  xhv_class_fields は、PADNAMELIST を含む PADNAME を指します; それぞれがクラスの定義された一つのフィールドです。 これらは宣言順に格納されます。 ただし、この配列のインデックスは各フィールドの fieldix と 必ずしも等しくないことに注意してください; サブクラスの場合、配列はゼロから始まりますが、その親クラスに フィールドが含まれている場合、配列の最初のフィールドのインデックスは ゼロではないからです。

  For more information on how individual fields are represented, see "Fields".

  個々のフィールドの表現方法の詳細については、"Fields" を参照してください。

• xhv_class_next_fieldix gives the field index that will be assigned to the next field to be added to the class. It is only useful at compile-time.

  xhv_class_next_fieldix は、クラスに追加される次の フィールドに代入されるフィールドインデックスを与えます。 これはコンパイル時にのみ有効です。

• xhv_class_param_map may point to an HV which maps field :param attribute names to the field index of the field with that name. This mapping is copied from parent classes; each class will contain the sum total of all its parents in addition to its own.

  xhv_class_param_map は、フィールド :param 属性名をその名前を持つ フィールドのフィールドインデックスにマッピングする HV を指す場合があります。 このマッピングは親クラスからコピーされます; 各クラスには、独自のクラスに加えて、すべての親の合計が含まれます。

フィールド¶

フィールドは基本的にあるスコープ内で宣言されたレキシカル変数であり、対応する CV の PADNAMELIST に存在します。 メソッドやその他のメソッドのような CV は、通常のレキシカル変数と 全く同じようにそれらを捕捉できます。 フィールドは、PadnameIsFIELD() マクロがそれに対して真を 返すという点で、他の種類のパッドエントリとは区別されます。

フィールドであることに関連する追加情報は、パッド名の PadnameFIELDINFO() マクロを介してアクセス可能な追加構造体に格納されます。 この構造体には、次のフィールドがあります:

    PADOFFSET  fieldix;
    HV        *fieldstash;
    OP        *defop;
    SV        *paramname;
    bool       def_if_undef;
    bool       def_if_false;

• fieldix stores the "field index" of the field; that is, the index into the instance field array where this field's value will be stored. Note that the first index in the array is not specially reserved. The first field in a class will start from field index 0.

  fieldix は、フィールドの「フィールドインデックス」を格納します; つまり、このフィールドの値が格納される実体フィールド配列への インデックスです。 配列の最初のインデックスは特別に予約されていないことに注意してください。 クラスの最初のフィールドは、フィールドインデックス 0 から始まります。

• fieldstash stores a pointer to the stash of the class that defined this field. This is necessary in case there are multiple classes defined within the same scope; it is used to disambiguate the fields of each.

  fieldstash は、このフィールドを定義したクラスのスタッシュへのポインタを 格納します。 これは、同じスコープ内に複数のクラスが定義されている場合に必要です; これは、それぞれのフィールドを明確にするために使用されます。

      {
          class C1; field $x;
          class C2; field $x;
      }

• defop may store a pointer to a defaulting expression optree for this field. Defaulting expressions are optional; this field may be NULL.

  defop は、このフィールドのデフォルト式 op 木へのポインタを格納できます。 デフォルト式はオプションです; このフィールドは NULL である場合があります。

• paramname may point to a regular string SV containing the :param name attribute given to the field. If none, it will be NULL.

  paramname は、フィールドに指定された :param 名前属性を含む 通常の文字列 SV を指す場合があります。 属性がない場合は、NULL になります。

• One of def_if_undef and def_if_false will be true if the defaulting expression was set using the //= or ||= operators respectively.

  def_if_undef および def_if_false のいずれかは、デフォルトの 式がそれぞれ //= 演算子また は ||= 演算子を使用して 設定された場合に真になります。

メソッド¶

メソッドは基本的には依然として CV であり、CV と同じ基本表現を持ちます。 op 木とパッドを持ち、GV を介して格納パッケージのスタッシュに格納されます。 CvIsMETHOD() マクロが真を返すという事実によって、 メソッド以外の CV と区別されます。

(注意: このマクロは、以前 CvMETHOD() と呼ばれていたものと 混同しないようにしてください。 このマクロはクラスシステムに関連しておらず、 この混同を避けるために CvNOWARN_AMBIGUOUS() に名前が変更されました。)

現在、メソッド CV に関して格納する必要のある追加情報はないため、 この構造体では新しいフィールドは追加されません。

実体¶

オブジェクト実体は、基底型が SVt_PVOBJ である 完全に新しい SV 型によって表現されます。 これは、依然としてそのクラススタッシュに bless され、 古典的なオブジェクトのための通常の方法で RV にラップされるべきです。

これらはハッシュや配列とは別の独自のコンテナ型なので、 コア builtin::reftype 関数はこれらについて訊ねられたときに 新しい値を返します。 その値は "OBJECT" です。

内部的には、このようなオブジェクトは SV ポインタの配列であり、 そのサイズは作成時に固定されています(クラスのフィールド数は コンパイル後にわかるため)。 オブジェクト実体には、最大フィールドインデックス (アクセス時の基本的なエラーチェック用)と、個々のフィールド値を 格納する SV ポインタの固定サイズの配列が格納されます。

配列およびハッシュ型のフィールドは、AV または HV のポインタを 配列に直接格納します。 これらのポインタは、介在する RV を介して格納されません。

API¶

前述のデータ構造は、次の API 関数で対応しています。

クラス操作¶

class_setup_stash¶

    void class_setup_stash(HV *stash);

class キーワードを検出したときにパーサーによって呼び出されます。 スタッシュをクラスにアップグレードし、メソッドやフィールドなどの クラス固有の項目を受信できるように準備します。

class_seal_stash¶

    void class_seal_stash(HV *stash);

class ブロックの最後、またはユニットクラスの場合はそれを含む スコープでパーサによって呼び出されます。 この関数は、クラスの実体を構築する前に必要なさまざまな 終了アクティビティを実行しますが、クラスのメンバに関するすべての 情報がわかるまでは実行できません。

コンパイル中のクラスへの追加または変更は、これら二つの関数呼び出しの間に 実行する必要があります。 クラスは、封印(seal)された後は変更できません。

class_add_field¶

    void class_add_field(HV *stash, PADNAME *pn);

現在のパッドで新しいフィールド名を定義する一環として、 pad.c によって呼び出されます。 この関数は padname を作成 しない ことに注意してください; 作成は pad.c によってすでに行われている必要があります。 この API 関数は、新しいフィールド名が作成され、使用可能になったことを クラスに通知するだけです。

class_add_ADJUST¶

    void class_add_ADJUST(HV *stash, CV *cv);

新しい ADJUST ブロックの CV を解析して構築した後に、パーサに よって呼び出されます。 これは、クラスによって格納されるリストに追加されます。

フィールド操作¶

class_prepare_initfield_parse¶

    void class_prepare_initfield_parse();

フィールド変数の初期化式を解析する直前にパーサによって 呼び出されます。 これは、すべてのフィールド初期化式を同じ CV に結合するために、 一時停止された compcv を使用します。

class_set_field_defop¶

    void class_set_field_defop(PADNAME *pn, OPCODE defmode, OP *defop);

フィールドの初期化式をパースした後に、パーサによって呼び出されます。 デフォルト式およびアプリケーションのモードを設定します。 defmode は、ゼロであるか、デフォルトのモードに応じて OP_ORASSIGN または OP_DORASSIGN のいずれかである必要があります。

padadd_FIELD¶

    #define padadd_FIELD

このフラグ定数は、pad_add_name_* ファミリの関数に、新しい名前を フィールドとして追加するように指示します。 class_add_field() を呼び出す必要はありません; これは自動的に行われます。

メソッド操作¶

class_prepare_method_parse¶

    void class_prepare_method_parse(CV *cv);

start_subparse() の後、他の処理を行う直前にパーサによって 呼び出されます。 これにより、メソッドを解析するための PL_compcv が準備されます; CvIsMETHOD テストが真になるように調整され、$self の字句が追加され、 その他の必要なアクティビティが追加されます。

class_wrap_method_body¶

    OP *class_wrap_method_body(OP *o);

メソッド本体を op 木に解析する最後に、ただし最終的な CV に ラップする直前に、パーサによって呼び出されます。 この関数は、メソッドを正しく動作させるために、op 木に 追加の op を挿入します。

オブジェクト実体¶

SVt_PVOBJ¶

    #define SVt_PVOBJ

SvTYPE() マクロとの比較に使用する SV 型の定数。

ObjectMAXFIELD¶

    SSize_t ObjectMAXFIELD(sv);

ObjectFIELDS 配列からアクセスできる最大有効フィールドインデックスを 取得する関数型マクロ。

ObjectFIELDS¶

    SV **ObjectFIELDS(sv);

オブジェクト実体から直接フィールド配列を取得する 関数型のマクロ。 フィールドは、0 から ObjectMAXFIELD で指定された 最大有効インデックスまでのフィールドインデックスによってアクセスできます。

OPCODES¶

OP_METHSTART¶

    newUNOP_AUX(OP_METHSTART, ...);

OP_METHSTART は UNOP_AUX であり、適切に動作させるために メソッド CV の先頭に存在しなければなりません。 これは class_wrap_method_body() によって挿入され、 シグニチャ引数のチェックまたは抽出に関連付けられた op 木フラグメントの前にも表示されます。

この op は、$self の値を引数リストからシフトし、メソッドが アクセスする必要のあるフィールド変数をパッドにバインドすることに 責任を持ちます。 AUX ベクトルには、必要なフィールド/パッドインデックスの組の 詳細が含まれます。

この op は、呼び出し元の値の健全性チェックも実行されます。 互換性のあるクラス型のオブジェクト参照であることが 確実であるかどうかをチェックします。 そうでない場合は、例外がスローされます。

op_private フィールドに OPpINITFIELDS フラグが含まれている場合、 op が特殊な xhv_optree_initfields_cv CV を始めることを示します。 この場合、引数リストから 2 番目の値を追加で取得する必要があります; これは、(RV 経由ではなく 直接 の)プレーンな HV ポインタである 必要があり、 生成された op 木がそれを見つけることを期待する 2 番目の パッドスロットにバインドします。

OP_INITFIELD¶

OP_INITFIELD は、実体の構築フェーズ中に xhv_class_initfields_cv CV の一部としてのみ起動されます。 これは、実体の変更可能なフィールドを構成する個々の SV (AV および HV を含む)が実際に ObjectFIELDS 配列に割り当てられる 時間です。 OPpINITFIELD_AV および OPpINITFIELD_HV プライベートフラグは、 AV または HV を作成しているかどうかを示します; どちらも設定されていない場合は、SV が作成されます。

OPにOPf_STACKEDフラグが設定されている場合は、スタックで初期化値が 検出されることを想定しています。 SVの場合、これはデータスタックの最上位のSVです。 AVおよびHVの場合は、マーク付きリストを想定しています。

コンパイル時の振る舞い¶

ADJUST Phasers¶

(ADJUST フェーズ処理)

コンパイル時には、ADJUST フェーザーのパースは、既存の perl フェイザー(BEGIN など)とは根本的に異なる方法で扱われます。

通常のルートを取るのではなく、トークン化器は、ADJUST キーワードが フェイザーブロックを導入することを認識します。 次に、パーサは、(匿名)メソッドの本体をパースする方法と同様に、 このブロックの本体を解析し、GV という名前のない CV を作成します。 これは、class_add_ADJUST を呼び出すことによってクラス情報に直接挿入され、 シンボルテーブルを完全にバイパスします。

属性¶

コンパイル中、クラスとフィールドの両方の属性は、サブルーチンおよび レキシカル変数の既存の perl 属性とは異なる方法で処理されます。

パーサ は依然として OP_CONST ノードの OP_LIST op 木を形成しますが、 これらは class_apply_attributes または class_apply_field_attributes 関数に渡されます。 パースされるクラス内のメソッドのクラス検索を使うのではなく、 既知の属性の固定された内部リストが、クラスまたはフィールドに属性を 適用する関数を検索するために使われます。 現在はコア自体によって定義されたもののみを認識しますが、将来的には ユーザ提供の拡張属性をサポートする可能性があります。

フィールド初期化式¶

コンパイル時に、パーサは、フィールドのデフォルト式を解析するときに、 中断された compcv を使います。 クラス内のすべてのフィールドのすべての式は、同じ中断された compcv を 共有します; これは、 そのクラスによって提供されるすべてのフィールドを初期化するために、 コンストラクタによって呼び出される同じ内部 CV にコンパイルされます。

実行時の振る舞い¶

コンストラクタ¶

クラス自体に対して生成されたコンストラクタは、三つのタスクを順番に 実行する XSUB です: 実体 SV 自体を作成し、フィールド初期化器を起動し、 それから ADJUST ブロック CV を起動します。 クラスにスーパークラスがあるかどうかにかかわらず、クラスの コンストラクタは常に同じ基本的な形です。

フィールド初期化器は、フィールド初期化器 CV と呼ばれる 生成された optree ベースの CV に収集されます。 これは、フィールド初期化式のすべての op 木フラグメントを含む CV です。 起動されると、フィールド初期化器 CV は、個々のフィールド初期化 op を 起動する前に、スーパークラスの初期化器が存在する場合は、 それへの連鎖呼び出しを行う可能性があります。 フィールド初期化器 CV は、スタック上の二つの項目で呼び出されます; 実体 SV と、コンストラクタパラメータを含む直接 HV です。 注意: この HV は、RV 参照を経由するのではなく、直接 渡されます。 これが許可されるのは、呼び出し元と呼び出し先の両方が直接生成された コードであり、任意の純粋な perl サブルーチンではないためです。

ADJUST ブロックの CV はすべて単一のフラットなリストに収集され、 スーパークラスによって定義されたすべての CV もマージされます。 これらはすべて、フィールド初期化器 CV の後に順番に呼び出されます。

$self Access During Methods¶

(メソッド内での $self へのアクセス)

class_prepare_method_parse() が呼び出されると、新しい CV の本体のパッドが $self と呼ばれるレキシカルで始まるように配置されます。 パッドはこの時点で新たに作成される必要があるため、パッドのインデックスは 1 になります。 この関数はこれをチェックし、これが真でない場合は中止します。

このため、メソッドまたはメソッド風 CV の本体内のコードでは、 パッドインデックス 1 を使用して invocant 参照を確実に取得できます。 OP_INITFIELD オペコードもこの事実に依存しています。

同様に、xhv_class_initfields_cv の間、次のパッドスロットは、 パッドインデックス 2 でコンストラクタ引数 HV を格納することに 依存します。

作者¶

Paul Evans