プログラミング/ruby/正規表現

文字クラスの中の # や空白はエスケープの必要がない†

上記３つのルールの他にもいくつか知っておくべきルールがあります。

1. 正規表現中に # や空白を含めるには \ でエスケープすればよい
2. ただし、[ ] で囲まれた文字クラスの中の # や空白はエスケープの必要がない
3. コメント中に / があれば正規表現の終了を意味するため、\ でエスケープしなければならない

LANG:ruby
p ' #'.match(/[ #]*/x)   # この 空白 や # は通常の文字扱い
# => #<MatchData " #">
p ' #'.match(/ #/x)      # こちらの 空白 や # はコメント扱い
# => #<MatchData "">
p ' #'.match(//)         # これと同じことになる
# => #<MatchData "">
p /  # \/                # コメント中でも \/ のようにエスケープが必要
  /x
# => /  # \/
#    /x

2. について Perl では [ ] の中の空白やコメントも除去されるそうです。 一方、Python では Ruby と同様だそうです。
https://github.com/k-takata/Onigmo/issues/43

MatchData へのインデックスは String でも Symbol でも良い†

上記の通り

名前付きグループによるキャプチャを通常通り数値で参照することも可能†

上記の通り

名前無しグループはキャプチャしなくなる†

名前付きグループを使うと、名前無しグループはまったくキャプチャされなくなります。

LANG:ruby
p "abcd" =~ /(?<a>.)(.)(?<b>.)(.)/
# => 0
p Regexp.last_match
# => #<MatchData "ab" a:"a" b:"c">
p Regexp.last_match.length
# => 3
p Regexp.last_match[1]
# => "a"
p Regexp.last_match[2]
# => "c"
p "abcdc" =~ /(?<a>.)(.)(?<b>.)(.)\1/
# SyntaxError: (24: numbered backref/call is not allowed. (use name): /(?<a>.)(.)(?<b>.)(.)\k<-1>/
#         from /usr/bin/2:in `<main>'
p "abcdc" =~ /(?<a>.)(.)(?<b>.)(.)\k<-1>/
# SyntaxError: (25: numbered backref/call is not allowed. (use name): /(?<a>.)(.)(?<b>.)(.)\k<-1>/
#         from /usr/bin/2:in `<main>'

正規表現中では名前付きグループを数値で後方参照できない†

名前付きグループを使うと正規表現中では \1 や \k<-1>, \g<1> などが SyntaxError を投げるようになります。

マニュアルの記述はここです。
https://github.com/k-takata/Onigmo/blob/d0b3173893b9499a4e53ae1da16ba76c06d85571/doc/RE.ja#L313

以下でも確認します。

LANG:ruby
p "aba" =~ 
    /
    (?<cap1>.)    # 'a' にマッチ
    .             # 'b' にマッチ
    \1            # １番目の括弧でキャプチャした 'a' にマッチ？  → できない！
    /x
# SyntaxError: (5: numbered backref/call is not allowed. (use name): /
#     (?<cap1>..)   # 'aa' にマッチ
#     .             # 'b' にマッチ
#     \1            # 'aa' にマッチ？？？
#     /x
#    from /usr/bin/2:in `<main>'
p "aabaac" =~ 
    /
    (..)          # 'aa' にマッチ
    .             # 'b' にマッチ
    \1            # １番目の括弧でキャプチャした 'aa' にマッチ → 名前が付いていなければＯＫ
    /x
# => 0

同じ名前が複数回現れるときは最後のキャプチャを返す†

LANG:ruby
p m = "ab".match /(?<a>.)(?<a>.)/
# => #<MatchData "ab" a:"a" a:"b">
p m.names
# => ["a"]
p m[:a]
# => "b"

最後のキャプチャの値が得られるみたいです？

#<MatchData "ab" a:"a" a:"b"> の中に a:"a" があるのが気になりますが・・・

(追記) 鬼雲の説明書き によると、 同じ名前で複数ある場合、上記のようにキャプチャ値の後方参照はできるものの、 下記にある部分式呼び出し（正規表現自体の後方参照）はできなくなるそうです。

複雑な文字列を要素に分解†

名前付きグループを使うと複雑な文字列を分かりやすく要素に分解できます。

LANG:ruby
p result = "Osamu Takeuchi <osamu@big.jp>".match /^(?<name>.+)\s<(?<email>[^@]+@[^@]+)>$/
# => #<MatchData "Osamu Takeuchi <osamu@big.jp>" name:"Osamu Takeuchi" email:"osamu@big.jp">
p result[:name]
# => "Osamu Takeuchi"
p result[:email]
# => "osamu@big.jp"

ん〜でも、、、

LANG:ruby
p "Osamu Takeuchi <osamu@big.jp>" =~ /^(.+)\s<([^@]+@[^@]+)>$/
# => 0
p $1
# => "Osamu Takeuchi"
p $2
# => "osamu@big.jp"

数値の方がシンプルかも？？？

正規表現を結合するときに便利†

相対位置で指定しておくことにより、複数の正規表現を結合した場合にも、グループの出現位置によらず、 後方参照との対応関係が崩れなくなります。

LANG:ruby
p regexp = /(..).\k<-1>/
# => /(..).\k<-1>/
p /#{regexp}#{regexp}/       # ２つ繋げても意味が変わらない
# => /(?-mix:(..).\k<-1>)(?-mix:(..).\k<-1>)/

MatchData へも負のインデックスを与えられる†

LANG:ruby
p "Osamu Takeuchi <osamu@big.jp>" =~ /^(.+)\s<([^@]+@[^@]+)>$/
# => 0
p Regexp.last_match[-1]      # 最後にマッチしたキャプチャ
# => "osamu@big.jp"
p Regexp.last_match[-2]      # その前にマッチしたキャプチャ
# => "Osamu Takeuchi"

名前付きキャプチャの例†

LANG:ruby
p "abcabcabcabc" =~ /(...)\k<-1>*/      # 始めの３文字の繰り返し
# => 0
p '<tag param="value">bra bra bra</tag>' =~ 
      /
      <           # <
      ([^>\s]+)   # タグ名
      [^>]*       # パラメータ部分
      >           # >
      [^<]*       # innerHTML
      <\/\k<-1>>  # 閉じタグ
      /x
# => 0

正規表現のサブルーチンのように使うことができます†

LANG:ruby
p "ba" =~ 
    /
    (?<a>a){0}     # 正規表現 \g<a> を定義
    (?<b>b){0}     # 正規表現 \g<b> を定義
    \g<b>          # \g<b> を呼び出し
    \g<a>          # \g<a> を呼び出し
    /x
# => 0

定義時に {0} を付けておくことで、定義部分がマッチしないようにしています。

同じ表現を複数回含む複雑な正規表現を簡易化して書けると思います。

実際に複数回記述するのに比べて、同じ表現を繰り返し呼ぶ方が 内部的に省メモリ化できるんだと思います。

こちらにも同様の例がありました。
https://github.com/k-takata/Onigmo/blob/d0b3173893b9499a4e53ae1da16ba76c06d85571/doc/RE.ja#L347

定義部に {0} を付ける代わりに、|\zEND に続いて定義を書くイディオムもあるようです。 \z は文字列末尾にマッチするので、その後ろに文字を続ければ絶対にマッチしない選択肢を作れるというわけです。

LANG:ruby
p "ba" =~ 
    /
    \g<b>          # \g<b> を呼び出し
    \g<a>          # \g<a> を呼び出し
    |\zEND         # これ以降は絶対にマッチしない
    (?<a>a)        # 正規表現 \g<a> を定義
    (?<b>b)        # 正規表現 \g<b> を定義
    /x
# => 0

正規表現が複数回呼ばれたときの内部キャプチャ†

LANG:ruby
p "ab" =~ 
    /
    (?<a>(.))
    \g<a>          # \g<a> を呼び出し
    /x
# => 0
p Regexp.last_match
# => #<MatchData "ab" a:"b">

最後のキャプチャ内容が返されるようです。

正規表現の再帰呼び出し†

\g< > の書式は、自身を含むグループや、自身より後に出てくるグループを参照することもできます。

自身より後を参照する例：
\g<+1> により、グループ番号１の (c) ではなく、直後の ([ab]) を参照しています

LANG:ruby
p  "cbcbaa" =~ /(c)\g<+1>([ab])/
# => 2

特に、自身を含むグループを参照することにより、「正規表現の再帰呼び出し」 が可能になります。

通常の正規表現では、与えられた文字列の中で 「ネスト可能な括弧の対応が取れているかどうか」 をチェックすることはできませんが、\g<> を使った正規表現の再帰呼び出しを行うことで そういった用途でも正規表現だけで事が済みます。

LANG:ruby
p '((a) (b(c)))'.match(
    /
    (              # グループ番号 (1) = 対応の取れた括弧から括弧まで
      \(           # 開き括弧
      (?:
        \g<-1>     # グループ (1) を包含する（対応の取れた括弧の対）
      |
        [^()]      # 括弧以外の文字
      )*
      \)           # 閉じ括弧
    )
    /x
)
# => #<MatchData "((a)((b)))" 1:"((a)((b)))">

LANG:ruby
p "(abc)(abc)" =~ /(\(((?:\g<-2>|[^(])*)\))/
# => 0
p $&
# => "(abc)"
p $1
# => "(abc)"
p $2
# ArgumentError: negative string size (or size too big)

LANG:ruby
p "(abc)(abc)" =~ /(\(((?:\g<-2>|[^()])*)\))/
# => 0
p $~
# => #<MatchData "(abc)" 1:"(abc)" 2:"abc">

LANG:ruby
p "((abc)(abc))" =~ /(\(((?:\g<-2>|[^()])*)\))/
# => 0
p $~
# => #<MatchData "((abc)(abc))" 1:"((abc)(abc))" 2:"abc)">

代替案†

上記の例を相対指定で行うための代替案として以下が考えられます。

LANG:ruby
p ['[abc]', 'abc'].map { |s|
  s.match(
    /
    \[(.*)\]      # 括弧入りの文字列
    |
    \g<-1>        # 括弧なしの文字列
    /x
  )
}
# => [#<MatchData "[abc]" 1:"abc">, #<MatchData "abc" 1:"abc">]

どちらもキャプチャグループ１で "abc" をキャプチャできているあたり、\g<-1> のありがたみが感じられます。