• Tweet

この記事はHaskell Advent Calendar 2021の25日目の記事です。

Haskellのよく言われる問題点の一つとして、文字列型が下記のようによく使われるものだけで5種類もある、という点があります:

• String
• StrictなText
• LazyなText
• StrictなByteString
• LazyなByteString

（上記の頻繁に使われるもの以外にも、もっとあります）

それぞれ確かに使いどころが違うので、アプリケーションで使用する場合は場面に応じて使い分ければいいのですが、文字列を使ったライブラリーを開発する場合はなかなか悩ましいものがあります。内部で依存しているライブラリーが使用しているものがあれば、それをそのまま使うのが簡単で確実ですが、そうでない場合も多いでしょう。そこで本稿では文字列型を抽象化して扱いたい場合の手段として、mono-traversalbeパッケージを検討したいと思います。

Link to
heremono-traversableパッケージの紹介

mono-traversableパッケージは、名前のとおりMonoTraversableやMonoFoldable、MonoFunctorといったおなじみの型クラスの名前にMonoという接頭辞を付けた型クラスによって、多様なコンテナ型を抽象化してくれます。これらの型クラスはすべて、ByteStringやTextのような、「要素として持てる値の型が1種類だけ」の型も対象にしているのが特徴です。Type Familyを応用し、次のように型毎に要素の型を固定することで、そうした特徴を実現しています:

type family Element mono

type instance Element ByteString = Word8
type instance Element Text = Char
type instance Element [a] = a

-- ...

class MonoFunctor mono where
  -- ...
  omap :: (Element mono -> Element mono) -> mono -> mono

instance MonoFunctor ByteString where
  omap = ByteString.map

instance MonoFunctor Text where
  omap = Text.map

instance MonoFunctor [a] where
  omap = map

※mono-traversableパッケージのソースから引用して少し改変しました。

さらに、これまで紹介したMonoTraversableやMonoFoldable、MonoFunctorに加えて、SemiSequenceやIsSequenceという型クラスで分解や構築に関わる操作（例えばconsやbreak）などの他、（今回は取り上げませんが）SetContainerなどの型クラスでMapやSet、IntMapなどの型まで抽象化してくれます。

そこで次の節では、このmono-traversableパッケージにおける型クラスを中心に、Data.TextモジュールやData.ByteStringモジュールにおける各関数が、どの型クラスに対するどの関数に対応するのか、まとめた表を作ってみました。

Link to
heremono-traversableパッケージにおける型クラスのメソッドと、各種文字列型向け関数の対応表

• ℹ️調査したmono-traversableパッケージのバージョンは1.0.15.3です
• ℹ️原則として関数の名前しか見ていないので、実際には異なる用途かも知れません
• ℹ️mono-traversableパッケージにある型クラスの他、baseパッケージにあるMonoid、Semigroupなどのメソッドも調査対象に含めました
• ℹ️Stringについてはbaseパッケージにある関数のみを対象にしていますが、Data.Listモジュールのドキュメントと自分の記憶を頼りに埋めているので間違いがあるかも知れません
• ℹ️Text・ByteStringについてはStrictなバージョンのドキュメントのみ参照しています。Lazyな方になかったらごめんなさい！
• ℹ️Textual型クラスについては、ByteStringがインスタンスになっていないのでご注意ください
• ℹ️以下のような関数は除外しました:
  • IOが絡むもの
  • プリミティブな処理で使うもの

以上です。残念ながら万能とはいかないようで、いくつか「N/A」、すなわち対応するものがない関数もありますが、他の関数の組み合わせで実装できるものもあるでしょう。

Link to
here⚠️パフォーマンスに関わる注意事項

MonoTraversableなどに限らず、型クラスを使って関数を多相化したとき全般に言えることですが、コンパイル時にインスタンスの解決が行えなかった場合、直接対象の型の相当する関数を呼ぶより少し遅くなってしまう場合があります（参考）。

また、それに限らず、各型クラスのメソッドでない関数は、各型の相当する関数でオーバーライドできないため、効率の悪い処理になってしまう恐れがあります。例えば、ointercalate関数の実装を見ると、TextやByteStringなどについてはRULESプラグマで最適な実装を設定しているようですが、それ以外の型については一旦リストに変換してから結合する、という効率の悪そうな処理をしています。

Link to
here事例: Stringから相互変換できる型を抽象化する

最後に、最近私が作った（まだリリースしてない）ライブラリーにおいて、MonoFoldableとIsStringを使うことで、TextとString両方をサポートした関数を紹介しておきます。ただ、時間とやる気パワーが残り少なくなってしまったので、該当の箇所だけこちらからコピペして、説明は簡単にしておきます:

stringVal :: (IsString a, MT.MonoFoldable a, MT.Element a ~ Char) => CodecEnvVal a
stringVal = valByFunction CodecEnvValByFunction
  { encode = MT.otoList
  , decode = Right . fromString
  }

CodecEnvVal a型は、a型をString型と相互変換するための情報を含んだ型です。stringValの場合、名前のとおり文字列っぽい型とStringとの相互変換ができなければなりません。もちろん単純にString型だけをサポートしてText用には別途CodecEnvVal Textを作ってもいいのですが、一つのCodecEnvVal aだけで扱えた方が楽でしょうし、今回はMonoFoldableのotoListとIsStringのfromStringを使って両方をサポートすることにしました。なお、これではByteStringがサポートできませんが、ここで相互変換するStringは、要件上人間が読み書きするファイルにおける文字列を想定しているので、ByteStringはバイナリーデータにだけ使うべきだ、という立場から敢えてサポートしていません。

Link to
hereまとめ

mono-traversableパッケージをうまく使えば、自前で専用の型クラスを作らなくてもString・Text・ByteStringなどを一挙にサポートする関数が書けるかも知れません！

それでは2022年はmono-traversableでHappy Haskell String Programming!🚝