Pythonの正規表現のr'\w(?u)'をJavaScriptで再現する

言語間の正規表現の互換性はなかなかやっかいな問題です。昔、Python上にRubyインタプリタを実装したときは、RubyによるRubyパーサを参考にしてたのですが、どうしてもうまく移植できなくて完全なパーサが作れなかったんですよね。まあそれはおいといて。

Sphinxでバグ報告があって、再度正規表現の互換性問題にぶち当たったのですが、他の言語の人でも問題にあたって悩む人がいるかもしれないのでそのメモを残しておきます。

Sphinxの事情
=============

Sphinxは静的なHTMLを生成するドキュメントジェネレータです。Latex経由でPDFを出力したり、texinfo、manなどさまざまな出力ができます。まあ一番使われているのはおそらくHTMLです。HTML出力で特徴的な点は、Pythonで検索インデックスを作り、JSONにします。ブラウザではそのJSONを読み込んで検索を行います。

Pythonでは、一定のルールで文章の単語分割を行って検索用語を作り出しています。JavaScriptでも検索用語の単語分割を行ってからPython側で作った辞書を使って検索をします。

JavaScriptは次の正規表現で単語分割をしていました

```js
/\s+/
```

Pythonは次の正規表現でマッチするものを単語としていました。

```python
re.compile(r'\w+(?u)')
```

どちらも、スペース区切りでは単語区切りができるので大きな問題が起きることはありませんでした。Sphinxのリリース以来、ほぼ10年そのままにされてきました。

1.4.7で入った変更
====================

https://github.com/sphinx-doc/sphinx/issues/2856

一本のISSUEが登録されました。 ```PIN-code``` という文字が検索できないと。これはPythonではPINとcodeにわけられてインデックスに入ります。JavaScriptの正規表現ではスペースがないので、PIN-codeで検索しにいきます。当然単語の分かれ方が違うので「インデックスが見つからない」となってしまいます。この時、Python側とJavaScript側で正規表現が違うことに初めて気づきました。

検索インデックスをPythonで作ってJavaScriptで検索する場合は、どちらも同じ前処理でないといけません。

とりあえず、Pythonに合わせていこうと、と思ってJavaScript側を ```/\W+/``` にしました。

http://docs.python.jp/3/library/re.html#re.ASCII

ここを見たら、```?(u)```はunicodeの文脈では無視される、後方互換のためだけに残っているとありました。なんだよ、後方互換のためにフラグ残すなら、```u"Unicode文字列"```のuプリフィックスをなぜ一度なくしたし・・・・と思いつつ、まあ不要なら削除で、とJS側はシンプルに ```/\w/``` にしました。実はコレが失敗のもとに・・・

1.4.7リリース以降に報告された問題
===================================

https://github.com/sphinx-doc/sphinx/issues/3150

なんか中国語(というか漢字)で検索できなくなったぞという報告。調べてみたらこんな感じっぽい。

| 言語 | 正規表現 | マッチする文字 |
|:-:|:-:|:-:|
| Python 2.x  | ```r'\w'``` | ```[a-zA-Z0-9_]```  |
| Python 2.x  | ```r'\w(?u)'```  | Unicode的に文字とみなされるものすべて(ひらがな漢字も) |
| Python 3.x  | ```r'\w'```  | Unicode的に文字とみなされるものすべて(ひらがな漢字も) |
| JavaScript | ```/\w/``` | ```[a-zA-Z0-9_]```   |

つまり、JavaScriptだと、```/\w/```では漢字にマッチしない。後から報告を受けた話だと、ウムラウト付きの文字もダメだったようです。つまり、日本語混じりの文章で検索すると、日本語部分がばっさり落とされて検索されると。[MDNの特殊文字の\bの注釈](https://developer.mozilla.org/ja/docs/Web/JavaScript/Guide/Regular_Expressions#Using_Special_Characters)にも書かれています。

Python2でも、Unicode文字列のインスタンスに対して実行しても、ASCIIコード範囲内のa-zA-Z0-9_以外にマッチしません。```(?u)```はおまけではなかった。これは想定外・・・・

修正が必要です。

r'\w(?u)' をJavaScriptで再現するには
========================================

実際にPython側でループしながら試した所、```r'\w(?u)'```でマッチすると、UTF-16(約650000の文字コードに対して、マッチしたのは50000件近くになりました。少ない反対(マッチしない)で正規表現を作るにしても、こんなにあると、```\uhhhh```形式で列挙することもできません。正規表現で対処するのは無理そうです。

いっその事、全コードでマッチした結果をそのまま配列で持たせて、それを使えばPythonと同じ結果が再現できます。何もロジックまで同じである必要はありません。関数がブラックボックスであれば、すべての入力に対してすべての出力が正確に出れば、中はデータベースでもいいのです。

そういうことでできたのが以下のコードです。さきほどマージされたので、1.4.9では修正されます。

```js
var splitChars = (function() {
    var result = {};
    var singles = [96, 180, 187, 191, 215, 247, 749, 885, 903, 907, 909, 930, 1014, 1648,
         1748, 1809, 2416, 2473, 2481, 2526, 2601, 2609, 2612, 2615, 2653, 2702,
         2706, 2729, 2737, 2740, 2857, 2865, 2868, 2910, 2928, 2948, 2961, 2971,
         2973, 3085, 3089, 3113, 3124, 3213, 3217, 3241, 3252, 3295, 3341, 3345,
         3369, 3506, 3516, 3633, 3715, 3721, 3736, 3744, 3748, 3750, 3756, 3761,
         3781, 3912, 4239, 4347, 4681, 4695, 4697, 4745, 4785, 4799, 4801, 4823,
         4881, 5760, 5901, 5997, 6313, 7405, 8024, 8026, 8028, 8030, 8117, 8125,
         8133, 8181, 8468, 8485, 8487, 8489, 8494, 8527, 11311, 11359, 11687, 11695,
         11703, 11711, 11719, 11727, 11735, 12448, 12539, 43010, 43014, 43019, 43587,
         43696, 43713, 64286, 64297, 64311, 64317, 64319, 64322, 64325, 65141];
    var i, j, start, end;
    for (i = 0; i < singles.length; i++) {
        result[singles[i]] = true;
    }
    var ranges = [[0, 47], [58, 64], [91, 94], [123, 169], [171, 177], [182, 184], [706, 709],
         [722, 735], [741, 747], [751, 879], [888, 889], [894, 901], [1154, 1161],
         [1318, 1328], [1367, 1368], [1370, 1376], [1416, 1487], [1515, 1519], [1523, 1568],
         [1611, 1631], [1642, 1645], [1750, 1764], [1767, 1773], [1789, 1790], [1792, 1807],
         [1840, 1868], [1958, 1968], [1970, 1983], [2027, 2035], [2038, 2041], [2043, 2047],
         [2070, 2073], [2075, 2083], [2085, 2087], [2089, 2307], [2362, 2364], [2366, 2383],
         [2385, 2391], [2402, 2405], [2419, 2424], [2432, 2436], [2445, 2446], [2449, 2450],
         [2483, 2485], [2490, 2492], [2494, 2509], [2511, 2523], [2530, 2533], [2546, 2547],
         [2554, 2564], [2571, 2574], [2577, 2578], [2618, 2648], [2655, 2661], [2672, 2673],
         [2677, 2692], [2746, 2748], [2750, 2767], [2769, 2783], [2786, 2789], [2800, 2820],
         [2829, 2830], [2833, 2834], [2874, 2876], [2878, 2907], [2914, 2917], [2930, 2946],
         [2955, 2957], [2966, 2968], [2976, 2978], [2981, 2983], [2987, 2989], [3002, 3023],
         [3025, 3045], [3059, 3076], [3130, 3132], [3134, 3159], [3162, 3167], [3170, 3173],
         [3184, 3191], [3199, 3204], [3258, 3260], [3262, 3293], [3298, 3301], [3312, 3332],
         [3386, 3388], [3390, 3423], [3426, 3429], [3446, 3449], [3456, 3460], [3479, 3481],
         [3518, 3519], [3527, 3584], [3636, 3647], [3655, 3663], [3674, 3712], [3717, 3718],
         [3723, 3724], [3726, 3731], [3752, 3753], [3764, 3772], [3774, 3775], [3783, 3791],
         [3802, 3803], [3806, 3839], [3841, 3871], [3892, 3903], [3949, 3975], [3980, 4095],
         [4139, 4158], [4170, 4175], [4182, 4185], [4190, 4192], [4194, 4196], [4199, 4205],
         [4209, 4212], [4226, 4237], [4250, 4255], [4294, 4303], [4349, 4351], [4686, 4687],
         [4702, 4703], [4750, 4751], [4790, 4791], [4806, 4807], [4886, 4887], [4955, 4968],
         [4989, 4991], [5008, 5023], [5109, 5120], [5741, 5742], [5787, 5791], [5867, 5869],
         [5873, 5887], [5906, 5919], [5938, 5951], [5970, 5983], [6001, 6015], [6068, 6102],
         [6104, 6107], [6109, 6111], [6122, 6127], [6138, 6159], [6170, 6175], [6264, 6271],
         [6315, 6319], [6390, 6399], [6429, 6469], [6510, 6511], [6517, 6527], [6572, 6592],
         [6600, 6607], [6619, 6655], [6679, 6687], [6741, 6783], [6794, 6799], [6810, 6822],
         [6824, 6916], [6964, 6980], [6988, 6991], [7002, 7042], [7073, 7085], [7098, 7167],
         [7204, 7231], [7242, 7244], [7294, 7400], [7410, 7423], [7616, 7679], [7958, 7959],
         [7966, 7967], [8006, 8007], [8014, 8015], [8062, 8063], [8127, 8129], [8141, 8143],
         [8148, 8149], [8156, 8159], [8173, 8177], [8189, 8303], [8306, 8307], [8314, 8318],
         [8330, 8335], [8341, 8449], [8451, 8454], [8456, 8457], [8470, 8472], [8478, 8483],
         [8506, 8507], [8512, 8516], [8522, 8525], [8586, 9311], [9372, 9449], [9472, 10101],
         [10132, 11263], [11493, 11498], [11503, 11516], [11518, 11519], [11558, 11567],
         [11622, 11630], [11632, 11647], [11671, 11679], [11743, 11822], [11824, 12292],
         [12296, 12320], [12330, 12336], [12342, 12343], [12349, 12352], [12439, 12444],
         [12544, 12548], [12590, 12592], [12687, 12689], [12694, 12703], [12728, 12783],
         [12800, 12831], [12842, 12880], [12896, 12927], [12938, 12976], [12992, 13311],
         [19894, 19967], [40908, 40959], [42125, 42191], [42238, 42239], [42509, 42511],
         [42540, 42559], [42592, 42593], [42607, 42622], [42648, 42655], [42736, 42774],
         [42784, 42785], [42889, 42890], [42893, 43002], [43043, 43055], [43062, 43071],
         [43124, 43137], [43188, 43215], [43226, 43249], [43256, 43258], [43260, 43263],
         [43302, 43311], [43335, 43359], [43389, 43395], [43443, 43470], [43482, 43519],
         [43561, 43583], [43596, 43599], [43610, 43615], [43639, 43641], [43643, 43647],
         [43698, 43700], [43703, 43704], [43710, 43711], [43715, 43738], [43742, 43967],
         [44003, 44015], [44026, 44031], [55204, 55215], [55239, 55242], [55292, 55295],
         [57344, 63743], [64046, 64047], [64110, 64111], [64218, 64255], [64263, 64274],
         [64280, 64284], [64434, 64466], [64830, 64847], [64912, 64913], [64968, 65007],
         [65020, 65135], [65277, 65295], [65306, 65312], [65339, 65344], [65371, 65381],
         [65471, 65473], [65480, 65481], [65488, 65489], [65496, 65497]];
    for (i = 0; i < ranges.length; i++) {
        start = ranges[i][0];
        end = ranges[i][1];
        for (j = start; j <= end; j++) {
            result[j] = true;
        }
    }
    return result;
})();
function splitQuery(query) {
    var result = [];
    var start = -1;
    for (var i = 0; i < query.length; i++) {
        if (splitChars[query.charCodeAt(i)]) {
            if (start !== -1) {
                result.push(query.slice(start, i));
                start = -1;
            }
        } else if (start === -1) {
            start = i;
        }
    }
    if (start !== -1) {
        result.push(query.slice(start));
    }
    return result;
}
```

singles/rangesの中の文字コード(singleはとびとびで1つのコード、rangesは指定の範囲まるごと)のリストは次のようにして作りました。絵文字はサロゲートペアなので2文字で構成されているのですが、どちらも1字だけ取り出すとinvalidです。この範囲は事前に除外して単語区切りにはならないようにしています。

```python
match = re.compile(r'\w(?u)')
begin = -1

ranges = []
singles = []

for i in range(65536):
    # 0xd800-0xdfff is surrogate pair area. skip this.
    if not match.match(six.unichr(i)) and not (0xd800 <= i <= 0xdfff):
        if begin == -1:
            begin = i
    elif begin != -1:
        if begin + 1 == i:
            singles.append(begin)
        else:
            ranges.append((begin, i - 1))
        begin = -1
```

皆さんの中にも、PythonとかPHPとかRuby処理系をJavaScriptに移植しようとする人とかいて、この手の問題にあたるかもしれませんが、こういうふうにすればなんとかなりますよ、という話でした。