_ Haskell (GHC 6.8) における拡張可能なレコードを実現する手法
Simple Extensible Records -- Quick Generic Tricks, Pt.1 という手法が開発されたというニュースを目にしました(from programming.reddit.com)。
GHC 6.8.2のData.Genericsと"Scrap your boilerplate" -- Generic programming in Haskellを理解されている方にはこれ以上の解説は不要だと思います。Simple Extensible Recordsは便利な手法なので、使いどころがあれば適用してはいかがでしょうか。
ここに私なりに理解したことをメモしておきます。間違いなどがあったらご指摘ください。
Haskell の基本と、その問題
Haskell が持っている強力な機能は、1. 代数的データ型 2. パターンマッチ(パターン束縛) です。これ以外にも Haskell には強力な機能はありますが、今回はこの 2 つの機能に注目します。
代数的データ型の例を挙げます：
data Color = Red | Green | Blue
これは、型 Color として三原色を定義した例です。色は、赤、緑、青の 3 種類です（説明のため、簡単に 3 つに絞りました）。もう少し複雑な代数的データ型を見てみましょう：
type Length = Int
type Radius = Length
data Circle = Circle Color Radius
これは、型 Circle として色付きの円を定義した例です。円は、色 Color と半径 Radius = Int を用いて表されます。
さて、円から色を取り出すにはどうしたらよいでしょうか。方法はいくつもあります。もっとも単純なのは、関数を定義することです：
color :: Circle -> Color
color (Circle c _) = c
しかし、関数を定義する代わりにもうすこし単純な方法が用意されています。それが、ラベル付きフィールドです。先ほどの Circle の定義を次のように書き換えます：
data Circle = Circle { color :: Color, radius :: Radius }
これにより、二つのメリットが生まれます。一つは、関数 color :: Circle -> Color が自動的に定義されることです。関数の定義は、上に述べた color :: Circle -> Color と同じものです。もう一つは、次のような書き方によって、フィールドラベルの更新が可能になることです：
one :: Circle
one = Circle Red 1
two :: Circle
two = one { radius = 2 } -- ==> two = Circle Red 2
次に型クラスについて、簡単に触れます。次のように、色のついた長方形を表す新しいデータ型を追加したくなったとしましょう：
type Height = Length
type Width = Length
data Rectangle = Rectangle Color Height Width
このとき、残念ながら、次のように書くことはできません：
data Circle = Circle { color :: Color, radius :: Radius }
data Rectangle = Rectangle { color :: Color, height :: Height, width :: Width }
なぜなら、color :: Circle -> Color と color :: Rectangle -> Color が衝突してしまうからです。この問題に対して、Haskell では type class という方法を提供しています：
class HasColor a where
color :: a -> Color
instance HasColor Circle where
color (Circle c _) = c
instance HsColor Rectangle where
color (Rectangle c _ _) = c
これで、関数 color を Color にも Rectangle にも適用することができます。この方法は、2 つの関数 colorCircle :: Circle -> Color, colorRectangle -> Rectangle -> Color を準備するよりは簡潔です。
衝突しないラベル付きフィールドを定義するには、次のような方法をとるより仕方ありません：
data Circle = Circle { colorCircle :: Color, radius :: Radius }
data Rectangle = Rectangle { colorRect :: Color, height :: Height, width :: Width }
さて、もうひとつのややこしい問題を述べます。次のように、データ型が複雑になってきたとしましょう：
data Shape = SC Circle
| SR Rectangle
newtype BackgroundColor = BackgroundColor Color
data Text = Text Color BackgroundColor String
data Widgets = WS Shape
| WT Text
このとき、Widgets から Color を取り出すために、パターンマッチを使う方法を用いると次のようになります(方法は一通りではありませんが、最初に思いついたのはこれです)：
instance Color Shape where
color (SC c) = color c
color (SR r) = color r
instance Color Text where
color Text c _ _ = c
instance Color Widgets where
color (WS s) = color s
color (WT t) = color t
データ構造が階層的に複雑になるにつれて、type class と instance の記述が複雑になります。これが第二の問題です。
以上の二つの問題をまとめます。代数的データ型はデータの定義を階層的に定義できて、その結果、関数定義のパターンマッチによる条件分岐が可能になります。これは強力な機能です。しかし、「同じ性質を持つ」という情報を書き下したい場合(今回の例でいえば color :: a -> Color)、その定義は綺麗とは言い難いです。オブジェクト指向言語ならば、color メソッドを各クラスに定義することで、共通のインターフェースを提供できるのに比べると、その点で Haskell は見劣りしてしまいます。
"Simple Extensible Records" による、これらの問題の解決
Simple Extensible Records は GHC 拡張機能の DeriveDataTypeable と "Scrap your boilerplate" -- Generic programming in Haskell を組みあわせて、この問題を解決します。方法は、以下の通り：
- 1 行目に LANGUAGE pragma DeriveDataTypeable を追加する
{#- LANGUAGE DeriveDataTypeable #-}
- それぞれの代数的データ型に deriving (Data, Typeable) をつける
- 以下の おまじないコードをつける(別モジュールにして import してもよい)
import Data.Generics
import Control.Monad
import Data.Maybe
greplace :: (Data a, Typeable b) => a -> b -> Maybe a
greplace x y = once (const Nothing `extM` (const (Just y))) x
where
once :: MonadPlus m => GenericM m -> GenericM m
once f z = f z `mplus` gmapMo (once f) z
gfind :: (Data a, Typeable b) => a -> Maybe b
gfind = something (const Nothing `extQ` Just)
- setter と getter を greplace と gfind を用いて、それぞれ定義する
class Data a => HasColor a where
getColor :: a -> Color
getColor = fromJust . gfind
setColor :: a -> Color -> a
setColor = (fromJust .) . greplace
- instance 宣言する。すでに、デフォルト実装(generics)されているので、列挙するだけでよい：
instance HasColor A
instance HasColor B
...
"Simple Extensible Records" が提案している手法は、この問題を解決する lightweight な方法です。ただし、その実装は Data.Generics という"黒魔術"を使っています。なにが黒魔術かというと、内部で cast:: (Typeable a, Typeable b) => a -> Maybe b という関数を用いていることです。これは動的な型安全を保証する関数です。また、パターンマッチを使って地道にプログラムを書くことに比べると若干の速度の低下を招きます。そのへんの詳細は "Scrap your boilerplate" -- Generic programming in Haskell の論文を参照してください。また、関数 greplace は関数 once を用いているので、最初にマッチしたものを返し、その他は捨ててしまいます。関数 gfind も最初にマッチしたものを返し、その他は捨ててしまいます。そのことを忘れてうかつに使うとはまること間違いなしです。
今回用いた具体例に対する完全に動作するコードは以下の通りです：
{-# LANGUAGE DeriveDataTypeable #-}
import Data.Generics
import Control.Monad
import Data.Maybe
greplace :: (Data a, Typeable b) => a -> b -> Maybe a
greplace x y = once (const Nothing `extM` (const (Just y))) x
where
once :: MonadPlus m => GenericM m -> GenericM m
once f z = f z `mplus` gmapMo (once f) z
gfind :: (Data a, Typeable b) => a -> Maybe b
gfind = something (const Nothing `extQ` Just)
data Color = Red | Green | Blue
deriving(Data, Show, Typeable)
class Data a => HasColor a where
getColor :: a -> Color
getColor = fromJust . gfind
setColor :: a -> Color -> a
setColor = (fromJust .) . greplace
type Length = Int
type Radius = Length
data Circle = Circle Color Radius
deriving(Data, Show, Typeable)
type Height = Length
type Width = Length
data Rectangle = Rectangle Color Height Width
deriving(Data, Show, Typeable)
data Shape = SC Circle
| SR Rectangle
deriving(Data, Show, Typeable)
newtype BackgroundColor = BackgroundColor Color
deriving(Data, Show, Typeable)
data Text = Text Color BackgroundColor String
deriving(Data, Show, Typeable)
data Widgets = WS Shape
| WT Text
deriving(Data, Show, Typeable)
data TwoWidgets = Two Widgets Widgets
deriving(Data, Show, Typeable)
-- instance HasColor ...
instance HasColor Rectangle
instance HasColor Widgets
instance HasColor TwoWidgets
widget :: Widgets -- a rectangle widget
widget = WS (SR (Rectangle Red 10 20))
two :: TwoWidgets
two = Two (WS (SR (Rectangle Red 10 20))) (WS (SR (Rectangle Blue 30 40)))
{-
*TestData> getColor widget
Red
it :: Color
*TestData> setColor widget Blue
WS (SR (Rectangle Blue 10 20))
it :: Widgets
*TestData> getColor two
Red -- <-- 後ろの Blue などは無視される、というのは greplace (once) のせい
it :: Color
*TestData> setColor two Green
Two (WS (SR (Rectangle Green 10 20))) (WS (SR (Rectangle Blue 30 40))) -- <-- 後ろの Blue は無視される、というのは gfind のせい
it :: Two
-}
蛇足ながら付け加えると、setter や getter を定義する方法は一通りだけではありません。"Simple Extensible Records" ではなく、Haskell として普通に定義すれば、「無視される」といった弊害は起こり得ません。あくまで、記述の面倒さとのトレードオフであるとお考えください。最後に Jeff に。Scrap Your Boilerplate の手法を紹介してくれてありがとう。
