perlreapi - perl regular expression plugin interface

perlreapi - perl 正規表現プラグインインターフェース

(訳注: (TBR)がついている段落は「みんなの自動翻訳@TexTra」による 機械翻訳です。)


As of Perl 5.9.5 there is a new interface for plugging and using other regular expression engines than the default one.

Perl 5.9.5 から、デフォルトと異なるその他の正規表現エンジンを使うための 新しいインターフェスがあります。

Each engine is supposed to provide access to a constant structure of the following format:

それぞれのエンジンは以下の形式の定数構造体へのアクセスを提供することに なっています:

    typedef struct regexp_engine {
        REGEXP* (*comp) (pTHX_ const SV * const pattern, const U32 flags);
        I32     (*exec) (pTHX_ REGEXP * const rx, char* stringarg, char* strend,
                         char* strbeg, I32 minend, SV* screamer,
                         void* data, U32 flags);
        char*   (*intuit) (pTHX_ REGEXP * const rx, SV *sv, char *strpos,
                           char *strend, U32 flags,
                           struct re_scream_pos_data_s *data);
        SV*     (*checkstr) (pTHX_ REGEXP * const rx);
        void    (*free) (pTHX_ REGEXP * const rx);
        void    (*numbered_buff_FETCH) (pTHX_ REGEXP * const rx, const I32 paren,
                                 SV * const sv);
        void    (*numbered_buff_STORE) (pTHX_ REGEXP * const rx, const I32 paren,
                                       SV const * const value);
        I32     (*numbered_buff_LENGTH) (pTHX_ REGEXP * const rx, const SV * const sv,
                                        const I32 paren);
        SV*     (*named_buff) (pTHX_ REGEXP * const rx, SV * const key,
                               SV * const value, U32 flags);
        SV*     (*named_buff_iter) (pTHX_ REGEXP * const rx, const SV * const lastkey,
                                    const U32 flags);
        SV*     (*qr_package)(pTHX_ REGEXP * const rx);
    #ifdef USE_ITHREADS
        void*   (*dupe) (pTHX_ REGEXP * const rx, CLONE_PARAMS *param);

When a regexp is compiled, its engine field is then set to point at the appropriate structure, so that when it needs to be used Perl can find the right routines to do so.

正規表現がコンパイルされるとき、engine フィールドが適切な構造体を 指すように設定されるので、使われる必要があるとき、Perl はそうするための 正しいルーチンを見つけられます。

In order to install a new regexp handler, $^H{regcomp} is set to an integer which (when casted appropriately) resolves to one of these structures. When compiling, the comp method is executed, and the resulting regexp structure's engine field is expected to point back at the same structure.

新しいregexpハンドラをインストールするために、$^H{regcomp}はこれらの構造体の1つを(適切にギプス固定時)解決する整数に設定されます。 コンパイル時にはcompメソッドが実行され、生成されたregexp構造体のエンジンフィールドは同じ構造体を指すことが期待されます。 (TBR)

The pTHX_ symbol in the definition is a macro used by perl under threading to provide an extra argument to the routine holding a pointer back to the interpreter that is executing the regexp. So under threading all routines get an extra argument.

定義内のpTHX_シンボルは、perlがスレッド化の下で使用するマクロで、regexpを実行しているインタプリタへのポインタを保持するルーチンに追加引数を提供します。 したがって、スレッド化の下では、すべてのルーチンが追加引数を取得します。 (TBR)



    REGEXP* comp(pTHX_ const SV * const pattern, const U32 flags);

Compile the pattern stored in pattern using the given flags and return a pointer to a prepared REGEXP structure that can perform the match. See "The REGEXP structure" below for an explanation of the individual fields in the REGEXP struct.

与えられたflagsを使用してpatternに格納されたパターンをコンパイルし、マッチを実行できる準備されたREGEXP構造体へのポインタを返します。 REGEXP構造体の個々のフィールドの説明については、下記の"The REGEXP structure"を参照してください。 (TBR)

The pattern parameter is the scalar that was used as the pattern. previous versions of perl would pass two char* indicating the start and end of the stringified pattern, the following snippet can be used to get the old parameters:

patternパラメータは、パターンとして使用されたスカラです。 以前のバージョンのperlでは、文字列化されたパターンの開始と終了を示す2つのchar*が渡されていました。 古いパラメータを取得するには、次のスニペットを使用できます。 (TBR)

    STRLEN plen;
    char*  exp = SvPV(pattern, plen);
    char* xend = exp + plen;

Since any scalar can be passed as a pattern it's possible to implement an engine that does something with an array ("ook" =~ [ qw/ eek hlagh / ]) or with the non-stringified form of a compiled regular expression ("ook" =~ qr/eek/). perl's own engine will always stringify everything using the snippet above but that doesn't mean other engines have to.

どんなスカラもパターンとして渡すことができるので、配列("ook" =~ [ qw/ eek hlagh / ])や、非ストリング形式のコンパイルされた正規表現("ook" =~ qr/eek/)を使って何かを行うエンジンを実装することができます。 perl自身のエンジンは常に上記のスニペットを使ってすべてをストリング化しますが、他のエンジンがそうしなければならないというわけではありません。 (TBR)

The flags parameter is a bitfield which indicates which of the msixp flags the regex was compiled with. It also contains additional info such as whether use locale is in effect.

flagsパラメータは、regexがどのmsixpフラグでコンパイルされたかを示すビットフィールドである。 また、use localeが有効かどうかといった追加情報も含まれる。 (TBR)

The eogc flags are stripped out before being passed to the comp routine. The regex engine does not need to know whether any of these are set as those flags should only affect what perl does with the pattern and its match variables, not how it gets compiled and executed.

eogcフラグはcompルーチンに渡される前に取り除かれます。 regexエンジンは、これらのフラグが設定されているかどうかを知る必要はありません。 なぜなら、これらのフラグはperlがパターンとマッチ変数で行うことに影響を与えるだけで、コンパイル方法や実行方法には影響を与えないからです。 (TBR)

By the time the comp callback is called, some of these flags have already had effect (noted below where applicable). However most of their effect occurs after the comp callback has run in routines that read the rx->extflags field which it populates.

compコールバックが呼び出されるまでに、これらのフラグのいくつかはすでに有効になっています(適用可能な場合は後述します)。 ただし、これらの効果のほとんどは、compコールバックがrx->extflags>>フィールドを読み込むルーチンで実行された後に発生します。 (TBR)

In general the flags should be preserved in rx->extflags after compilation, although the regex engine might want to add or delete some of them to invoke or disable some special behavior in perl. The flags along with any special behavior they cause are documented below:

一般に、これらのフラグはコンパイル後にrx->extflags>>に保存する必要があります。 ただし、regexエンジンは、perlでの特殊な動作を起動または無効にするために、フラグの一部を追加または削除する必要がある場合があります。 これらのフラグとフラグが引き起こす特殊な動作については、以下で説明します。 (TBR)

The pattern modifiers:

パターン修飾子: (TBR)


If this is in rx->extflags it will be passed to Perl_fbm_instr by pp_split which will treat the subject string as a multi-line string.

これがrx->extflags>>にある場合、pp_splitによってPerl_fbm_instrに渡されます。 pp_splitは、対象ストリングを複数行ストリングとして処理します。 (TBR)

/i - RXf_PMf_FOLD

If present on a regex # comments will be handled differently by the tokenizer in some cases.

regexに存在する場合、#コメントは、場合によってはトークナイザによって異なる方法で処理されます。 (TBR)

TODO: Document those cases.

TODO:これらのケースを記録します。 (TBR)


Additional flags:

追加フラグ: (TBR)


Set if use locale is in effect. If present in rx->extflags split will use the locale dependent definition of whitespace under when RXf_SKIPWHITE or RXf_WHITE are in effect. Under ASCII whitespace is defined as per isSPACE, and by the internal macros is_utf8_space under UTF-8 and isSPACE_LC under use locale.

use localeが有効な場合に設定されます。 rx->extflags>>に存在する場合、splitは、RXf_SKIPWHITEまたはRXf_WHITEが有効な場合に、以下の空白のロケール依存の定義を使用します。 ASCIIでは、空白はisSPACEによって定義され、内部マクロis_utf8_space(UTF-8)とisSPACE_LC(use locale)によって定義されます。 (TBR)


Set if the pattern is SvUTF8(), set by Perl_pmruntime.

パターンがPerl_pmruntimeで設定されたSvUTF8()の場合に設定されます。 (TBR)

A regex engine may want to set or disable this flag during compilation. The perl engine for instance may upgrade non-UTF-8 strings to UTF-8 if the pattern includes constructs such as \x{...} that can only match Unicode values.

regexエンジンは、コンパイル中にこのフラグを設定または無効にしたい場合があります。 例えば、Perlエンジンは、パターンにUnicode値にしか一致しない\x{.}のような構造体が含まれている場合、非UTF-8文字列をUTF-8にアップグレードします。 (TBR)


If split is invoked as split ' ' or with no arguments (which really means split(' ', $_), see split), perl will set this flag. The regex engine can then check for it and set the SKIPWHITE and WHITE extflags. To do this the perl engine does:

splitsplit ' 'として、または引数なしで呼び出された場合(これは実際にはsplit(' ', $_)を意味します。 splitを参照してください)、perlはこのフラグを設定します。 regexエンジンはこのフラグをチェックして、SKIPWHITEとホワイトextflagsを設定します。 これを行うために、perlエンジンは以下を行います。 (TBR)

    if (flags & RXf_SPLIT && r->prelen == 1 && r->precomp[0] == ' ')
        r->extflags |= (RXf_SKIPWHITE|RXf_WHITE);

These flags can be set during compilation to enable optimizations in the split operator.

コンパイル時にこれらのフラグを設定して、split演算子での最適化を有効にすることができます。 (TBR)


If the flag is present in rx->extflags split will delete whitespace from the start of the subject string before it's operated on. What is considered whitespace depends on whether the subject is a UTF-8 string and whether the RXf_PMf_LOCALE flag is set.

フラグがrx->extflags>>に存在する場合、splitは操作の前に対象文字列の先頭から空白文字を削除します。 空白文字とみなされるものは、対象文字列がUTF-8文字列であるかどうか、およびRXf_PMf_LOCALEフラグが設定されているかどうかによって異なります。 (TBR)

If RXf_WHITE is set in addition to this flag split will behave like split " " under the perl engine.

このフラグに加えてRXf_WHITEが設定されている場合、Perlエンジンではsplitsplit " "のように動作します。 (TBR)


Tells the split operator to split the target string on newlines (\n) without invoking the regex engine.

regexエンジンを呼び出さずに、ターゲット文字列を改行(\n)で分割するように、分割演算子に指示します。 (TBR)

Perl's engine sets this if the pattern is /^/ (plen == 1 && *exp == '^'), even under /^/s, see split. Of course a different regex engine might want to use the same optimizations with a different syntax.

Perlのエンジンは、パターンが/^/(plen == 1 && *exp == '^')の場合にこれを設定します。 /^/sの下でも、splitを参照してください。 もちろん、regexエンジンが異なれば、同じ最適化を異なる構文で使用することもできます。 (TBR)


Tells the split operator to split the target string on whitespace without invoking the regex engine. The definition of whitespace varies depending on whether the target string is a UTF-8 string and on whether RXf_PMf_LOCALE is set.

regexエンジンを呼び出さずにターゲット文字列を空白で分割するよう、分割演算子に指示します。 空白の定義は、ターゲット文字列がUTF-8文字列であるかどうか、およびRXf_PMf_LOCALEが設定されているかどうかによって異なります。 (TBR)

Perl's engine sets this flag if the pattern is \s+.

Perlのエンジンは、パターンが\s+の場合、このフラグを設定します。 (TBR)


Tells the split operator to split the target string on characters. The definition of character varies depending on whether the target string is a UTF-8 string.

ターゲット文字列を文字で分割するように分割演算子に指示します。 文字の定義は、ターゲット文字列がUTF-8文字列かどうかによって異なります。 (TBR)

Perl's engine sets this flag on empty patterns, this optimization makes split // much faster than it would otherwise be. It's even faster than unpack.

Perlのエンジンは空のパターンにこのフラグをセットします。 この最適化により、split //は、そうでない場合よりもはるかに高速になります。 unpackよりもさらに高速です。 (TBR)


    I32 exec(pTHX_ REGEXP * const rx,
             char *stringarg, char* strend, char* strbeg,
             I32 minend, SV* screamer,
             void* data, U32 flags);

Execute a regexp.

regexpを実行します。 (TBR)


    char* intuit(pTHX_ REGEXP * const rx,
                  SV *sv, char *strpos, char *strend,
                  const U32 flags, struct re_scream_pos_data_s *data);

Find the start position where a regex match should be attempted, or possibly whether the regex engine should not be run because the pattern can't match. This is called as appropriate by the core depending on the values of the extflags member of the regexp structure.

正規表現の一致を試行する開始位置、またはパターンが一致しないために正規表現エンジンを実行すべきでないかどうかを検索します。 これは、regexp構造体のextflagsメンバーの値に応じて、コアによって適切に呼び出されます。 (TBR)


    SV* checkstr(pTHX_ REGEXP * const rx);

Return a SV containing a string that must appear in the pattern. Used by split for optimising matches.

パターンに表示される文字列を含むSVを返します。 マッチを最適化するためにsplitによって使用されます。 (TBR)


    void free(pTHX_ REGEXP * const rx);

Called by perl when it is freeing a regexp pattern so that the engine can release any resources pointed to by the pprivate member of the regexp structure. This is only responsible for freeing private data; perl will handle releasing anything else contained in the regexp structure.

perlがregexpパターンを解放して、regexp構造体のpprivateメンバーによってポイントされたリソースをエンジンが解放できるようにするときに呼び出されます。 これはプライベートデータの解放のみを行います。 perlはregexp構造体に含まれる他のすべての解放を処理します。 (TBR)


Called to get/set the value of $`, $', $& and their named equivalents, ${^PREMATCH}, ${^POSTMATCH} and $^{MATCH}, as well as the numbered capture buffers ($1, $2, ...).

$`$'$&、およびそれらに対応する名前付きの${^PREMATCH}、${^POSTMATCH}、$^{MATCH}、および番号付きキャプチャバッファ($1$2、.)の値を取得/設定するために呼び出されます。 (TBR)

The paren parameter will be -2 for $`, -1 for $', 0 for $&, 1 for $1 and so forth.

parenパラメータは、$`に対して-2$'に対して-1$&に対して0$1に対して1などとなります。 (TBR)

The names have been chosen by analogy with Tie::Scalar methods names with an additional LENGTH callback for efficiency. However named capture variables are currently not tied internally but implemented via magic.

名前は、効率性のためにTie::Scalarメソッド名と追加のLENGTHコールバックから類推して選択されている。 ただし、名前付きキャプチャ変数は現在、内部では結合されておらず、マジックによって実装されている。 (TBR)


    void numbered_buff_FETCH(pTHX_ REGEXP * const rx, const I32 paren,
                             SV * const sv);

Fetch a specified numbered capture. sv should be set to the scalar to return, the scalar is passed as an argument rather than being returned from the function because when it's called perl already has a scalar to store the value, creating another one would be redundant. The scalar can be set with sv_setsv, sv_setpvn and friends, see perlapi.

指定された番号付きキャプチャをフェッチします。 svを返すスカラに設定する必要があります。 このスカラは関数から返されるのではなく引数として渡されます。 というのは、perlという関数が既に値を格納するスカラを持っている場合には、別のスカラを作成するのは冗長になるからです。 スカラはsv_setsvsv_setpvn、friendsで設定できます。 perlapiを参照してください。 (TBR)

This callback is where perl untaints its own capture variables under taint mode (see perlsec). See the Perl_reg_numbered_buff_fetch function in regcomp.c for how to untaint capture variables if that's something you'd like your engine to do as well.

このコールバックは、perlがuntaintsモード(perlsecを参照)で独自のキャプチャ変数をテイントする場所です。 エンジンにも同様に行わせたい場合は、regcomp.cPerl_reg_numbered_buff_fetch関数を参照してください。 (TBR)


    void    (*numbered_buff_STORE) (pTHX_ REGEXP * const rx, const I32 paren,
                                    SV const * const value);

Set the value of a numbered capture variable. value is the scalar that is to be used as the new value. It's up to the engine to make sure this is used as the new value (or reject it).

番号付きキャプチャ変数の値を設定します。 valueは、新しい値として使用されるスカラです。 これが新しい値として使用される(または拒否される)かどうかはエンジン次第です。 (TBR)


例: (TBR)

    if ("ook" =~ /(o*)/) {
        # `paren' will be `1' and `value' will be `ee'
        $1 =~ tr/o/e/;

Perl's own engine will croak on any attempt to modify the capture variables, to do this in another engine use the following callback (copied from Perl_reg_numbered_buff_store):

Perl自身のエンジンは、キャプチャ変数を変更しようとするときにクロッキングします。 別のエンジンでこれを行うには、次のコールバック(Perl_reg_numbered_buff_storeからコピー)を使用します。 (TBR)

    Example_reg_numbered_buff_store(pTHX_ REGEXP * const rx, const I32 paren,
                                                            SV const * const value)

        if (!PL_localizing)
            Perl_croak(aTHX_ PL_no_modify);

Actually perl will not always croak in a statement that looks like it would modify a numbered capture variable. This is because the STORE callback will not be called if perl can determine that it doesn't have to modify the value. This is exactly how tied variables behave in the same situation:

実際には、番号付きのキャプチャ変数を変更するような文では、perlは<常に>確認できません。 これは、perlが値を変更する必要がないと判断した場合には、STOREコールバックが呼び出されないためです。 同じ状況では、ひも付き変数は次のように動作します。 (TBR)

    package CaptureVar;
    use base 'Tie::Scalar';

    sub TIESCALAR { bless [] }
    sub FETCH { undef }
    sub STORE { die "This doesn't get called" }

    package main;

    tie my $sv => "CatptureVar";
    $sv =~ y/a/b/;

Because $sv is undef when the y/// operator is applied to it the transliteration won't actually execute and the program won't die. This is different to how 5.8 and earlier versions behaved since the capture variables were READONLY variables then, now they'll just die when assigned to in the default engine.

$svundefなので、y///演算子がそれに適用されたときに音訳は実際には実行されず、プログラムはdieを実行しません。 これは5.8以前のバージョンとは異なります。 なぜなら、キャプチャ変数はREADONLY変数であったため、デフォルトエンジンでに割り当てられたときに単に消滅するからです。 (TBR)


    I32 numbered_buff_LENGTH (pTHX_ REGEXP * const rx, const SV * const sv,
                              const I32 paren);

Get the length of a capture variable. There's a special callback for this so that perl doesn't have to do a FETCH and run length on the result, since the length is (in perl's case) known from an offset stored in rx->offs this is much more efficient:

キャプチャ変数のlengthを取得します。 このための特別なコールバックがあり、perlがFETCHを実行して結果に対してlengthを実行する必要がありません。 長さは(perlの場合)rx->offs>>に格納されたオフセットからわかるので、これは非常に効率的です: (TBR)

    I32 s1  = rx->offs[paren].start;
    I32 s2  = rx->offs[paren].end;
    I32 len = t1 - s1;

This is a little bit more complex in the case of UTF-8, see what Perl_reg_numbered_buff_length does with is_utf8_string_loclen.

これはUTF-8の場合にはもう少し複雑です。 Perl_reg_reg_numbered_buff_lengthis_utf8_string_loclenで行っていることを見てください。 (TBR)


Called to get/set the value of %+ and %- as well as by some utility functions in re.

%+%-の値を取得/設定するために、またreのユーティリティ関数によって呼び出されます。 (TBR)

There are two callbacks, named_buff is called in all the cases the FETCH, STORE, DELETE, CLEAR, EXISTS and SCALAR Tie::Hash callbacks would be on changes to %+ and %- and named_buff_iter in the same cases as FIRSTKEY and NEXTKEY.

2つのコールバックがあります。 named_buffはすべての場合に呼び出されます。 FETCH、STORE、DELETE、CLEAR、EXISTSおよびSCALAR Tie::Hashコールバックは、%+%-およびnamed_buff_iterへの変更時に、FIRSTKEYおよびNEXTKEYと同じ場合に呼び出されます。 (TBR)

The flags parameter can be used to determine which of these operations the callbacks should respond to, the following flags are currently defined:

flagsパラメータを使用して、これらのどの操作にコールバックが応答するかを決定できます。 現在、次のフラグが定義されています。 (TBR)

Which Tie::Hash operation is being performed from the Perl level on %+ or %+, if any:

%+または%+<%+>に対して実行されているTie::Hash操作(ある場合): (TBR)


Whether %+ or %- is being operated on, if any.

%+または%-が操作されているかどうか(もしあれば)。 (TBR)

    RXapif_ONE /* %+ */
    RXapif_ALL /* %- */

Whether this is being called as re::regname, re::regnames or re::regnames_count, if any. The first two will be combined with RXapif_ONE or RXapif_ALL.

re::regnamere::regnames、またはre::regnames_countのいずれか(存在する場合)。 最初の2つはRXapif_ONEまたはRXapif_ALLと結合されます。 (TBR)


Internally %+ and %- are implemented with a real tied interface via Tie::Hash::NamedCapture. The methods in that package will call back into these functions. However the usage of Tie::Hash::NamedCapture for this purpose might change in future releases. For instance this might be implemented by magic instead (would need an extension to mgvtbl).

内部的には、%+%-は、Tie::Hash::NamedCaptureを介して実際に結合されたインターフェイスで実装されます。 そのパッケージのメソッドは、これらの関数にコールバックします。 ただし、この目的のためのTie::Hash::NamedCaptureの使用方法は、将来のリリースで変更される可能性があります。 例えば、これは代わりにmagicによって実装される可能性があります(mgvtblへの拡張が必要です)。 (TBR)


    SV*     (*named_buff) (pTHX_ REGEXP * const rx, SV * const key,
                           SV * const value, U32 flags);


    SV*     (*named_buff_iter) (pTHX_ REGEXP * const rx, const SV * const lastkey,
                                const U32 flags);


    SV* qr_package(pTHX_ REGEXP * const rx);

The package the qr// magic object is blessed into (as seen by ref qr//). It is recommended that engines change this to their package name for identification regardless of whether they implement methods on the object.

(ref qr//で見られるように)qr//magicオブジェクトが祝福されるパッケージ。 エンジンは、オブジェクトにメソッドを実装しているかどうかに関係なく、識別のためにこれをパッケージ名に変更することを推奨する。 (TBR)

The package this method returns should also have the internal Regexp package in its @ISA. qr//-isa("Regexp")> should always be true regardless of what engine is being used.

このメソッドが返すパッケージには、@ISA内に内部Regexpパッケージも含まれている必要があります。 qr//-isa("Regexp")>は、使用されているエンジンに関係なく常にtrueである必要があります。 (TBR)

Example implementation might be:

実装例は次のようになります。 (TBR)

    Example_qr_package(pTHX_ REGEXP * const rx)
        return newSVpvs("re::engine::Example");

Any method calls on an object created with qr// will be dispatched to the package as a normal object.

qr//で作成されたオブジェクトに対するメソッド呼び出しは、通常のオブジェクトとしてパッケージにディスパッチされます。 (TBR)

    use re::engine::Example;
    my $re = qr//;
    $re->meth; # dispatched to re::engine::Example::meth()

To retrieve the REGEXP object from the scalar in an XS function use the SvRX macro, see "REGEXP Functions" in perlapi.

XS関数のスカラからREGEXPオブジェクトを取得するには、SvRXマクロを使用します。 "REGEXP Functions"in perlapiを参照してください。 (TBR)

    void meth(SV * rv)
        REGEXP * re = SvRX(sv);


    void* dupe(pTHX_ REGEXP * const rx, CLONE_PARAMS *param);

On threaded builds a regexp may need to be duplicated so that the pattern can be used by multiple threads. This routine is expected to handle the duplication of any private data pointed to by the pprivate member of the regexp structure. It will be called with the preconstructed new regexp structure as an argument, the pprivate member will point at the old private structure, and it is this routine's responsibility to construct a copy and return a pointer to it (which perl will then use to overwrite the field as passed to this routine.)

スレッド化ビルドでは、パターンを複数のスレッドで使用できるように、regexpを複製する必要がある場合があります。 このルーチンは、regexp構造体のpprivateメンバによってポイントされるプライベートデータの複製を処理することが期待されています。 このルーチンは、事前に構築された新しいregexp構造体を引数として呼び出され、pprivateメンバはoldプライベート構造体をポイントします。 そして、コピーを作成してそのポインタを返すのは、このルーチンの責任です(このルーチンに渡されたフィールドを上書きするためにperlが使用します)。 (TBR)

This allows the engine to dupe its private data but also if necessary modify the final structure if it really must.

これにより、エンジンはプライベートデータを複製することができますが、必要に応じて最終構造を変更することもできます。 (TBR)

On unthreaded builds this field doesn't exist.

スレッド化されていないビルドでは、このフィールドは存在しません。 (TBR)


The REGEXP struct is defined in regexp.h. All regex engines must be able to correctly build such a structure in their "comp" routine.

REGEXP構造体はregexp.hで定義されています。 すべてのregexエンジンは、"comp"ルーチンでこのような構造体を正しく構築できなければなりません。 (TBR)

The REGEXP structure contains all the data that perl needs to be aware of to properly work with the regular expression. It includes data about optimisations that perl can use to determine if the regex engine should really be used, and various other control info that is needed to properly execute patterns in various contexts such as is the pattern anchored in some way, or what flags were used during the compile, or whether the program contains special constructs that perl needs to be aware of.

REGEXP構造体には、正規表現で適切に動作するためにperlが認識する必要があるすべてのデータが含まれています。 この構造体には、regexエンジンを実際に使用すべきかどうかを判断するためにperlが使用できる最適化に関するデータや、さまざまなコンテキストでパターンを適切に実行するために必要なその他のさまざまな制御情報(パターンが何らかの方法で固定されているかどうか、コンパイル時にどのフラグが使用されたか、プログラムにperlが認識する必要がある特殊な構造体が含まれているかどうかなど)が含まれています。 (TBR)

In addition it contains two fields that are intended for the private use of the regex engine that compiled the pattern. These are the intflags and pprivate members. pprivate is a void pointer to an arbitrary structure whose use and management is the responsibility of the compiling engine. perl will never modify either of these values.

さらに、パターンをコンパイルしたregexエンジンのプライベートな使用を目的とした2つのフィールドが含まれています。 これらはintflagsメンバとpprivateメンバです。 pprivateは任意の構造体へのvoidポインタで、その使用と管理はコンパイルエンジンが担当します。 perlはこれらの値を変更することはありません。 (TBR)

    typedef struct regexp {
        /* what engine created this regexp? */
        const struct regexp_engine* engine;

        /* what re is this a lightweight copy of? */
        struct regexp* mother_re;

        /* Information about the match that the perl core uses to manage things */
        U32 extflags;   /* Flags used both externally and internally */
        I32 minlen;     /* mininum possible length of string to match */
        I32 minlenret;  /* mininum possible length of $& */
        U32 gofs;       /* chars left of pos that we search from */

        /* substring data about strings that must appear
           in the final match, used for optimisations */
        struct reg_substr_data *substrs;

        U32 nparens;  /* number of capture buffers */

        /* private engine specific data */
        U32 intflags;   /* Engine Specific Internal flags */
        void *pprivate; /* Data private to the regex engine which 
                           created this object. */

        /* Data about the last/current match. These are modified during matching*/
        U32 lastparen;            /* last open paren matched */
        U32 lastcloseparen;       /* last close paren matched */
        regexp_paren_pair *swap;  /* Swap copy of *offs */
        regexp_paren_pair *offs;  /* Array of offsets for (@-) and (@+) */

        char *subbeg;  /* saved or original string so \digit works forever. */
        SV_SAVED_COPY  /* If non-NULL, SV which is COW from original */
        I32 sublen;    /* Length of string pointed by subbeg */

        /* Information about the match that isn't often used */
        I32 prelen;           /* length of precomp */
        const char *precomp;  /* pre-compilation regular expression */

        char *wrapped;  /* wrapped version of the pattern */
        I32 wraplen;    /* length of wrapped */

        I32 seen_evals;   /* number of eval groups in the pattern - for security checks */
        HV *paren_names;  /* Optional hash of paren names */

        /* Refcount of this regexp */
        I32 refcnt;             /* Refcount of this regexp */
    } regexp;

The fields are discussed in more detail below:

フィールドについては、以下で詳しく説明します。 (TBR)


This field points at a regexp_engine structure which contains pointers to the subroutines that are to be used for performing a match. It is the compiling routine's responsibility to populate this field before returning the regexp object.

このフィールドは、マッチングの実行に使用されるサブルーチンへのポインタを含むregexp_engine構造体を指します。 regexpオブジェクトを返す前にこのフィールドに値を入力するのは、コンパイルルーチンの責任です。 (TBR)

Internally this is set to NULL unless a custom engine is specified in $^H{regcomp}, perl's own set of callbacks can be accessed in the struct pointed to by RE_ENGINE_PTR.

$^H{regcomp}でカスタムエンジンが指定されていない限り、内部的にはこれはNULLに設定されます。 perl独自のコールバックセットは、RE_ENGINE_PTRが指す構造体でアクセスできます。 (TBR)


TODOについては、http://www.mail-archive.com/perl5-changes@perl.org/msg17328.htmlを参照してください。 (TBR)


This will be used by perl to see what flags the regexp was compiled with, this will normally be set to the value of the flags parameter by the comp callback. See the comp documentation for valid flags.

これは、perlがregexpがコンパイルされたフラグを確認するために使用します。 これは通常、compコールバックによってflagsパラメータの値に設定されます。 有効なフラグについては、compのドキュメントを参照してください。 (TBR)

minlen minlenret

The minimum string length required for the pattern to match. This is used to prune the search space by not bothering to match any closer to the end of a string than would allow a match. For instance there is no point in even starting the regex engine if the minlen is 10 but the string is only 5 characters long. There is no way that the pattern can match.

パターンが一致するために必要な文字列の最小長。 これは、一致が可能な文字列よりも文字列の最後に近い文字列を一致させないようにすることで、サーチスペースを削減するために使用されます。 例えば、minlenが10で文字列が5文字しかない場合、regexエンジンを起動しても意味がありません。 パターンが一致する方法はありません。 (TBR)

minlenret is the minimum length of the string that would be found in $& after a match.

minlenretは、$&の中でマッチ後に見つかる文字列の最小長です。 (TBR)

The difference between minlen and minlenret can be seen in the following pattern:

minlenminlenretの違いは、次のパターンで確認できます。 (TBR)


where the minlen would be 3 but minlenret would only be 2 as the \d is required to match but is not actually included in the matched content. This distinction is particularly important as the substitution logic uses the minlenret to tell whether it can do in-place substitution which can result in considerable speedup.

この場合、minlenは3になりますが、minlenretは2になります。 これは、\dは一致する必要がありますが、一致したコンテンツに実際には含まれていないためです。 この区別は特に重要です。 置換ロジックでは、minlenretを使用して、大幅な高速化が可能なin-place置換が可能かどうかを判断します。 (TBR)


Left offset from pos() to start match at.

pos()からマッチを開始するまでの左オフセット。 (TBR)


Substring data about strings that must appear in the final match. This is currently only used internally by perl's engine for but might be used in the future for all engines for optimisations.

最終マッチで出現しなければならない文字列に関する部分文字列データ。 これは現在、perlのエンジン内部でのみ使用されていますが、将来的には最適化のためにすべてのエンジンで使用される可能性があります。 (TBR)

nparens, lasparen, and lastcloseparen

These fields are used to keep track of how many paren groups could be matched in the pattern, which was the last open paren to be entered, and which was the last close paren to be entered.

これらのフィールドは、パターン内でマッチさせることができる括弧グループの数、入力されるべき最後のオープン括弧と入力されるべき最後のクローズ括弧を追跡するために使用されます。 (TBR)


The engine's private copy of the flags the pattern was compiled with. Usually this is the same as extflags unless the engine chose to modify one of them.

パターンがコンパイルされたフラグのエンジンのプライベートコピーです。 通常、エンジンがフラグのいずれかを変更しない限り、これはextflagsと同じです。 (TBR)


A void* pointing to an engine-defined data structure. The perl engine uses the regexp_internal structure (see "Base Structures" in perlreguts) but a custom engine should use something else.

エンジン定義のデータ構造体を指すvoid*です。 perlエンジンはregexp_internal構造体("Base Structures" in perlregutsを参照)を使用しますが、カスタムエンジンは他の構造体を使用する必要があります。 (TBR)


TODO: document

TODO:ドキュメント (TBR)


A regexp_paren_pair structure which defines offsets into the string being matched which correspond to the $& and $1, $2 etc. captures, the regexp_paren_pair struct is defined as follows:

regexp_paren_pair構造体は、$&$1$2などのキャプチャに対応する、マッチングされる文字列へのオフセットを定義します。 regexp_paren_pair構造体は以下のように定義されます。 (TBR)

    typedef struct regexp_paren_pair {
        I32 start;
        I32 end;
    } regexp_paren_pair;

If ->offs[num].start or ->offs[num].end is -1 then that capture buffer did not match. ->offs[0].start/end represents $& (or ${^MATCH under //p) and ->offs[paren].end matches $$paren where $paren = 1>.

->offs[num].start>>または->offs[num].end>>が-1の場合、そのキャプチャバッファは一致しませんでした。 ->offs[0].start/end>>は$&(または//pの下の${^MATCH)を表し、->offs[paren].end>>は$$paren(ここで$paren =1>)と一致します。 (TBR)

precomp prelen

Used for optimisations. precomp holds a copy of the pattern that was compiled and prelen its length. When a new pattern is to be compiled (such as inside a loop) the internal regcomp operator checks whether the last compiled REGEXP's precomp and prelen are equivalent to the new one, and if so uses the old pattern instead of compiling a new one.

最適化に使用されます。 precompはコンパイルされたパターンのコピーを保持し、prelenはその長さを保持します。 新しいパターンがコンパイルされる場合(ループ内など)、内部regcomp演算子は最後にコンパイルされたREGEXPprecompprelenが新しいパターンと等価であるかどうかをチェックし、等価である場合は新しいパターンをコンパイルする代わりに古いパターンを使用します。 (TBR)

The relevant snippet from Perl_pp_regcomp:

Perl_pp_regcompの関連スニペットは次のとおりです。 (TBR)

        if (!re || !re->precomp || re->prelen != (I32)len ||
            memNE(re->precomp, t, len))
        /* Compile a new pattern */


This is a hash used internally to track named capture buffers and their offsets. The keys are the names of the buffers the values are dualvars, with the IV slot holding the number of buffers with the given name and the pv being an embedded array of I32. The values may also be contained independently in the data array in cases where named backreferences are used.

これは、名前付き取得バッファとそのオフセットを追跡するために内部的に使用されるハッシュです。 キーはバッファの名前で、値はdualvarsです。 IVスロットは指定された名前を持つバッファの数を保持し、pvはI32の埋め込み配列です。 名前付き後方参照が使用されている場合は、値がデータ配列に独立して含まれることもあります。 (TBR)


Holds information on the longest string that must occur at a fixed offset from the start of the pattern, and the longest string that must occur at a floating offset from the start of the pattern. Used to do Fast-Boyer-Moore searches on the string to find out if its worth using the regex engine at all, and if so where in the string to search.

パターンの先頭から固定オフセットで発生する必要がある最長文字列、およびパターンの先頭から浮動オフセットで発生する必要がある最長文字列に関する情報を保持します。 Fast-Boyer-Moore検索を実行して、regexエンジンを使用する価値があるかどうか、ある場合は文字列のどこを検索するかを調べるために使用します。 (TBR)

subbeg sublen saved_copy

Used during execution phase for managing search and replace patterns.

実施段階中に検索および置換パターンを管理するために使用されます。 (TBR)

wrapped wraplen

Stores the string qr// stringifies to. The perl engine for example stores (?-xism:eek) in the case of qr/eek/.

文字列qr//stringifiesを格納します。 たとえばPerlエンジンは、qr/eek/の場合に(?-xism:eek)を格納します。 (TBR)

When using a custom engine that doesn't support the (?:) construct for inline modifiers, it's probably best to have qr// stringify to the supplied pattern, note that this will create undesired patterns in cases such as:

インライン修飾子の(?:)構造体をサポートしていないカスタムエンジンを使用する場合は、おそらくqr//を提供されたパターンに紐付けするのが最善です。 これは、次のような場合に望ましくないパターンを作成することに注意してください。 (TBR)

    my $x = qr/a|b/;  # "a|b"
    my $y = qr/c/i;   # "c"
    my $z = qr/$x$y/; # "a|bc"

There's no solution for this problem other than making the custom engine understand a construct like (?:).

カスタム・エンジンに(?:)のような構造体を理解させる以外に、この問題に対する解決策はありません。 (TBR)


This stores the number of eval groups in the pattern. This is used for security purposes when embedding compiled regexes into larger patterns with qr//.

パターン内の評価グループの数を格納します。 これは、コンパイルされた正規表現をqr//を使用してより大きなパターンに埋め込む際のセキュリティ目的で使用されます。 (TBR)


The number of times the structure is referenced. When this falls to 0 the regexp is automatically freed by a call to pregfree. This should be set to 1 in each engine's "comp" routine.

構造体が参照される回数です。 これが0になると、regexpはpregfreeへの呼び出しによって自動的に解放されます。 これは各エンジンの"comp"ルーチンで1に設定する必要があります。 (TBR)


Originally part of perlreguts.

元は perlreguts の一部です。


Originally written by Yves Orton, expanded by Ævar Arnfjörð Bjarmason.

元は Yves Orton によって書かれ Ævar Arnfjörð Bjarmason によって拡張されました。


Copyright 2006 Yves Orton and 2007 Ævar Arnfjörð Bjarmason.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.


Hey! The above document had some coding errors, which are explained below:

Around line 191:

Unterminated C< ... > sequence

Around line 204:

Unterminated C< ... > sequence

Around line 230:

Unterminated C< ... > sequence

Around line 287:

Unterminated C< ... > sequence

Around line 361:

Unterminated C< ... > sequence

Around line 710:

Unterminated C< ... > sequence

Around line 1281:

Unterminated C< C< C< C< ... > > > > sequence