実例によるPureScript

ウェブのための関数型プログラミング

Phil Freeman, "PureScript by Example - Functional Programming for the Web"

第1章 はじめに

1.1 関数型JavaScript

関数型プログラミングの手法は、かねてよりJavaScriptでも用いられてきました。

    var sumOfPrimes =
        _.chain(_.range(1000))
         .filter(isPrime)
         .reduce(function(x, y) {
             return x + y;
         })
         .value();
    require('fs').readFile(sourceFile, function (error, data) {
      if (!error) {
        require('fs').writeFile(destFile, data, function (error) {
          if (!error) {
            console.log("File copied");
          }
        });
      }
    });

関数は単純な抽象化を可能にし、優れた生産性をもたらしてくれます。しかし、JavaScriptでの関数型プログラミングには欠点があります。JavaScriptは冗長で、型付けされず、強力な抽象化を欠いているのです。また、無秩序に書かれたJavaScriptコードでは、式の理解がとても困難です。

PureScriptはこのような問題を解決すべく作られたプログラミング言語です。PureScriptは、とても表現力豊かでありながらわかりやすく読みやすいコードを書けるようにする、軽量な構文を備えています。強力な抽象化を提供する豊かな型システムも採用しています。また、JavaScriptやJavaScriptへとコンパイルされる他の言語と相互運用するときに重要な、高速で理解しやすいコードを生成します。PureScriptをひとことで言えば、純粋関数型プログラミングの理論的な強力さと、JavaScriptのお手軽で緩いプログラミングスタイルとの、とても現実的なバランスを狙った言語だということを理解して頂けたらと思います。

1.2 型と型推論

動的型付けの言語と静的型付けの言語をめぐる議論についてはよく知られています。PureScriptは静的型付けの言語、つまり正しいプログラムはコンパイラによってその動作を示すようなを与えられる言語です。逆にいえば、型を​​与えることができないプログラムは誤ったプログラムであり、コンパイラによって拒否されます。動的型付けの言語とは異なり、PureScriptでは型はコンパイル時のみに存在し、実行時には型の表現はありません。

PureScriptの型は、これまでJavaやC#のような他の言語で見たような型とは、いろいろな意味で異なっていることにも注意することが大切です。おおまかに言えばPureScriptの型はJavaやC#と同じ目的を持っているものの、PureScriptの型はMLとHaskellのような言語に影響を受けています。開発者がプログラムについての強い主張を表明できるので、PureScriptの型は表現力豊かなのです。最も重要なのは、PureScriptの型システムは型推論(type inference)をサポートしていることです。型推論があれば明示的な型注釈は必要最低限となり、型システムを厄介者ではなく道具にしてくれます。簡単な例を示すと、次のコードはを定義していますが、それが Number型だという注釈はコードのどこにもありません。

iAmANumber =
  let square x = x * x
  in square 42.0

次のもっと複雑な例では、コンパイラにとって未知の型が存在しているときでさえも、型注釈なしで型の正しさを確かめることができるということが示されています。

iterate f 0 x = x
iterate f n x = iterate f (n - 1) (f x)

ここで xの型は不明ですが、 xがどんな型を持っているかにかかわらず、 iterateが型システムの規則に従っていることをコンパイラは検証することができます。

静的型はプログラムの正しさについての確信を得るためだけではなく、その正しさによって開発を助ける、ということをあなたに納得させる(もしくは、あなたの理解を確認する)ことをこの本では試みます。最も単純な抽象化を使わないかぎりJavaScriptでコードの大規模なリファクタリングすることは難しいですが、型検証器のある表現力豊かな型システムは、リファクタリングさえ楽しく対話的な体験にしてくれます。

加えて、型システムによって提供されたこのセーフティネットは、より高度な抽象化をも可能にします。実際に、関数型プログラミング言語Haskellによって知られるようになった、型主導の強力な抽象化である『型クラス』をPureScriptは備えています。

1.3 多言語Webプログラミング

関数型プログラミングはすでに多くの成功を収めています。特に成功している応用例をいくつか挙げると、データ解析、構文解析、コンパイラの実装、ジェネリックプログラミング、並列処理などがあります。

PureScriptのような関数型言語は、アプリケーション開発の最初から最後までを​実施することが可能です。値や関数の型を提供することで既存のJavaScriptコードをインポートし、通常のPureScriptコードからこれらの関数を使用する機能をPureScriptは提供しています。この手法については本書の後半で見ていくことになります。

しかしながら、PureScriptの強みのひとつは、JavaScriptを対象とする他​​の言語との相互運用性にあります。アプリケーションの開発の一部にだけPureScriptを使用し、JavaScriptの残りの部分を記述するのに他の言語を使用するという方法もあります。

いくつかの例を示します。

この本では小規模な課題をPureScriptで解決することに焦点を当てますが、ここで学ぶ手法は大規模なアプリケーションに組み込むこともできます。JavaScriptからPureScriptコードを呼び出す方法、およびその逆についても見ていきます。

1.4 ソフトウェア要件

この本でのソフトウェア要件は最小限です。第1章では開発環境の構築を一から案内します。これから使用するツールは、ほとんどの現代のオペレーティングシステムの標準リポジトリで使用できるものです。

PureScriptコンパイラ自体は、コンパイル済みバイナリ形式でダウンロードすることもできますし、最新のHaskellコンパイラが稼働しているシステム上でソースからビルドすることもできます。次の章ではこの手順を説明していきます。

本書のこのバージョンのコードは、 0.11.*バージョンのPureScriptコンパイラと互換性があります。

1.5 読者について

読者はJavaScriptの基本をすでに理解しているものと仮定します。すでにNPMやBowerのようなJavaScriptのエコシステムでの経験があれば、自身の好みに応じて標準設定をカスタマイズしたい場合などに役に立ちますが、そのような知識は必要ではありません。

関数型プログラミングの予備知識は必要ありませんが、あっても害にはならないでしょう。実例には新しいアイデアがつきものですから、これから使う関数型プログラミングからこうした概念に対する直感的な理解を得ることができるはずです。

PureScriptはプログラミング言語Haskellに強く影響を受けているため、Haskellに通じている読者はこの本の中で提示された概念や構文の多くに見覚えがあるでしょう。しかしながら、読者はPureScriptとHaskellの間にはいくつか重要な違いがあることも理解しておかなければなりません。ここで紹介する概念の多くはHaskellでも同じように解釈できるとはいえ、どちらかの言語での考え方を他方の言語でそのまま応用しようとすることは、必ずしも適切ではありません。

1.6 本書の読み進めかた

本書の各章は、概ね章ごとに完結しています。しかしながら、多少の関数型プログラミングの経験がある初心者でも、まずは各章を順番に進めていくことをおすすめします。最初の数章では、本書の後半の内容を理解するために必要な基礎知識を養います。関数型プログラミングの考え方に十分通じた読者(特にMLやHaskellのよう強く型付けされた言語での経験を持つ読者)なら、本書の前半の章を読まなくても、後半の章のコードの大まかな理解を得ることがおそらく可能でしょう。

各章ではそれぞれひとつの実用的な例に焦点をあて、新しい考え方を導入するための動機付けとして用います。各章のコードは本書のGitHubのリポジトリから入手できます。各章にはソースコードから抜粋したコード片が掲載されていますが、完全に理解するためには本書に掲載されたコードと平行してリポジトリのソースコードを読む必要があります。対話式環境 PSCiで実行し理解を確かめられるように、長めの節には短いコード片が掲載されていることがあります。

コード例は次のように等幅フォントで示されています。

module Example where

import Control.Monad.Eff.Console (log)

main = log "Hello, World!"

先頭にドル記号がついた行は、コマンドラインに入力されたコマンドです。

$ pulp build

通常、これらのコマンドはLinuxやMac OSの利用者ならそのまま適用できますが、Windowsの利用者はファイル区切り文字を変更する、シェルの組み込み機能をWindowsの相当するものに置き換えるなどの小さな変更を加える必要があるかもしれません。

pulp repl対話式プロンプトに入力するコマンドは、行の先頭に山括弧が付けられています。

> 1 + 2
3

各章には演習が付いており、それぞれ難易度も示されています。各章の内容を完全に理解するために、演習に取り組むことを強くお勧めします。

この本は初心者にPureScriptへの導入を提供することを目的としており、問題についてのお決まりの解決策の一覧を提供するような種類の本ではありません。初心者にとってこの本を読むのは楽しい挑戦になるはずですし、本書の内容を読み演習に挑戦すればだいたいの利益を得られるでしょうが、なにより重要なのは、あなたが自分自身のコードを書いてみることです。

1.7 困ったときには

もしどこかでつまずいたときには、PureScriptを学べるオンラインで利用可能な資料がたくさんあります。

もしあなたが例を読んで学ぶことを好むなら、GitHubの purescript組織、 purescript-node組織および purescript-contrib組織にはPureScriptコードの例がたくさんあります。

1.8 著者について

私はPureScriptコンパイラの最初の開発者です。私はカリフォルニア州ロサンゼルスを拠点にしており、8ビットパーソナルコンピュータ、Amstrad CPC上のBASICでまだ幼い時にプログラミングを始めました。それ以来、私はいくつものプログラミング言語(JavaやScala、C#、F#、HaskellそしてPureScript)で業務に携わってきました。

プロとしての経歴が始まって間もなく、私は関数型プログラミングと数学の関係を理解するようになり、そしてプログラミング言語Haskellとの恋に落ちました。

JavaScriptでの経験をもとに、私はPureScriptコンパイラの開発を始めることにしました。私は自分がHaskellのような言語から取り上げた関数型プログラミングの手法を使っていることに気が付きましたが、それを応用するためのもっと理にかなった環境を求めていました。そのとき検討した案のなかには、Haskellをその意味論を維持しながらJavaScriptへとコンパイルするいろいろな試み(Fay、Haste、GHCJS)もありましたが、私が興味を持っていたのは、この問題への別の切り口からのアプローチ、すなわちHaskellのような言語の構文と型システムを楽しみながらJavaScriptの意味論も維持するということが、どのようにすれば可能になるのかでした。

私はウェブサイトを運営しており、Twitterで連絡をとることもできます。

1.9 謝辞

現在の状態に到達するまでPureScriptを手伝ってくれた多くの協力者に感謝したいと思います。コンパイラやツール、ライブラリ、ドキュメント、テストでの組織的で弛まぬ努力がなかったら、プロジェクトは間違いなく失敗していたことでしょう。

この本の表紙に表示されたPureScriptのロゴはGareth Hughesによって作成されたもので、Creative Commons Attribution 4.0 licenseの条件の下で再利用させて頂いています 。

最後に、この本の内容に関する反応や訂正をくださったすべての方に、心より感謝したいと思います。

第2章 開発環境の準備

2.1 この章の目標

この章の目標は、作業用のPureScript開発環境を準備し、最初のPureScriptプログラムを書くことです。

これから書く最初のコードはごく単純なPureScriptライブラリで、直角三角形の対角線の長さを計算する関数ひとつだけを提供します。

2.2 導入

PureScript開発環境を準備するために、次のツールを使います。

この章ではこれらのツールのインストール方法と設定を説明します。

2.3 PureScriptのインストール

PureScriptコンパイラをインストールするときにお勧めなのは、PureScriptのウェブサイトからバイナリ配布物としてダウンロードする方法です。PureScriptコンパイラおよび関連する実行ファイルが、パス上で利用できるかどうか確認をしてください。試しに、コマンドラインでPureScriptコンパイラを実行してみましょう。

$ purs

PureScriptコンパイラをインストールする他の選択肢としては、次のようなものがあります。

2.4 各ツールのインストール

もしNodeJSがインストールされていないなら、NodeJSをインストールする必要があります。そうするとシステムに npmパッケージマネージャもインストールされるはずです。 npmがインストールされ、パス上で利用可能であることを確認してください。

npmがインストールされたら、 pulpbowerもインストールする必要があります。プロジェクトがどこで作業しているかにかかわらずこれらのコマンドラインツールが利用可能であるようにするため、通常はグローバルにインストールしておくのがいいでしょう。

$ npm install -g pulp bower

これで、最初のPureScriptプロジェクトを作成するために必要なすべてのツールの用意ができたことになります。

2.5 Hello, PureScript!

まずはシンプルに始めましょう。PureScriptコンパイラpulpを直接使用して、基本的なHello World! プログラムをコンパイルします。 最初に空のディレクトリmy-projectを作成し、そこでpulp initを実行します。

$ mkdir my-project
$ cd my-project
$ pulp init

* Generating project skeleton in ~/my-project

$ ls

bower.json	src		test

Pulpはsrctestという2つのディレクトリと設定ファイルbower.jsonを作成してくれます。srcディレクトリにはソースコードファイルを保存し、testディレクトリにはテストコードファイルを保存します。testディレクトリはこの本の後半で使います。

src/Main.pursという名前のファイルに、以下のコードを貼り付けてください。

module Main where

import Control.Monad.Eff.Console

main = log "Hello, World!"

これは小さなサンプルコードですが、​​いくつかの重要な概念を示しています。

それではこのコードをビルドして実行してみましょう。次のコマンドを実行します。

$ pulp run

* Building project in ~/my-project
* Build successful.
Hello, World!

おめでとうございます! はじめてPureScriptで作成されたプログラムのコンパイルと実行ができました。

2.6 ブラウザ向けのコンパイル

Pulpは pulp browserifyを実行して、PureScriptコードをブラウザで使うことに適したJavaScriptに変換することができます。

$ pulp browserify

* Browserifying project in ~/my-project
* Building project in ~/my-project
* Build successful.
* Browserifying...

これに続いて、大量のJavaScriptコードがコンソールに表示されます。 これはBrowserifyの出力で、Preludeと呼ばれる標準のPureScriptライブラリに加え、srcディレクトリのコードにも適用されます。このJavaScriptコードをファイルに保存し、HTML文書に含めることもできます。これを試しに実行してみると、ブラウザのコンソールに"Hello、World!"という文章が出力されます。

2.7 使用されていないコードを取り除く

Pulpは代替コマンド pulp buildを提供しています。 -Oオプションで未使用コードの削除を適用すると、不要なJavaScriptを出力から取り除くことができます。

$ pulp build -O --to output.js

* Building project in ~/my-project
* Build successful.
* Bundling Javascript...
* Bundled.

この場合も、生成されたコードはHTML文書で使用できます。 output.jsを開くと、次のようなコンパイルされたモジュールがいくつか表示されます。

(function(exports) {
  "use strict";

  var Control_Monad_Eff_Console = PS["Control.Monad.Eff.Console"];

  var main = Control_Monad_Eff_Console.log("Hello, World!");
  exports["main"] = main;
})(PS["Main"] = PS["Main"] || {});

ここでPureScriptコンパイラがJavaScriptコードを生成する方法の要点が示されています。

PureScriptはシンプルで理解しやすいコードを生成すること重視しているので、これらの点は大切です。実際に、ほとんどのコード生成処理はごく軽い変換です。PureScriptについての理解が比較的浅くても、ある入力からどのようなJavaScriptコードが生成されるかを予測することは難しくありません。

2.8 CommonJSモジュールのコンパイル

pulpは、PureScriptコードからCommonJSモジュールを生成するためにも使用できます。 これは、NodeJSを使用する場合やCommonJSモジュールを使用してコードを小さなコンポーネントに分割する大きなプロジェクトを開発する場合に便利です。

CommonJSモジュールをビルドするには、( -Oオプションなしで) pulp buildコマンドを使います。

$ pulp build

* Building project in ~/my-project
* Build successful.

生成されたモジュールはデフォルトで outputディレクトリに置かれます。 各PureScriptモジュールは、それ自身のサブディレクトリにある独自のCommonJSモジュールにコンパイルされます。

2.9 Bowerによる依存関係の追跡

この章の目的となっている diagonal関数を書くためには、平方根を計算できるようにする必要があります。 purescript-mathパッケージにはJavaScriptの Mathオブジェクトのプロパティとして定義されている関数の型定義が含まれていますので、 purescript-mathパッケージをインストールしてみましょう。 npmの依存関係でやったのと同じように、次のようにコマンドラインに入力すると直接このパッケージをダウンロードできます。

$ bower install purescript-math --save

--saveオプションは依存関係を bower.json設定ファイルに追加させます。

purescript-mathライブラリは、依存するライブラリと一緒に bower_componentsサブディレクトリにインストールされます。

2.10 対角線の長さの計算

それでは外部ライブラリの関数を使用する例として diagonal関数を書いてみましょう。

まず、 src/Main.pursファイルの先頭に次の行を追加し、 Mathモジュールをインポートします。

import Math (sqrt)

また、数値の加算や乗算のようなごく基本的な演算を定義する Preludeモジュールをインポートすることも必要です。

import Prelude

そして、次のように diagonal関数を定義します。

diagonal w h = sqrt (w * w + h * h)

この関数の型を定義する必要はないことに注意してください。 diagonalは2つの数を取り数を返す関数である、とコンパイラは推論することができます。しかし、ドキュメントとしても役立つので、通常は型注釈を提供しておくことをお勧めします。

それでは、新しい diagonal関数を使うように main関数も変更してみましょう。

main = logShow (diagonal 3.0 4.0)

pulp runを使用して、モジュールを再コンパイルします。

$ pulp run

* Building project in ~/my-project
* Build successful.
5.0

2.11 対話式処理系を使用したコードのテスト

PureScriptコンパイラには PSCiと呼ばれる対話式のREPL(Read-eval-print loop)が付属しています。 PSCiはコードをテストなど思いついたことを試すのにとても便利です。それでは、 psciを使って diagonal関数をテストしてみましょう。

pulp replコマンドを使ってソースモジュールを自動的に PSCiにロードすることができます。

$ pulp repl
>

コマンドの一覧を見るには、 :?と入力します。

> :?
The following commands are available:

    :?                        Show this help menu
    :quit                     Quit PSCi
    :reset                    Reset
    :browse           Browse 
    :type               Show the type of 
    :kind               Show the kind of 
    :show        import       Show imported modules
    :show        loaded       Show loaded modules
    :paste       paste        Enter multiple lines, terminated by ^D

Tabキーを押すと、自分のコードで利用可能なすべての関数、及びBowerの依存関係とプレリュードモジュールのリストをすべて見ることができるはずです。

Preludeモジュールを読み込んでください。

> import Prelude

幾つか数式を評価してみてください。 PSCiで評価を行うには、1行以上の式を入力し、Ctrl+ Dで入力を終了します。

> 1 + 2
3

> "Hello, " <> "World!"
"Hello, World!"

それでは PSCidiagonal関数を試してみましょう。

> import Main
> diagonal 5.0 12.0

13.0

また、 PSCiで関数を定義することもできます。

> double x = x * 2

> double 10
20

コード例の構文がまだよくわからなくても心配はいりません。 この本を読み進めるうちにわかるようになっていきます。

最後に、 :typeコマンドを使うと式の型を確認することができます。

> :type true
Boolean

> :type [1, 2, 3]
Array Int

PSCiで試してみてください。もしどこかでつまずいた場合は、メモリ内にあるコンパイル済みのすべてのモジュールをアンロードするリセットコマンド :resetを使用してみてください。

演習

  1. (簡単) Mathモジュールで定義されている pi定数を使用し、指定された半径の円の面積を計算する関数 circleAreaを書いてみましょう。また、 PSCiを使用してその関数をテストしてください。 (ヒントimport math文を修正して、 piをインポートすることを忘れないようにしましょう)
  2. (やや難しい) purescript-globalsパッケージを依存関係としてインストールするには、bower installを使います。PSCiでその機能を試してみてください。 (ヒント: PSCiの :browseコマンドを使うと、モジュールの内容を閲覧することができます)

まとめ

この章では、Pulpツールを使用して簡単なPureScriptプロジェクトを設定しました。

また、最初のPureScript関数を書き、コンパイルし、NodeJSを使用して実行することができました。

以降の章では、コードをコンパイルやデバッグ、テストするためにこの開発設定を使用しますので、これらのツールや使用手順に十分習熟しておくとよいでしょう。

第3章 関数とレコード

3.1 この章の目標

この章では、関数およびレコードというPureScriptプログラムのふたつの構成要素を導入します。さらに、どのようにPureScriptプログラムを構造化するのか、どのように型をプログラム開発に役立てるかを見ていきます。

連絡先のリストを管理する簡単​​な住所録アプリケーションを作成していきます。このコード例により、PureScriptの構文からいくつかの新しい概念を導入します。

このアプリケーションのフロントエンドは対話式処理系 PSCiを使うようにしていますが、JavaScriptでフロントエンドを書くこともできるでしょう。実際に後の章で、フォームの検証と保存および復元の機能追加について詳しく説明します。

3.2 プロジェクトの準備

この章のソースコードは src/Data/AddressBook.pursというファイルに含まれています。このファイルは次のようなモジュール宣言とインポート一覧から始まります。

module Data.AddressBook where

import Prelude

import Control.Plus (empty)
import Data.List (List(..), filter, head)
import Data.Maybe (Maybe)

ここでは、いくつかのモジュールをインポートします。

このモジュールのインポート内容が括弧内で明示的に列挙されていることに注目してください。明示的な列挙はインポート内容の衝突を避けるのに役に立つので、一般に良い習慣です。

ソースコードリポジトリを複製したと仮定すると、この章のプロジェクトは次のコマンドを使用してPulpを使用して構築できます。

$ cd chapter3
$ bower update
$ pulp build

3.3 単純な型

JavaScriptのプリミティブ型に対応する組み込みデータ型として、PureScriptでは数値型と文字列型、真偽型の3つが定義されており、それぞれ NumberStringBooleanと呼ばれています。これらの型はすべてのモジュールに暗黙にインポートされる Primモジュールで定義されています。pulp repl:typeコマンドを使用すると、簡単な値の型を確認できます。

$ pulp repl

> :type 1.0
Number

> :type "test"
String

> :type true
Boolean

PureScriptには他にも、配列とレコード、関数などの組み込み型が定義されています。

整数は、小数点以下を省くことによって、型 Numberの浮動小数点数の値と区別されます。

> :type 1
Int

二重引用符を使用する文字列リテラルとは異なり、文字リテラルは一重引用符で囲みます。

> :type 'a'
Char

配列はJavaScriptの配列に対応していますが、JavaScriptの配列とは異なり、PureScriptの配列のすべての要素は同じ型を持つ必要があります。

> :type [1, 2, 3]
Array Int

> :type [true, false]
Array Boolean

> :type [1, false]
Could not match type Int with Boolean.

最後の例で起きているエラーは型検証器によって報告されたもので、配列の2つの要素の型を単一化(Unification)しようとして失敗したこと示しています。

レコードはJavaScriptのオブジェクトに対応しており、レコードリテラルはJavaScriptのオブジェクトリテラルと同じ構文になっています。

> author = { name: "Phil", interests: ["Functional Programming", "JavaScript"] }

> :type author
{ name :: String
, interests :: Array String
}

この型が示しているのは、オブジェクト authorは、

という2つのフィールド(field)を持っているということです。

レコードのフィールドは、ドットに続けて参照したいフィールドのラベルを書くと参照することができます。

> author.name
"Phil"

> author.interests
["Functional Programming","JavaScript"]

PureScriptの関数はJavaScriptの関数に対応しています。PureScriptの標準ライブラリは多くの関数の例を提供しており、この章ではそれらをもう少し詳しく見ていきます。

> import Prelude
> :type flip
forall a b c. (a -> b -> c) -> b -> a -> c

> :type const
forall a b. a -> b -> a

ファイルのトップレベルでは、等号の直前に引数を指定することで関数を定義することができます。

add :: Int -> Int -> Int
add x y = x + y

バックスラッシュに続けて空白文字で区切られた引数名のリストを書くことで、関数をインラインで定義することもできます。PSCiで複数行の宣言を入力するには、 :pasteコマンドを使用して"paste mode"に入ります。このモードでは、Control-Dキーシーケンスを使用して宣言を終了します。

> :paste
… add :: Int -> Int -> Int
… add = \x y -> x + y
… ^D

PSCiでこの関数が定義されていると、次のように関数の隣に2つの引数を空白で区切って書くことで、関数をこれらの引数に適用(apply)することができます。

> add 10 20
30

3.4 量化された型

前の節ではPreludeで定義された関数の型をいくつか見てきました。たとえば flip関数は次のような型を持っていました。

> :type flip
forall a b c. (a -> b -> c) -> b -> a -> c

この forallキーワードは、 flip全称量化された型(universally quantified type)を持っていることを示しています。これは、 abcをどの型に置き換えても、 flipはその型でうまく動作するという意味です。

例えば、 aIntbStringcStringというように選んでみたとします。この場合、 flipの型を次のように特殊化(specialize)することができます。

(Int -> String -> String) -> String -> Int -> String

量化された型を特殊化したいということをコードで示す必要はありません。特殊化は自動的に行われます。たとえば、すでにその型の flipを持っていたかのように、次のように単に flipを使用することができます。

> flip (\n s -> show n <> s) "Ten" 10

"10Ten"

abcの型はどんな型でも選ぶことができるといっても、型の不整合は生じないようにしなければなりません。 flipに渡す関数の型は、他の引数の型と整合性がなくてはなりません。第2引数として文字列 "Ten"、第3引数として数 10を渡したのはそれが理由です。もし引数が逆になっているとうまくいかないでしょう。

> flip (\n s -> show n <> s) 10 "Ten"

Could not match type Int with type String

3.5 字下げについての注意

JavaScriptとは異なり、PureScriptのコードは字下げの大きさに影響されます(indentation-sensitive)。これはHaskellと同じようになっています。コード内の空白の多寡は無意味ではなく、Cのような言語で中括弧によってコードのまとまりを示しているように、PureScriptでは空白がコードのまとまりを示すのに使われているということです。

宣言が複数行にわたる場合は、2つめの行は最初の行の字下げより深く字下げしなければなりません。

したがって、次は正しいPureScriptコードです。

add x y z = x +
  y + z

しかし、次は正しいコードではありません。

add x y z = x +
y + z

後者では、PureScriptコンパイラはそれぞれの行ごとにひとつ、つまり2つの宣言であると構文解析します。

一般に、同じブロック内で定義された宣言は同じ深さで字下げする必要があります。例えば PSCiでlet文の宣言は同じ深さで字下げしなければなりません。次は正しいコードです。

> :paste
… x = 1
… y = 2
… ^D

しかし、これは正しくありません。

> :paste
… x = 1
…  y = 2
… ^D

PureScriptのいくつかの予約語(例えば whereoflet)は新たなコードのまとまりを導入しますが、そのコードのまとまり内の宣言はそれより深く字下げされている必要があります。

example x y z = foo + bar
  where
    foo = x * y
    bar = y * z

ここで foobarの宣言は exampleの宣言より深く字下げされていることに注意してください。

ただし、ソースファイルの先頭、最初の module宣言における予約語 whereだけは、この規則の唯一の例外になっています。

3.6 独自の型の定義

PureScriptで新たな問題に取り組むときは、まずはこれから扱おうとする値の型の定義を書くことから始めるのがよいでしょう。最初に、住所録に含まれるレコードの型を定義してみます。

type Entry = { firstName :: String, lastName :: String, address :: Address }

これは Entryという型同義語(type synonym、型シノニム)を定義しています。 型 Entryは等号の右辺と同じ型ということです。レコードの型はいずれも文字列である firstNamelastNamephoneという3つのフィールドからなります。前者の2つのフィールドは型 Stringを持ち、 addressは以下のように定義された型 Addressを持っています。

type Address = { street :: String, city :: String, state :: String }

それでは、2つめの型同義語も定義してみましょう。住所録のデータ構造としては、単に項目の連結リストとして格納することにします。

type AddressBook = List Entry

List EntryArray Entryとは同じではないということに注意してください。 Array Entryは住所録の項目の配列を意味しています。

3.7 型構築子と種

List型構築子(type constructor、型コンストラクタ)の一例になっています。 Listそのものは型ではなく、何らかの型 aがあるとき List aが型になっています。つまり、 List型引数(type argument)aをとり、新たな型 List aを構築するのです。

ちょうど関数適用と同じように、型構築子は他の型に並べることで適用されることに注意してください。型 List Entryは実は型構築子 Listが型 Entry適用されたものです。これは住所録項目のリストを表しています。

(型注釈演算子 ::を使って)もし型 Listの値を間違って定義しようとすると、今まで見たことのないような種類のエラーが表示されるでしょう。

> import Data.List
> Nil :: List
In a type-annotated expression x :: t, the type t must have kind Type

これは種エラー(kind error)です。値がそので区別されるのと同じように、型はその(kind)によって区別され、間違った型の値が型エラーになるように、間違った種の型は種エラーを引き起こします。

NumberStringのような、値を持つすべての型の種を表す Typeと呼ばれる特別な種があります。

型構築子にも種があります。たとえば、種 Type -> Typeはちょうど Listのような型から型への関数を表しています。ここでエラーが発生したのは、値が種 Typeであるような型を持つと期待されていたのに、 Listは種 Type -> Typeを持っているためです。

PSCiで型の種を調べるには、 :kind命令を使用します。例えば次のようになります。

> :kind Number
Type

> import Data.List
> :k List
Type -> Type

> :kind List String
Type

PureScriptの種システムは他にも面白い種に対応していますが、それらについては本書の他の部分で見ていくことになるでしょう。

3.8 住所録の項目の表示

それでは最初に、文字列で住所録の項目を表現するような関数を書いてみましょう。まずは関数に型を与えることから始めます。型の定義は省略することも可能ですが、ドキュメントとしても役立つので型を書いておくようにすると良いでしょう。型宣言は関数の名前とその型を ::記号で区切るようにして書きます。

showEntry :: Entry -> String

showEntryは引数として Entryを取り stringを返す関数であるということを、この型シグネチャは言っています。 showEntryの定義は次のとおりです。

showEntry entry = entry.lastName <> ", " <>
                  entry.firstName <> ": " <> 
                  showAddress entry.address

この関数は Entryレコードの3つのフィールドを連結し、単一の文字列にします。ここで使用される showAddressaddressフィールドを連接し、単一の文字列にする関数です。 showAddressの定義は次のとおりです。

showAddress :: Address -> String
showAddress addr = addr.street <> ", " <>
                   addr.city <> ", " <>
                   addr.state

関数定義は関数の名前で始まり、引数名のリストが続きます。関数の結果は等号の後ろに定義します。フィールドはドットに続けてフィールド名を書くことで参照することができます。PureScriptでは、文字列連結はJavaScriptのような単一のプラス記号ではなく、ダイアモンド演算子( <>)を使用します。

3.9 はやめにテスト、たびたびテスト

PSCi対話式処理系では反応を即座に得られるので、試行錯誤を繰り返したいときに向いています。それではこの最初の関数が正しく動作するかを PSCiを使用して確認してみましょう。

まず、これまで書かれたコードをビルドします。

$ pulp build

次に、 PSCiを起動し、この新しいモジュールをインポートするために import命令を使います。

$ pulp repl

> import Data.AddressBook

レコードリテラルを使うと、住所録の項目を作成することができます。レコードリテラルはJavaScriptの無名オブジェクトと同じような構文で名前に束縛します。

> address = { street: "123 Fake St.", city: "Faketown", state: "CA" }

​それでは、この例に関数を適用してみてください。

> showAddress address

"123 Fake St., Faketown, CA"

そして、例で作成した addressを含む住所録の entryレコードを作成し showEntryに適用させましょう。

> entry = { firstName: "John", lastName: "Smith", address: address }
> showEntry entry

"Smith, John: 123 Fake St., Faketown, CA"

3.10 住所録の作成

今度は住所録の操作を支援する関数をいくつか書いてみましょう。空の住所録を表す値として、空のリストを使います。

emptyBook :: AddressBook
emptyBook = empty

既存の住所録に値を挿入する関数も必要でしょう。この関数を insertEntryと呼ぶことにします。関数の型を与えることから始めましょう。

insertEntry :: Entry -> AddressBook -> AddressBook

insertEntryは、最初の引数として Entry、第二引数として AddressBookを取り、新しい AddressBookを返すということを、この型シグネチャは言っています。

既存の AddressBookを直接変更することはしません。その代わりに、同じデータが含まれている新しい AddressBookを返すようにします。このように、 AddressBook永続データ構造(persistent data structure)の一例となっています。これはPureScriptにおける重要な考え方です。変更はコードの副作用であり、コードの振る舞いについての判断するのを難しくします。そのため、我々は可能な限り純粋な関数や不変のデータを好むのです。

Data.ListCons関数を使用すると insertEntryを実装できます。 PSCiを起動し :typeコマンドを使って、この関数の型を見てみましょう。

$ pulp repl

> import Data.List
> :type Cons

forall a. a -> List a -> List a

Consは、なんらかの型 aの値と、型 aを要素に持つリストを引数にとり、同じ型の要素を持つ新しいリストを返すということを、この型シグネチャは言っています。 aEntry型として特殊化してみましょう。

Entry -> List Entry -> List Entry

しかし、 List Entryはまさに AddressBookですから、次と同じになります。

Entry -> AddressBook -> AddressBook

今回の場合、すでに適切な入力があります。 EntryAddressBookConsを適用すると、新しい AddressBookを得ることができます。これこそまさに私たちが求めていた関数です!

insertEntryの実装は次のようになります。

insertEntry entry book = Cons entry book

等号の左側にある2つの引数 entrybookがスコープに導入されますから、これらに Cons関数を適用して結果の値を作成しています。

3.11 カリー化された関数

PureScriptでは、関数は常にひとつの引数だけを取ります。 insertEntry関数は2つの引数を取るように見えますが、これは実際にはカリー化された関数(curried function)の一例となっています。

insertEntryの型に含まれる ->は右結合の演算子であり、つまりこの型はコンパイラによって次のように解釈されます。

Entry -> (AddressBook -> AddressBook)

すなわち、 insertEntryは関数を返す関数である、ということです!この関数は単一の引数 Entryを取り、それから単一の引数 AddressBookを取り新しい AddressBookを返す新しい関数を返すのです。

これは例えば、最初の引数だけを与えると insertEntry部分適用(partial application)できることを意味します。 PSCiでこの結果の型を見てみましょう。

> :type insertEntry example

AddressBook -> AddressBook

期待したとおり、戻り値の型は関数になっていました。この結果の関数に、ふたつめの引数を適用することもできます。

> :type (insertEntry example) emptyBook
AddressBook

ここで括弧は不要であることにも注意してください。次の式は同等です。

> :type insertEntry example emptyBook
AddressBook

これは関数適用が左結合であるためで、なぜ単に空白で区切るだけで関数に引数を与えることができるのかも説明にもなっています。

本書では今後、「2引数の関数」というように表現することがあることに注意してください。これはあくまで、最初の引数を取り別の関数を返す、カリー化された関数を意味していると考えてください。

今度は insertEntryの定義について考えてみます。

insertEntry :: Entry -> AddressBook -> AddressBook
insertEntry entry book = Cons entry book

もし式の右辺に明示的に括弧をつけるなら、 (Cons entry)bookとなります。 insertEntry entryはその引数が単に関数 (Cons entry)に渡されるような関数だということです。この2つの関数はどんな入力についても同じ結果を返しますから、つまりこれらは同じ関数です!よって、両辺から引数 bookを削除できます。

insertEntry :: Entry -> AddressBook -> AddressBook
insertEntry entry = Cons entry

そして、同様の理由で両辺から entryも削除することができます。

insertEntry :: Entry -> AddressBook -> AddressBook
insertEntry = Cons

この処理はイータ変換(eta conversion)と呼ばれ、引数を参照することなく関数を定義するポイントフリー形式(point-free form)へと関数を書き換えるのに使うことができます。

insertEntryの場合には、イータ変換によって「 insertEntryは単にリストに対する consだ」と関数の定義はとても明確になりました。しかしながら、常にポイントフリー形式のほうがいいのかどうかには議論の余地があります。

3.12 あなたの住所録は?

最小限の住所録アプリケーションの実装で必要になる最後の関数は、名前で人を検索し適切な Entryを返すものです。これは小さな関数を組み合わせることでプログラムを構築するという、関数型プログラミングで鍵となる考え方のよい応用例になるでしょう。

まずは住所録をフィルタリングし、該当する姓名を持つ項目だけを保持するようにするのがいいでしょう。それから、結果のリストの先頭の(head)要素を返すだけです。

この大まかな仕様に従って、この関数の型を計算することができます。まず PSCiを起動し、 filter関数と head関数の型を見てみましょう。

$ pulp repl

> import Data.List
> :type filter

forall a. (a -> Boolean) -> List a -> List a

> :type head

forall a. List a -> Maybe a

型の意味を理解するために、これらの2つの型の一部を取り出してみましょう。

filterはカリー化された2引数の関数です。最初の引数は、リストの要素を取り Boolean値を結果として返す関数です。第2引数は要素のリストで、返り値は別のリストです。

headは引数としてリストをとり、 Maybe aという今まで見たことがないような型を返します。 Maybe aは型 aのオプショナルな値、つまり aの値を持つか持たないかのどちらかの値を示しており、JavaScriptのような言語で値がないことを示すために使われる nullの型安全な代替手段を提供します。これについては後の章で詳しく扱います。

filterheadの全称量化された型は、PureScriptコンパイラによって次のように特殊化(specialized)されます。

filter :: (Entry -> Boolean) -> AddressBook -> AddressBook

head :: AddressBook -> Maybe Entry

検索する関数の引数として姓と名前を渡す必要があるのもわかっています。

filterに渡す関数も必要になることもわかります。この関数を filterEntryと呼ぶことにしましょう。 filterEntryEntry -> Booleanという型を持っています。 filter filterEntryという関数適用の式は、 AddressBook -> AddressBookという型を持つでしょう。もしこの関数の結果を head関数に渡すと、型 Maybe Entryの結果を得ることになります。

これまでのことをまとめると、この findEntry関数の妥当な型シグネチャは次のようになります。

findEntry :: String -> String -> AddressBook -> Maybe Entry

findEntryは、姓と名前の2つの文字列、および AddressBookを引数にとり、 Maybe Entryという型の値を結果として返すということを、この型シグネチャは言っています。結果の Maybe Entryという型は、名前が住所録で発見された場合にのみ Entryの値を持ちます。

そして、 findEntryの定義は次のようになります。

findEntry firstName lastName book = head $ filter filterEntry book
  where
    filterEntry :: Entry -> Boolean
    filterEntry entry = entry.firstName == firstName && entry.lastName == lastName

一歩づつこのコードの動きを調べてみましょう。

findEntryは、どちらも文字列型である firstNamelastNameAddressBook型の bookという3つの名前をスコープに導入します

定義の右辺では filter関数と head関数が組み合わされています。まず項目のリストをフィルタリングし、その結果に head関数を適用しています。

真偽型を返す関数 filterEntrywhere節の内部で補助的な関数として定義されています。このため、 filterEntry関数はこの定義の内部では使用できますが、外部では使用することができません。また、 filterEntryはそれを包む関数の引数に依存することができ、 filterEntryは指定された Entryをフィルタリングするために引数 firstNamelastNameを使用しているので、 filterEntryfindEntryの内部にあることは必須になっています。

最上位での宣言と同じように、必ずしも filterEntryの型シグネチャを指定しなくてもよいことに注意してください。ただし、ドキュメントとしても役に立つので型シグネチャを書くことは推奨されています。

3.13 中置の関数適用

上でみた findEntryのコードでは、少し異なる形式の関数適用が使用されています。 head関数は中置の $演算子を使って式 filter filterEntry bookに適用されています。

これは head (filter filterEntry book)という通常の関数適用と同じ意味です。

($)はPreludeで定義されている apply関数の別名で、次のように定義されています。

apply :: forall a b. (a -> b) -> a -> b
apply f x = f x

infixr 0 apply as $

ここで、 applyは関数と値をとり、その値にその関数を適用します。 infixrキーワードは ($)applyの別名として定義します。

しかし、なぜ通常の関数適用の代わりに $を使ったのでしょうか? その理由は $は右結合で優先順位の低い演算子だということにあります。これは、深い入れ子になった関数適用のための括弧を、 $を使うと取り除くことができることを意味します。

たとえば、ある従業員の上司の住所がある道路を見つける、次の入れ子になった関数適用を考えてみましょう。

street (address (boss employee))

これは $を使用して表現すればずっと簡単になります。

street $ address $ boss employee

3.14 関数合成

イータ変換を使うと insertEntry関数を簡略化できたのと同じように、引数をよく考察すると findEntryの定義を簡略化することができます。

引数 bookが関数 filter filterEntryに渡され、この適用の結果が headに渡されることに注目してください。これは言いかたを変えれば、 filter filterEntryhead合成(composition) に bookは渡されるということです。

PureScriptの関数合成演算子は <<<>>>です。前者は「逆方向の合成」であり、後者は「順方向の合成」です。

いずれかの演算子を使用して findEntryの右辺を書き換えることができます。逆順の合成を使用すると、右辺は次のようになります。

(head <<< filter filterEntry) book

この形式なら最初の定義にイータ変換の技を適用することができ、 findEntryは最終的に次のような形式に到達します。

findEntry firstName lastName = head <<< filter filterEntry
  where
    ...

右辺を次のようにしても同じです。

filter filterEntry >>> head

どちらにしても、これは「 findEntryはフィルタリング関数と head関数の合成である」という findEntry関数のわかりやすい定義を与えます。

どちらの定義のほうがわかりやすいかの判断はお任せしますが、このように関数を部品として捉え、関数はひとつの役目だけをこなし、機能を関数合成で組み立てるというように考えると有用なことがよくあります。

3.15 テスト、テスト、テスト……

これでこのアプリケーションの中核部分が完成しましたので、 PSCiを使って試してみましょう。

$ pulp repl

> import Data.AddressBook

まずは空の住所録から項目を検索してみましょう(これは明らかに空の結果が返ってくることが期待されます)。

> findEntry "John" "Smith" emptyBook

No type class instance was found for

    Data.Show.Show { firstName :: String
                   , lastName :: String
                   , address :: { street :: String
                                , city :: String
                                , state :: String
                                }
                   }

エラーです!でも心配しないでください。これは単に 型 Entryの値を文字列として出力する方法を PSCiが知らないという意味のエラーです。

findEntryの返り値の型は Maybe Entryですが、これは手作業で文字列に変換することができます。

showEntry関数は Entry型の引数を期待していますが、今あるのは Maybe Entry型の値です。この関数は Entry型のオプショナルな値を返すことを忘れないでください。行う必要があるのは、オプショナルな値の中に項目の値が存在すれば showEntry関数を適用し、そうでなければ存在しないという値をそのまま伝播することです。

幸いなことに、Preludeモジュールはこれを行う方法を提供しています。 map演算子は Maybeのような適切な型構築子まで関数を「持ち上げる」ことができます(この本の後半で関手について説明するときに、この関数やそれに類似する他のものについて詳しく見ていきます)。

> import Prelude
> map showEntry (findEntry "John" "Smith" emptyBook)

Nothing

今度はうまくいきました。この返り値 Nothingは、オプショナルな返り値に値が含まれていないことを示しています。期待していたとおりです。

もっと使いやすくするために、 Entryを文字列として出力するような関数を定義し、毎回 showEntryを使わなくてもいいようにすることもできます。

printEntry firstName lastName book
  = map showEntry (findEntry firstName lastName book)

それでは空でない住所録を作成してもう一度試してみましょう。先ほどの項目の例を再利用します。

> book1 = insertEntry entry emptyBook

> printEntry "John" "Smith" book1

Just ("Smith, John: 123 Fake St., Faketown, CA")

今度は結果が正しい値を含んでいました。 book1に別の名前で項目を挿入して、ふたつの名前がある住所録 book2を定義し、それぞれの項目を名前で検索してみてください。

演習

  1. (簡単) findEntry関数の定義の主な部分式の型を書き下し、 findEntry関数についてよく理解しているか試してみましょう。たとえば、 findEntryの定義のなかにある head関数の型は AddressBook -> Maybe Entryと特殊化されています。

  2. (簡単) findEntryの既存のコードを再利用し、与えられた電話番号から Entryを検索する関数を書いてみましょう。また、 PSCiで実装した関数をテストしてみましょう。

  3. (やや難しい) 指定された名前が AddressBookに存在するかどうかを調べて真偽値で返す関数を書いてみましょう。 (ヒント:リストが空かどうかを調べる Data.List.null関数の型を psciで調べてみてみましょう)

  4. (難しい) 姓名が重複している項目を住所録から削除する関数 removeDuplicatesを書いてみましょう。 (ヒント:値どうしの等価性を定義する述語関数に基づいてリストから重複要素を削除する関数 Data.List.nubByの型を、 psciを使用して調べてみましょう)

まとめ

この章では、関数型プログラミングの新しい概念をいくつか導入しました。

次の章からは、これらの考えかたに基づいて進めていきます。

第4章 再帰、マップ、畳み込み

4.1 この章の目標

この章では、アルゴリズムを構造化するときに再帰関数をどのように使うかについて見ていきましょう。再帰は関数型プログラミングの基本的な手法であり、この本の全体に渡って使われます。

また、PureScriptの標準ライブラリから標準的な関数をいくつか取り扱います。mapfoldのようなよく知られた関数だけでなく、filterconcatMapといった珍しいけれど便利なものについても見ていきます。

この章では、仮想的なファイルシステムを操作する関数のライブラリを動機付けに用います。この章で学ぶ手法を応用して、擬似的なファイルシステムによって表されるファイルのプロパティを計算する関数を記述します。

4.2 プロジェクトの準備

この章のソースコードには、src/Data/Path.purssrc/FileOperations.pursという2つのファイルが含まれています。

Data.Pathモジュールには、仮想ファイルシステムが含まれています。このモジュールの内容を変更する必要はありません。

FileOperationsモジュールには、Data.PathAPIを使用する関数が含まれています。演習への回答はこのファイルだけで完了することができます。

このプロジェクトには以下のBower依存関係があります。

4.3 はじめに

再帰は一般のプログラミングでも重要な手法ですが、特に純粋関数型プログラミングでは当たり前のように用いられます。この章で見ていくように、再帰はプログラムの変更可能な状態を減らすために役立つからです。

再帰は分割統治(divide and conquer)戦略と密接な関係があります。分割統治とはすなわち、いろいろな入力に対する問題を解決するために、入力を小さな部分に分割し、それぞれの部分について問題を解いて、部分ごとの答えから最終的な答えを組み立てるということです。

それでは、PureScriptにおける再帰の簡単な例をいくつか見てみましょう。

次は階乗関数(factorial function)のよくある例です。

fact :: Int -> Int
fact 0 = 1
fact n = n * fact (n - 1)

部分問題へ問題を分割することによって階乗関数がどのように計算されるかがわかります。より小さい数へと階乗を計算していくということです。ゼロに到達すると、答えは直ちに求まります。

次は、フィボナッチ関数(Fibonacci function)を計算するという、これまたよくある例です。

fib :: Int -> Int
fib 0 = 1
fib 1 = 1
fib n = fib (n - 1) + fib (n - 2)

やはり、部分問題の解決策を考えることで全体を解決していることがわかります。このとき、fib (n - 1)fib (n - 2)という式に対応した、2つの部分問題があります。これらの2つの部分問題が解決されていれば、この部分的な答えを加算することで、全体の答えを組み立てることができます。

4.4 配列上での再帰

再帰関数の定義は、Int型だけに限定されるものではありません!本書の後半でパターン照合(pattern matching)を扱うときに、いろいろなデータ型の上での再帰関数について見ていきますが、ここでは数と配列に限っておきます。

入力がゼロでないかどうかについて分岐するのと同じように、配列の場合も、配列が空でないかどうかについて分岐していきます。再帰を使用して配列の長さを計算する次の関数を考えてみます。

import Prelude

import Data.Array (null)
import Data.Array.Partial (tail)
import Partial.Unsafe (unsafePartial)

length :: forall a. Array a -> Int
length arr =
  if null arr
    then 0
    else 1 + length (unsafePartial tail arr)

この関数では配列が空かどうかで分岐するためにif ... then ... else式を使っています。このnull関数は配列が空のときにtrueを返します。空の配列の長さはゼロであり、空でない配列の長さは配列の先頭を取り除いた残りの部分の長さより1大きいというわけです。

JavaScriptで配列の長さを調べるのには、この例はどうみても実用的な方法とはいえませんが、次の演習を完了するための手がかりとしては充分でしょう。

演習

  1. (簡単) 入力が偶数であるとき、かつそのときに限りtrueに返すような再帰関数を書いてみましょう。

  2. (少し難しい) 配列内の偶数の数を数える再帰関数を書いてみましょう。ヒントData.Array.PartialモジュールのunsafePartial head関数を使うと、空でない配列の最初の要素を見つけることができます。

4.5 マップ

map関数は配列に対する再帰関数のひとつです。この関数を使うと、配列の各要素に順番に関数を適用することで、配列の要素を変換することができます。そのため、配列の内容は変更されますが、その形状(ここでは「長さ」)は保存されます。

本書で後ほど型クラス(type class)を扱うとき、形状を保存しながら型構築子のクラスを変換する関手(functor)と呼ばれる関数を紹介しますが、その時にmap関数は関手の具体例であることがわかるでしょう。

それでは、PSCimap関数を試してみましょう。

$ pulp repl

import Prelude
map (\n -> n + 1) [1, 2, 3, 4, 5]

[2, 3, 4, 5, 6]

mapがどのように使われているかに注目してください。最初の引数には配列がどのように対応付けられるかを示す関数、第2引数には配列そのものを渡します。

4.6 中置演算子

バッククォート(`)で関数名を囲むと、対応関係を表す関数と配列のあいだに、map関数を書くことができます。

(\n -> n + 1) `map` [1, 2, 3, 4, 5]

[2, 3, 4, 5, 6]

この構文は中置関数適用と呼ばれ、どんな関数でもこのように中置することができます。普通は2引数の関数に対して使うのが最も適切でしょう。

配列を扱うときは、map関数と等価な<$>という演算子が存在します。この演算子は他の二項演算子と同じように中置で使用することができます。

(\n -> n + 1) <$> [1, 2, 3, 4, 5]

[2, 3, 4, 5, 6]

それではmapの型を見てみましょう。

:type map
forall a b f. Functor f => (a -> b) -> f a -> f b

実はmapの型は、この章で必要とされているものよりも一般的な型になっています。今回の目的では、mapは次のようなもっと具体的な型であるかのように考えるとよいでしょう。

forall a b. (a -> b) -> Array a -> Array b

この型では、map関数に適用するときにはabという2つの型を自由に選ぶことができる、ということも示されています。aは元の配列の要素の型で、bは目的の配列の要素の型です。もっと言えば、mapが配列要素の型を変化させても構わないということです。たとえば、mapを使用すると数値を文字列に変換することができます。

show <$> [1, 2, 3, 4, 5]

["1","2","3","4","5"]

中置演算子<$>は特別な構文のように見えるかもしれませんが、実はPureScriptの普通の関数です。中置構文を使用した単なる適用にすぎません。実際、括弧でその名前を囲むと、この関数を通常の関数のように使用することができます。これは、map代わりに、括弧で囲まれた(<$>)という名前を使って配列に関数を適用できるということです。

(<$>) show [1, 2, 3, 4, 5]
["1","2","3","4","5"]

新しい中置演算子を定義するには、関数と同じ記法を使います。演算子名を括弧で囲み、あとは普通の関数のようにその中置演算子を定義します。たとえば、Data.Arrayモジュールでは次のようにrange関数と同じ振る舞いの中置演算子(..)を定義しています。

infix 8 range as ..

この演算子は次のように使うことができます。

import Data.Array
1 .. 5
[1, 2, 3, 4, 5]

show <$> (1 .. 5)
["1","2","3","4","5"]

注意: 独自の中置演算子は、自然な構文を持った領域特化言語を定義するのに優れた手段になりえます。ただし、使用には充分注意してください。初心者が読めないコードになることがありますから、新たな演算子の定義には慎重になるのが賢明です。

上記の例では、1 .. 5という式は括弧で囲まれていましたが、実際にはこれは必要ありません。なぜなら、Data.Arrayモジュールは、<$>に割り当てられた優先順位より高い優先順位を..演算子に割り当てているからです。上の例では、..の優先順位は、予約語infixのあとに書かれた数の8 と定義されていました。ここでは<$>の優先順位よりも高い優先順位を..に割り当てており、このため括弧を付け加える必要がないということです。

show <$> 1 .. 5
  
["1","2","3","4","5"]

中置演算子に左結合性または右結合性を与えたい場合は、代わりに予約語infixlinfixrを使います。

4.7 配列のフィルタリング

Data.Arrayモジュールでは他にも、mapと同様によく使われる関数filterも提供しています。この関数は、述語関数に適合する要素のみを残し、既存の配列から新しい配列を作成する機能を提供します。

たとえば、1から10までの数で、偶数であるような数の配列を計算したいとします。これは次のように行うことができます。

import Data.Array

filter (\n -> n `mod` 2 == 0) (1 .. 10)
[2,4,6,8,10]

演習

  1. (簡単)map関数や<$>関数を使用して、 配列に格納された数のそれぞれの平方を計算する関数を書いてみましょう。

  2. (簡単)filter関数を使用して、数の配列から負の数を取り除く関数を書いてみましょう。

  3. (やや難しい)filter関数と同じ意味の中置演算子<$?>を定義してみましょう。先ほどの演習の回答を、この新しい演算子を使用して書き換えてください。また、PSCiでこの演算子の優先順位と結合性を試してみてください。

4.8 配列の平坦化

配列に関する標準的な関数としてData.Arrayで定義されているものには、concat関数もあります。concatは配列の配列をひとつの配列へと平坦化します。

import Data.Array
:type concat 
forall a. Array (Array a) -> Array a

concat [[1, 2, 3], [4, 5], [6]]
[1, 2, 3, 4, 5, 6]

関連する関数として、concatmapを組み合わせたようなconcatMapと呼ばれる関数もあります。mapは(相異なる型も可能な)値からの値への関数を引数に取りますが、それに対してconcatMapは値から値の配列の関数を取ります。

実際に動かして見てみましょう。

import Data.Array

:type concatMap
forall a b. (a -> Array b) -> Array a -> Array b

concatMap (\n -> [n, n * n]) (1 .. 5)
[1,1,2,4,3,9,4,16,5,25]

ここでは、数をその数とその数の平方の2つの要素からなる配列に写す関数\n -> [n, n * n]を引数にconcatMapを呼び出しています。結果は、1から5の数と、そのそれぞれの数の平方からなる、10個の数になります。

concatMapがどのように結果を連結しているのかに注目してください。渡された関数を元の配列のそれぞれの要素について一度づつ呼び出し、その関数はそれぞれ配列を生成します。最後にそれらの配列を単一の配列に押し潰し、それが結果となります。

mapfilterconcatMapは、「配列内包表記」(array comprehensions)と呼ばれる、配列に関するあらゆる関数の基盤を形成しています。

4.9 配列内包表記

nのふたつの因数を見つけたいとしましょう。これを行うための簡単​​な方法としては、総当りで調べる方法があります。つまり、1からnの数のすべての組み合わせを生成し、それを乗算してみるわけです。もしその積がnなら、nの因数の組み合わせを見つけたということになります。

配列内包表記を使用すると、この計算を実行することができます。PSCiを対話式の開発環境として使用し、ひとつづつこの手順を進めていきましょう。

n以下の数の組み合わせの配列を生成する最初の手順は、concatMapを使えば行うことができます。

1 .. nのそれぞれの数を配列1 .. nへとマッピングすることから始めましょう。

pairs n = concatMap (\i -> 1 .. n) (1 .. n)

この関数をテストしてみましょう。

pairs 3
[1,2,3,1,2,3,1,2,3]

これは求めているものとはぜんぜん違います。単にそれぞれの組み合わせの2つ目の要素を返すのではなく、ペア全体を保持することができるように、内側の1 .. nの複製について関数をマッピングする必要があります。

:paste
… pairs' n =
…   concatMap (\i ->
…     map (\j -> [i, j]) (1 .. n)
…   ) (1 .. n)
… ^D

pairs' 3
[[1,1],[1,2],[1,3],[2,1],[2,2],[2,3],[3,1],[3,2],[3,3]]

いい感じになってきました。しかし、[1, 2][2, 1]の両方があるように、重複した組み合わせが生成されています。jiからnの範囲に限定することで、2つ目の場合を取り除くことができます。

:paste
… pairs'' n =
…   concatMap (\i ->
…     map (\j -> [i, j]) (i .. n)
…   ) (1 .. n)
… ^D

pairs'' 3
[[1,1],[1,2],[1,3],[2,2],[2,3],[3,3]]

すばらしいです!因数の候補のすべての組み合わせを手に入れたので、filterを使えば、その積がnであるような組み合わせを選び出すことができます。

import Data.Foldable

factors n = filter (\pair -> product pair == n) (pairs'' n)

factors 10
[[1,10],[2,5]]

このコードでは、purescript-foldable-traversableライブラリのData.Foldableモジュールにあるproduct関数を使っています。

うまくいきました!重複のなく、因数の組み合わせの正しい集合を見つけることができました。

4.10 do記法

機能は実現できましたが、このコードの可読性は大幅に向上することができます。mapconcatMapは基本的な関数であり、do記法(do notation)と呼ばれる特別な構文の基礎になっています(もっと厳密にいえば、それらの一般化であるmapbindが基礎をなしています)。

注意mapconcatMap配列内包表記を書けるようにしているように、もっと一般的な演算子であるmapbindモナド内包表記(monad comprehensions)と呼ばれているものを書けるようにします。本書の後半ではモナド(monad)の例をたっぷり見ていくことになります。

do記法を使うと、先ほどのfactors関数を次のように書き直すことができます。

factors :: Int -> Array (Array Int)
factors n = filter (\xs -> product xs == n) $ do
  i <- 1 .. n
  j <- i .. n
  pure [i, j]

予約語doはdo記法を使うコードのブロックを導入します。このブロックは幾つかの型の式で構成されています。

この新しい記法を使うと、アルゴリズムの構造がわかりやすくなることがあります。心のなかで<-を「選ぶ」という単語に置き換えるとすると、「1からnの間の要素iを選び、それからiからnの間の要素jを選び、[i, j]を返す」というように読むことができるかもしれません。

最後の行では、pure関数を使っています。この関数はPSCiで評価することができますが、型を明示する必要があります。

pure [1, 2] :: Array (Array Int)
[[1, 2]]

配列の場合、pureは単に1要素の配列を作成します。実際に、factors関数を変更して、pureの代わりにこの形式を使うようにすることもできます。

factors :: Int -> Array (Array Int)
factors n = filter (\xs -> product xs == n) $ do
  i <- 1 .. n
  j <- i .. n
  [[i, j]]

そして、結果は同じになります。

4.11 ガード

factors関数を更に改良する方法としては、このフィルタを配列内包表記の内側に移動するというものがあります。これはpurescript-controlライブラリにあるControl.MonadZeroモジュールのguard関数を使用することで可能になります。

import Control.MonadZero (guard)

factors :: Int -> Array (Array Int)
factors n = do
  i <- 1 .. n
  j <- i .. n
  guard $ i * j == n
  pure [i, j]

pureと同じように、guard関数がどのように動作するかを理解するために、PSCiguard関数を適用して調べてみましょう。guard関数の型は、ここで必要とされるものよりもっと一般的な型になっています。

import Control.MonadZero

:type guard
forall m. MonadZero m => Boolean -> m Unit

今回の場合は、PSCiは次の型を報告するものと考えてください。

Boolean -> Array Unit

次の計算の結果から、配列におけるguard関数について今知りたいことはすべてわかります。

import Data.Array

length $ guard true
1

length $ guard false
0

つまり、guardtrueに評価される式を渡された場合、単一の要素を持つ配列を返すのです。もし式がfalseと評価された場合は、その結果は空です。

ガードが失敗した場合、配列内包表記の現在の分岐は、結果なしで早めに終了されることを意味します。これは、guardの呼び出しが、途中の配列に対してfilterを使用するのと同じだということです。これらが同じ結果になることを確認するために、factorsの二つの定義を試してみてください。

演習

  1. (簡単) factors関数を使用して、整数の引数が素数であるかどうかを調べる関数isPrimeを定義してみましょう。

  2. (やや難しい) 2つの配列の直積集合を見つけるための関数を書いてみましょう。直積集合とは、要素abのすべての組み合わせの集合のことです。ここでaは最初の配列の要素、bは2つ目の配列の要素です。

  3. (やや難しい) ピタゴラスの三つ組数とは、a² + b² = c²を満たすような3つの数の配列[a, b, c]のことです。配列内包表記の中でguard関数を使用して、数nを引数に取り、どの要素もnより小さいようなピタゴラスの三つ組数すべてを求める関数を書いてみましょう。その関数はInt -> Array (Array Int)という型を持っていなければなりません。

  4. (難しい) factors関数を使用して、数nのすべての因数分解を求める関数factorizationsを定義してみましょう。数nの因数分解とは、それらの積がnであるような整数の配列のことです。ヒント:1は因数ではないと考えてください。また、無限再帰に陥らないように注意しましょう。

4.12 畳み込み

再帰を利用して実装される興味深い関数としては、配列に対する左畳み込み(left fold)と右畳み込み(right fold)があります。

PSCiを使って、Data.Foldableモジュールをインポートし、foldlfoldr関数の型を調べることから始めましょう。

import Data.Foldable

:type foldl
forall a b f. Foldable f => (b -> a -> b) -> b -> f a -> b

:type foldr
forall a b f. Foldable f => (a -> b -> b) -> b -> f a -> b

これらの型は、現在興味があるものよりも一般的です。この章の目的では、PSCiは以下の(より具体的な)答えを与えていたと考えておきましょう。

:type foldl
forall a b. (b -> a -> b) -> b -> Array a -> b

:type foldr
forall a b. (a -> b -> b) -> b -> Array a -> b

どちらの型でも、aは配列の要素の型に対応しています。型bは、配列を走査(traverse)したときの結果を累積する「累積器」(accumulator)の型だと考えることができます。

foldl関数とfoldr関数の違いは走査の方向です。foldrが「右から」配列を畳み込むのに対して、foldlは「左から」配列を畳み込みます。

これらの関数の動きを見てみましょう。foldlを使用して数の配列の和を求めてみます。型aNumberになり、結果の型bNumberとして選択することができます。ここでは、次の要素を累積器に加算するNumber -> Number -> Numberという型の関数、Number型の累積器の初期値、和を求めたいNumberの配列という、3つの引数を提供する必要があります。最初の引数としては、加算演算子を使用することができますし、累積器の初期値はゼロになります。

foldl (+) 0 (1 .. 5)
15

この場合では、引数が逆になっていても(+)関数は同じ結果を返すので、foldlfoldrのどちらでも問題ありません。

foldr (+) 0 (1 .. 5)
15

foldlfoldrの違いを説明するために、畳み込み関数の選択が影響する例も書いてみましょう。加算関数の代わりに、文字列連結を使用して文字列を作ってみます。

foldl (\acc n -> acc <> show n) "" [1,2,3,4,5]
"12345"

foldr (\n acc -> acc <> show n) "" [1,2,3,4,5]
"54321"

これは、2つの関数の​​違いを示しています。左畳み込み式は、以下の関数適用と同等です。

((((("" <> show 1) <> show 2) <> show 3) <> show 4) <> show 5)

それに対し、右畳み込みは以下に相当します。

((((("" <> show 5) <> show 4) <> show 3) <> show 2) <> show 1)

4.13 末尾再帰

再帰はアルゴリズムを定義するための強力な手法ですが、問題も抱えています。JavaScriptで再帰関数を評価するとき、入力が大きすぎるとスタックオーバーフローでエラーを起こす可能性があるのです。

PSCiで次のコードを入力すると、この問題を簡単に検証できます。

f 0 = 0
f n = 1 + f (n - 1)

f 10
10
  
f 10000
RangeError: Maximum call stack size exceeded

これは問題です。関数型プログラミングの基本的な手法として再帰を採用しようとするなら、無限かもしれない再帰でも扱える方法が必要です。

PureScriptは末尾再帰最適化(tail recursion optimization)の形でこの問題に対する部分的な解決策を提供しています。

注意:この問題へのより完全な解決策としては、いわゆるトランポリン(trampolining)を使用したライブラリで実装する方法がありますが、それはこの章で扱う範囲を超えています。この内容に興味のある読者はpurescript-freepurescript-tailrecパッケージのドキュメントを参照してみてください。

末尾再帰の最適化が可能かどうかには条件があります。末尾位置(tail position)にある関数の再帰的な呼び出しは、スタックフレームが確保されないジャンプに置き換えることができます。呼び出しは、関数が戻るより前の最後の呼び出しであるとき、末尾位置にあるといいます。なぜこの例でスタックオーバーフローを観察したのかはこれが理由です。このfの再帰呼び出しは、末尾位置ではないからです。

実際には、PureScriptコンパイラは再帰呼び出しをジャンプに置き換えるのではなく、再帰的な関数全体をwhileループに置き換えます。

以下はすべての再帰呼び出しが末尾位置にある再帰関数の例です。

fact :: Int -> Int -> Int
fact 0 acc = acc
fact n acc = fact (n - 1) (acc * n)

factへの再帰呼び出しは、この関数の中で起こる最後のものである、つまり末尾位置にあることに注意してください。

4.14 累積器

末尾再帰ではない関数を末尾再帰関数に変える一般的な方法としては、累積器引数(accumulator parameter)を使用する方法があります。結果を累積するために返り値を使うと末尾再帰を妨げることがありますが、それとは対照的に累積器引数は返り値を累積する関数へ追加される付加的な引数です。

たとえば、入力配列を逆順にする、この配列の再帰を考えてみましょう。

reverse :: forall a. Array a -> Array a
reverse [] = []
reverse xs = snoc (reverse (unsafePartial tail xs))
                  (unsafePartial head xs)

この実装は末尾再帰ではないので、大きな入力配列に対して実行されると、生成されたJavaScriptはスタックオーバーフローを発生させるでしょう。しかし、代わりに、結果を蓄積するための2つ目の引数を関数に導入することで、これを末尾再帰に変えることができます。

reverse :: forall a. Array a -> Array a
reverse = reverse' []
  where
    reverse' acc [] = acc
    reverse' acc xs = reverse' (unsafePartial head xs : acc)
                               (unsafePartial tail xs)

ここでは、配列を逆転させる作業を補助関数reverse'に委譲しています。関数`reverse'が末尾再帰的であることに注目してください。 その唯一の再帰呼び出しは、最後の場合の末尾位置にあります。これは、生成されたコードがwhileループとなり、大きな入力でもスタックが溢れないことを意味します。

reverseのふたつめの実装を理解するためには、部分的に構築された結果を状態として扱うために、補助関数reverse'で累積器引数の使用することが必須であることに注意してください。結果は空の配列で始まりますが、入力配列の要素ひとつごとに、ひとつづつ大きくなっていきます。後の要素は配列の先頭に追加されるので、結果は元の配列の逆になります!

累積器を「状態」と考えることもできますが、直接に変更がされているわけではないことにも注意してください。この累積器は不変の配列であり、計算に沿って状態受け渡すために、単に関数の引数を使います。

4.15 明示的な再帰より畳み込みを選ぶ

末尾再帰を使用して再帰関数を記述することができれば末尾再帰最適化の恩恵を受けることができるので、すべての関数をこの形で書こうとする誘惑にかられます。しかし、多くの関数は配列やそれに似たデータ構造に対する折り畳みとして直接書くことができることを忘れがちです。mapfoldのようなコンビネータを使って直接アルゴリズムを書くことには、コードの単純さという利点があります。これらのコンビネータはよく知られており、アルゴリズムの意図をはっきりとさせるのです。

例えば、 先ほどのreverseの例は、畳み込みとして少なくとも2つの方法で書くことができます。foldrを使用すると次のようになります。

import Data.Foldable
:paste
… reverse :: forall a. Array a -> Array a
… reverse = foldr (\x xs -> xs <> [x]) []
… ^D
reverse [1, 2, 3]

[3,2,1]

foldlを使ってreverseを書くことは、読者への課題として残しておきます。

演習

  1. (簡単)foldlを使って、真偽値の配列の要素すべてが真かどうか調べてみてください。

  2. (やや難しい) 関数foldl (==) false xsが真を返すような配列xsとはどのようなものか説明してください。

  3. (やや難しい) 累積器引数を使用して、次の関数を末尾再帰形に書きなおしてください。

    import Prelude
    import Data.Array.Partial (head, tail)
    count :: forall a. (a -> Boolean) -> Array a -> Int
    count _ [] = 0
    count p xs = if p (unsafePartial head xs)
                   then count p (unsafePartial tail xs) + 1
                   else count p (unsafePartial tail xs)
    
  4. (やや難しい)foldlを使ってreverseを書いてみましょう。

4.16 仮想ファイルシステム

この節では、これまで学んだことを応用して、模擬的なファイルシステムで動作する関数を書いていきます。事前に定義されたAPIで動作するように、マップ、畳み込み、およびフィルタを使用します。

Data.Pathモジュールでは、次のように仮想ファイルシステムのAPIが定義されています。

型については、型定義は次のようになっています。

root :: Path

ls :: Path -> Array Path

filename :: Path -> String

size :: Path -> Maybe Number

isDirectory :: Path -> Boolean

PSCiでこのAPIを試してみましょう。

$ pulp repl
import Data.Path

root
/

isDirectory root
true

ls root
[/bin/,/etc/,/home/]

FileOperationsモジュールでは、Data.PathAPIを操作するための関数を定義されています。Data.Pathモジュールを変更したり実装を理解したりする必要はありません。すべてFileOperationsモジュールだけで作業を行います。

4.17 すべてのファイルの一覧

それでは、内側のディレクトリまで、すべてのファイルを列挙する関数を書いてみましょう。この関数は以下のような型を持つでしょう。

allFiles :: Path -> Array Path

再帰を使うとこの関数を定義することができます。まずはlsを使用してディレクトリの直接の子を列挙します。それぞれの子について再帰的にallFilesを適用すると、それぞれパスの配列が返ってくるでしょう。concatMapを適用すると、この結果を同時に平坦化することができます。

最後に、:演算子を使って現在のファイルも含めます。

allFiles file = file : concatMap allFiles (ls file)

注意:cons演算子は、実際には不変な配列に対してパフォーマンスが悪いので、一般的には推奨されません。 リンクリストやシーケンスなどの他のデータ構造を使用すると、パフォーマンスを向上させることができます。

それではPSCiでこの関数を試してみましょう。

import FileOperations
import Data.Path

allFiles root
  
[/,/bin/,/bin/cp,/bin/ls,/bin/mv,/etc/,/etc/hosts, ...]

すばらしい!do記法で配列内包表記を使ってもこの関数を書くことができるので見ていきましょう。

逆向きの矢印は配列から要素を選択するのに相当することを思い出してください。最初の手順は、引数の直接の子から要素を選択することです。それから、単にそのファイルに対してこの再帰関数を呼びします。do記法を使用しているので、再帰的な結果をすべて連結するconcatMapが暗黙に呼び出されています。

新しいコードは次のようになります。

allFiles' :: Path -> Array Path
allFiles' file = file : do
  child <- ls file
  allFiles' child

PSCiで新しいコードを試してみてください。同じ結果が返ってくるはずです。どちらのほうがわかりやすいかの選択はお任せします。

演習

  1. (簡単) ディレクトリのすべてのサブディレクトリの中まで、ディレクトリを除くすべてのファイルを返すような関数onlyFilesを書いてみてください。

  2. (やや難しい) このファイルシステムで最大と最小のファイルを決定するような畳み込みを書いてください。

  3. (難しい) ファイルを名前で検索する関数whereIsを書いてください。この関数は型Maybe Pathの値を返すものとします。この値が存在するなら、そのファイルがそのディレクトリに含まれているということを表します。この関数は次のように振る舞う必要があります。

    > whereIs "/bin/ls"
    Just (/bin/)
    
    > whereIs "/bin/cat"
    Nothing
    

    ヒント:do記法で配列内包表記を使用して、この関数を記述してみてください。

まとめ

この章では、アルゴリズムを簡潔に表現する手段として、PureScriptでの再帰の基本を説明しました。また、独自の中置演算子や、マップ、フィルタリングや畳み込みなどの配列に対する標準関数、およびこれらの概念を組み合わせた配列内包表記を導入しました。最後に、スタックオーバーフローエラーを回避するために末尾再帰を使用することの重要性、累積器引数を使用して末尾再帰形に関数を変換する方法を示しました。

第5章 パターン照合

5.1 この章の目標

この章では、代数的データ型とパターン照合という、ふたつの新しい概念を導入します。また、行多相というPureScriptの型システムの興味深い機能についても簡単に取り扱います。

パターン照合(Pattern matching)は関数​​型プログラミングにおける一般的な手法で、複数の場合に実装を分解することにより、開発者は潜在的に複雑な動作の関数を簡潔に書くことができます。

代数的データ型はPureScriptの型システムの機能で、パターン照合とも密接に関連しています。

この章の目的は、代数的データ型やパターン照合を使用して、単純なベクターグラフィックスを描画し操作するためのライブラリを書くことです。

5.2 プロジェクトの準備

この章のソースコードはファイル src/Data/Picture.pursで定義されています。

このプロジェクトでは、これまで見てきたBowerパッケージを引き続き使用しますが、それに加えて次の新しい依存関係が追加されます。

Data.Pictureモジュールは、簡単な図形を表すデータ型 Shapeや、図形の集合である型 Picture、及びこれらの型を扱うための関数を定義しています。

このモジュールでは、データ構造の畳込みを行う関数を提供する Data.Foldableモジュールもインポートします。

module Data.Picture where

import Prelude
import Data.Foldable (foldl)

Data.Pictureモジュールでは、 GlobalMathモジュールもインポートするため asキーワードを使用します。

import Global as Global
import Math as Math

これは型や関数をモジュール内で使用できるようにしますが、Global.infinityMath.maxといった修飾名でのみ使用にできるようにします。これは重複したインポートをさけ、使用するモジュールを明確にするのに有効な方法です。

注意:同じモジュール名を修飾名に使用する場合には不要な作業です。一般的にはimport Math as Mなどの短い名前がよく使われています。

5.3 単純なパターン照合

それではコード例を見ることから始めましょう。パターン照合を使用して2つの整数の最大公約数を計算する関数は、次のようになります。

gcd :: Int -> Int -> Int
gcd n 0 = n
gcd 0 m = m
gcd n m = if n > m
            then gcd (n - m) m
            else gcd n (m - n)

このアルゴリズムはユークリッドの互除法と呼ばれています。その定義をオンラインで検索すると、おそらく上記のコードによく似た数学の方程式が見つかるでしょう。パターン照合の利点のひとつは、上記のようにコードを場合分けして定義することができ、数学関数の定義と似たような簡潔で宣言型なコードを書くことができることです。

パターン照合を使用して書かれた関数は、条件と結果の組み合わせによって動作します。この定義の各行は選択肢(alternative)や場合(case)と呼ばれています。等号の左辺の式はパターンと呼ばれており、それぞれの場合は空白で区切られた1つ以上のパターンで構成されています。等号の右側の式が評価され値が返される前に引数が満たさなければならない条件について、これらの場合は説明しています。それぞれの場合は上からこの順番に試されていき、最初に入力に適合した場合が返り値を決定します。

たとえば、 gcd関数は次の手順で評価されます。

パターンは値を名前に束縛することができることに注意してください。この例の各行では nという名前と mという名前の両方、またはどちらか一方に、入力された値を束縛しています。これより、入力の引数から名前を選ぶためのさまざまな方法に対応した、さまざまな種類のパターンを見ていくことになります。

5.4 単純なパターン

上記のコード例では、2種類のパターンを示しました。

単純なパターンには他にも種類があります。

ここではこれらの単純なパターンを使用した、さらに2つの例を示します。

fromString :: String -> Boolean
fromString "true" = true
fromString _      = false

toString :: Boolean -> String
toString true  = "true"
toString false = "false"

PSCiでこれらの関数を試してみてください。

5.5 ガード

ユークリッドの互除法の例では、 m > nのときと m <= nのときの2つに分岐するために if .. then .. else式を使っていました。こういうときには他にガード(guard)を使うという選択肢もあります。

ガードは真偽値の式で、パターンによる制約に加えてそのガードが満たされたときに、その場合の結果になります。ガードを使用してユークリッドの互除法を書き直すと、次のようになります。

gcd :: Int -> Int -> Int
gcd n 0 = n
gcd 0 n = n
gcd n m | n > m = gcd (n - m) m
        | otherwise = gcd n (m - n)

3行目ではガードを使用して、最初の引数が第2引数よりも厳密に大きいという条件を付け加えています。

この例が示すように、ガードは等号の左側に現れ、パイプ文字( |)でパターンのリストと区切られています。

演習

  1. (簡単)パターン照合を使用して、階乗関数を書いてみましょう。ヒント:入力がゼロのときとゼロでないときの、ふたつの場合を考えてみてください。

  2. (やや難しい)二項係数を計算するためのパスカルの公式(Pascal's Rule、パスカルの三角形を参照のこと)について調べてみてください。パスカルの公式を利用し、パターン照合を使って二項係数を計算する関数を記述してください。

5.6 配列リテラルパターン

配列リテラルパターン(array literal patterns)は、固定長の配列に対して照合を行う方法を提供します。たとえば、空の配列であることを特定する関数 isEmptyを書きたいとします。最初の選択肢に空の配列パターン( [])を用いるとこれを実現できます。

isEmpty :: forall a. Array a -> Boolean
isEmpty [] = true
isEmpty _ = false

次の関数では、長さ5の配列と適合し、配列の5つの要素をそれぞれ異なった方法で束縛しています。

takeFive :: Array Int -> Int
takeFive [0, 1, a, b, _] = a * b
takeFive _ = 0

最初のパターンは、第1要素と第2要素がそれぞれ0と1であるような、5要素の配列にのみ適合します。その場合、関数は第3要素と第4要素の積を返します。それ以外の場合は、関数は0を返します。 PSCiで試してみると、たとえば次のようになります。

> :paste
… takeFive [0, 1, a, b, _] = a * b
… takeFive _ = 0
… ^D

> takeFive [0, 1, 2, 3, 4]
6

> takeFive [1, 2, 3, 4, 5]
0

> takeFive []
0

配列のリテラルパターンでは、固定長の配列と一致させることはできますが、不特定の長さの配列を照合させる手段を提供していません。PureScriptでは、そのような方法で不変な配列を分解すると、実行速度が低下する可能性があるためです。不特定の長さの配列に対して照合を行うことができるデータ構造が必要な場合は、Data.Listを使うことをお勧めします。そのほかの操作について、より優れた漸近性能を提供するデータ構造も存在します。

5.7 レコードパターンと行多相

レコードパターン(Record patterns)は(ご想像のとおり)レコードに照合します。

レコードパターンはレコードリテラルに見た目が似ていますが、レコードリテラルでラベルと式をコロンで区切るのとは異なり、レコードパターンではラベルとパターンを等号で区切ります。

たとえば、次のパターンは firstlastと呼ばれるフィールドが含まれた任意のレコードにマッチし、これらのフィールドの値はそれぞれ xyという名前に束縛されます。

showPerson :: { first :: String, last :: String } -> String
showPerson { first: x, last: y } = y <> ", " <> x

レコードパターンはPureScriptの型システムの興味深い機能である行多相(row polymorphism)の良い例となっています。もし上のshowPersonを型シグネチャなしで定義していたとすると、この型はどのように推論されるのでしょうか?面白いことに、推論される型は上で与えた型とは同じではありません。

> showPerson { first: x, last: y } = y <> ", " <> x

> :type showPerson
forall r. { first :: String, last :: String | r } -> String

この型変数 rとは何でしょうか?PSCishowPersonを使ってみると、面白いことがわかります。

> showPerson { first: "Phil", last: "Freeman" }
"Freeman, Phil"

> showPerson { first: "Phil", last: "Freeman", location: "Los Angeles" }
"Freeman, Phil"

レコードにそれ以外のフィールドが追加されていても、 showPerson関数はそのまま動作するのです。型が Stringであるようなフィールド firstlastがレコードに少なくとも含まれていれば、関数適用は正しく型付けされます。しかし、フィールドが不足していると、 showPersonの呼び出しは不正となります。

> showPerson { first: "Phil" }

Type of expression lacks required label "last"

showPersonの推論された型シグネチャは、 Stringであるような firstlastというフィールドと、それ以外の任意のフィールドを持った任意のレコードを引数に取り、 Stringを返す、というように読むことができます。

この関数はレコードフィールドの行 rについて多相的なので、行多相と呼ばれるわけです。

次のように書くことができることにも注意してください。

> showPerson p = p.last <> ", " <> p.first

この場合も、 PSCiは先ほどと同じ型を推論するでしょう。

後ほど拡張可能作用(Extensible effects)について議論するときに、再び行多相について見ていくことになります。

5.8 入れ子になったパターン

配列パターンとレコードパターンはどちらも小さなパターンを組み合わせることで大きなパターンを構成しています。これまでの例では配列パターンとレコードパターンの内部に単純なパターンを使用していましたが、パターンが自由に入れ子にすることができることも知っておくのが大切です。入れ子になったパターンを使うと、潜在的に複雑なデータ型に対して関数が条件分岐できるようになります。

たとえば、次のコードでは、レコードパターンと配列パターンを組み合わせて、レコードの配列と照合させています。

type Address = { street :: String, city :: String }

type Person = { name :: String, address :: Address }

livesInLA :: Person -> Boolean
livesInLA { address: { city: "Los Angeles" } } = true
livesInLA _ = false

5.9 名前付きパターン

パターンには名前を付けることができ、入れ子になったパターンを使うときにスコープに追加の名前を導入することができます。任意のパターンに名前を付けるには、 @記号を使います。

たとえば、次のコードは1つ以上の要素を持つ任意の配列と適合しますが、配列の先頭を xという名前、配列全体を arrという名前に束縛します。

sortPair :: Array Int -> Array Int
sortPair arr@[x, y]
  | x <= y = arr
  | otherwise = [y, x]
sortPair arr = arr

その結果、ペアがすでにソートされている場合は、新しい配列を複製する必要がありません。

演習

  1. (簡単)レコードパターンを使って、2つの Personレコードが同じ都市にいるか探す関数 sameCityを定義してみましょう。

  2. (やや難しい)行多相を考慮すると、 sameCity関数の最も一般的な型は何でしょうか?先ほど定義した livesInLA関数についてはどうでしょうか?

  3. (やや難しい)配列リテラルパターンを使って、1要素の配列の唯一のメンバーを抽出する関数fromSingletonを書いてみましょう。1要素だけを持つ配列でない場合、関数は指定されたデフォルト値を返さなければなりません。この関数は forall a. a -> Array a -> a.という型を持っていなければなりません。

5.10 Case式

パターンはソースコードの最上位にある関数だけに現れるわけではありません。 case式を使用すると計算の途中の値に対してパターン照合を使うことができます。case式には無名関数に似た種類の便利さがあります。関数に名前を与えることがいつも望ましいわけではありません。パターン照合を使いたいためだけで関数に名前をつけるようなことを避けられるようになります。

例を示しましょう。次の関数は、配列の"longest zero suffix"(和がゼロであるような、最も長い配列の末尾)を計算します。

import Data.Array.Partial (tail)
import Partial.Unsafe (unsafePartial)

lzs :: Array Int -> Array Int
lzs [] = []
lzs xs = case sum xs of
           0 -> xs
           _ -> lzs (unsafePartial tail xs)

例えば次のようになります。

> lzs [1, 2, 3, 4]
[]

> lzs [1, -1, -2, 3]
[-1, -2, 3]

この関数は場合ごとの分析によって動作します。もし配列が空なら、唯一の選択肢は空の配列を返すことです。配列が空でない場合は、さらに2つの場合に分けるためにまず case式を使用します。配列の合計がゼロであれば、配列全体を返します。そうでなければ、配列の残りに対して再帰します。

5.11 パターン照合の失敗

case式のパターンを順番に照合していって、もし選択肢のいずれの場合も入力が適合しなかった時は何が起こるのでしょうか?この場合、パターン照合失敗によって、case式は実行時に失敗します。

簡単な例でこの動作を見てみましょう。

import Partial.Unsafe (unsafePartial)

partialFunction :: Boolean -> Boolean
partialFunction = unsafePartial \true -> true

この関数はゼロの入力に対してのみ適合する単一の場合を含みます。このファイルをコンパイルして PSCiでそれ以外の値を与えてテストすると、実行時エラーが発生します。

> partialFunction false

Failed pattern match

どんな入力の組み合わせに対しても値を返すような関数は全関数(total function)と呼ばれ、そうでない関数は部分関数(partial function)と呼ばれています。

一般的には、可能な限り全関数として定義したほうが良いと考えられています。もしその関数が正しい入力に対して値を返さないことがあるとわかっているなら、大抵は aに対して型 Maybe aの返り値にし、失敗を示すときには Nothingを使うようにしたほうがよいでしょう。この方法なら、型安全な方法で値の有無を示すことができます。

PureScriptコンパイラは、パターンマッチが不完全で関数が全関数ではないことを検出するとエラーを生成します。部分関数が安全である場合、unsafePartial関数を使ってこれらのエラーを抑制することができます(その部分関数が安全だとあなたが言い切れるなら!)。もし上記の unsafePartial関数の呼び出しを取り除くと、コンパイラは次のエラーを生成します。

A case expression could not be determined to cover all inputs.
The following additional cases are required to cover all inputs:

  false

これは値falseが、定義されたどのパターンとも一致しないことを示しています。これらの警告には、複数の不一致のケースが含まれることがあります。

上記の型シグネチャも省略した場合は、次のようになります。

partialFunction true = true

このとき、PSCiは興味深い型を推論します。

:type partialFunction

Partial => Boolean -> Boolean

本書ではのちに=>記号を含むいろいろな型を見ることができます(これらは型クラスに関連しています)。しかし、今のところは、PureScriptは型システムを使って部分関数を追跡していること、開発者は型検証器にコードが安全であることを明示する必要があることを確認すれば十分です。

コンパイラは、定義されたパターンが冗長であることを検出した場合(すでに定義されたパターンに一致するケースのみ)でも警告を生成します。

redundantCase :: Boolean -> Boolean
redundantCase true = true
redundantCase false = false
redundantCase false = false

このとき、最後のケースは冗長であると正しく検出されます。

Redundant cases have been detected.
The definition has the following redundant cases:

  false

注意:PSCiは警告を表示しないので、この例を再現するには、この関数をファイルとして保存し、 pulp buildを使ってコンパイルします。

5.12 代数的データ型

この節では、PureScriptの型システムでパターン照合に原理的に関係している代数的データ型(Algebraic data type, ADT)と呼ばれる機能を導入します。

しかしまずは、ベクターグラフィックスライブラリの実装というこの章の課題を解決する基礎として、簡単な例を切り口にして考えていきましょう。

直線、矩形、円、テキストなどの単純な図形の種類を表現する型を定義したいとします。オブジェクト指向言語では、おそらくインタフェースもしくは抽象クラス Shapeを定義し、使いたいそれぞれの図形について具体的なサブクラスを定義するでしょう。

しかしながら、この方針は大きな欠点をひとつ抱えています。 Shapeを抽象的に扱うためには、実行したいと思う可能性のあるすべての操作を事前に把握し、 Shapeインタフェースに定義する必要があるのです。このため、モジュール性を壊さずに新しい操作を追加することが難しくなります。

もし図形の種類が事前にわかっているなら、代数的データ型はこうした問題を解決する型安全な方法を提供します。モジュール性のある方法で Shapeに新たな操作を定義し、型安全なまま保守することを可能にします。

代数的データ型として表現された Shapeがどのように記述されるかを次に示します。

data Shape
  = Circle Point Number
  | Rectangle Point Number Number
  | Line Point Point
  | Text Point String

次のように Point型を代数的データ型として定義することもできます。

data Point = Point
  { x :: Number
  , y :: Number
  }

この Pointデータ型は、興味深い点をいくつか示しています。

この宣言ではいくつかの構築子の和として Shapeを定義しており、各構築子に含まれたデータはそれぞれ区別されます。 Shapeは、中央 Pointと半径を持つ Circleか、 RectangleLineTextのいずれかです。他には Shape型の値を構築する方法はありません。

代数的データ型の定義は予約語 dataから始まり、それに新しい型の名前と任意個の型引数が続きます。その型のデータ構築子は等号の後に定義され、パイプ文字( |)で区切られます。

それではPureScriptの標準ライブラリから別の例を見てみましょう。オプショナルな値を定義するのに使われる Maybe型を本書の冒頭で扱いました。 purescript-maybeパッケージでは Maybeを次のように定義しています。

data Maybe a = Nothing | Just a

この例では型引数 aの使用方法を示しています。パイプ文字を「または」と読むことにすると、この定義は「 Maybe a型の値は、無い(Nothing)、またはただの(Just)型 aの値だ」と英語のように読むことができます。

データ構築子は再帰的なデータ構造を定義するために使用することもできます。更に例を挙げると、要素が型 aの単方向連結リストのデータ型を定義はこのようになります。

data List a = Nil | Cons a (List a)

この例は purescript-listsパッケージから持ってきました。ここで Nil構築子は空のリストを表しており、 Consは先頭となる要素と他の配列から空でないリストを作成するために使われます。 Consの2つ目のフィールドでデータ型 List aを使用しており、再帰的なデータ型になっていることに注目してください。

5.13 代数的データ型の使用

代数的データ型の構築子を使用して値を構築するのはとても簡単です。対応する構築子に含まれるデータに応じた引数を用意し、その構築子を単に関数のように適用するだけです。

例えば、上で定義した Line構築子は2つの Pointを必要としていますので、 Line構築子を使って Shapeを構築するには、型 Pointのふたつの引数を与えなければなりません。

exampleLine :: Shape
exampleLine = Line p1 p2
  where
    p1 :: Point
    p1 = Point { x: 0.0, y: 0.0 }

    p2 :: Point
    p2 = Point { x: 100.0, y: 50.0 }

p1及び p2を構築するため、レコードを引数として Point構築子を適用しています。

代数的データ型で値を構築することは簡単ですが、これをどうやって使ったらよいのでしょうか?ここで代数的データ型とパターン照合との重要な接点が見えてきます。代数的データ型の値がどの構築子から作られたかを調べたり、代数的データ型からフィールドの値を取り出す唯一の方法は、パターン照合を使用することです。

例を見てみましょう。 ShapeStringに変換したいとしましょう。 Shapeを構築するのにどの構築子が使用されたかを調べるには、パターン照合を使用しなければなりません。これには次のようにします。

showPoint :: Point -> String
showPoint (Point { x: x, y: y }) =
  "(" <> show x <> ", " <> show y <> ")"

showShape :: Shape -> String
showShape (Circle c r)      = ...
showShape (Rectangle c w h) = ...
showShape (Line start end)  = ...
showShape (Text p text) = ...

各構築子はパターンとして使用することができ、構築子への引数はそのパターンで束縛することができます。 showShapeの最初の場合を考えてみましょう。もし ShapeCircle構築子適合した場合、2つの変数パターン crを使って Circleの引数(中心と半径)がスコープに導入されます。その他の場合も同様です。

showPointは、パターン照合の別の例にもなっています。 showPointはひとつの場合しかありませんが、 Point構築子の中に含まれたレコードのフィールドに適合する、入れ子になったパターンが使われています。

5.14 レコード同名利用

showPoint関数は引数内のレコードと一致し、 xyプロパティを同じ名前の値に束縛します。 PureScriptでは、このようなパターン一致を次のように単純化できます。

showPoint :: Point -> String
showPoint (Point { x, y }) = ...

ここでは、プロパティの名前のみを指定し、名前に導入したい値を指定する必要はありません。 これはレコード同名利用(record pun)と呼ばれます。

レコード同名利用をレコードの構築に使用することもできます。例えば、スコープ内に xyという名前の値があれば、 Point {x、y}を使って Pointを作ることができます。

origin :: Point
origin = Point { x, y }
  where
    x = 0.0
    y = 0.0

これは、状況によってはコードの可読性を向上させるのに役立ちます。

演習

  1. (簡単)半径 10で中心が原点にある円を表す Shapeの値を構築してください。

  2. (やや難しい)引数の Shapeを原点を中心として 2.0倍に拡大する、 Shapeから Shapeへの関数を書いてみましょう。

  3. (やや難しい) Shapeからテキストを抽出する関数を書いてください。この関数は Maybe Stringを返さなければならず、もし入力が Textを使用して構築されたのでなければ、返り値には Nothing構築子を使ってください。

5.15 newtype宣言

代数的データ型の特別な場合に、newtypeと呼ばれる重要なものあります。newtypeは予約語 dataの代わりに予約語 newtypeを使用して導入します。

newtype宣言では過不足なくひとつだけの構築子を定義しなければならず、その構築子は過不足なくひとつだけの引数を取る必要があります。つまり、newtype宣言は既存の型に新しい名前を与えるものなのです。実際、newtypeの値は、元の型と同じ実行時表現を持っています。しかし、これらは型システムの観点から区別されます。これは型安全性の追加の層を提供するのです。

例として、ピクセルとインチのような単位を表現するために、 Numberの型レベルの別名を定義したくなる場合があるかもしれません。

newtype Pixels = Pixels Number
newtype Inches = Inches Number

こうすると Inchesを期待している関数に Pixels型の値を渡すことは不可能になりますが、実行時の効率に余計な負荷が加わることはありません。

newtypeは次の章で型クラスを扱う際に重要になります。newtypeは実行時の表現を変更することなく型に異なる振る舞いを与えることを可能にするからです。

5.16 ベクターグラフィックスライブラリ

これまで定義してきたデータ型を使って、ベクターグラフィックスを扱う簡単なライブラリを作成していきましょう。

ただの Shapeの配列であるような、 Pictureという型同義語を定義しておきます。

type Picture = Array Shape

デバッグしていると PictureStringとして表示できるようにしたくなることもあるでしょう。これはパターン照合を使用して定義された showPicture関数で行うことができます。

showPicture :: Picture -> Array String
showPicture = map showShape

それを試してみましょう。 モジュールを pulp buildでコンパイルし、 pulp replでPSCiを開きます。

$ pulp build
$ pulp repl

> import Data.Picture

> :paste
… showPicture
…   [ Line (Point { x: 0.0, y: 0.0 })
…          (Point { x: 1.0, y: 1.0 })
…   ]
… ^D

["Line [start: (0.0, 0.0), end: (1.0, 1.0)]"]

5.17 外接矩形の算出

このモジュールのコード例には、 Pictureの最小外接矩形を計算する関数 boundsが含まれています。

Boundsは外接矩形を定義するデータ型です。また、構築子をひとつだけ持つ代数的データ型として定義されています。

data Bounds = Bounds
  { top    :: Number
  , left   :: Number
  , bottom :: Number
  , right  :: Number
  }

Picture内の Shapeの配列を走査し、最小の外接矩形を累積するため、 boundsData.Foldablefoldl関数を使用しています。

bounds :: Picture -> Bounds
bounds = foldl combine emptyBounds
  where
    combine :: Bounds -> Shape -> Bounds
    combine b shape = union (shapeBounds shape) b

畳み込みの初期値として空の Pictureの最小外接矩形を求める必要がありますが、 emptyBoundsで定義される空の外接矩形がその条件を満たしています。

累積関数 combinewhereブロックで定義されています。 combinefoldlの再帰呼び出しで計算された外接矩形と、配列内の次の Shapeを引数にとり、ユーザ定義の演算子 unionを使ってふたつの外接矩形の和を計算しています。 shapeBounds関数は、パターン照合を使用して、単一の図形の外接矩形を計算します。

演習

  1. (やや難しい) ベクターグラフィックライブラリを拡張し、 Shapeの面積を計算する新しい操作 areaを追加してください。この演習では、テキストの面積は0であるものとしてください。

  2. (難しい) Shapeを拡張し、新しいデータ構築子 Clippedを追加してください。 Clippedは他の Pictureを矩形に切り抜き出ます。切り抜かれた Pictureの境界を計算できるよう、 shapeBounds関数を拡張してください。これは Shapeを再帰的なデータ型にすることに注意してください。

まとめ

この章では、関数型プログラミングから基本だが強力なテクニックであるパターン照合を扱いました。複雑なデータ構造の部分と照合するために、簡単なパターンだけでなく配列パターンやレコードパターンをどのように使用するかを見てきました。

またこの章では、パターン照合に密接に関連する代数的データ型を導入しました。代数的データ型がデータ構造のわかりやすい記述をどのように可能にするか、新たな操作でデータ型を拡張するためのモジュール性のある方法を提供することを見てきました。

最後に、多くの既存のJavaScript関数に型を与えるために、強力な抽象化である行多相を扱いました。この本の後半ではこれらの概念を再び扱います。

本書では今後も代数的データ型とパターン照合を使用するので、今のうちにこれらに習熟しておくと後で役立つでしょう。これ以外にも独自の代数的データ型を作成し、パターン照合を使用してそれらを使う関数を書くことを試してみてください。

第6章 型クラス

6.1 章の目標

この章では、PureScriptの型システムによって可能になる強力な抽象化の手法である、型クラスを導入します。

この章ではデータ構造をハッシュするためのライブラリを題材に説明していきます。データ自身の構造について直接考えることなく複雑な構造のデータのハッシュ値を求めるために、型クラスの仕組みがどのようにして働くのかを見ていきます。

また、PureScriptのPreludeや標準ライブラリに含まれる、標準的な型クラスも見ていきます。PureScriptのコードは概念を簡潔に表現するために型クラスの強力さに大きく依存しているので、これらのクラスに慣れておくと役に立つでしょう。

6.2 プロジェクトの準備

この章のソースコードは、ファイル src/data/Hashable.pursで定義されています。

このプロジェクトには以下のBower依存関係があります。

モジュール Data.Hashableでは、これらのBowerパッケージによって提供されるモジュールのいくつかをインポートしています。

module Data.Hashable where

import Data.Maybe
import Data.Tuple
import Data.Either
import Data.String
import Data.Function

6.3 見せてください!(Show Me!)

型クラスの最初に扱う例は、すでに何回か見たことがある関数と関係しています。 showは、何らかの値を取り、それを文字列として表示する関数です。

showPreludeモジュールの Showと呼ばれる型クラスで次のように定義されています。

class Show a where
  show :: a -> String

このコードでは、型変数 aでパラメータ化された、 Showという新しい型クラス(type class)を宣言しています。

型クラスインスタンスには、型クラスで定義された関数の、その型に特殊化された実装が含まれています。

例えば、Preludeにある Boolean値に対する Show型クラスインスタンスの定義は次のとおりです。

instance showBoolean :: Show Boolean where
  show true = "true"
  show false = "false"

このコードは showBool​​eanという名前の型クラスのインスタンスを宣言します。

PureScriptでは、生成されたJavaScriptの可読性を良くするために、型クラスインスタンスに名前をつけます。このとき、Boolean型は Show型クラスに属しているといいます。

PSCiで、いろいろな型の値をShow型クラスを利用して表示してみましょう。

> import Prelude
> show true
"true"

> show 1.0
"1.0"

> show "Hello World"
"\"Hello World\""

この例ではさまざまなプリミティブ型の値を showしましたが、もっと複雑な型を持つ値を showすることもできます。

> import Data.Tuple

> show (Tuple 1 true)
"(Tuple 1 true)"

> import Data.Maybe

> show (Just "testing")
"(Just \"testing\")"

Data.Eitherの値を表示しようとすると、興味深いエラーメッセージが表示されます。

> import Data.Either
> show (Left 10)

The inferred type

    forall a. Show a => String

has type variables which are not mentioned in the body of the type.
Consider adding a type annotation.

ここでの問題は showしようとしている型に対する Showインスタンスが存在しないということではなく、 PSCiがこの型を推論できなかったということです。このエラーメッセージで未知の型aと表示されているのがそれです。

::演算子を使って式に対して型注釈を加えると、 PSCiが正しい型クラスインスタンスを選ぶことができるようになります。

> show (Left 10 :: Either Int String)
"(Left 10)"

Showインスタンスをまったく持っていない型もあります。関数の型 ->がその一例です。 Intから Intへの関数を showしようとすると、型検証器によってその通りのエラーメッセージが表示されます。

> import Prelude
> show $ \n -> n + 1

No type class instance was found for

  Data.Show.Show (Int -> Int)

演習

  1. (簡単)前章の showShape関数を使って、 Shape型に対しての Showインスタンスを定義してみましょう。

6.4 標準的な型クラス

この節では、Preludeや標準ライブラリで定義されている標準的な型クラスをいくつか見ていきましょう。これらの型クラスはPureScript特有の抽象化の基礎としてあちこちで使われているので、これらの関数の基本についてよく理解しておくことを強くお勧めします。

Eq型クラス

Eq型クラスは、2つの値が等しいかどうかを調べるeq関数を定義しています。等値演算子(==)はeqの別名にすぎません。

class Eq a where
  eq :: a -> a -> Boolean

異なる型の2つの値を比較しても意味がありませんから、いずれの演算子も2つの引数が同じ型を持つ必要があることに注意してください。

PSCiEq型クラスを試してみましょう。

> 1 == 2
false

> "Test" == "Test"
true

Ord型クラス

Ord型クラスは順序付け可能な型に対して2つの値を比較する compare関数を定義します。 compare関数が定義されていると、比較演算子 <>と、その仲間 <=>=も定義されます。

data Ordering = LT | EQ | GT

class Eq a <= Ord a where
  compare :: a -> a -> Ordering

compare関数は2つの値を比較して Orderingの3つの値のうちいずれかを返します。

compare関数についても PSCiで試してみましょう。

> compare 1 2
LT

> compare "A" "Z"
LT

Num型クラス

Field型クラスは加算、減算、乗算、除算などの数値演算子を使用可能な型を示します。必要に応じて再利用できるように、これらの演算子を抽象化するわけです。

注意: 関数呼び出しが型クラスの実装に基いて呼び出されるのとは対照的に、型クラス EqOrdのクラスと同様に、 Field型のクラスはPureScriptでは特別に扱われ、 1 + 2 * 3のような単純な式は単純なJavaScriptへと変換されます。

class EuclideanRing a <= Field a

Field型クラスは、いくつかのより抽象的な上位クラス(Super Class)が組み合わさってできています。これは、その型はField型クラスの操作をすべてを提供しているわけではないが、その一部を提供する、というように抽象的に説明することができます。この型クラスは抽象的なすべてではないいくつかの数値演算子をサポートしています。例えば、自然数の型は加算および乗算については閉じていますが、減算については閉じていないため、この型はSemiringクラス(これはNumの上位クラスです)のインスタンスですが、RingFieldのインスタンスではありません。

上位クラスについては、この章の後半で詳しく説明します。しかし、すべての数値型クラスの階層について述べるのはこの章の目的から外れているため、この内容に興味のある読者はpurescript-prelude内の Fieldに関するドキュメントを参照してください。

半群とモノイド

Semigroup(半群)型クラスは、連結演算子 appendを提供する型を示します。

class Semigroup a where
  append :: a -> a -> a

普通の文字列連結について文字列は半群をなし、同様に配列も半群をなします。その他の標準的なインスタンスの幾つかは、 purescript-monoidパッケージで提供されています。

以前に見た <>連結演算子は、 appendの別名として提供されています。

purescript-monoidパッケージで提供されている Monoid型クラスは、 memptyと呼ばれる空の値の概念で Semigroup型クラスを拡張します。

class Semigroup m <= Monoid m where
  mempty :: m

文字列や配列はモノイドの簡単な例になっています。

Monoid型クラスインスタンスでは、「空」の値から始めて新たな値を合成していき、その型で累積した結果を返すにはどうするかを記述する型クラスです。例えば、畳み込みを使っていくつかのモノイドの値の配列を連結する関数を書くことができます。 PSCiで試すと次のようになります。

> import Data.Monoid
> import Data.Foldable

> foldl append mempty ["Hello", " ", "World"]  
"Hello World"

> foldl append mempty [[1, 2, 3], [4, 5], [6]]
[1,2,3,4,5,6]

purescript-monoidパッケージにはモノイドと半群の多くの例を提供しており、これらを本書で扱っていきます。

Foldable型クラス

Monoid型クラスは畳み込みの結果になるような型を示しますが、 Foldable型クラスは、畳み込みの元のデータとして使えるような型構築子を示しています。

また、 Foldable型クラスは、配列や Maybeなどのいくつかの標準的なコンテナのインスタンスを含む purescript-foldable-traversableパッケージで提供されています。

Foldableクラスに属する関数の型シグネチャは、これまで見てきたものよりも少し複雑です。

class Foldable f where
  foldr :: forall a b. (a -> b -> b) -> b -> f a -> b
  foldl :: forall a b. (b -> a -> b) -> b -> f a -> b
  foldMap :: forall a m. Monoid m => (a -> m) -> f a -> m

この定義は fを配列の型構築子だと特殊化して考えてみるとわかりやすくなります。この場合、すべての aについて f aArray aに置き換える事ができますが、 foldlfoldrの型が、最初に見た配列に対する畳み込みの型になるとわかります。

foldMapについてはどうでしょうか?これは forall a m. Monoid m => (a -> m) -> Array a -> mになります。この型シグネチャは、型 mMonoid型クラスのインスタンスであればどんな型でも返り値の型として選ぶことができると言っています。配列の要素をそのモノイドの値へと変換する関数を提供すれば、そのモノイドの構造を利用して配列を畳み込み、ひとつの値にして返すことができます。

それでは PSCifoldMapを試してみましょう。

> import Data.Foldable

> foldMap show [1, 2, 3, 4, 5]
"12345"

ここではモノイドとして文字列を選び、 Intを文字列として表示する show関数を使いました。それから、数の配列を渡し、それぞれの数を showしてひとつの文字列へと連結した結果出力されました。

畳み込み可能な型は配列だけではありません。 purescript-foldable-traversableでは MaybeTupleのような型の Foldableインスタンスが定義されており、 purescript-listsのような他のライブラリでは、そのライブラリのそれぞれのデータ型に対して Foldableインスタンスが定義されています。 Foldable順序付きコンテナ(ordered container)の概念を抽象化するのです。

関手と型クラス則

PureScriptで副作用を伴う関数型プログラミングのスタイルを可能にするための FunctorApplicativeMonadといった型クラスがPreludeでは定義されています。これらの抽象については本書で後ほど扱いますが、まずは「持ち上げ演算子」 mapの形ですでに見てきた Functor型クラスの定義を見てみましょう。

class Functor f where
  map :: forall a b. (a -> b) -> f a -> f b

演算子 map関数(別名<$>)は関数をそのデータ構造まで「持ち上げる」(lift)ことができます。ここで「持ち上げ」という言葉の具体的な定義は問題のデータ構造に依りますが、すでにいくつかの単純な型についてその動作を見てきました。

> import Prelude

> map (\n -> n < 3) [1, 2, 3, 4, 5]
[true, true, false, false, false]

> import Data.Maybe
> import Data.String (length)

> map length (Just "testing")
(Just 7)

map演算子は様々な構造の上でそれぞれ異なる振る舞いをしますが、 map演算子の意味はどのように理解すればいいのでしょうか。

直感的には、 map演算子はコンテナのそれぞれの要素へ関数を適用し、その結果から元のデータと同じ形状を持った新しいコンテナを構築するのだというように理解することができます。しかし、この概念を厳密にするにはどうしたらいいでしょうか?

Functorの型クラスのインスタンスは、関手則(functor laws)と呼ばれる法則を順守するものと期待されています。

最初の法則は恒等射律(identity law)です。これは、恒等関数をその構造まで持ち上げると、元の構造をそのまま返す恒等射になるということと言っています。恒等関数は入力を変更しませんから、これは理にかなっています。

第二の法則は合成律(composition law)です。構造をひとつの関数で写してから2つめの関数で写すのは、2つの関数の合成で構造を写すのと同じだ、と言っています。

「持ち上げ」の一般的な意味が何であれ、データ構造に対する持ち上げ関数の正しい定義はこれらの法則に従っていなければなりません。

標準の型クラスの多くには、このような法則が付随しています。一般に、型クラスに与えられた法則は、型クラスの関数に構造を与え、インスタンスについて調べられるようにします。興味のある読者は、すでに見てきた標準の型クラスに属する法則について調べてみてもよいでしょう。

演習

  1. (簡単)次のnewtypeは複素数を表します。

    newtype Complex = Complex 
        { real :: Number
        , imaginary :: Number 
        }
    

    Complexについて、 ShowEqのインスタンスを定義してください。

6.5 型注釈

型クラスを使うと、関数の型に制約を加えることができます。例を示しましょう。 Eq型クラスのインスタンスで定義された等値性を使って、3つの値が等しいかどうかを調べる関数を書きたいとします。

threeAreEqual :: forall a. Eq a => a -> a -> a -> Boolean
threeAreEqual a1 a2 a3 = a1 == a2 && a2 == a3

この型宣言は forallを使って定義された通常の多相型のようにも見えます。しかし、太い矢印 =>で型の残りの部分から区切られた、型クラス制約(type class constraint)Eq aがあります。

インポートされたモジュールのどれかに aに対する Eqインスタンスが存在するなら、どんな型 aを選んでも threeAsEqualを呼び出すことができる、とこの型は言っています。

制約された型には複数の型クラスインスタンスを含めることができますし、インスタンスの型は単純な型変数に限定されません。 OrdShowのインスタンスを使って2つの値を比較する例を次に示します。

showCompare :: forall a. Ord a => Show a => a -> a -> String
showCompare a1 a2 | a1 < a2 =
  show a1 <> " is less than " <> show a2
showCompare a1 a2 | a1 > a2 =
  show a1 <> " is greater than " <> show a2
showCompare a1 a2 =
  show a1 <> " is equal to " <> show a2

=>シンボルを複数回使って複数の制約を指定できることに注意してください。複数の引数のカリー化された関数を定義するのと同様です。しかし、2つの記号を混同しないように注意してください。

PureScriptコンパイラは、型の注釈が提供されていない場合、制約付き型を推測しようとします。これは、関数に対して可能な最も一般的な型を使用したい場合に便利です。

PSCiSemiringのような標準の型クラスのいずれかを使って、このことを試してみましょう。

> import Prelude

> :type \x -> x + x
forall a. Semiring a => a -> a

ここで、この関数にはInt -> IntまたはNumber -> Numberと注釈を付けることが考えられますが、最も一般的な型がSemiringで動作するため、PSCiではIntNumberの両方で関数を実行させることができます。

6.6 インスタンスの重複

PureScriptには型クラスのインスタンスに関する重複インスタンス規則(Overlapping instances rule)という規則があります。型クラスのインスタンスが関数呼び出しのところで必要とされるときはいつでも、PureScriptは正しいインスタンスを選択するために型検証器によって推論された情報を使用します。そのとき、その型の適切なインスタンスがちょうどひとつだけ存在しなければなりません。

これを実証するために、適当な型に対して2つの異なる型クラスのインスタンスを作成してみましょう。次のコードでは、型 Tの2つの重複する Showインスタンスを作成しています。

module Overlapped where
import Prelude
data T = T

instance showT1 :: Show T where
  show _ = "Instance 1"
  
instance showT2 :: Show T where
  show _ = "Instance 2"

このモジュールはエラーなくコンパイルされます。 PSCiを起動し、型 TShowインスタンスを見つけようとすると、重複インスタンス規則が適用され、エラーになります。

Overlapping instances found for Prelude.Show T

重複インスタンスルールが適用されるのは、型クラスのインスタンスの自動選択が予測可能な処理であるようにするためです。もし型に対してふたつの型クラスインスタンスを許し、モジュールインポートの順序に従ってどちらかを選ぶようにすると、実行時のプログラムの振る舞いが予測できなくなってしまい好ましくありません。

適切な法則を満たすふたつ妥当な型クラスインスタンスが存在しうるなら、既存の型を包むnewtypeを定義するのが一般的な方法です。重複インスタンスのルールの下でも、異なるnewtypeなら異なる型クラスインスタンスを持つことが許されるので、問題はなくなります。この手法はPureScriptの標準ライブラリでも使われており、例えば purescript-monoidでは、 Maybe a型は Monoid型クラスの妥当なインスタンスを複数持っています。

6.7 インスタンスの依存関係

制約された型を使うと関数の実装が型クラスインスタンスに依存できるように、型クラスインスタンスの実装は他の型クラスインスタンスに依存することができます。これにより、型を使ってプログラムの実装を推論するという、プログラム推論の強力な形式を提供します。

Show型クラスを例に考えてみましょう。要素を showする方法があるとき、その要素の配列を showする型クラスインスタンスを書くことができます。

instance showArray :: Show a => Show (Array a) where
  ...

型クラスインスタンスが複数の他のインスタンスに依存する場合、括弧で囲んでそれらのインスタンスをコンマで区切り、それを=>シンボルの左側に置く必要があります。

instance showEither :: (Show a, Show b) => Show (Either a b) where
  ...

これらの2つの型クラスインスタンスは purescript-preludeライブラリにあります。

プログラムがコンパイルされると、 Showの正しい型クラスのインスタンスは showの引数の推論された型に基づいて選ばれますが、このあたりの複雑さに開発者が関与することはありません。

演習

  1. (簡単)次は型 aの要素の空でない配列の型を定義しています。

    data NonEmpty a = NonEmpty a (Array a)
    
`Eq a`と `Eq (Array a)`のインスタンスを再利用して、型 `NonEmpty a`に対する `Eq`インスタンスを書いてみましょう。    
  1. (やや難しい)Semigroupインスタンスを Arrayに再利用して NonEmpty aSemigroupインスタンスを作成しましょう。
  1. (やや難しい)NonEmptyFunctorインスタンスを書いてみましょう。
  1. (やや難しい)Ordのインスタンスを持つ型 aがあれば、他の値より大きい新しい 無限の値を追加することができます。
```haskell
data Extended a = Finite a | Infinite
```
`a`の `Ord`インスタンスを再利用して、 `Extended a`の `Ord`インスタンスを書いてみましょう。
  1. (難しい)NonEmptyFoldableインスタンスを書いてみましょう。ヒント:配列の Foldableインスタンスを再利用してみましょう。
  1. (難しい) 順序付きコンテナを定義する(そして Foldableのインスタンスを持っている)ような型構築子 fが与えられたとき、追加の要素を先頭に含めるような新たなコンテナ型を作ることができます。

    data OneMore f a = OneMore a (f a)
    

    このコンテナ OneMore fもまた順序を持っています。ここで、新しい要素は任意の fの要素よりも前にきます。この OneMore fFoldableインスタンスを書いてみましょう。

    instance foldableOneMore :: Foldable f => Foldable (OneMore f) where
    

6.8 多変数型クラス

型クラスは必ずしもひとつの型だけを型変数としてとるわけではありません。型変数がひとつだけなのが最も一般的ですが、実際には型クラスはゼロ個以上の型変数を持つことができます。

それでは2つの型引数を持つ型クラスの例を見てみましょう。

module Stream where

import Data.Array as Array
import Data.Maybe (Maybe)
import Data.String as String

class Stream stream element where
  uncons :: stream -> Maybe { head :: element, tail :: stream }

instance streamArray :: Stream (Array a) a where
  uncons = Array.uncons

instance streamString :: Stream String Char where
  uncons = String.uncons

この Streamモジュールでは、 uncons関数を使ってストリームの先頭から要素を取り出すことができる、要素のストリームのような型を示すクラス Streamが定義されています。

Stream型クラスは、ストリーム自身の型だけでなくその要素の型も型変数として持っていることに注意してください。これによって、ストリームの型が同じでも要素の型について異なる型クラスインスタンスを定義することができます。

このモジュールでは、 unconsがパターン照合で配列の先頭の要素を取り除くような配列のインスタンスと、文字列から最初の文字を取り除くような文字列のインスタンスという、2つの型クラスインスタンスが定義されています。

任意のストリーム上で動作する関数を記述することができます。例えば、ストリームの要素に基づいて Monoidに結果を累積する関数は次のようになります。

import Prelude
import Data.Maybe (Maybe(..))
import Data.Monoid (class Monoid, mempty)

foldStream :: forall l e m. Stream l e => Monoid m => (e -> m) -> l -> m
foldStream f list =
  case uncons list of
    Nothing -> mempty
    Just cons -> f cons.head <> foldStream f cons.tail

PSCiで使って、異なる Streamの型や異なる Monoidの型について foldStreamを呼び出してみましょう。

6.9 関数従属性

多変数型クラスは非常に便利ですが、混乱しやすい型や型推論の問題にもつながります。簡単な例として、上記の Streamクラスを使って genericTail関数をストリームに書くことを考えてみましょう。

genericTail xs = map _.tail (uncons xs)

これはやや複雑なエラーメッセージを出力します。

The inferred type

  forall stream a. Stream stream a => stream -> Maybe stream

has type variables which are not mentioned in the body of the type.
Consider adding a type annotation.

エラーは、 genericTail関数が Stream型クラスの定義で言及された element型を使用しないので、その型は未解決のままであることを指しています。

さらに、特定の型のストリームに genericTailを適用することができません。

> map _.tail (uncons "testing")

The inferred type

  forall a. Stream String a => Maybe String

has type variables which are not mentioned in the body of the type.
Consider adding a type annotation.

ここでは、コンパイラが streamStringインスタンスを選択することを期待しています。結局のところ、 StringCharのストリームであり、他の型のストリームであってはなりません。

コンパイラは自動的にその排除を行うことはできず、 streamStringインスタンスに引き渡すことはできません。しかし、型クラス定義にヒントを追加すると、コンパイラを助けることができます。

class Stream stream element | stream -> element where
  uncons :: stream -> Maybe { head :: element, tail :: stream }

ここで、 stream -> element関数従属性(functional dependency)と呼ばれます。関数従属性は、多変数型クラスの型引数間の関数関係を宣言します。この関数の依存関係は、ストリーム型から(一意の)要素型への関数があることをコンパイラに伝えるので、コンパイラがストリーム型を知っていれば要素型へ適用できます。

このヒントは、コンパイラが上記の genericTail関数の正しい型を推論するのに十分です。

> :type genericTail
forall stream element. Stream stream element => stream -> Maybe stream

> genericTail "testing"
(Just "esting")

多種の型のクラスを使用して特定のAPIを設計する場合、関数従属性は非常に有用です。

6.10 型変数のない型クラス

ゼロ個の型変数を持つ型クラスを定義することもできます!これらは関数に対するコンパイル時のアサーションに対応しており、型システム内のコードの大域的な性質を追跡することができます。

たとえば、型システムを使って部分関数の使用を追跡したいとしましょう。すでに Data.Array.Partialで定義されている headtailの部分関数を確認します。

head :: forall a. Partial => Array a -> a

tail :: forall a. Partial => Array a -> Array a

Partialモジュールの Partial型クラスのインスタンスを定義していないことに注意してください。こうすると目的を達成できます。このままの定義では head関数を使用しようとすると型エラーになるのです。

> head [1, 2, 3]

No type class instance was found for

  Prim.Partial

代わりに、これらの部分関数を利用するすべての関数で Partial制約を再発行する方法ができます。

secondElement :: forall a. Partial => Array a -> a
secondElement xs = head (tail xs)

前章で見た unsafePartial関数を使用し、部分関数を通常の関数(unsafely)として扱うことができます。 この関数は Partial.Unsafeモジュールで定義されています。

unsafePartial :: forall a. (Partial => a) -> a

Partial制約は関数の矢印の左側の括弧の中に現れますが、外側の forallでは現れません。 つまり、 unsafePartialは部分的な値から通常の値への関数です。

6.11 上位クラス

インスタンスを別のインスタンスに依存させることによって型クラスのインスタンス間の関係を表現することができるように、いわゆる上位クラス(superclass)を使って型クラス間の関係を表現することができます。

あるクラスのどんなインスタンスも、その他のあるクラスのインスタンスで必要とされているとき、前者の型クラスは後者の型クラスの上位クラスであるといい、クラス定義で逆向きの太い矢印(<=)を使い上位クラス関係を示します。

すでに上位クラスの関係の一例について見ています。 Eqクラスは Ordの上位クラスです。 Ordクラスのすべての型クラスインスタンスについて、その同じ型に対応する Eqインスタンスが存在しなければなりません。 compare関数が2つの値が比較できないと報告した時は、それらが実は同値であるかどうかを決定するために Eqクラスを使いたくなることが多いでしょうから、これは理にかなっています。

一般に、下位クラスの法則が上位クラスのメンバに言及しているとき、上位クラス関係を定義するのは理にかなっています。例えば、 OrdEqのインスタンスのどんな組についても、もしふたつの値が Eqインスタンスのもとで同値であるなら、 compare関数は EQを返すはずだとみなすのは妥当です。言い換えれば、 a == bならば compare a b == EQです。法則の階層上のこの関係は、 EqOrdの間の上位クラス関係を説明します。

この場合に上位クラス関係を定義する別の考え方としては、この2つのクラスの間には明らかに"is-a"の関係があることです。下位クラスのすべてのメンバは、上位クラスのメンバでもあるということです。

演習

  1. (やや難しい) 整数の空でない配列の最大値を求める部分関数を定義します。あなたの関数の型は Partial => Array Int - > Intでなければなりません。 unsafePartialを使ってPSCiであなたの関数をテストしてください。 ヒントData.Foldablemaximum関数を使います。
  1. (やや難しい) 次の Actionクラスは、ある型の動作(action)を定義する、多変数型クラスです。

    class Monoid m <= Action m a where
      act :: m -> a -> a
    

    actはモノイドがどうやって他の型の値を変更するのに使われるのかを説明する関数です。この動作が モノイドの連結演算子に従っていると期待しましょう。

    • act mempty a = a
    • act (m1 <> m2) a = act m1 (act m2 a)

    この動作は Monoidクラスによって定義された操作を順守します。

    たとえば、乗算を持つ自然数のモノイドを形成します。

    newtype Multiply = Multiply Int
    
    instance semigroupMultiply :: Semigroup Multiply where
      append (Multiply n) (Multiply m) = Multiply (n * m)
    
    instance monoidMultiply :: Monoid Multiply where
      mempty = Multiply 1
    

    このモノイドは、文字列の何度かの繰り返しとして文字列に対して動作します。このアクションを実装するインスタンスを作成します。

    instance repeatAction :: Action Multiply String
    

    このインスタンスが上記の法則を満たしているか確かめましょう。

  2. (やや難しい) インスタンス Action m a => Action m(Array a)を書いてみましょう。ここで、 配列上の動作は要素の順序で実行されるように定義されるものとします。

  3. (難しい) 以下のnewtypeが与えられたとき、 Action m (Self m)のインスタンスを書いてみましょう。ここで、モノイド mは連結によって自身に作用するものとします。

    newtype Self m = Self m
    

1.(難しい)多変数型のクラス Actionの引数は、いくつかの関数従属性によって関連づけられるべきですか。それはなぜでしょうか。

6.12 ハッシュの型クラス

この最後の節では、章の残りを費やしてデータ構造をハッシュするライブラリを作ります。

このライブラリの目的は説明だけであり、堅牢なハッシングの仕組みの提供を目的としていないことに注意してください。

ハッシュ関数に期待される性質とはどのようなものでしょうか?

最初の性質はまさに型クラスの法則のように見える一方で、2番目の性質はもっとぼんやりとした規約に従っていて、PureScriptの型システムによって確実に強制できるようなものではなさそうです。しかし、これは型クラスについて次のような直感的理解を与えるはずです。

newtype HashCode = HashCode Int

hashCode :: Int -> HashCode
hashCode h = HashCode (h `mod` 65535)

class Eq a <= Hashable a where
  hash :: a -> HashCode

これに、 a == bならば hash a == hash bという関係性の法則が付随しています。

この節の残りの部分を費やして、 Hashable型クラスに関連付けられているインスタンスと関数のライブラリを構築していきます。

決定的な方法でハッシュ値を結合する方法が必要になります。

combineHashes :: HashCode -> HashCode -> HashCode
combineHashes (HashCode h1) (HashCode h2) = hashCode (73 * h1 + 51 * h2)

combineHashes関数は、2つのハッシュ値を混ぜて結果を0-65535の間に分布します。

それでは、入力の種類を制限する Hashable制約を使う関数を書いてみましょう。ハッシュ関数を必要とするよくある目的としては、2つの値が同じハッシュ値にハッシュされるかどうかを決定することです。 hashEqual関係はそのような機能を提供します。

hashEqual :: forall a. Hashable a => a -> a -> Boolean
hashEqual = eq `on` hash

この関数はハッシュ同値性を定義するために Data.Functionon関数を使っていますが、このハッシュ同値性の定義は『それぞれの値が hash関数に渡されたあとで2つの値が等しいなら、それらの値は「ハッシュ同値」である』というように宣言的に読めるはずです。

プリミティブ型の Hashableインスタンスをいくつか書いてみましょう。まずは整数のインスタンスです。 HashCodeは実際には単なるラップされた整数なので、これは簡単です。hashCodeヘルパー関数を使うことができます。

instance hashInt :: Hashable Int where
  hash = hashCode

パターン照合を使うと、Boolean値の単純なインスタンスを定義することもできます。

instance hashBoolean :: Hashable Boolean where
  hash false = hashCode 0
  hash true  = hashCode 1

整数のインスタンスでは、 Data.ChartoCharCode関数を使うとCharをハッシュするインスタンスを作成できます。

instance hashChar :: Hashable Char where
  hash = hash <<< toCharCode

(要素型が Hashableのインスタンスでもあるならば)配列の要素に hash関数を mapしてから、 combineHashes関数の結果を使ってハッシュを左側に畳み込むことで、配列のインスタンスを定義します。

instance hashArray :: Hashable a => Hashable (Array a) where
  hash = foldl combineHashes (hashCode 0) <<< map hash

すでに書いたより単純なインスタンスを使用して新たなインスタンスを構築する方法に注目してください。 StringCharの配列に変換し、この新たなArrayインスタンスを使ってStringインスタンスを定義しましょう。

instance hashString :: Hashable String where
  hash = hash <<< toCharArray

これらの Hashableインスタンスが先ほどの型クラスの法則を満たしていることを証明するにはどうしたらいいでしょうか。同じ値が等しいハッシュ値を持っていることを確認する必要があります。 IntCharStringBooleanの場合は、 Eqの意味では同じ値でも厳密には同じではない、というような型の値は存在しないので簡単です。

もっと面白い型についてはどうでしょうか。この場合、配列の長さに関する帰納を使うと、型クラスの法則を証明することができます。長さゼロの唯一の配列は []です。配列の Eqの定義により、任意の二つの空でない配列は、それらの先頭の要素が同じで配列の残りの部分が等しいとき、その時に限り等しくなります。この帰納的な仮定により、配列の残りの部分は同じハッシュ値を持ちますし、もし Hashable aインスタンスがこの法則を満たすなら、先頭の要素も同じハッシュ値をもつことがわかります。したがって、2つの配列は同じハッシュ値を持ち、 Hashable(Array a)も同様に型クラス法則を満たしています。

この章のソースコードには、 MaybeTuple型のインスタンスなど、他にも Hashableインスタンスの例が含まれています。

演習

  1. (簡単)PSCiを使って、各インスタンスのハッシュ関数をテストしてください。

  2. (やや難しい) 同値性の近似として hashEqual関数のハッシュ同値性を使い、配列が重複する要素を持っているかどうかを調べる関数を書いてください。ハッシュ値が一致したペアが見つかった場合は、 ==を使って値の同値性を厳密に検証することを忘れないようにしてください。 ヒントData.ArraynubBy関数を使用してみてください。

  3. (やや難しい) 型クラスの法則を満たす、次のnewtypeの Hashableインスタンスを書いてください。

    newtype Hour = Hour Int
    
    instance eqHour :: Eq Hour where
      eq (Hour n) (Hour m) = mod n 12 == mod m 12
    

    newtypeの Hourとその Eqインスタンスは、12進数である型を表します。したがって、1と13は等しいと見なされます。そのインスタンスが型クラスの法則を満たしていることを証明してください。

  4. (難しい)MaybeEitherTupleHashableインスタンスが型クラスの法則を満たしていることを証明してください。

まとめ

この章では、型に基づく抽象化で、コードの再利用のための強力な形式化を可能にする型クラスを導入しました。PureScriptの標準ライブラリから標準の型クラスを幾つか見てきました。また、ハッシュ値を計算する型クラスに基づく独自のライブラリを定義しました。

この章では型クラス法則の考え方を導入するとともに、抽象化のための型クラスを使うコードについて、その性質を証明する手法を導入しました。型クラス法則は等式推論(equational reasoning)と呼ばれる大きな分野の一部であり、プログラミング言語の性質と型システムはプログラムについて論理的な推論をできるようにするために使われています。これは重要な考え方で、本書では今後あらゆる箇所で立ち返る話題となるでしょう。

第7章 Applicativeによる検証

7.1 この章の目標

この章では、Applicative型クラスによって表現されるApplicative関手(applicative functor)という重要な抽象化と新たに出会うことになります。名前が難しそうに思えても心配しないでください。フォームデータの検証という実用的な例を使ってこの概念を説明していきます。Applicative関手を使うと、大量の決まり文句を伴うような入力項目の内容を検証するためのコードを、簡潔で宣言的な記述へと変えることができるようになります。

また、Traversable関手(traversable functor)を表現するTraversableという別の型クラスにも出会います。現実の問題への解決策からこの概念が自然に生じるということがわかるでしょう。

この章では第3章に引き続き住所録を例として扱います。今回は住所録のデータ型を拡張し、これらの型の値を検証する関数を書きます。これらの関数は、例えばデータ入力フォームの一部で、使用者へエラーを表示するウェブユーザインタフェースで使われると考えてください。

7.2 プロジェクトの準備

この章のソース·コードは、次のふたつのファイルで定義されています。

このプロジェクトは多くのBower依存関係を持っていますが、その大半はすでに見てきたものです。新しい依存関係は2つです。

Data.AddressBookモジュールには、このプロジェクトのデータ型とそれらの型に対するShowインスタンスが定義されており、Data.AddressBook.Validationモジュールにはそれらの型の検証規則含まれています。

7.3 関数適用の一般化

Applicative関手の概念を理解するために、まずは以前扱った型構築子Maybeについて考えてみましょう。

このモジュールのソースコードでは、次のような型を持つaddress関数が定義されています。

address :: String -> String -> String -> Address

この関数は、通りの名前、市、州という3つの文字列から型Addressの値を構築するために使います。

この関数は簡単に適用できますので、PSCiでどうなるか見てみましょう。

> import Data.AddressBook

> address "123 Fake St." "Faketown" "CA"
Address { street: "123 Fake St.", city: "Faketown", state: "CA" }

しかし、通り、市、州の三つすべてが必ずしも入力されないものとすると、三つの場合がそれぞれ省略可能であることを示すためにMaybe型を使用したくなります。

考えられる場合としては、市が省略されている場合があるでしょう。もしaddress関数を直接適用しようとすると、型検証器からエラーが表示されます。

> import Data.Maybe
> address (Just "123 Fake St.") Nothing (Just "CA")

Could not match type Maybe String with type String

addressMaybe String型ではなく文字列型の引数を取るので、もちろんこれは型エラーになります。

しかし、もしaddress関数を「持ち上げる」ことができれば、Maybe型で示される省略可能な値を扱うことができるはずだと期待することは理にかなっています。実際に、Control.Applyで提供されている関数lift3が、まさに求めているものです。

> import Control.Apply
> lift3 address (Just "123 Fake St.") Nothing (Just "CA")

Nothing

このとき、引数のひとつ(市)が欠落していたので、結果はNothingになります。もし3つの引数すべてがJust構築子を使って与えられれば、結果は値を含むことになります。

> lift3 address (Just "123 Fake St.") (Just "Faketown") (Just "CA")
  
Just (Address { street: "123 Fake St.", city: "Faketown", state: "CA" })

lift3という関数の名前は、3引数の関数を持ち上げるために使用できることを示しています。関数を持ち上げる同様の関数で、引数の数が異なるものが、Control.Applyで定義されています。

7.4 任意個の引数を持つ関数の持ち上げ

これで、lift2lift3のような関数を使えば、引数が2個や3個の関数を持ち上げることができるのはわかりました。でも、これを任意個の引数の関数へと一般化することはできるのでしょうか。

lift3の型を見てみるとわかりやすいでしょう。

> :type lift3
forall a b c d f. Apply f => (a -> b -> c -> d) -> f a -> f b -> f c -> f d

上のMaybeの例では型構築子fMaybeですから、lift3は次のように特殊化されます。

forall a b c d. (a -> b -> c -> d) -> Maybe a -> Maybe b -> Maybe c -> Maybe d

この型が言っているのは、3引数の任意の関数を取り、その関数を引数と返り値がMaybeで包まれた新しい関数へと持ち上げる、ということです。

もちろんどんな型構築子fについても持ち上げができるわけではないのですが、それではMaybe型を持ち上げができるようにしているものは何なのでしょうか。さて、先ほどの型の特殊化では、fに対する型クラス制約からApply型クラスを取り除いていました。ApplyはPreludeで次のように定義されています。

class Functor f where
  map :: forall a b. (a -> b) -> f a -> f b
class Functor f <= Apply f where
  apply :: forall a b. f (a -> b) -> f a -> f b

Apply型クラスはFunctorの下位クラスであり、追加の関数applyが定義しています。Preludeモジュールでは<$>を、mapの別名として、<*>applyの別名として定義しています。mapとよく似た型を持つ追加の関数applyが定義されています。mapapplyの違いは、mapがただの関数を引数に取るのに対し、applyの最初の引数は型構築子fで包まれているという点です。これをどのように使うのかはこれからすぐに見ていきますが、その前にまずMaybe型についてApply型クラスをどう実装するのかを見ていきましょう。

instance functorMaybe :: Functor Maybe where
  map f (Just a) = Just (f a)
  map f Nothing  = Nothing

instance applyMaybe :: Apply Maybe where
  apply (Just f) (Just x) = Just (f x)
  apply _        _        = Nothing

この型クラスのインスタンスが言っているのは、任意のオプショナルな値にオプショナルな関数を適用することができ、その両方が定義されている時に限り結果も定義される、ということです。

それでは、mapapplyを一緒に使ってどうやって引数が任意個の関数を持ち上げるのかを見ていきましょう。

1引数の関数については、mapをそのまま使うだけです。

2引数の関数についても考えてみます。型a -> b -> cを持つカリー化された関数fがあるとしましょう。これは型a -> (b -> c)と同じですから、mapfに適用すると型f a -> f (b -> c)の新たな関数を得ることになります。持ち上げられた(型f aの)最初の引数にその関数を部分適用すると、型f (b -> c)の新たな包まれた関数が得られます。それから、2番目の持ち上げられた(型f bの)引数へapplyを適用することができ、型f cの最終的な値を得ます。

まとめると、x :: f ay :: f bがあるとき、式(f <$> x) <*> yの型はf cになります(この式はapply (map f x) yと同じ意味だということを思い出しましょう)。Preludeで定義された優先順位の規則に従うと、f <$> x <*> yというように括弧を外すことができます。

一般的にいえば、最初の引数に<$>を使い、残りの引数に対しては<*>を使います。lift3で説明すると次のようになります。

lift3 :: forall a b c d f
       . Apply f
      => (a -> b -> c -> d)
      -> f a
      -> f b
      -> f c
      -> f d
lift3 f x y z = f <$> x <*> y <*> z 

この式の型がちゃんと整合しているかの確認は、読者への演習として残しておきます。

例として、<$><*>をそのまま使うと、Maybe上にaddress関数を持ち上げることができます。

> address <$> Just "123 Fake St." <*> Just "Faketown" <*> Just "CA"
Just (Address { street: "123 Fake St.", city: "Faketown", state: "CA" })

> address <$> Just "123 Fake St." <*> Nothing <*> Just "CA"
Nothing

このように、引数が異なる他のいろいろな関数をMaybe上に持ち上げてみてください。

7.5 Applicative型クラス

これに関連するApplicativeという型クラスが存在しており、次のように定義されています。

class Apply f <= Applicative f where
  pure :: forall a. a -> f a

ApplicativeApplyの下位クラスであり、pure関数が定義されています。pureは値を取り、その型の型構築子fで包まれた値を返します。

MaybeについてのApplicativeインスタンスは次のようになります。

instance applicativeMaybe :: Applicative Maybe where
  pure x = Just x

Applicative関手は関数を持ち上げることを可能にする関手だと考えるとすると、pureは引数のない関数の持ち上げだというように考えることができます。

7.6 Applicativeに対する直感的理解

PureScriptの関数は純粋であり、副作用は持っていません。Applicative関手は、関手fによって表現されたある種の副作用を提供するような、より大きな「プログラミング言語」を扱えるようにします。

たとえば、関手Maybeはオプショナルな値の副作用を表現しています。その他の例としては、型errのエラーの可能性の副作用を表すEither errや、大域的な構成を読み取る副作用を表すArrow関手(arrow functor)r ->があります。ここではMaybe関手についてだけを考えることにします。

もし関手fが作用を持つより大きなプログラミング言語を表すとすると、ApplyApplicativeインスタンスは小さなプログラミング言語(PureScript)から新しい大きな言語へと値や関数を持ち上げることを可能にします。

pureは純粋な(副作用がない)値をより大きな言語へと持ち上げますし、関数については上で述べたとおりmapapplyを使うことができます。

ここで新たな疑問が生まれます。もしPureScriptの関数と値を新たな言語へ埋め込むのにApplicativeが使えるなら、どうやって新たな言語は大きくなっているというのでしょうか。この答えは関手fに依存します。もしなんらかのxについてpure xで表せないような型f aの式を見つけたなら、その式はそのより大きな言語だけに存在する項を表しているということです。

fMaybeのときの式Nothingがその例になっています。Nothingを何らかのxについてpure xというように書くことはできません。したがって、PureScriptは省略可能な値を表す新しい項Nothingを含むように拡大されたと考えることができます。

7.7 その他の作用について

それでは、他にもApplicative関手へと関数を持ち上げる例をいろいろ見ていきましょう。

次は、PSCiで定義された3つの名前を結合して完全な名前を作る簡単なコード例です。

> import Prelude
> fullName first middle last = last <> ", " <> first <> " " <> middle
> fullName "Phillip" "A" "Freeman"
Freeman, Phillip A

この関数は、クエリパラメータとして与えられた3つの引数を持つ、(とても簡単な!)ウェブサービスの実装であるとしましょう。使用者が3つの引数すべてを与えたことを確かめたいので、引数が存在するかどうかを表すMaybe型をつかうことになるでしょう。fullNameMaybeの上へ持ち上げると、省略された引数を確認するウェブサービスを実装することができます。

> import Data.Maybe
> fullName <$> Just "Phillip" <*> Just "A" <*> Just "Freeman"
Just ("Freeman, Phillip A")
> fullName <$> Just "Phillip" <*> Nothing <*> Just "Freeman"
Nothing

この持ち上げた関数は、引数のいずれかがNothingならNothing返すことに注意してください。

これで、もし引数が不正ならWebサービスからエラー応答を送信することができるので、なかなかいい感じです。しかし、どのフィールドが間違っていたのかを応答で表示できると、もっと良くなるでしょう。

Meybe上へ持ち上げる代わりにEither String上へ持ち上げるようにすると、エラーメッセージを返すことができるようになります。まずは入力をEither Stringを使ってエラーを発信できる計算に変換する演算子を書きましょう。

> :paste
… withError Nothing err = Left err
… withError (Just a) _  = Right a
… ^D

注意Either errApplicative関手において、Left構築子は失敗を表しており、Right構築子は成功を表しています。

これでEither String上へ持ち上げることで、それぞれの引数について適切なエラーメッセージを提供できるようになります。

> :paste
… fullNameEither first middle last =
…   fullName <$> (first  `withError` "First name was missing")
…            <*> (middle `withError` "Middle name was missing")
…            <*> (last   `withError` "Last name was missing")
… ^D

> :type fullNameEither
Maybe String -> Maybe String -> Maybe String -> Either String String

この関数はMaybeの3つの省略可能な引数を取り、StringのエラーメッセージかStringの結果のどちらかを返します。

いろいろな入力でこの関数を試してみましょう。

> fullNameEither (Just "Phillip") (Just "A") (Just "Freeman")
(Right "Freeman, Phillip A")

> fullNameEither (Just "Phillip") Nothing (Just "Freeman")
(Left "Middle name was missing")

> fullNameEither (Just "Phillip") (Just "A") Nothing
(Left "Last name was missing")

このとき、すべてのフィールドが与えられば成功の結果が表示され、そうでなければ省略されたフィールドのうち最初のものに対応するエラーメッセージが表示されます。しかし、もし複数の入力が省略されているとき、最初のエラーしか見ることができません。

> fullNameEither Nothing Nothing Nothing

(Left "First name was missing")

これでも十分なときもありますが、エラー時にすべての省略されたフィールドの一覧がほしいときは、Either Stringよりも強力なものが必要です。この章の後半でこの解決策を見ていきます。

7.8 作用の結合

抽象的にApplicative関手を扱う例として、Applicative関手fによって表現された副作用を総称的に組み合わせる関数をどのように書くのかをこの節では示します。

これはどういう意味でしょうか?何らかのaについて型f aの包まれた引数の配列があるとしましょう。型List (f a)の配列があるということです。直感的には、これはfによって追跡される副作用を持つ、返り値の型がaの計算の配列を表しています。これらの計算のすべてを順番に実行することができれば、List a型の結果の配列を得るでしょう。しかし、まだfによって追跡される副作用が残ります。つまり、元の配列の中の作用を「結合する」ことにより、型List (f a)の何かを型List aの何かへと変換することができると考えられます。

任意の固定長配列の長さnについて、その引数を要素に持った長さnの配列を構築するようなn引数の関数が存在します。たとえば、もしn3なら、関数は\x y z -> x : y : z : Nilです。 この関数の型はa -> a -> a -> List aです。Applicativeインスタンスを使うと、この関数をfの上へ持ち上げて関数型f a -> f a -> f a -> f (List a)を得ることができます。しかし、いかなるnについてもこれが可能なので、いかなる引数の配列についても同じように持ち上げられることが確かめられます。

したがって、次のような関数を書くことができるはずです。

combineList :: forall f a. Applicative f => List (f a) -> f (List a)

この関数は副作用を持つかもしれない引数の配列をとり、それぞれの副作用を適用することで、fに包まれた単一の配列を返します。

この関数を書くためには、引数の配列の長さについて考えます。配列が空の場合はどんな作用も実行する必要はありませんから、pureを使用して単に空の配列を返すことができます。

combineList Nil = pure Nil

実際のところ、これが可能な唯一の​​定義です!

入力の配列が空でないならば、型f aの先頭要素と、型List (f a)の配列の残りについて考えます。また、再帰的に配列の残りを結合すると、型f (List a)の結果を得ることができます。<$><*>を使うと、cons関数を先頭と配列の残りの上に持ち上げることができます。

combineList (Cons x xs) = Cons <$> x <*> combineList xs

繰り返しになりますが、これは与えられた型に基づいている唯一の妥当な実装です。

Maybe型構築子を例にとって、PSCiでこの関数を試してみましょう。

> import Data.List
> import Data.Maybe
> combineList (fromFoldable [Just 1, Just 2, Just 3])
(Just (Cons 1 (Cons 2 (Cons 3 Nil))))
> combineList (fromFoldable [Just 1, Nothing, Just 2])
Nothing

Meybeへ特殊化して考えると、配列のすべての要素がJustであるとき、そのときに限りこの関数はJustを返します。そうでなければ、Nothingを返します。オプショナルな結果を返す計算の配列は、そのすべての計算が結果を持っていたときに全体も結果を持っているという、オプショナルな値に対応したより大きな言語での振る舞いに対する直感的な理解とこれは一致しています。

しかも、combineArray関数はどんなApplicativeに対しても機能します!Either errを使ってエラーを発信するかもしれなかったり、r ->を使って大域的な状態を読み取る計算を連鎖させるときにもcombineArray関数を使うことができるのです。

combineArray関数については、後ほどTraversable関手について考えるときに再び扱います。

演習

  1. (簡単)lift2を使って、オプショナルな引数に対して働く、数に対する演算子+-*/の持ち上げられたバージョンを書いてください。

  2. (やや難しい) 上で与えられたlift3の定義について、<$><*>の型が整合していることを確認して下さい。

  3. (難しい) 次の型を持つ関数combineMaybeを書いてください。

    combineMaybe : forall a f. (Applicative f) => Maybe (f a) -> f (Maybe a)
    

    この関数は副作用をもつオプショナルな計算をとり、オプショナルな結果をもつ副作用のある計算を返します。

7.9 Applicativeによる検証

この章のソースコードでは住所録アプリケーションで使われるいろいろなデータ型が定義されています。詳細はここでは割愛しますが、Data.AddressBookモジュールからエクスポートされる重要な関数は次のような型を持っています。

address :: String -> String -> String -> Address

phoneNumber :: PhoneType -> String -> PhoneNumber

person :: String -> String -> Address -> Array PhoneNumber -> Person

ここで、PhoneTypeは次のような代数的データ型として定義されています。

data PhoneType = HomePhone | WorkPhone | CellPhone | OtherPhone

これらの関数は住所録の項目を表すPersonを構築するのに使います。例えば、Data.AddressBookには次のような値が定義されています。

examplePerson :: Person
examplePerson =
  person "John" "Smith"
         (address "123 Fake St." "FakeTown" "CA")
                [ phoneNumber HomePhone "555-555-5555"
                , phoneNumber CellPhone "555-555-0000"
                ]

PSCiでこれらの値使ってみましょう(結果は整形されています)。

> import Data.AddressBook
> examplePerson
Person
  { firstName: "John",
  , lastName: "Smith",
  , address: Address
    { street: "123 Fake St."
    , city: "FakeTown"
    , state: "CA"
    },
  , phones: [ PhoneNumber
              { type: HomePhone
              , number: "555-555-5555"
              }
            , PhoneNumber
              { type: CellPhone
              , number: "555-555-0000"
              }
            ]
  }

前の章では型Personのデータ構造を検証するのにEither String関手をどのように使うかを見ました。例えば、データ構造の2つの名前を検証する関数が与えられたとき、データ構造全体を次のように検証することができます。

nonEmpty :: String -> Either String Unit
nonEmpty "" = Left "Field cannot be empty"
nonEmpty _ = Right unit

validatePerson :: Person -> Either String Person
validatePerson (Person o) =
  person <$> (nonEmpty o.firstName *> pure o.firstName)
         <*> (nonEmpty o.lastName *> pure o.lastName)
         <*> pure o.address
         <*> pure o.phones

最初の2行ではnonEmpty関数を使って空文字列でないことを検証しています。もし入力が空ならnonEMptyはエラーを返し(Left構築子で示されています)、そうでなければRight構築子を使って空の値(unit)を正常に返します。2つの検証を実行し、右辺の検証の結果を返すことを示す連鎖演算子*>を使っています。ここで、入力を変更せずに返す検証器として右辺では単にpureを使っています。

最後の2行では何の検証も実行せず、単にaddressフィールドとphonesフィールドを残りの引数としてperson関数へと提供しています。

この関数はPSCiでうまく動作するように見えますが、以前見たような制限があります。

> validatePerson $ person "" "" (address "" "" "") []
(Left "Field cannot be empty")

Either StringApplicative関手は遭遇した最初のエラーだけを返します。でもこの入力では、名前の不足と姓の不足という2つのエラーがわかるようにしたくなるでしょう。

purescript-validationライブラリは別のApplicative関手も提供されています。これは単にVと呼ばれていて、何らかの半群(Semigroup)でエラーを返す機能があります。たとえば、V (Array String)を使うと、新しいエラーを配列の最後に連結していき、Stringの配列をエラーとして返すことができます。

Data.ValidationモジュールはData.AddressBookモジュールのデータ構造を検証するためにV (Array String)Applicative関手を使っています。

Data.AddressBook.Validationモジュールにある検証の例としては次のようになります。

type Errors = Array String

nonEmpty :: String -> String -> V Errors Unit
nonEmpty field "" = invalid ["Field '" <> field <> "' cannot be empty"]
nonEmpty _     _  = pure unit

lengthIs :: String -> Number -> String -> V Errors Unit
lengthIs field len value | S.length value /= len =
  invalid ["Field '" <> field <> "' must have length " <> show len]
lengthIs _ _ _ =
  pure unit

validateAddress :: Address -> V Errors Address
validateAddress (Address o) =
  address <$> (nonEmpty "Street" o.street  *> pure o.street)
          <*> (nonEmpty "City"   o.city    *> pure o.city)
          <*> (lengthIs "State"  2 o.state *> pure o.state)

validateAddressAddressを検証します。streetcityが空でないかどうか、stateの文字列の長さが2であるかどうかを検証します。

nonEmptylengthIsの2つの検証関数はいずれも、Data.Validationモジュールで提供されているinvalid関数をエラーを示すために使っていることに注目してください。Array String半群を扱っているので、invalidは引数として文字列の配列を取ります。

PSCiでこの関数を使ってみましょう。

> import Data.AddressBook
> import Data.AddressBook.Validation

> validateAddress $ address "" "" ""
(Invalid [ "Field 'Street' cannot be empty"
         , "Field 'City' cannot be empty"
         , "Field 'State' must have length 2"
         ])

> validateAddress $ address "" "" "CA"
(Invalid [ "Field 'Street' cannot be empty"
         , "Field 'City' cannot be empty"
         ])

これで、すべての検証エラーの配列を受け取ることができるようになりました。

7.10 正規表現検証器

validatePhoneNumber関数では引数の形式を検証するために正規表現を使っています。重要なのはmatches検証関数で、この関数はData.String.Regexモジュールのて定義されているRegexを使って入力を検証しています。

matches :: String -> R.Regex -> String -> V Errors Unit
matches _ regex value | R.test regex value =
  pure unit
matches field _ _ =
  invalid ["Field '" <> field <> "' did not match the required format"]

繰り返しになりますが、pureは常に成功する検証を表しており、エラーの配列の伝達にはinvalidが使われています。

これまでと同じような感じで、validatePhoneNumbermatches関数から構築されています。

validatePhoneNumber :: PhoneNumber -> V Errors PhoneNumber
validatePhoneNumber (PhoneNumber o) =
  phoneNumber <$> pure o."type"
              <*> (matches "Number" phoneNumberRegex o.number *> pure o.number)

また、PSCiでいろいろな有効な入力や無効な入力に対して、この検証器を実行してみてください。

> validatePhoneNumber $ phoneNumber HomePhone "555-555-5555"
Valid (PhoneNumber { type: HomePhone, number: "555-555-5555" })

> validatePhoneNumber $ phoneNumber HomePhone "555.555.5555"
Invalid (["Field 'Number' did not match the required format"])

演習

  1. (簡単) 正規表現の検証器を使って、Address型のstateフィールドが2文字のアルファベットであることを確かめてください。ヒントphoneNumberRegexのソースコードを参照してみましょう。

  2. (やや難しい)matches検証器を使って、文字列に全く空白が含まれないことを検証する検証関数を​​書いてください。この関数を使って、適切な場合にnonEmptyを置き換えてください。

7.11 Traversable関手

残った検証器は、これまで見てきた検証器を組み合わせてPerson全体を検証するvalidatePersonです。

arrayNonEmpty :: forall a. String -> Array a -> V Errors Unit
arrayNonEmpty field [] =
  invalid ["Field '" <> field <> "' must contain at least one value"]
arrayNonEmpty _ _ =
  pure unit

validatePerson :: Person -> V Errors Person
validatePerson (Person o) =
  person <$> (nonEmpty "First Name" o.firstName *>
              pure o.firstName)
         <*> (nonEmpty "Last Name" o.lastName *>
              pure o.lastName)
               <*> validateAddress o.address
         <*> (arrayNonEmpty "Phone Numbers" o.phones *>
              traverse validatePhoneNumber o.phones)

ここに今まで見たことのない興味深い関数がひとつあります。最後の行で使われているtraverseです。

traverseData.TraversableモジュールのTraversable型クラスで定義されています。

class (Functor t, Foldable t) <= Traversable t where
  traverse :: forall a b f. Applicative f => (a -> f b) -> t a -> f (t b)
  sequence :: forall a f. Applicative f => t (f a) -> f (t a)

TraversableTraversable関手の型クラスを定義します。これらの関数の型は少し難しそうに見えるかもしれませんが、validatePersonは良いきっかけとなる例です。

すべてのTraversable関手はFunctorFoldableのどちらでもあります(Foldable 関手は構造をひとつの値へとまとめる、畳み込み操作を提供する型構築子であったことを思い出してください)。それ加えて、Traversable関手はその構造に依存した副作用のあつまりを連結する機能を提供します。

複雑そうに聞こえるかもしれませんが、配列の場合に特殊化して簡単に考えてみましょう。配列型構築子はTraversableである、つまり次のような関数が存在するということです。

traverse :: forall a b f. Applicative f => (a -> f b) -> Array a -> f (Array b)

直感的には、Applicative関手fと、型aの値をとり型bの値を返す(fで追跡される副作用を持つ)関数が与えられたとき、型[a]の配列の要素それぞれにこの関数を適用し、型[b]の(fで追跡される副作用を持つ)結果を得ることができます。

まだよくわからないでしょうか。それでは、更にfV ErrorsApplicative関手に特殊化して考えてみましょう。traversableが次のような型の関数だとしましょう。

traverse :: forall a b. (a -> V Errors b) -> Array a -> V Errors (Array b)

この型シグネチャは、型aについての検証関数fがあれば、traverse fは型Array aの配列についての検証関数であるということを言っています。これはまさに今必要になっているPersonデータ構造体のphonesフィールドを検証する検証器そのものです!それぞれの要素が成功するかどうかを検証する検証関数を作るために、validatePhoneNumbertraverseへ渡しています。

一般に、traverseはデータ構造の要素をひとつづつ辿っていき、副作用のある計算を実行して結果を累積します。

Traversableのもう一つの関数、sequenceの型シグネチャには見覚えがあるかもしれません。

sequence :: forall a f. (Applicative m) => t (f a) -> f (t a)

実際、先ほど書いたcombineArray関数はTraversable型のsequence関数が特殊化されたものに過ぎません。tを配列型構築子として、combineArray関数の型をもう一度考えてみましょう。

combineList :: forall f a. Applicative f => List (f a) -> f (List a)

Traversable関手は、作用のある計算の集合を集めてその作用を連鎖させるという、データ構造走査の考え方を把握できるようにするものです。実際、sequencetraversableTraversableを定義するのにどちらも同じくらい重要です。これらはお互いが互いを利用して実装することができます。これについては興味ある読者への演習として残しておきます。

配列のTraversableインスタンスはData.Traversableモジュールで与えられています。traverseの定義は次のようになっています。

-- traverse :: forall a b f. Applicative f => (a -> f b) -> List a -> f (List b)
traverse _ Nil = pure Nil
traverse f (Cons x xs) = Cons <$> f x <*> traverse f xs

入力が空の配列のときには、単にpureを使って空の配列を返すことができます。配列が空でないときは、関数fを使うと先頭の要素から型f bの計算を作成することができます。また、配列の残りに対してtraverseを再帰的に呼び出すことができます。最後に、Applicative関手fまでcons演算子(:)を持ち上げて、2つの結果を組み合わせます。

Traversable関手の例はただの配列以外にもあります。以前に見たMaybe型構築子もTraversableのインスタンスを持っています。PSCiで試してみましょう。

> import Data.Maybe
> import Data.Traversable

> traverse (nonEmpty "Example") Nothing
(Valid Nothing)

> traverse (nonEmpty "Example") (Just "")
(Invalid ["Field 'Example' cannot be empty"])

> traverse (nonEmpty "Example") (Just "Testing")
(Valid (Just unit))

これらの例では、Nothingの値の走査は検証なしでNothingの値を返し、Just xを走査するとxを検証するのにこの検証関数が使われるということを示しています。つまり、traverseは型aについての検証関数をとり、Maybe aについての検証関数を返すのです。

他にも、何らかの型aについてのTuple aEither aや、連結リストの型構築子ListといったTraversable関手があります。一般的に、「コンテナ」のようなデータの型構築子は大抵Traversableインスタンスを持っています。例として、演習では二分木の型のTraversableインスタンスを書くようになっています。

演習

  1. (やや難しい) 左から右へと副作用を連鎖させる、次のような二分木データ構造についてのTraversableインスタンスを書いてください。

    data Tree a = Leaf | Branch (Tree a) a (Tree a)
    

    これは木の走査の順序に対応しています。行きがけ順の走査についてはどうでしょうか。帰りがけ順では?

  2. (やや難しい)Data.Maybeを使ってPersonaddressフィールドを省略可能になるようにコードを変更してください。ヒントtraverseを使って型Maybe aのフィールドを検証してみましょう。

  3. (難しい)traverseを使ってsequenceを書いてみましょう。また、sequenceを使ってtraverseを書けるでしょうか?

7.12 Applicative関手による並列処理

これまでの議論では、Applicative関手がどのように「副作用を結合」させるかを説明するときに、「結合」(combine)という単語を選びました。しかしながら、これらのすべての例において、Applicative関手は作用を「連鎖」(sequence)させる、というように言っても同じく妥当です。Traverse関手はデータ構造に従って作用を順番に結合させるsequence関数を提供する、という直感的理解とこれは一致するでしょう。

しかし一般には、Applicative関手はこれよりももっと一般的です。Applicative関手の規則は、その計算を実行する副作用にどんな順序付けも強制しません。実際、並列に副作用を実行するためのApplicative関手というものは妥当になりえます。

たとえば、V検証関手はエラーの配列を返しますが、その代わりにSet半群を選んだとしてもやはり正常に動き、このときどんな順序でそれぞれの検証器を実行しても問題はありません。データ構造に対して並列にこれを実行することさえできるのです!

別の例とし、purescript-parallelパッケージは、並列計算をサポートするParallel型クラスを与えます。非同期計算を表現する型構築子parallelは、並列に結果を計算するApplicativeインスタンスを持つことができます。

f <$> parallel computation1
  <*> parallel computation2

この計算は、computation1computation2を非同期に使って値を計算を始めるでしょう。そして両方の結果の計算が終わった時に、関数fを使ってひとつの結果へと結合するでしょう。

この考え方の詳細は、本書の後半でコールバック地獄の問題に対してApplicative関手を応用するときに見ていきます。

Applicative関手は並列に結合されうる副作用を捕捉する自然な方法です。

まとめ

この章では新しい考え方をたくさん扱いました。

Applicative関手は多くの問題に対して優れた解決策を与える興味深い抽象化です。本書を通じて何度も見ることになるでしょう。今回は、どうやって検証を行うかではなく、何を検証器が検証すべきなのかを定義することを可能にする、宣言的なスタイルで書く手段をApplicative関手は提供しました。一般に、Applicative関手は領域特化言語の設計のための便利な道具になります。

次の章では、これに関連するモナドという型クラスについて見ていきましょう。

第8章 Effモナド

8.1 この章の目標

第7章では、オプショナルな型やエラーメッセージ、データの検証など、副作用を扱いを抽象化するApplicative関手を導入しました。この章では、より表現力の高い方法で副作用を扱うための別の抽象化、モナドを導入します。

この章の目的は、なぜモナドが便利な抽象化なのか、do記法とどう関係するのかについて説明することです。ブラウザでユーザインターフェイスを構築する副作用を扱うためのある種のモナドを使って、前の章の住所録の例を作ることにしましょう。これから扱うEffモナドは、PureScriptにおけるとても重要なモナドです。Effモナドはいわゆるネイティブな作用をカプセル化するのに使われます。

8.2 プロジェクトの準備

このプロジェクトのソースコードは前の章のソースコードの上に構築しますが、以前のプロジェクトのモジュールは、このプロジェクトの srcディレクトリに含まれています。

このプロジェクトでは、以下のBowerの依存関係が追加されています。

前章のモジュールに加えて、この章ではMainモジュールを使用します。このモジュールはエントリポイントであるとともに、UIの描写も行います。

このプロジェクトをコンパイルするには、まずReactをインストールするためnpm installを実行し、それからpulp browserify --to dist/Main.jsでビルドを行います。このプロジェクトを実行するには、html/index.htmlファイルをウェブブラウザで開いてください。

8.3 モナドとdo記法

do記法は配列内包表記を扱うときに最初に導入されました。配列内包表記は Data.Arrayモジュールの concatMap関数の構文糖として提供されています。

次の例を考えてみましょう。2つのサイコロを振って出た目を数え、出た目の合計が nのときそれを得点とすることを考えます。次のような非決定的なアルゴリズムを使うとこれを実現することができます。

配列内包表記を使うと、この非決定的アルゴリズムを自然に書くことができます。

import Prelude

import Control.Plus (empty)
import Data.Array ((..))

countThrows :: Int -> Array (Array Int)
countThrows n = do
  x <- 1 .. 6
  y <- 1 .. 6
  if x + y == n
    then pure [x, y]
    else empty

PSCiで動作を見てみましょう。

> countThrows 10
[[4,6],[5,5],[6,4]]

> countThrows 12  
[[6,6]]

前の章では、オプショナルな値に対応したより大きなプログラミング言語へとPureScriptの関数を埋め込む、 Maybe Applicative関手についての直感的理解を養いました。同様に配列モナドについても、非決定選択に対応したより大きなプログラミング言語へPureScriptの関数を埋め込む、というような直感的理解を得ることができます。

一般に、ある型構築子 mのモナドは、型 m aの値を持つdo記法を使う方法を提供します。上の配列内包表記では、すべての行に何らかの型 aについての型 Array aの計算が含まれていることに注目してください。一般に、do記法ブロックのすべての行は、何らかの型 aとモナド mについて、型 m aの計算を含んでいます。モナド mはすべての行で同じでなければなりません(つまり、副作用の種類は固定されます)が、型 aは異なることもあります(言い換えると、ここの計算は異なる型の結果を持つことができます)。

型構築子 Maybeが適用された、do記法の別の例を見てみましょう。XMLノードを表す型 XMLと演算子があるとします。

child :: XML -> String -> Maybe XML

この演算子はノードの子の要素を探し、もしそのような要素が存在しなければ Nothingを返します。

この場合、do記法を使うと深い入れ子になった要素を検索することができます。XML文書として符号化された利用者情報から、利用者の住んでいる市町村を読み取りたいとします。

userCity :: XML -> Maybe XML
userCity root = do
  prof <- child root "profile"
  addr <- child prof "address"
  city <- child addr "city"
  pure city

userCity関数は子の要素である profileを探し、 profile要素の中にある address要素、最後に address要素から city要素を探します。これらの要素のいずれかが欠落している場合は、返り値は Nothingになります。そうでなければ、返り値は cityノードから Justを使って構築されています。

最後の行にあるpure関数は、すべてのApplicative関手について定義されているのでした。MaybeApplicative関手のpure関数はJustとして定義されており、最後の行を Just cityへ変更しても同じように正しく動きます。

8.4 モナド型クラス

Monad型クラスは次のように定義されています。

class Apply m <= Bind m where
  bind :: forall a b. m a -> (a -> m b) -> m b
class (Applicative m, Bind m) <= Monad m

ここで鍵となる関数は Bind型クラスで定義されている演算子 bindで、 Functor及び Apply型クラスにある <$><*>などの演算子と同じ様に Preludeでは >>=として bindの別名が定義されています。

Monad型クラスは、すでに見てきた Applicative型クラスの操作で Bindを拡張します。

Bind型クラスの例をいくつか見てみるのがわかりやすいでしょう。配列についての Bindの妥当な定義は次のようになります。

instance bindArray :: Bind Array where
  bind xs f = concatMap f xs

これは以前にほのめかした配列内包表記と concatMap関数の関係を説明しています。

Maybe型構築子についての Bindの実装は次のようになります。

instance bindMaybe :: Bind Maybe where
  bind Nothing  _ = Nothing
  bind (Just a) f = f a

この定義はdo記法ブロックを通じて伝播された欠落した値についての直感的理解を補強するものです。

Bind型クラスとdo記法がどのように関係しているかを見て行きましょう。最初に何らかの計算結果から値を束縛するような、簡単などdo記法ブロックについて考えてみましょう。

do value <- someComputation
   whatToDoNext

PureScriptコンパイラはこのようなパターンを見つけるたびにコードを次にように置き換えます。

bind someComputation \value -> whatToDoNext

下記のように表記することもできます。

someComputation >>= \value -> whatToDoNext

この計算 whatToDoNextvalueに依存することができます。

連続した複数の束縛がある場合でも、この規則が先頭のほうから複数回適用されます。例えば、先ほど見た userCityの例では次のように構文糖が脱糖されます。

userCity :: XML -> Maybe XML
userCity root =
  child root "profile" >>= \prof ->
    child prof "address" >>= \addr ->
      child addr "city" >>= \city ->
        pure city

do記法を使って表現されたコードは、 >>=演算子を使って書かれた同じ意味のコードよりしばしば読みやすくなることも特筆すべき点です。一方で、明示的に >>=を使って束縛が書くと、point-free形式でコードを書く機会を増やすことになります。ただし、通常は読みやすさを優先すべきでしょう。

8.5 モナド則

Monad型クラスはモナド則(monad laws)と呼ばれる3つの規則を持っています。これらは Monad型クラスの理にかなった実装から何を期待できるかを教えてくれます。

do記法を使用してこれらの規則を説明していくのが最も簡単でしょう。

Identity律

右単位元則(right-identity law)が3つの規則の中で最も簡単です。この規則はdo記法ブロックの最後の式であれば、 pureの呼び出しを排除することができると言っています。

do
  x <- expr
  pure x

右単位元則は、この式は単なる exprと同じだと言っています。

左単位元則(left-identity law)は、もしそれがdo記法ブロックの最初の式であれば、 pureの呼び出しを除去することができると述べています。

do
  x <- pure y
  next

このコードの名前 xを式 yで置き換えたものと nextは同じです。

最後の規則は結合則(associativity law)です。これは入れ子になったdo記法ブロックをどう扱うのかについて教えてくれます。

c1 = do
  y <- do
    x <- m1
    m2
  m3

上記のコード片は、次のコードと同じです。

c2 = do
  x <- m1
  y <- m2
  m3

これら計算にはそれぞれ、3つのモナドの式 m1m2m3が含まれています。どちらの場合でも m1の結果は名前 xに束縛され、 m2の結果は名前 yに束縛されます。

c1では2つの式 m1m2がそれぞれのdo記法ブロック内にグループ化されています。

c2では m1m2m3の3つすべての式が同じdo記法ブロックに現れています。

結合規則は 入れ子になったdo記法ブロックをこのように単純化しても安全であるということを言っています。

注意: do記法がどのように bindの呼び出しへと脱糖されるかの定義により、 c1c2はいずれも次のコードと同じです。 `

c3 = do
  x <- m1
  do
    y <- m2
    m3

8.6 モナドと畳み込み

抽象的にモナドを扱う例として、この節では Monad型クラスの何らかの型構築子と一緒に機能するある関数を示していきます。これはモナドによるコードが副作用を伴う「より大きな言語」でのプログラミングと対応しているという直感的理解を補強しますし、モナドによるプログラミングがもたらす一般性も示しています。

これから foldMと呼ばれる関数を書いてみます。これは以前扱った foldl関数をモナドの文脈へと一般化します。型シグネチャは次のようになっています。

foldM :: forall m a b
       . Monad m
      => (a -> b -> m a)
      -> a
      -> List b
      -> m a

モナド mが現れている点を除いて、 foldlの型と同じであることに注意しましょう。

foldl :: forall a b
       . (a -> b -> a)
      -> a
      -> List b
      -> a

直感的には、 foldMはさまざまな副作用の組み合わせに対応した文脈での配列の畳み込みを行うと捉えることができます。

例として mMaybeであるとすると、この畳み込みはそれぞれの段階で Nothingを返すことで失敗することができます。それぞれの段階ではオプショナルな結果を返しますから、それゆえ畳み込みの結果もオプショナルになります。

もし mとして配列の型構築子 Arrayを選ぶとすると、畳み込みのそれぞれの段階で複数の結果を返すことができ、畳み込みは結果それぞれに対して次の手順を継続します。最後に、結果の集まりは、可能な経路すべての畳み込みから構成されることになります。これはグラフの走査と対応しています!

foldMを書くには、単に入力の配列について場合分けをするだけです。

配列が空なら、型 aの結果を生成するための選択肢はひとつしかありません。第2引数を返します。

foldM _ a Nil = pure a

aをモナド mまで持ち上げるために pureを使わなくてはいけないことも忘れないようにしてください。

配列が空でない場合はどうでしょうか?その場合、型 aの値、型 bの値、型 a -> b -> m aの関数があります。もしこの関数を適用すると、型 m aのモナドの結果を手に入れることになります。この計算の結果を逆向きの矢印 <-で束縛することができます。

あとは配列の残りに対して再帰するだけです。実装は簡単です。

foldM f a (b : bs) = do
  a' <- f a b
  foldM f a' bs

do記法を除けば、この実装は配列に対する foldlの実装とほとんど同じであることにも注意してください。

PSCiでこれを定義し、試してみましょう。除算可能かどうかを調べて、失敗を示すために Maybe型構築子を使う、整数の「安全な除算」関数を定義するとしましょう。

safeDivide :: Int -> Int -> Maybe Int
safeDivide _ 0 = Nothing
safeDivide a b = Just (a / b)

これで、 foldMで安全な除算の繰り返しを表現することができます。

> import Data.List

> foldM safeDivide 100 (fromFoldable [5, 2, 2])
(Just 5)

> foldM safeDivide 100 (fromFoldable [2, 0, 4])
Nothing

もしいずれかの時点で整数にならない除算が行われようとしたら、 foldM safeDivide関数は Nothingを返します。そうでなければ、 Just構築子に包まれた除算の繰り返した累積の結果を返します。

8.7 モナドとApplicative

クラス間に上位クラス関係があるため、 Monad型クラスのすべてのインスタンスは Applicative型クラスのインスタンスでもあります。

しかしながら、どんな Monadのインスタンスについても Applicative型クラスの実装が、それ以上の条件なしで存在し、次のような apが与えられます。

ap :: forall m a b. Monad m => m (a -> b) -> m a -> m b
ap mf ma = do
  f <- mf
  a <- ma
  pure (f a)

もし mMonad型クラスの規則に従っているなら、 mapで与えられるような、妥当な Applicativeインスタンスが存在します。

興味のある読者は、これまで登場した ArrayMaybeEither eといったモナドについて、この apapplyと一致することを確かめてみてください。

もしすべてのモナドがApplicative関手でもあるなら、Applicative関手についての直感的理解をすべてのモナドについても適用することができるはずです。特に、更なる副作用の組み合わせで増強された「より大きな言語」でのプログラミングとモナドがいろいろな意味で一致することを当然に期待することができます。 mapapplyを使って、引数が任意個の関数をこの新しい言語へと持ち上げることができるはずです。

しかし、モナドはApplicative関手で可能な以上のことを行うことができ、重要な違いはdo記法の構文で強調されています。利用者情報を符号化したXML文書から利用者の都市を検索する、 userCityの例についてもう一度考えてみましょう。

userCity :: XML -> Maybe XML
userCity root = do
  prof <- child root "profile"
  addr <- child prof "address"
  city <- child addr "city"
  pure city

2番目の計算が最初の結果 profに依存し、3番目の計算が2番目の計算の結果 addrに依存するというようなことをdo記法は可能にします。 Applicative型クラスのインターフェイスだけを使うのでは、このような以前の値への依存は不可能です。

pureapplyだけを使って userCityを書こうとしてみれば、これが不可能であることがわかるでしょう。Applicativeは関数の互いに独立した引数を持ち上げることだけを可能にしますが、モナドはもっと興味深いデータ依存関係に関わる計算を書くことを可能にします。

前の章では Applicative型クラスは並列処理を表現できることを見ました。持ち上げられた関数の引数は互いに独立していますから、これはまさにその通りです。 Monad型クラスは計算が前の計算の結果に依存できるようにしますから、同じようにはなりません。モナドはその副作用を順番に組み合わせしなければいけません。

演習

  1. (簡単) purescript-arraysパッケージの Data.Arrayモジュールから head関数と tail関数の型を探してください。 Maybeモナドとdo記法を使い、 headtailを組み合わせて、3要素以上の配列の3番目の要素を返すような関数を作ってください。その関数は適当な Maybe型を返さなければいけません。

  2. (やや難しい) 与えられた幾つかの硬貨を組み合わせてできる可能性のあるすべての合計を決定する関数 sumを、 foldMを使って書いてみましょう。入力の硬貨は、硬貨の価値の配列として与えられます。この関数は次のような結果にならなくてはいけません。

    > sums []
    [0]
    
    > sums [1, 2, 10]
    [0,1,2,3,10,11,12,13]
    

    ヒントfoldMを使うと1行でこの関数を書くことが可能です。重複する要素を取り除いたり、結果を昇順に並び替えたりするのに、 nub関数や sort関数を使いたくなるかもしれません。

  3. (やや難しい) Maybe型構築子について、 ap関数と apply演算子が一致することを確認してください。

  4. (やや難しい) purescript-maybeパッケージで定義されている Maybe型についての Monadインスタンスが、モナド則を満たしていることを検証してください。

  5. (やや難しい) 配列上の filterの関数を一般化した関数 filterMを書いてください。この関数は次の型シグネチャを持つ必要があります。

    filterM :: forall m a. Monad m => (a -> m Boolean) -> List a -> m (List a)
    

    PSCiMaybeArrayモナドを使ってその関数を試してみてください。

  6. (難しい) すべてのモナドは、次で与えられるような既定の Functorインスタンスがあります。

    map f a = do
      x <- a
      pure (f x)
    

    モナド則を使って、すべてのモナドが次を満たすことを証明してください。

    lift2 f (pure a) (pure b) = pure (f a b)
    

    ここで、 Applicativeインスタンスは上で定義された ap関数を使用しています。 lift2が次のように定義されていたことを思い出してください。

    lift2 :: forall f a b c. Applicative f => (a -> b -> c) -> f a -> f b -> f c
    lift2 f a b = f <$> a <*> b
    

8.8 ネイティブな作用

ここではPureScriptの中核となる重要なモナド、 Effモナドについて見ていきます。

Effモナドは Control.Monad.Effモジュール、およびPreludeで定義されています。これはいわゆるネイティブな作用を扱うために使います。

ネイティブな副作用とは何でしょうか。ネイティブな副作用とは、従来のJavaScriptの式が持つ副作用と、PureScript特有の式が持つ副作用を区別するものです。ネイティブな作用には次のようなものがあります。

また、ブラウザでは次のようなものがあります。

すでに「ネイティブでない」副作用の例については数多く見てきています。

これらの区別はわかりにくいので注意してください。エラーメッセージは例外の形でJavaScriptの式の副作用となることがあります。その意味では例外はネイティブな副作用を表していて、 Effを使用して表現することができます。しかし、 Eitherを使用して実装されたエラーメッセージはJavaScriptランタイムの副作用ではなく、 Effを使うスタイルでエラーメッセージを実装するのは適切ではありません。そのため、ネイティブなのは作用自体というより、実行時にどのように実装されているかです。

8.9 副作用と純粋性

PureScriptのような言語が純粋であるとすると、疑問が浮かんできます。副作用がないなら、どうやって役に立つ実際のコードを書くことができるというのでしょうか。

その答えはPureScriptの目的は副作用を排除することではないということです。これは、純粋な計算と副作用のある計算とを型システムにおいて区別することができるような方法で、副作用を表現することを目的としているのです。この意味で、言語はあくまで純粋だということです。

副作用のある値は、純粋な値とは異なる型を持っています。このように、例えば副作用のある引数を関数に渡すことはできず、予期せず副作用持つようなことが起こらなくなります。

Effモナドで管理された副作用を実行する唯一の方法は、型 Eff eff aの計算をJavaScriptから実行することです。

ビルドツールPulp(や他のツール)は、オプションを与えることで、アプリケーションの起動時に main計算を呼び出すためのJavaScriptコードを簡単に追加で生成できるようにしています。 mainEffモナドでの計算であることが要求されます。

このように、 mainによって使われる副作用が期待されることを、開発者は正確に知ることができます。加えて、 mainがどのような種類の副作用を持つかを制限するのに Effモナドを使うことができるので、例えば、アプリケーションはコンソールと相互作用するが、それ以外は何もしない、ということを確実に言うことができます。

8.10 Effモナド

Effモナドの目的は、副作用のある計算に型付けされたAPIを提供すると同時に、効率的なJavaScriptを生成することにあります。これは拡張可能作用(extensible effects)のモナドとも呼ばれており、これについては後述します。

例を示しましょう。次のコードでは乱数を生成するための関数が定義されている purescript-randomモジュールを使用しています。

module Main where

import Prelude

import Control.Monad.Eff.Random (random)
import Control.Monad.Eff.Console (logShow)

main = do
  n <- random
  logShow n

このファイルが Main.pursという名前で保存されているなら、次のコマンドでコンパイルすることができます。

$ pulp run

コンパイルされたJavaScriptを実行すると、コンソールに出力 01の間で無作為に選ばれた数が表示されるでしょう。

このプログラムは、乱数生成とコンソール入出力というJavaScriptランタイムが提供する2種類のネイティブな作用を、do記法で組み合わせて使っています。

8.11 拡張可能作用

PSCiでモジュールを読み込み、 mainの型を調べてみましょう。

> import Main

> :type main
forall eff. Eff (console :: CONSOLE, random :: RANDOM | eff) Unit

この型はかなり複雑そうに見えますが、PureScriptのレコードの比喩で簡単に説明することができます。

レコード型を使った簡単な関数を考えてみましょう。

fullName person = person.firstName <> " " <> person.lastName

この関数は firstNamelastNameというプロパティを含むレコードから完全な名前の文字列を作成します。もし PSCiでこの関数の型を同様に調べたとすると、次のように表示されるでしょう。

forall r. { firstName :: String, lastName :: String | r } -> String

この型は「少なくともfullNamefirstNamelastNameという2つのフィールドを持つようなレコードをとり、 Stringを返す。」というように読みます。

渡したレコードが firstNamelastNameいうプロパティさえ持っていれば、その他に余計なフィールドを持っていたとしても fullNameは気にしません。

> firstName { firstName: "Phil", lastName: "Freeman", location: "Los Angeles" }
Phil Freeman

同様に、上の mainの型は「 main副作用のある計算で、乱数生成とコンソール入出力、およびそれ以外の任意の種類の副作用を備えた任意の環境で実行することができ、型 Unitの値を返す」というように解釈できます。

これは 「拡張可能作用」という名前の由来になっています。必要な副作用さえ備えていれば、その副作用の集まりをいつでも拡張できるということです。

8.12 作用の混在

拡張可能作用は Effモナドで異なる型の副作用を混在(interleave)させることを可能にします。

先ほど使った random関数は次のような型を持っています。

forall eff1. Eff (random :: RANDOM | eff1) Number

この作用の集まり (random :: RANDOM | eff1)mainで見たものと同じではありません

しかし、作用が一致するように randomの型を特殊化できます。 eff1(console :: CONSOLE | eff)を選べば、これらの2つの作用の集合は同じになります。

同様に logShowmainの作用に合わせて特殊化できる型を持っています。

forall eff2. Show a => a -> Eff (console :: CONSOLE | eff2) Unit

この場合は、 eff2(random :: Random | eff)を選ばなくてはなりません。

それが含む副作用を示す randomlogShowの型がポイントで、より大きな副作用の集まりを持ったより大きな計算を構築するために、他の副作用を混ぜ合わせることができるのです。

mainの型注釈を与えなくてもよいことに注意してください。コンパイラは randomlogShowの多相的な型が与えられた mainについて、最も一般的な型を見つけることができます。

8.13 Effの種

mainの型は今まで見てきた他の型とは異なります。それを説明するためには、まず Effについて考える必要があります。値がその型によって分類されるように、型がその種によって分類されることを思い出してください。これまでは Type(型の種)と ->(型構築子のための種を構築する)だけから構築された種のみを見てきました。

Effの種を見るには、 PSCi:kindコマンドを使います。

> import Control.Monad.Eff

> :kind Eff
# Control.Monad.Eff.Effect -> Type -> Type

今まで見たことのない記号が2つあります。

Control.Monad.Eff.Effectは副作用の型についての型レベルのラベルを表す作用の種です。これを理解するためには、上の mainで見た2つのラベルがいずれも種 Control.Monad.Eff.Effectを持っていることに注目してください。

> import Control.Monad.Eff.Console
> import Control.Monad.Eff.Random

> :kind CONSOLE
Control.Monad.Eff.Effect

> :kind RANDOM
Control.Monad.Eff.Effect

#種構築子はの種を構築するのに使われます。行とは順序なしラベル付きの集合のことです。

そして、 Effは作用の行と作用の返り値の型という2つの引数を持っています。つまり、 Effの最初の引数は、作用の型の順序なしラベル付きの集合であり、2つめの引数は返り値の型だということです。

これで、先ほどの mainの型を読むことができるようになりました。

forall eff. Eff (console :: CONSOLE, random :: RANDOM | eff) Unit

Effの最初の引数は (console :: CONSOLE, random :: RANDOM | eff)です。これは CONSOLE作用と Random作用を含む行です。パイプ記号 |は、ラベルが付けられた作用と、それに混ぜあわせたいそれ以外の任意の作用を表す行変数(row variable)effを区切っています。

Effの2番目の引数は、計算の戻り値の型 Unitです。

8.14 オブジェクトと行

拡張可能作用とレコードに深いつながりをもたらしている Effの種を考えてみましょう。

上で定義した関数 fullNameを考えます。

fullName :: forall r. { firstName :: String, lastName :: String | r } -> String
fullName person = person.firstName <> " " <> person.lastName

Typeの型だけが値を持つので、関数の矢印の左辺にある型の種は Typeでなければなりません。

中括弧は実際には構文糖であり、PureScriptコンパイラによって理解されている完全な型は次のようなものです。

fullName :: forall r. Record (firstName :: String, lastName :: String | r) -> String

中括弧がなくなっており、 Record構築子が追加されていることに注意してください。 RecordPrimモジュールで定義されている組み込みの型構築子です。 Recordの種を調べてみると、次のようになっています。

> :kind Record
# Type -> Type

つまり、 Record型の行をとり型を構築する型構築子なのです。これがレコードについての行多相関数を書くことを可能にしているのです。

この型システムでは、拡張可能作用を扱うのに、行多相レコード(拡張可能レコード)を使うときと同じ機構が使われています。唯一の違いは、ラベルに現れる型のです。レコードは型の行によってパラメータ化され、 Effは作用の行によってパラメータ化されるのです。

これと同じ型システムの機能は、型構築子の行や、行の行でパラメータ化される型を構築するのにさえ使われることがあります!

8.15 きめ細かな作用

作用の行は推論されるので、大抵の場合は Effを使うときに型注釈は必須ではありませんが、計算でどの作用が期待されるのかをコンパイラに示すために型注釈が使われることがあります。

先ほどの例を、作用の閉じた行で注釈すると次のようになります。

main :: Eff (console :: CONSOLE, random :: RANDOM) Unit
main = do
  n <- random
  logShow n

行変数 effがないことに注意してください。こうすると、異なった作用の型を使う計算を誤って含めることはできません。このように、コードが持つことを許される副作用を制御することができるのです。

8.16 ハンドラとアクション

logShowrandomのような関数はアクションと呼ばれます。アクションはそれらの関数の右辺に Eff型を持っており、その目的は新たな効果を導入することにあります。

これは Eff型が関数の引数の型として現れるハンドラとは対照的です。アクションが集合へ必要な作用を追加するのに対し、ハンドラは集合から作用を除去します。

例として、 purescript-exceptionsパッケージを考えてみます。このパッケージでは throwExceptioncatchExceptionという二つの関数が定義されています。

throwException :: forall a eff
                . Error
               -> Eff (exception :: EXCEPTION | eff) a

catchException :: forall a eff
                . (Error -> Eff eff a)
               -> Eff (exception :: EXCEPTION | eff) a
               -> Eff eff a

throwExceptionはアクションです。 Effは右辺に現れていて、新しく Exception作用を導入します。

catchExceptionはハンドラです。 Effは関数の第2引数の型として出現しており、作用全体としては Exception作用を除去します。

特定の作用を必要とするコードの部分を限定するために型システムを使うことができるので、これは便利です。作用のあるコードをハンドラで包むことにより、その作用を許さないコードブロックの中に埋め込むことができます。

例えば、 Exception作用を使って例外を投げるコード片を書き、それからそのコードを catchExceptionで包むことによって、例外を許さないコード片の中にその計算を埋め込むことができるのです。

JSONドキュメントからアプリケーションの設定を読みたいとしましょう。文書を構文解析する過程で例外を投げることがあります。設定を読み構文解析するこの処理は、次のような型シグネチャを持つ関数として書くことができます。

readConfig :: forall eff. Eff (exception :: EXCEPTION | eff) Config

それから、 main関数で catchExceptionを使用して Exception作用を処理することができます。

main = do
    config <- catchException printException readConfig
    runApplication config
  where
    printException e = do
      log (message e)
      pure defaultConfig

purescript-effパッケージでも、副作用なしの計算を取り、それを純粋な値として安全に評価する runPureハンドラが定義されています。

type Pure a = Eff () a

runPure :: forall a. Pure a -> a

8.17 可変状態

Preludeには ST作用というまた別の作用も定義されています。

ST作用は変更可能な状態を操作するために使われます。純粋関数プログラミングを知っているなら、共有される変更可能な状態は問題を引き起こしやすいということも知っているでしょう。しかしながら、 ST作用は型システムを使って安全で局所的な状態変化を可能にし、状態の共有を制限するのです。

ST作用は Control.Monad.STモジュールで定義されています。これがどのように動作するかを確認するには、そのアクションの型を見る必要があります。

newSTRef :: forall a h eff. a -> Eff (st :: ST h | eff) (STRef h a)

readSTRef :: forall a h eff. STRef h a -> Eff (st :: ST h | eff) a

writeSTRef :: forall a h eff. STRef h a -> a -> Eff (st :: ST h | eff) a

modifySTRef :: forall a h eff. STRef h a -> (a -> a) -> Eff (st :: ST h | eff) a

newSTRefは型 STRef h aの変更可能な参照領域を新しく作るのに使われます。 STRef h areadSTRefアクションを使って状態を読み取ったり、 writeSTRefアクションや modifySTRefアクションで状態を変更するのに使われます。型 aは領域に格納された値の型で、型 hは型システムのメモリ領域を表しています。

例を示します。小さな時間刻みで簡単な更新関数の実行を何度も繰り返すことによって、重力に従って落下する粒子の落下の動きをシミュレートしたいとしましょう。

粒子の位置と速度を保持する変更可能な参照領域を作成し、領域に格納された値を更新するのにforループ(Control.Monad.EffforEアクション)を使うことでこれを実現することができます。

import Prelude

import Control.Monad.Eff (Eff, forE)
import Control.Monad.ST (ST, newSTRef, readSTRef, modifySTRef)

simulate :: forall eff h. Number -> Number -> Int -> Eff (st :: ST h | eff) Number
simulate x0 v0 time = do
  ref <- newSTRef { x: x0, v: v0 }
  forE 0 (time * 1000) \_ -> do
    modifySTRef ref \o ->
      { v: o.v - 9.81 * 0.001
      , x: o.x + o.v * 0.001
      }
    pure unit
  final <- readSTRef ref
  pure final.x

計算の最後では、参照領域の最終的な値を読み取り、粒子の位置を返しています。

この関数が変更可能な状態を使っていても、その参照区画 refがプログラムの他の部分で使われるのが許されない限り、これは純粋な関数のままであることに注意してください。 ST作用が禁止するものが正確には何であるのかについては後ほど見ます。

ST作用で計算を実行するには、 runST関数を使用する必要があります。

runST :: forall a eff. (forall h. Eff (st :: ST h | eff) a) -> Eff eff a

ここで注目して欲しいのは、領域型 hが関数矢印の左辺にある括弧の内側で量化されているということです。 runSTに渡したどんなアクションでも、 任意の領域hがなんであれ動作するということを意味しています。

しかしながら、ひとたび参照領域が newSTRefによって作成されると、その領域の型はすでに固定されており、 runSTによって限定されたコードの外側で参照領域を使おうとしても型エラーになるでしょう。 runSTが安全に ST作用を除去できるのはこれが理由なのです!

実際に、 STはこの例の唯一の作用なので、 runPurerunSTを併用すると simulateを純粋な関数に変えることができます、

simulate' :: Number -> Number -> Number -> Number
simulate' x0 v0 time = runPure (runST (simulate x0 v0 time))

PSCiでこの関数を実行してみてください。

> import Main

> simulate' 100.0 0.0 0.0
100.00

> simulate' 100.0 0.0 1.0
95.10

> simulate' 100.0 0.0 2.0
80.39

> simulate' 100.0 0.0 3.0
55.87

> simulate' 100.0 0.0 4.0
21.54

もし simulateの定義を runSTの呼び出しのところへ埋め込むとすると、次のようになります。

simulate :: Number -> Number -> Int -> Number
simulate x0 v0 time = runPure $ runST do
  ref <- newSTRef { x: x0, v: v0 }
  forE 0 (time * 1000) \_ -> do
    modifySTRef ref \o ->  
      { v: o.v - 9.81 * 0.001
      , x: o.x + o.v * 0.001  
      }
    pure unit  
  final <- readSTRef ref
  pure final.x

参照区画はそのスコープから逃れることができないことがコンパイラにわかりますし、安全に varに変換することができます。 runSTの呼び出しの本体に対して生成されたJavaScriptは次のようになります。

var ref = { x: x0, v: v0 };

Control_Monad_Eff.forE(0)(time * 1000 | 0)(function (i) {
  return function __do() {
    ref = (function (o) {
      return {
        v: o.v - 9.81 * 1.0e-3,
        x: o.x + o.v * 1.0e-3
      };
    })(ref);
    return Prelude.unit;
  };
})();

return ref.x;

局所的な変更可能状態を扱うとき、特に Effモナドで効率のよいループを生成する forEforeachEwhileEuntilEのようなアクションを一緒に使うときには、 ST作用は短いJavaScriptを生成できる良い方法となります。

演習

  1. (やや難しい) もし分母で分子を割り切れないなら throwExceptionを使って例外を投げるように safeDivide関数を書き直してください。

  2. (難しい) PIを推定するには次のような簡単な方法があります。単位正方形内にある多数の N個の点を無作為に選び、内接する円に含まれるものの個数 nを数えます。このとき 4n/Nが円周率 piの概算となります。 forE関数、 Random作用、 ST作用を使って、この方法で円周率 piを推定する関数を書いてください。

8.18 DOM作用

この章の最後の節では、 Effモナドでの作用についてこれまで学んだことを、実際のDOM操作の問題に応用します。

DOMを直接扱ったり、オープンソースのDOMライブラリを扱う、自由に利用可能なPureScriptパッケージが幾つかあります。

上記のライブラリを抽象化するPureScript向けのライブラリもあります。

この章では purescript-reactを使用し、住所簿にインターフェイスを追加しますが、興味のあるユーザは異なるアプローチで進めることをおすすめします。

8.19 住所録のユーザーインタフェース

purescript-reactを使用するためにReactコンポーネントと同じ様にアプリケーションを定義します。Reactコンポーネントは、コード内のHTML要素を純粋なデータ構造体として記述し、効率的にDOMにレンダリングします。さらに、コンポーネントはボタンのクリックなどのイベントに応答できます。 purescript-reactライブラリは Effモナドを使ってこれらのイベントをどのように扱うかを記述します。

Reactライブラリの完全なチュートリアルはこの章の範囲をはるかに超えていますが、読者は必要に応じてマニュアルを参照することをお勧めします。目的に応じて、Reactは Effモナドの実用的な例を提供してくれます。

まずは利用者が住所録に新しい項目を追加できるフォームを構築することにしましょう。フォームには、さまざまなフィールド(姓、名前、都市、州など)を入力するテキストボックス、および検証エラーが表示される領域が含まれます。テキストボックスに利用者がテキストを入力すると、検証エラーが更新されます。

シンプルさを保つために、フォームは固定の形状とします。電話番号は種類(自宅、携帯電話、仕事、その他)ごとに別々のテキストボックスへ分けることにします。

次の行を除いて、HTMLファイルは基本的に空です。

<script type="text/javascript" src="../dist/Main.js"></script>

この行には、Pulpによって生成されたJavaScriptコードが含まれています。これをファイルの最後に配置して、コードからアクセスしようとする関連要素が上にあることを確認します。 Main.jsファイルを再構築するには、 pulp browserifyコマンドを使うことができます。最初に distディレクトリが存在し、ReactをNPM依存関係としてインストールしたことを確認してください。

$ npm install # Install React
$ mkdir dist/
$ pulp browserify --to dist/Main.js

Mainモジュールは住所録コンポーネントを作成して画面に表示する main関数を定義しています。 main関数は CONSOLE作用と DOM作用のみを使用しており、型シグニチャは次のことを示します。

main :: Eff (console :: CONSOLE, dom :: DOM) Unit

まず、 mainはコンソールにステータスメッセージを記録します。

main = void do
  log "Rendering address book component"

その後、 mainはDOM APIを使用してドキュメント本体への参照( doc)を取得します。

  doc <- window >>= document

これは混在した作用の一例になっていることに注目してください。 log関数は CONSOLE作用を使い、 windowdocument関数は両方とも DOM作用を使います。 mainの型は両方の作用を利用することを示します。

mainwindowアクションを使ってウィンドウオブジェクトへの参照を取得し、その結果を document関数に >>=を使って渡します。 documentはウィンドウオブジェクトをとり、そのドキュメントへの参照を返します。

do記法の定義により、これを次のようにも書けることに注意してください。

  w <- window
  doc <- document w

どちらが読みやすいかどうかは個人の好みの問題です。前者は名前が付けられた関数の引数がなく、point-free形式の一例となっています。その一方で、後者ではウィンドウオブジェクトの名前として wが使われています。

Mainモジュールは addressBookと呼ばれる住所録コンポーネントを定義します。その定義を理解するために、まずいくつかの概念を理解する必要があります。

Reactコンポーネントを作成するには、最初にコンポーネントのテンプレートのように動作するReactクラスを作成する必要があります。 purescript-reactでは、 createClass関数を使ってクラスを作成することができます。 createClassはクラスの仕様を必要とします。この本質は、コンポーネントのライフサイクルについて処理するために使われる Effアクションの集合です。開発者が注目するべきなのは Renderアクションです。

Reactライブラリが提供するいくつかの関連する関数の型は次のとおりです。

createClass
  :: forall props state eff
   . ReactSpec props state eff
  -> ReactClass props

type Render props state eff
   = ReactThis props state
  -> Eff ( props :: ReactProps
         , refs :: ReactRefs Disallowed
         , state :: ReactState ReadOnly
         | eff
         ) ReactElement

spec
  :: forall props state eff
   . state
  -> Render props state eff
  -> ReactSpec props state eff

Mainモジュールは、住所録コンポーネントの状態の型と初期状態を定義します。

newtype AppState = AppState
  { person :: Person
  , errors :: Errors
  }

initialState :: AppState
initialState = AppState
  { person: examplePerson
  , errors: []
  }

状態には、(フォームコンポーネントを使用して編集可能にする) Personレコードと、既存の検証コードを使用して入力されるエラーの配列が含まれています。

次に、コンポーネントの定義を見てみましょう。

addressBook :: forall props. ReactClass props

すでに述べたように、addressBookcreateClassspecを使用してReactクラスを作成します。ここから初期状態の値とRenderアクションを得ることができます。取得したRenderアクションでいったい何ができるのでしょうか? 例えば、purescript-reactは以下のような単純なアクションを提供しています。

readState
  :: forall props state access eff
   . ReactThis props state
  -> Eff ( state :: ReactState ( read :: Read
                               | access
                               )
         | eff
         ) state

writeState
  :: forall props state access eff
   . ReactThis props state
  -> state
  -> Eff ( state :: ReactState ( write :: Write
                               | access
                               )
         | eff
         ) state

readStatewriteStateアクションは拡張可能作用を伴って、ReactState作用を使ってReactの状態にアクセスできるようにしますが、他の行の ReactState作用をパラメータ化することで、読み書き権限がさらに分離されることに注意してください!

これは、PureScriptの行ベースの作用に関する興味深い点を示しています。行内に現れる作用は単純な1要素である必要はなく、様々な構造を持つことができ、この柔軟性によってコンパイル時にいくつかの有用な制限が可能になります。 purescript-reactライブラリがこの制限をしなかった場合、 Renderアクションで状態を書き込もうとすると、実行時に例外を受け取ることになります。適切な制限を行うことで、このような間違いがコンパイル時に捕捉されるようになりました。

これで addressBookコンポーネントの定義を読むことができるようになりました。まずは現在のコンポーネントの状態を読むことから始めましょう。

addressBook = createClass $ spec initialState \ctx -> do
  AppState { person: Person person@{ homeAddress: Address address }
           , errors
           } <- readState ctx

次の点に注意してください。

RenderはDOMの次の状態を表すReactElement構造体を返さなければならないのでした。Renderアクションはいくつかの補助関数から定義されています。その補助関数の1つは renderValidationErrorsです。これはErrors構造体をReactElementの配列に変換します。

renderValidationError :: String -> ReactElement
renderValidationError err = D.li' [ D.text err ]

renderValidationErrors :: Errors -> Array ReactElement
renderValidationErrors [] = []
renderValidationErrors xs =
  [ D.div [ P.className "alert alert-danger" ]
          [ D.ul' (map renderValidationError xs) ]
  ]

purescript-reactでは、 ReactElementは通常、単一のHTML要素を divのような関数を適用することで作成します。これらの関数は通常、属性の配列と子要素の配列を引数として取ります。しかし、ここでは ul'のようにプライム記号(', prime character)で終わる名前は属性配列を省略し、代わりにデフォルトの属性を使用します。

ここでは通常のデータ構造体を単純に操作しているので、 mapのような関数を使って様々な要素を構築することができます。

2番目の補助関数は formFieldです。これは、単一フォームフィールドのテキスト入力を含む ReactElementを作成します。

formField
  :: String
  -> String
  -> String
  -> (String -> Person)
  -> ReactElement
formField name hint value update =
  D.div [ P.className "form-group" ]
        [ D.label [ P.className "col-sm-2 control-label" ]
                  [ D.text name ]
        , D.div [ P.className "col-sm-3" ]
                [ D.input [ P._type "text"
                          , P.className "form-control"
                          , P.placeholder hint
                          , P.value value
                          , P.onChange (updateAppState ctx update)
                          ] []
                ]
        ]

繰り返しますが、単純な要素から様々な要素を構成し、それぞれの要素に属性を適用しています。ここで注目すべき属性の1つは、 input要素に適用される onChange属性です。これはイベントハンドラで、ユーザーがテキストボックス内のテキストを編集するときにコンポーネントの状態を更新するために使用されます。イベントハンドラは、3番目の補助関数 updateAppStateを使用して定義されています。

updateAppState
  :: forall props eff
   . ReactThis props AppState
  -> (String -> Person)
  -> Event
  -> Eff ( console :: CONSOLE
         , state :: ReactState ReadWrite
         | eff
         ) Unit

updateAppStateは、 ReactThis値の形式でコンポーネントへの参照、 Personレコードを更新する関数、そして Eventレコードを取ります。まず、(valueOf補助関数を使用して) changeイベントからテキストボックスの新しい値を抽出し、それを使って新しい Person状態を作成します。

  for_ (valueOf e) \s -> do
    let newPerson = update s

次に、検証関数を実行し、それに応じて(writeStateを使用して)コンポーネントの状態を更新します。

    log "Running validators"
    case validatePerson' newPerson of
      Left errors ->
        writeState ctx (AppState { person: newPerson
                                 , errors: errors
                                 })
      Right _ ->
        writeState ctx (AppState { person: newPerson
                                 , errors: []
                                 })

これは、コンポーネント実装の基本をカバーしています。しかし、コンポーネントの仕組みを完全に理解するためには、この章に付随する情報をお読みください。

pulp browserify --to dist/Main.jsを実行して、それからWebブラウザで html/index.htmlを開き、ユーザインターフェイスを試してみてください。フォームフィールドにいろいろな値を入力すると、ページ上に出力された検証エラーを見ることができるでしょう。

このユーザインタフェースには明らかに改善すべき点がたくさんあります。演習ではアプリケーションがより使いやすくなるような方法を追究していきます。

演習

  1. (簡単) このアプリケーションを変更し、職場の電話番号を入力できるテキストボックスを追加してください。

  2. (やや難しい) 検証エラーを ul要素を使ってリストで表示するかわりに、それぞれのエラーについてひとつづつ alertスタイルで divを作成するように、コードを変更してください。

  3. (難しい、拡張) このユーザーインターフェイスの問題のひとつは、検証エラーがその発生源であるフォームフィールドの隣に表示されていないことです。コードを変更してこの問題を解決してください。

    ヒント:検証器によって返されるエラーの型は、エラーの原因となっているフィールドを示すために拡張する必要があります。次のようなエラー型を使用したくなるかもしれません。

    data Field = FirstNameField
               | LastNameField
               | StreetField
               | CityField
               | StateField
               | PhoneField PhoneType
    
    data ValidationError = ValidationError String Field
    
    type Errors = Array ValidationError
    

    適切なフォーム要素を選択するように、 FieldquerySelectorアクションの呼び出しに変更する関数を書く必要があるでしょう。

まとめ

この章ではPureScriptでの副作用の扱いについての多くの考え方を導入しました。

Effモナドは現実のPureScriptコードにおける基本的なツールです。本書ではこのあとも、様々な場面で副作用を処理するために Effモナドを使っていきます。

第9章 キャンバスグラフィックス

9.1 この章の目標

この章のコード例では、PureScriptでHTML5のCanvas APIを使用して2Dグラフィックスを生成する purescript-canvasパッケージに焦点をあててコードを拡張していきます。

9.2 プロジェクトの準備

このモジュールのプロジェクトでは、以下のBowerの依存関係が新しく追加されています。

この章のソースコードは、それぞれに mainメソッドが定義されている複数のモ​​ジュールへと分割されています。この章の節の内容はそれぞれ異なるファイルで実装されており、それぞれの節で対応するファイルの mainメソッドを実行できるように、Pulpビルドコマンドを変更することで Mainモジュールが変更できるようになっています。

HTMLファイル html/index.htmlには、各例で使用される単一の canvas要素、およびコンパイルされたPureScriptコードを読み込む script要素が含まれています。各節のコードをテストするには、ブラウザでこのHTMLファイルを開いてください。

9.3 単純な図形

Example/Rectangle.pursファイルにはキャンバスの中心に青い四角形をひとつ描画するという簡単な例が含まれています。このモジュールは、 Control.Monad.Effモジュールと、Canvas APIを扱うための Effモナドのアクションが定義されている Graphics.Canvasモジュールをインポートします。

他のモジュールでも同様ですが、 mainアクションは最初に getCanvasElementByIdアクションを使ってCanvasオブジェクトへの参照を取得しています。また、 getContext2Dアクションを使ってキャンバスの2Dレンダリングコンテキストを参照しています。

main = void $ unsafePartial do
  Just canvas <- getCanvasElementById "canvas"
  ctx <- getContext2D canvas

注意:このunsafePartialの呼び出しは必須です。これは getCanvasElementByIdの結果のパターンマッチングが部分的で、Just値構築子だけと照合するためです。ここではこれで問題ありませんが、実際の製品のコードではおそらくNothing値構築子と照合させ、適切なエラーメッセージを提供したほうがよいでしょう。

これらのアクションの型は、PSCiを使うかドキュメントを見ると確認できます。

getCanvasElementById :: forall eff. String ->
  Eff (canvas :: Canvas | eff) (Maybe CanvasElement)

getContext2D :: forall eff. CanvasElement ->
  Eff (canvas :: Canvas | eff) Context2D

CanvasElementContext2DGraphics.Canvasモジュールで定義されている型です。このモジュールでは、モジュール内のすべてのアクションで使用されている Canvas作用も定義されています。

グラフィックスコンテキスト ctxは、キャンバスの状態を管理し、プリミティブな図形を描画したり、スタイルや色を設定したり、座標変換を適用するためのメソッドを提供しています。

ctxの取得に続けて、 setFillStyleアクションを使って塗りのスタイルを青一色の塗りつぶしに設定しています。

  setFillStyle "#0000FF" ctx

setFillStyleアクションがグラフィックスコンテキストを引数として取っていることに注意してください。これは Graphics.Canvasで共通のパターンです。

最後に、 fillPathアクションを使用して矩形を塗りつぶしています。 fillPathは次のような型を持っています。

fillPath :: forall eff a. Context2D ->
                          Eff (canvas :: Canvas | eff) a ->
                          Eff (canvas :: Canvas | eff) a

fillPathはグラフィックスコンテキストとレンダリングするパスを構築する別のアクションを引数にとります。パスは rectアクションを使うと構築することができます。 rectはグラフィックスコンテキストと矩形の位置及びサイズを格納するレコードを引数にとります。

  fillPath ctx $ rect ctx
    { x: 250.0
    , y: 250.0
    , w: 100.0
    , h: 100.0
    }

mainモジュールの名前としてExample.Rectangleを指定して、この長方形のコード例をビルドしましょう。

$ mkdir dist/
$ pulp build -O --main Example.Rectangle --to dist/Main.js

それでは html/index.htmlファイルを開き、このコードによってキャンバスの中央に青い四角形が描画されていることを確認してみましょう。

9.4 行多相を利用する

パスを描画する方法は他にもあります。 arc関数は円弧を描画します。 moveTo関数、 lineTo関数、 closePath関数は細かい線分を組み合わせることでパスを描画します。

Shapes.pursファイルでは長方形と円弧セグメント、三角形の、3つの図形を描画しています。

rect関数は引数としてレコードをとることを見てきました。実際には、長方形のプロパティは型同義語で定義されています。

type Rectangle = { x :: Number
                 , y :: Number
                 , w :: Number
                 , h :: Number 
                 }

xyプロパティは左上隅の位置を表しており、 whのプロパティはそれぞれ幅と高さを表しています。

arc関数に以下のような型を持つレコードを渡して呼び出すと、円弧を描画することができます。

type Arc = { x     :: Number
           , y     :: Number
           , r     :: Number
           , start :: Number
           , end   :: Number
           }

ここで、 xyプロパティは弧の中心、 rは半径、 startendは弧の両端の角度を弧度法で表しています。

たとえば、次のコードは中心 (300、300)、半径 50の円弧を塗りつぶします。

  fillPath ctx $ arc ctx
    { x      : 300.0
    , y      : 300.0
    , r      : 50.0
    , start  : Math.pi * 5.0 / 8.0
    , end    : Math.pi * 2.0
    }

Number型の xyというプロパティが Rectangleレコード型と Arcレコード型の両方に含まれていることに注意してください。どちらの場合でもこの組は点を表しています。これは、いずれのレコード型にも適用できる、行多相な関数を書くことができることを意味します。

たとえば、 Shapesモジュールでは xyのプロパティを変更し図形を並行移動する translate関数を定義されています。

translate :: forall r. Number -> Number ->
              { x :: Number, y :: Number | r } ->
              { x :: Number, y :: Number | r }
translate dx dy shape = shape
  { x = shape.x + dx
  , y = shape.y + dy
  }

この行多相型に注目してください。これは trianglexyというプロパティと、それに加えて他の任意のプロパティを持ったどんなレコードでも受け入れるということを言っています。 xフィールドと yフィールドは更新されますが、残りのフィールドは変更されません。

これはレコード更新構文の例です。 shape { ... }という式は、 shapeを元にして、括弧の中で指定されたように値が更新されたフィールドを持つ新たなレコードを作ります。波括弧の中の式はレコードリテラルのようなコロンではなく、等号でラベルと式を区切って書くことに注意してください。

Shapesの例からわかるように、 translate関数は Rectangleレコードと Arcレコード双方に対して使うことができます。

Shapeの例で描画される3つめの型は線分ごとのパスです。対応するコードは次のようになります。

  setFillStyle "#FF0000" ctx

  fillPath ctx $ do
    moveTo ctx 300.0 260.0
    lineTo ctx 260.0 340.0
    lineTo ctx 340.0 340.0
    closePath ctx

ここでは3つの関数が使われています。

このコード片を実行すると、二等辺三角形を塗りつぶされます。

mainモジュールとしてExample.Shapesを指定して、この例をビルドしましょう。

$ pulp build -O --main Example.Shapes --to dist/Main.js

そしてもう一度 html/index.htmlを開き、結果を確認してください。キャンバスに3つの異なる図形が描画されるはずです。

演習

  1. (簡単) これまでの例のそれぞれについて、 strokePath関数や setStrokeStyle関数を使ってみましょう。

  2. (簡単) 関数の引数の内部でdo記法ブロックを使うと、 fillPath関数と strokePath関数で共通のスタイルを持つ複雑なパスを描画することができます。同じ fillPath呼び出しで隣り合った2つの矩形を描画するように、 Rectangleのコード例を変更してみてください。線分と円弧を組み合わせてを、円の扇形を描画してみてください。

  3. (やや難しい) 次のような2次元の点を表すレコードが与えられたとします。

    type Point = { x :: Number, y :: Number }
    

    多数の点からなる閉じたパスを描く関数 renderPath書いてください。

    renderPath :: forall eff. Context2D -> Array Point -> 
                                           Eff (canvas :: Canvas | eff) Unit
    

    次のような関数を考えます。

    f :: Number -> Point
    

    この関数は引数として 1から 0の間の Numberをとり、 Pointを返します。 renderPath関数を利用して関数 fのグラフを描くアクションを書いてください。そのアクションは有限個の点を fからサンプリングすることによって近似しなければなりません。

    関数 fを変更し、異なるパスが描画されることを確かめてください。

9.5 無作為に円を描く

Example/Random.pursファイルには2種類の異なる副作用が混在した Effモナドを使う例が含まれています。この例では無作為に生成された円をキャンバスに100個描画します。

mainアクションはこれまでのようにグラフィックスコンテキストへの参照を取得し、ストロークと塗りつぶしスタイルを設定します。

  setFillStyle "#FF0000" ctx
  setStrokeStyle "#000000" ctx

次のコードでは forEアクションを使って 0から 100までの整数について繰り返しをしています。

  for_ (1 .. 100) \_ -> do

これらの数は 0から 1の間に無作為に分布しており、それぞれ x座標、 y座標、半径 rを表しています。

    x <- random
    y <- random
    r <- random

次のコードでこれらの変数に基づいて Arcを作成し、最後に現在のスタイルに従って円弧の塗りつぶしと線描が行われます。

    let path = arc ctx
         { x     : x * 600.0
         , y     : y * 600.0
         , r     : r * 50.0
         , start : 0.0
         , end   : Math.pi * 2.0
         }
    fillPath ctx path
    strokePath ctx path

forEに渡された関数が正しい型を持つようにするため、最後の行は必要であることに注意してください。

mainモジュールとしてExample.Randomを指定して、この例をビルドしましょう。

$ pulp build -O --main Example.Random --to dist/Main.js

html/index.htmlを開いて、結果を確認してみましょう。

9.6 座標変換

キャンバスは簡単な図形を描画するだけのものではありません。キャンバスは変換行列を扱うことができ、図形は描画の前に形状を変形してから描画されます。図形は平行移動、回転、拡大縮小、および斜め変形することができます。

purescript-canvasライブラリではこれらの変換を以下の関数で提供しています。

translate :: forall eff. TranslateTransform -> Context2D
                                            -> Eff (canvas :: Canvas | eff) Context2D
rotate    :: forall eff. Number             -> Context2D
                                            -> Eff (canvas :: Canvas | eff) Context2D
scale     :: forall eff. ScaleTransform     -> Context2D
                                            -> Eff (canvas :: Canvas | eff) Context2D
transform :: forall eff. Transform          -> Context2D
                                            -> Eff (canvas :: Canvas | eff) Context2D

translateアクションは TranslateTransformレコードのプロパティで指定した大きさだけ平行移動を行います。

rotateアクションは最初の引数で指定されたラジアンの値に応じて原点を中心とした回転を行います。

scaleアクションは原点を中心として拡大縮小します。 ScaleTransformレコードは X軸と y軸に沿った拡大率を指定するのに使います。

最後の transformはこの4つのうちで最も一般的なアクションです。このアクションは行列に従ってアフィン変換を行います。

これらのアクションが呼び出された後に描画される図形は、自動的に適切な座標変換が適用されます。

実際には、これらの関数のそれぞれの作用は、コンテキストの現在の変換行列に対して変換行列を右から乗算していきます。つまり、もしある作用の変換をしていくと、その作用は実際には逆順に適用されていきます。次のような座標変換のアクションを考えてみましょう。

transformations ctx = do
  translate { translateX: 10.0, translateY: 10.0 } ctx
  scale { scaleX: 2.0, scaleY: 2.0 } ctx
  rotate (Math.pi / 2.0) ctx

  renderScene

このアクションの作用では、まずシーンが回転され、それから拡大縮小され、最後に平行移動されます。

9.7 コンテキストの保存

一般的な使い方としては、変換を適用してシーンの一部をレンダリングし、それからその変換を元に戻します。

Canvas APIにはキャンバスの状態のスタックを操作する saverestoreメソッドが備わっています。 purescript-canvasではこの機能を次のような関数でラップしています。

save    :: forall eff. Context2D -> Eff (canvas :: Canvas | eff) Context2D
restore :: forall eff. Context2D -> Eff (canvas :: Canvas | eff) Context2D

saveアクションは現在のコンテキストの状態(現在の変換行列や描画スタイル)をスタックにプッシュし、 restoreアクションはスタックの一番上の状態をポップし、コンテキストの状態を復元します。

これらのアクションにより、現在の状態を保存し、いろいろなスタイルや変換を適用し、プリミティブを描画し、最後に元の変換と状態を復元することが可能になります。例えば、次の関数はいくつかのキャンバスアクションを実行しますが、その前に回転を適用し、そのあとに変換を復元します。

rotated ctx render = do
  save ctx
  rotate Math.pi ctx
  render
  restore ctx

こういったよくある使いかたの高階関数を利用した抽象化として、 purescript-canvasライブラリでは元のコンテキスト状態を維持しながらいくつかのキャンバスアクションを実行する withContext関数が提供されています。

withContext :: forall eff a. Context2D -> 
                             Eff (canvas :: Canvas | eff) a ->
                             Eff (canvas :: Canvas | eff) a          

withContextを使うと、先ほどの rotated関数を次のように書き換えることができます。

rotated ctx render = withContext ctx do
    rotate Math.pi ctx
    render

9.8 大域的な変更可能状態

この節では purescript-refsパッケージを使って Effモナドの別の作用について実演してみます。

Control.Monad.Eff.Refモジュールでは大域的に変更可能な参照のための型構築子、および関連する作用を提供します。

> import Control.Monad.Eff.Ref

> :kind Ref
Type -> Type

> :kind REF
Control.Monad.Eff.Effect

RefVal aの値は型 a値を保持する変更可能な領域への参照で、前の章で見た STRef h aによく似ています。その違いは、 ST作用は runSTを用いて除去することができますが、 Ref作用はハンドラを提供しないということです。 STは安全に局所的な状態変更を追跡するために使用されますが、 Refは大域的な状態変更を追跡するために使用されます。そのため、 Refは慎重に使用する必要があります。

Example/Refs.pursファイルには canvas要素上のマウスクリックを追跡するのに Ref作用を使用する例が含まれています。

このコー​​ドでは最初に newRefアクションを使って値 0で初期化された領域への新しい参照を作成しています。

  clickCount <- newRef 0

クリックイベントハンドラの内部では、 modifyRefアクションを使用してクリック数を更新しています。

    modifyRef clickCount (\count -> count + 1)

readRefアクションは新しいクリック数を読み取るために使われています。

    count <- readRef clickCount

render関数では、クリック数に応じて変換を矩形に適用しています。

    withContext ctx do
      let scaleX = Math.sin (toNumber count * Math.pi / 4.0) + 1.5
      let scaleY = Math.sin (toNumber count * Math.pi / 6.0) + 1.5

      translate { translateX: 300.0, translateY:  300.0 } ctx
      rotate (toNumber count * Math.pi / 18.0) ctx
      scale { scaleX: scaleX, scaleY: scaleY } ctx
      translate { translateX: -100.0, translateY: -100.0 } ctx

      fillPath ctx $ rect ctx
        { x: 0.0
        , y: 0.0
        , w: 200.0
        , h: 200.0
        }

このアクションでは元の変換を維持するために withContextを使用しており、それから続く変換を順に適用しています(変換が下から上に適用されることを思い出してください)。

このコード例をビルドしてみましょう。

$ pulp build -O --main Example.Refs --to dist/Main.js

html/index.htmlファイルを開いてみましょう。何度かキャンバスをクリックすると、キャンバスの中心の周りを回転する緑の四角形が表示されるはずです。

演習

  1. (簡単) パスの線描と塗りつぶしを同時に行う高階関数を書いてください。その関数を使用して Random.purs例を書きなおしてください。

  2. (やや難しい)Random作用と DOM作用を使用して、マウスがクリックされたときにキャンバスに無作為な位置、色、半径の円を描画するアプリケーションを作成してください。

  3. (やや難しい) シーンを指定された座標を中心に回転する関数を書いてください。ヒント:最初にシーンを原点まで平行移動しましょう。

9.9 L-Systems

この章の最後の例として、 purescript-canvasパッケージを使用してL-systems(Lindenmayer systems)を描画する関数を記述します。

L-Systemsはアルファベット、つまり初期状態となるアルファベットの文字列と、生成規則の集合で定義されています。各生成規則は、アルファベットの文字をとり、それを置き換える文字の配列を返します。この処理は文字の初期配列から始まり、複数回繰り返されます。

もしアルファベットの各文字がキャンバス上で実行される命令と対応付けられていれば、その指示に順番に従うことでL-Systemsを描画することができます。

たとえば、アルファベットが文字 L(左回転)、 R(右回転)、 F(前進)で構成されていたとします。また、次のような生成規則を定義します。

L -> L
R -> R
F -> FLFRRFLF

配列 "FRRFRRFRR" から始めて処理を繰り返すと、次のような経過を辿ります。

FRRFRRFRR
FLFRRFLFRRFLFRRFLFRRFLFRRFLFRR
FLFRRFLFLFLFRRFLFRRFLFRRFLFLFLFRRFLFRRFLFRRFLF...

この命令群に対応する線分パスをプロットすると、コッホ曲線と呼ばれる曲線に近似します。反復回数を増やすと、曲線の解像度が増加していきます。

それでは型と関数の言語へとこれを翻訳してみましょう。

アルファベットの選択肢は型の選択肢によって表すことができます。今回の例では、以下のような型で定義することができます。

data Alphabet = L | R | F

このデータ型では、アルファベットの文字ごとに1つづつデータ構築子が定義されています。

文字の初期配列はどのように表したらいいでしょうか。単なるアルファベットの配列でいいでしょう。これを Sentenceと呼ぶことにします。

type Sentence = Array Alphabet

initial :: Sentence
initial = [F, R, R, F, R, R, F, R, R]

生成規則は Alphabetから Sentenceへの関数として表すことができます。

productions :: Alphabet -> Sentence
productions L = [L]
productions R = [R]
productions F = [F, L, F, R, R, F, L, F]

これはまさに上記の仕様をそのまま書き写したものです。

これで、この形式の仕様を受け取りキャンバスに描画する関数 lsystemを実装することができます。 lsystemはどのような型を持っているべきでしょうか。この関数は初期状態 initialと生成規則 productionsのような値だけでなく、アルファベットの文字をキャンバスに描画する関数を引数に取る必要があります。

lsystemの型の最初の大まかな設計としては、次のようになるかもしれません。

forall eff. Sentence
         -> (Alphabet -> Sentence)
         -> (Alphabet -> Eff (canvas :: Canvas | eff) Unit)
         -> Int
         -> Eff (canvas :: Canvas | eff) Unit

最初の2つの引数の型は、値 initialproductionsに対応しています。

3番目の引数は、アルファベットの文字を取り、キャンバス上のいくつかのアクションを実行することによって翻訳する関数を表します。この例では、文字 Lは左回転、文字 Rで右回転、文字 Fは前進を意味します。

最後の引数は、実行したい生成規則の繰り返し回数を表す数です。

最初に気づくことは、現在の lsystem関数は Alphabet型だけで機能しますが、どんなアルファベットについても機能すべきですから、この型はもっと一般化されるべきです。それでは、量子化された型変数 aについて、 AlphabetSentenceaArray aで置き換えましょう。

forall a eff. Array a
           -> (a -> Array a)
           -> (a -> Eff (canvas :: Canvas | eff) Unit)
           -> Int
           -> Eff (canvas :: Canvas | eff) Unit

次に気付くこととしては、「左回転」と「右回転」のような命令を実装するためには、いくつかの状態を管理する必要があります。具体的に言えば、その時点でパスが向いている方向を状態として持たなければなりません。計算を通じて状態を関数に渡すように変更する必要があります。ここでも lsystem関数は状態がどんな型でも動作しなければなりませんから、型変数 sを使用してそれを表しています。

sを追加する必要があるのは3箇所で、次のようになります。

forall a s eff. Array a
             -> (a -> Array a)
             -> (s -> a -> Eff (canvas :: Canvas | eff) s)
             -> Int
             -> s
             -> Eff (canvas :: Canvas | eff) s

まず追加の引数の型として lsystemに型 sが追加されています。この引数はL-Systemの初期状態を表しています。

sは引数にも現れますが、翻訳関数(lsystemの第3引数)の返り値の型としても現れます。翻訳関数は今のところ、引数としてL-Systemの現在の状態を受け取り、返り値として更新された新しい状態を返します。

この例の場合では、次のような型を使って状態を表す型を定義することができます。

type State =
  { x :: Number
  , y :: Number
  , theta :: Number
  }

プロパティ xyはパスの現在の位置を表しており、プロパティ thetaは現在の向きを表しており、ラジアンで表された水平線に対するパスの角度です。

システムの初期状態としては次のようなものが考えられます。

initialState :: State
initialState = { x: 120.0, y: 200.0, theta: 0.0 }

それでは、 lsystem関数を実装してみます。定義はとても単純であることがわかるでしょう。

lsystemは第4引数の値(型 Number)に応じて再帰するのが良さそうです。再帰の各ステップでは、生成規則に従って状態が更新され、現在の文が変化していきます。このことを念頭に置きつつ、まずは関数の引数の名前を導入して、補助関数に処理を移譲することから始めましょう。

lsystem :: forall a s eff. Array a
        -> (a -> Array a)
        -> (s -> a -> Eff (canvas :: Canvas | eff) s)
        -> Int
        -> s
        -> Eff (canvas :: Canvas | eff) s
lsystem init prod interpret n state = go init n
  where

go関数は第2引数に応じて再帰することで動きます。 nがゼロであるときと nがゼロでないときの2つの場合で分岐します。

nがゼロの場合では再帰は完了し、解釈関数に応じて現在の文を解釈します。ここでは引数として与えられている、

を参照することができます。これらの引数の型を考えると、以前定義した foldMの呼び出しにちょうど対応していることがわかります。 foldMpurescript-controlパッケージでも定義されています。

  go s 0 = foldM interpret state s

ゼロでない場合ではどうでしょうか。その場合は、単に生成規則を現在の文のそれぞれの文字に適用して、その結果を連結し、そしてこの処理を再帰します。

  go s n = go (concatMap prod s) (n - 1)

これだけです!foldMconcatMapのような高階関数を使うと、このようにアイデアを簡潔に表現することができるのです。

しかし、まだ完全に終わったわけではありません。ここで与えた型は、実際はまだ特殊化されすぎています。この定義ではキャンバスの操作が実装のどこにも使われていないことに注目してください。それに、まったく Effモナドの構造を利用していません。実際には、この関数はどんなモナド mについても動作するのです!

この章に添付されたソースコードで定義されている、 lsystemのもっと一般的な型は次のようになっています。

lsystem :: forall a m s . Monad m =>
           Array a
        -> (a -> Array a)
        -> (s -> a -> m s)
        -> Int
        -> s
        -> m s

この型が言っているのは、この翻訳関数はモナド mで追跡される任意の副作用をまったく自由に持つことができる、ということだと理解することができます。キャンバスに描画したり、またはコンソールに情報を出力するかもしれませんし、失敗や複数の戻り値に対応しているかもしれません。こういった様々な型の副作用を使ったL-Systemを記述してみることを読者にお勧めします。

この関数は実装からデータを分離することの威力を示す良い例となっています。この手法の利点は、複数の異なる方法でデータを解釈する自由が得られることです。 lsystemは2つの小さな関数へと分解することができるかもしれません。ひとつめは concatMapの適用の繰り返しを使って文を構築するもので、ふたつめは foldMを使って文を翻訳するものです。これは読者の演習として残しておきます。

それでは翻訳関数を実装して、この章の例を完成させましょう​​。 lsystemの型は型シグネチャが言っているのは、翻訳関数の型は、何らかの型 as、型構築子 mについて、 s -> a -> m sでなければならないということです。今回は aAlphabetsState、モナド mEff (canvas :: Canvas)というように選びたいということがわかっています。これにより次のような型になります。

interpret :: State -> Alphabet -> Eff (canvas :: Canvas) State

この関数を実装するには、 Alphabet型の3つのデータ構築子それぞれについて処理する必要があります。文字 L(左回転)と R(右回転)の解釈では、 thetaを適切な角度へ変更するように状態を更新するだけです。

interpret state L = pure $ state { theta = state.theta - Math.pi / 3 }
interpret state R = pure $ state { theta = state.theta + Math.pi / 3 }

文字 F(前進)を解釈するには、パスの新しい位置を計算し、線分を描画し、状態を次のように更新します。

interpret state F = do
  let x = state.x + Math.cos state.theta * 1.5
      y = state.y + Math.sin state.theta * 1.5
  moveTo ctx state.x state.y
  lineTo ctx x y
  pure { x, y, theta: state.theta }

この章のソースコードでは、名前 ctxを参照できるようにするために、 interpret関数は main関数内で let束縛を使用して定義されていることに注意してください。 State型がコンテキストを持つように変更することは可能でしょうが、それはこのシステムの状態の変化部分ではないので不適切でしょう。

このL-Systemsを描画するには、次のような strokePathアクションを使用するだけです。

strokePath ctx $ lsystem initial productions interpret 5 initialState

L-Systemをコンパイルし、

$ pulp build -O --main Example.LSystem --to dist/Main.js

html/index.htmlを開いてみましょう。キャンバスにコッホ曲線が描画されるのがわかると思います。

演習

  1. (簡単)strokePathの代わりに fillPathを使用するように、上のL-Systemsの例を変更してください。ヒントclosePathの呼び出しを含め、 moveToの呼び出しを interpret関数の外側に移動する必要があります。

  2. (簡単) 描画システムへの影響を理解するために、コード中の様々な数値の定数を変更してみてください。

  3. (やや難しい)lsystem関数を2つの小さな関数に分割してください。ひとつめは concatMapの適用の繰り返しを使用して最終的な結果を構築するもので、ふたつめは foldMを使用して結果を解釈するものでなくてはなりません。

  4. (やや難しい)setShadowOffsetXアクション、 setShadowOffsetYアクション、 setShadowBlurアクション、 setShadowColorアクションを使い、塗りつぶされた図形にドロップシャドウを追加してください。ヒントPSCiを使って、これらの関数の型を調べてみましょう。

  5. (やや難しい) 向きを変えるときの角度の大きさは今のところ一定(pi/3)です。その代わりに、 Alphabetデータ型の中に角度の大きさを追加して、生成規則によって角度を変更できるようにしてください。

    type Angle = Number
    
    data Alphabet = L Angle | R Angle | F Angle
    

    生成規則でこの新しい情報を使うと、どんな面白い図形を作ることができるでしょうか。

  6. (難しい)L(60度左回転 )、 R(60度右回転)、 F(前進)、 M(これも前進)という4つの文字からなるアルファベットでL-Systemが与えられたとします。

    このシステムの文の初期状態は、単一の文字 Mです。

    このシステムの生成規則は次のように指定されています。

    L -> L
    R -> R
    F -> FLMLFRMRFRMRFLMLF
    M -> MRFRMLFLMLFLMRFRM
    

    このL-Systemを描画してください。注意:最後の文のサイズは反復回数に従って指数関数的に増大するので、生成規則の繰り返しの回数を削減することが必要になります。

    ここで、生成規則における LMの間の対称性に注目してください。ふたつの「前進」命令は、次のようなアルファベット型を使用すると、 Boolean値を使って区別することができます。

    data Alphabet = L | R | F Boolean
    

    このアルファベットの表現を使用して、もう一度このL-Systemを実装してください。

  7. (難しい) 翻訳関数で別のモナド mを使ってみましょう。 Trace作用を利用してコンソール上にL-Systemを出力したり、 Random作用を利用して状態の型に無作為の突然変異を適用したりしてみてください。

まとめ

この章では、 purescript-canvasライブラリを使用することにより、PureScriptからHTML5 Canvas APIを使う方法について学びました。マップや畳み込み、レコードと行多型、副作用を扱うための Effモナドなど、これまで学んできた手法を利用した実用的な例について多く見ました。

この章の例では、高階関数の威力を示すとともに、実装からのデータの分離も実演してみせました。これは例えば、代数データ型を使用してこれらの概念を次のように拡張し、描画関数からシーンの表現を完全に分離できるようになります。

data Scene = Rect Rectangle
           | Arc Arc
           | PiecewiseLinear (Array Point)
           | Transformed Transform Scene
           | Clipped Rectangle Scene
           | ...

この手法は purescript-drawingパッケージでも採用されており、描画前にさまざまな方法でデータとしてシーンを操作することができるという柔軟性をもたらしています。

次の章では、PureScriptの外部関数インタフェース(foreign function interface)を使って、既存のJavaScriptの関数をラップした purescript-canvasのようなライブラリを実装する方法について説明します。

第10章 外部関数インタフェース

10.1 この章の目標

この章では、PureScriptコードからJavaScriptコードへの呼び出し、およびその逆を可能にする、PureScriptの外部関数インタフェース(foreign function interface, FFI)を紹介します。これから扱うのは次のようなものです。

この章の終わりにかけて、再び住所録のコード例について検討します。この章の目的は、FFIを使ってアプリケーションに次のような新しい機能を追加することです。

10.2 プロジェクトの準備

このモジュールのソースコードは、第3章、第7章及び第8章の続きになります。今回もそれぞれのディレクトリから適切なソースファイルがソースファイルに含められています。

この章では、2つの新しいBower依存関係を追加します。

  1. purescript-foreign- データ型と関数を提供しています。
  2. purescript-foreign-generic- データ型ジェネリックプログラミングを操作するためのデータ型と関数を提供します。

注意:ウェブページがローカルファイルから配信されているときに起こる、ローカルストレージとブラウザ特有の問題を避けるために、この章の例を実行するには、HTTPを経由してこの章のプロジェクトを実行する必要があります。

10.3 免責事項

JavaScriptとの共同作業をできる限り簡単にするため、PureScriptは単純な多言語関数インタフェースを提供します。しかしながら、FFIはPureScriptの高度な機能であることには留意していただきたいと思います。FFIを安全かつ効率的に使用するには、扱うつもりであるデータの実行時の表現についてよく理解していなければなりません。この章では、PureScriptの標準ライブラリのコードに関連する、そのような理解を与えることを目指しています。

PureScriptのFFIはとても柔軟に設計されています。実際には、外部関数に最低限の型だけを与えるか、それとも型システムを利用して外部のコードの誤った使い方を防ぐようにするか、開発者が選ぶことができるということを意味しています。標準ライブラリのコードは、後者の手法を好む傾向にあります。

簡単な例としては、JavaScriptの関数で戻り値が nullをされないことを保証することはできません。実のところ、既存のJavaScriptコードはかなり頻繁に nullを返します!しかし、PureScriptの型は通常null値を持っていません。そのため、FFIを使ってJavaScriptコードのインターフェイスを設計するときは、これらの特殊な場合を適切に処理するのは開発者の責任です。

10.4 JavaScriptからPureScriptを呼び出す

少なくとも単純な型を持った関数については、JavaScriptからPureScript関数を呼び出すのはとても簡単です。

例として以下のような簡単なモジュールを見てみましょう。

module Test where

gcd :: Int -> Int -> Int
gcd 0 m = m
gcd n 0 = n
gcd n m
  | n > m     = gcd (n - m) m
  | otherwise = gcd (m - n) n

この関数は、減算を繰り返すことによって2つの数の最大公約数を見つけます。関数を定義するのにPureScriptを使いたくなるかもしれない良い例となっていますが、JavaScriptからそれを呼び出すためには条件があります。 PureScriptでパターン照合と再帰を使用してこの関数を定義するのは簡単で、実装する開発者は型検証器の恩恵を受けることができます。

この関数をJavaScriptから呼び出す方法を理解するには、PureScriptの関数は常に引数がひとつのJavaScript関数へと変換され、引数へは次のようにひとつづつ適用していかなければならないことを理解するのが重要です。

var Test = require('Test');
Test.gcd(15)(20);

ここでは、コードがPureScriptモジュールをCommonJSモジュールにコンパイルする pulp buildでコンパイルされていると仮定しています。 そのため、 requireを使って Testモジュールをインポートした後、 Testオブジェクトの gcd関数を参照することができました。

pulp build -O --to file.jsを使用して、ブラウザ用のJavaScriptコードをバンドルすることもできます。 その場合、グローバルなPureScript名前空間から Testモジュールにアクセスします。デフォルトは PSです。

var Test = PS.Test;
Test.gcd(15)(20);

10.5 名前の生成を理解する

PureScriptはコード生成時にできるだけ名前を保存することを目的としています。具体的には、トップレベルでの宣言では、JavaScriptのキーワードでなければ任意の識別子が保存されます。

識別子としてJavaScriptの予約語を使う場合は、名前はダブルダラー記号でエスケープされます。たとえば、次のPureScriptコードを考えてみます。

null = []

これは以下のようなJavaScriptへコンパイルされます。

var $$null = [];

また、識別子に特殊文字を使用したい場合は、単一のドル記号を使用してエスケープされます。たとえば、このPureScriptコードを考えます。

example' = 100

これは以下のJavaScriptにコンパイルされます。

var example$prime = 100;

この方式は、ユーザー定義の中置演算子の名前を生成するためにも使用されます。

(%) a b = ...

これは次のようにコンパイルされます。

var $percent = ...

コンパイルされたPureScriptコードがJavaScriptから呼び出されることを意図している場合、識別子は英数字のみを使用し、JavaScriptの予約語を避けることをお勧めします。ユーザ定義演算子がPureScriptコードでの使用のために提供される場合でも、JavaScriptから使うための英数字の名前を持った代替関数を提供しておくことをお勧めします。

10.6 実行時のデータ表現

型はプログラムがある意味で「正しい」ことをコンパイル時に判断できるようにします。つまり、実行時には中断されません。しかし、これは何を意味するのでしょうか?PureScriptでは式の型は実行時の表現と互換性がなければならないことを意味します。

そのため、PureScriptとJavaScriptコードを一緒に効率的に使用できるように、実行時のデータ表現について理解することが重要です。これは、与えられた任意のPureScriptの式について、その値が実行時にどのように評価されるかという挙動を理解できるべきであることを意味しています。

PureScriptの式は、実行時に特に単純な表現を持っているということは朗報です。実際に標準ライブラリのコードについて、その型を考慮すれば式の実行時のデータ表現を把握することが可能です。

単純な型については、対応関係はほとんど自明です。たとえば、式が型 Booleanを持っていれば、実行時のその値 vtypeof v === 'boolean'を満たします。つまり、型 Booleanの式は trueもしくは falseのどちらか一方の(JavaScriptの)値へと評価されます。実のところ、 nullundefinedに評価される、型 BooleanのPureScriptの式はありません。

NumberStringの型の式についても同様のことが成り立ちます。 Number型の式は nullでないJavaScriptの数へと評価されますし、 String型の式は nullでないJavaScriptの文字列へと評価されます。

もっと複雑な型についてはどうでしょうか?

すでに見てきたように、PureScriptの関数は引数がひとつのJavaScriptの関数に対応しています。厳密に言えば、任意の型 abについて、式 fの型が a -> bで、式 xが型 aについての適切な実行時表現の値へと評価されるなら、 fはJavaScriptの関数へと評価され、 xを評価した結果に fを適用すると、それは型 bの適切な実行時表現を持ちます。簡単な例としては、 String -> String型の式は、 nullでないJavaScript文字列から nullでないJavaScript文字列への関数へと評価されます。

ご想像のとおり、PureScriptの配列はJavaScriptの配列に対応しています。しかし、PureScriptの配列は均質であり、つまりすべての要素が同じ型を持っていることは覚えておいてください。具体的には、もしPureScriptの式 eが任意の型 aについて型 Array aを持っているなら、 eはすべての要素が型 aの適切な実行時表現を持った(nullでない)JavaScript配列へと評価されます。

PureScriptのレコードがJavaScriptのオブジェクトへと評価されることはすでに見てきました。ちょうど関数と配列の場合のように、そのラベルに関連付けられている型を考慮すれば、レコードのフィールドのデータの実行時の表現についても推論することができます。もちろん、レコードのそれぞれのフィールドは、同じ型である必要はありません。

10.7 代数的データ型の実行時表現

PureScriptコンパイラは、代数的データ型のすべての構築子についてそれぞれ関数を定義し、新たなJavaScriptオブジェクト型を作成します。これらの構築子はこれらのプロトタイプに基づいて新しいJavaScriptオブジェクトを作成する関数に対応しています。

たとえば、次のような単純な代数的データ型を考えてみましょう。

data ZeroOrOne a = Zero | One a

PureScriptコンパイラは、次のようなコードを生成します。

function One(value0) {
    this.value0 = value0;
};

One.create = function (value0) {
    return new One(value0);
};

function Zero() {
};

Zero.value = new Zero();

ここで2つのJavaScriptオブジェクト型 ZeroOneを見てください。JavaScriptの予約語 newを使用すると、それぞれの型の値を作成することができます。引数を持つ構築子については、コンパイラは value0value1などと呼ばれるフィールドに対応するデータを格納します。

PureScriptコンパイラは補助関数も生成します。引数のない構築子については、コンパイラは構築子が使われるたびに new演算子を使うのではなく、データを再利用できるように valueプロパティを生成します。ひとつ以上の引数を持つ構築子では、適切な表現を持つ引数を取り適切な構築子を適用する create関数をコンパイラは生成します。

2引数以上の構築子についてはどうでしょうか?その場合でも、PureScriptコンパイラは新しいオブジェクト型と補助関数を作成します。しかし今回は、補助関数は2引数のカリー化された関数です。たとえば、次のような代数的データ型を考えます。

data Two a b = Two a b

このコードからは、次のようなJavaScriptコードを生成されます。

function Two(value0, value1) {
    this.value0 = value0;
    this.value1 = value1;
};

Two.create = function (value0) {
    return function (value1) {
        return new Two(value0, value1);
    };
};

ここで、オブジェクト型 Twoの値は予約語 newまたは Two.create関数を使用すると作成することができます。

newtypeの場合はまた少し異なります。newtypeは単一の引数を取る単一の構築子を持つよう制限された代数的データ型であることを思い出してください。この場合には、実際はnewtypeの実行時表現は、その引数の型と同じになります。

例えば、電話番号を表す次のようなnewtypeを考えます。

newtype PhoneNumber = PhoneNumber String

これは実行時にはJavaScriptの文字列として表されます。newtypeは型安全性の追加の層を提供しますが、実行時の関数呼び出しのオーバーヘッドがないので、ライブラリを設計するのに役に立ちます。

10.8 量化された型の実行時表現

量化された型(多相型)の式は、制限された表現を実行時に持っています。実際には、量化された型の式が比較的少数与えられたとき、とても効率的に解決できることを意味しています。

例えば、次の多相型を考えてみます。

forall a. a -> a

この型を持っている関数にはどんなものがあるでしょうか。少なくともひとつはこの型を持つ関数が存在しています。すなわち、 Preludeで定義されている恒等関数 idです。

id :: forall a. a -> a
id a = a

実のところ、 idの関数はこの型の唯一の(全)関数です!これは確かに間違いなさそうに見えますが(この型を持った idとは明らかに異なる式を書こうとしてみてください)、これを確かめるにはどうしたらいいでしょうか。これは型の実行時表現を考えることによって確認することができます。

量化された型 forall a. tの実行時表現はどうなっているのでしょうか。さて、この型の実行時表現を持つ任意の式は、型 aをどのように選んでも型 tの適切な実行時表現を持っていなければなりません。上の例では、型 forall a. a -> aの関数は、 String -> StringNumber -> NumberArray Boolean -> Array Booleanなどといった型について、適切な実行時表現を持っていなければなりません。 これらは、数から数、文字列から文字列の関数でなくてはなりません。

しかし、それだけでは十分ではありません。量化された型の実行時表現は、これよりも更に厳しくなります。任意の式がパラメトリック多相的でなければなりません。つまり、その実装において、引数の型についてのどんな情報も使うことができないのです。この追加の条件は、考えられる多相型のうち、次のようなJavaScriptの関数として問題のある実装を禁止します。

function invalid(a) {
    if (typeof a === 'string') {
        return "Argument was a string.";
    } else {
        return a;
    }
}

確かにこの関数は文字列から文字列、数から数へというような関数ではありますが、追加の条件を満たしていません。引数の実行時の型を調べているからです。したがって、この関数は型 forall a. a -> aの正しい実装だとはいえないのです。

関数の引数の実行時の型を検査することができなければ、唯一の選択肢は引数をそのまま返すことだけであり、したがって idは、 forall a. a -> aのまったく唯一の実装なのです。

パラメトリック多相(parametric polymorphism)とパラメトリック性(parametricity)についての詳しい議論は本書の範囲を超えています。しかしながら、PureScriptの型は、実行時に消去されているので、PureScriptの多相関数は(FFIを使わない限り)引数の実行時表現を検査することができないし、この多相的なデータの表現は適切であることに注意してください。

10.9 制約された型の実行時表現

型クラス制約を持つ関数は、実行時に面白い表現を持っています。関数の振る舞いはコンパイラによって選ばれた型クラスのインスタンスに依存する可能性があるため、関数には選択したインスタンスから提供された型クラスの関数の実装が含まれてた型クラス辞書(type class dictionary)と呼ばれる追加の引数が与えられています。

例えば、 Show型クラスを使用している制約された型を持つ、次のような単純なPureScript関数について考えます。

shout :: forall a. Show a => a -> String
shout a = show a <> "!!!"

このコードから生成されるJavaScriptは次のようになります。

var shout = function (dict) {
    return function (a) {
        return show(dict)(a) + "!!!";
    };
};

shoutは1引数ではなく、2引数の(カリー化された)関数にコンパイルされていることに注意してください。最初の引数 dictShow制約の型クラス辞書です。 dictには型 ashow関数の実装が含まれています。

最初の引数として明示的にPreludeの型クラス辞書を渡すと、JavaScriptからこの関数を呼び出すことができます。

shout(require('Prelude').showNumber)(42);

演習

  1. (簡単) これらの型の実行時の表現は何でしょうか。

    forall a. a
    forall a. a -> a -> a
    forall a. Ord a => Array a -> Boolean
    

    これらの型を持つ式についてわかることはなんでしょうか。

  2. (やや難しい)pulp buildを使ってコンパイルし、NodeJSの require関数を使ってモジュールをインポートすることで、JavaScriptから purescript-arraysライブラリの関数を使ってみてください。ヒント:生成されたCommonJSモジュールがNodeJSモジュールのパスで使用できるように、出力パスを設定する必要があります。

10.10 PureScriptからのJavaScriptコードを使う

PureScriptからJavaScriptコードを使用する最も簡単な方法は、外部インポート宣言(foreign import declaration)を使用し、既存のJavaScriptの値に型を与えることです。外部インポート宣言では、対応するJavaScriptの宣言を外部JavaScriptモジュール(foreign JavaScript module)に持つ必要があります。

たとえば、特殊文字をエスケープすることによりURIのコンポーネントを符号化するJavaScriptの encodeURIComponent関数について考えてみます。

$ node

node> encodeURIComponent('Hello World')
'Hello%20World'

nullでない文字列から nullでない文字列への関数であり、副作用を持っていないので、この関数はその型 String -> Stringについて適切な実行時表現を持っています。

次のような外部インポート宣言を使うと、この関数に型を割り当てることができます。

module Data.URI where

foreign import encodeURIComponent :: String -> String

また、外部JavaScriptモジュールを書く必要があります。上記のモジュールをsrc/Data/URI.pursとして保存した場合、次のような外部JavaScriptモジュールをsrc/Data/URI.jsとして保存します。

"use strict";

exports.encodeURIComponent = encodeURIComponent;

Pulpはsrcディレクトリにある.jsファイルを見つけ、それを外部JavaScriptモジュールとしてコンパイラに提供します。

JavaScriptの関数と値は、通常のCommonJSモジュールと同じようにexportsオブジェクトに代入することで、外部JavaScriptモジュールからエクスポートされます。pursコンパイラは、このモジュールを通常のCommonJSモジュールのように扱い、コンパイルされたPureScriptモジュールへの依存関係として追加します。しかし、psc-bundlepulp build -O --toを使ってブラウザ向けのコードをバンドルするときは、上記のパターンに従い、プロパティ代入を使ってexportsオブジェクトにエクスポートする値を代入することがとても重要です。 これは、psc-bundleがこの形式を認識し、未使用のJavaScriptのエクスポートをバンドルされたコードから削除できるようにするためです。

これら2つの部品を使うことで、PureScriptで書かれた関数のように、PureScriptからencodeURIComponent関数を使うことができます。たとえば、この宣言をモジュールとして保存してPSCiにロードすると、上記の計算を再現できます。

$ pulp repl

> import Data.URI
> encodeURIComponent "Hello World"
"Hello%20World"

この手法は簡単なJav​​aScriptの値には適していますが、もっと複雑な値に使うには限界があります。ほとんどの既存のJavaScriptコードは、基本的なPureScriptの型の実行時表現によって課せられた厳しい条件を満たしていないからです。このような場合のためには、適切な実行時表現に従うことを強制するようにJavaScriptコードをラップするという別の方法があります。

10.11 JavaScriptの値のラッピング

これはPureScriptの型を与えるためにJavaScriptコードの既存の部分をラップする場合に特に便利です。このようにしたくなる理由はいくつかあります。

外部インポート宣言を使用して、配列についての head関数を作成したいとしましょう。JavaScriptでは次のような関数になるでしょう。

function head(arr) {
    return arr[0];
}

しかし、この関数には問題があります。型 forall a. Array a -> aを与えようとしても、空の配列に対してこの関数は undefinedを返します。したがって、この特殊な場合を処理するために、ラッパー関数を使用する必要があります。

簡単な方法としては、空の配列の場合に例外を投げる方法があります。厳密に言えば、純粋な関数は例外を投げるべきではありませんが、デモンストレーションの目的ではこれで十分ですし、安全性でないということを関数名で示しておけばいいでしょう。

foreign import unsafeHead :: forall a. Array a -> a

JavaScriptモジュールでは、 unsafeHeadを以下のように定義することができます。

exports.unsafeHead = function(arr) {
  if (arr.length) {
    return arr[0];
  } else {
    throw new Error('unsafeHead: empty array');
  }
};

10.12 外部型の定義

失敗した場合に例外を投げるという方法は、あまり理想的とはいえません。PureScriptのコードでは、欠けた値のような副作用は型システムを使って扱うのが普通です。この手法としては Maybe型構築子を使う方法もありますが、この節ではFFIを使用した別の解決策を扱います。

実行時には型 aのように表現されますが undefinedの値も許容するような新しい型 Undefined aを定義したいとしましょう。

外部インポート宣言とFFIを使うと、外部型(foreign type)を定義することができます。構文は外部関数を定義するのと似ています。

foreign import data Undefined :: Type -> Type

この予約語 dataは値ではなく定義している型を表していることに注意してください。型シグネチャの代わりに、新しい型のを与えます。このとき、種 UndefinedType -> Typeであると宣言しています。つまり Undefinedは型構築子です。

これで headの定義を簡素化することができます。

exports.head = function(arr) {
  return arr[0];
};

PureScriptモジュールには以下を追加します。

foreign import head :: forall a. Array a -> Undefined a

2点変更がある注意してください。 head関数の本体ははるかに簡単で、もしその値が未定義であったとしても arr[0]を返し、型シグネチャはこの関数が未定義の値を返すことがあるという事実を反映するよう変更されています。

この関数はその型の適切な実行時表現を持っていますが、型 Undefined aの値を使用する方法がありませんので、まったく役に立ちません。しかし、FFIを使用して新しい関数を幾つか書くことによって、それを修正することができます!

次の関数は、値が定義されているかどうかを教えてくれる最も基本的な関数です。

foreign import isUndefined :: forall a. Undefined a -> Boolean

JavaScriptモジュールで次のように簡単に定義できます。

exports.isUndefined = function(value) {
  return value === undefined;
};

PureScriptから isUndefinedheadを一緒に使用すると、便利な関数を定義することができます。

isEmpty :: forall a. Array a -> Boolean
isEmpty = isUndefined <<< head

ここで、定義されたこの外部関数はとても簡単であり、PureScriptの型検査器を使うことによる利益をなるべく多く得るということを意味します。一般に外部関数は可能な限り小さく保ち、アプリケーションの処理はPureScriptコードへ移動しておくことをおすすめします。

10.13 多変数​関数

PureScriptのPreludeには、興味深い外部型がいくつかも含まれています。すでに扱ってきたように、PureScriptの関数型は単一の引数だけを取りますが、カリー化(Currying)を使うと複数の引数の関数をシミュレートすることができます。これには明らかな利点があります。関数を部分適用することができ、関数型の型クラスインスタンスを与えることができます。ただし、効率上のペナルティが生じます。パフォーマンス重視するコードでは、複数の引数を受け入れる本物のJavaScript関数を定義することが必要な場合があります。Preludeではそのような関数を安全に扱うことができるようにする外部型が定義されています。

たとえば、Preludeの Data.Function.Uncurriedモジュールには次の外部型宣言があります。

foreign import data Fn2 :: Type -> Type -> Type -> Type

これは3つの型引数を取る型構築子 Fn2を定義します。 Fn2 a b cは、型 abの2つの引数、返り値の型 cをもつJavaScript関数の型を表現しています。

Preludeでは0引数から10引数までの関数について同様の型構築子が定義されています。

次のように mkFn2関数を使うと、2引数の関数を作成することができます。

import Data.Function.Uncurried

divides :: Fn2 Int Int Boolean
divides = mkFn2 \n m -> m % n == 0

そして、 runFn2関数を使うと、2引数の関数を適用することができます。

> runFn2 divides 2 10
true

> runFn2 divides 3 10
false

ここで重要なのは、引数がすべて適用されるなら、コンパイラは mkFn2関数や runFn2関数をインライン化するということです。そのため、生成されるコードはとてもコンパクトになります。

exports.divides = function(n, m) {
    return m % n === 0;
};

10.14 副作用の表現

EffモナドもPreludeの外部型として定義されています。その実行時表現はとても簡単です。型 Eff eff aの式は、任意の副作用を実行し型 aの適切な実行時表現で値を返す、引数なしのJavaScript関数へと評価されます。

Eff型の構築子の定義は、 Control.Monad.Effモジュールで次のように与えられています。

foreign import data Eff :: # Effect -> Type -> Type

Eff型の構築子は作用の行と返り値の型によってパラメータ化されおり、それが種に反映されることを思い出してください。

簡単な例として、 purescript-randomパッケージで定義される random関数を考えてみてください。その型は次のようなものでした。

foreign import random :: forall eff. Eff (random :: RANDOM | eff) Number

random関数の定義は次のように与えられます。

exports.random = function() {
  return Math.random();
};

random関数は実行時には引数なしの関数として表現されていることに注目してください。これは乱数生成という副作用を実行しそれを返しますが、返り値は Number型の実行時表現と一致します。それは nullでないJavaScriptの数です。

もう少し興味深い例として、 Preludeの Control.Monad.Eff.Consoleモジュールで定義された log関数を考えてみましょう。 log関数は次の型を持っています。

foreign import log :: forall eff. String -> Eff (console :: CONSOLE | eff) Unit

この定義は次のようになっています。

exports.log = function (s) {
  return function () {
    console.log(s);
  };
};

実行時の logの表現は、引数なしの関数を返す、単一の引数のJavaScript関数です。内側の関数はコンソールにメッセージを書き込むという副作用を実行し、空のレコードを返します。 Unitは空のレコード型のnewtypeとしてPreludeで定義されているので、内側の関数の戻り値の型は Unit型の実行時表現と一致していることに注意してください。

作用 RANDOMCONSOLEも外部型として定義されています。その種は !、つまり作用であると定義されています。例えば次のようになります。

foreign import data RANDOM :: Effect

詳しくはあとで見ていきますが、このように新たな作用を定義することが可能なのです。

Eff eff a型の式は、通常のJavaScriptのメソッドのようにJavaScriptから呼び出すことができます。例えば、この main関数は作用の集合 effと何らかの型 aについて Eff eff aという型でなければならないので、次のように実行することができます。

require('Main').main();

pulp build -O --toまたは pulp runを使用するときは、 mainモジュールが定義されていると、この mainの呼び出しを自動的に生成することができます。

10.15 新しい作用の定義

この章のソースコードでは、2つの新しい作用が定義されています。最も簡単なのは Control.Monad.Eff.Alertモジュールで定義された ALERT作用です。これはその計算がポップアップウィンドウを使用してユーザに警告しうることを示すために使われます。

この作用は最初に外部型宣言を使用して定義されています。

foreign import data ALERT :: Effect

Alertは種 Effectが与えられており、 Alertが型ではなく作用であることを示しています。

次に、 alertアクションが定義されています。 alertアクションはポップアップを表示し、作用の行に Alert作用を追加します。

foreign import alert :: forall eff. String -> Eff (alert :: ALERT | eff) Unit

JavaScriptモジュールは簡単で、 alert関数を exports変数に代入して定義します。

"use strict";

exports.alert = function(msg) {
    return function() {
        window.alert(msg);
    };
};

このアクションは Control.Monad.Eff.Consoleモジュールの logアクションととてもよく似ています。唯一の違いは、 logアクションが console.logメソッドを使用しているのに対し、 alertアクションは window.alertメソッドを使用していることです。このように、 alertwindow.alertが定義されているウェブブラウザのような環境で使用することができます。

logの場合のように、 alert関数は型 Eff (alert :: ALERT | eff) Unitの計算を表現するために引数なしの関数を使っていることに注意してください。

この章で定義される2つめの作用は、 Control.Monad.Eff.Storageモジュールで定義されている STORAGE作用です。これは計算がWeb Storage APIを使用して値を読み書きする可能性があることを示すために使われます。

この作用も同じように定義されています。

foreign import data STORAGE :: Effect

Control.Monad.Eff.Storageモジュールには、ローカルストレージから値を取得する getItemと、ローカルストレージに値を挿入したり値を更新する setItemという、2つのアクションが定義されています。この二つの関数は、次のような型を持っています。

foreign import getItem :: forall eff . String
  -> Eff (storage :: STORAGE | eff) Foreign
foreign import setItem :: forall eff . String
  -> String -> Eff (storage :: STORAGE | eff) Unit

興味のある読者は、このモジュールのソースコードでこれらのアクションがどのように定義されているか調べてみてください。

setItemはキーと値(両方とも文字列)を受け取り、指定されたキーでローカルストレージに値を格納する計算を返します。

getItemの型はもっと興味深いものです。 getItemはキーを引数に取り、キーに関連付けられた値をローカルストレージから取得しようとします。 window.localStoragegetItemメソッドは nullを返すことがあるので、返り値は Stringではなく、 purescript-foreignパッケージの Data.Foreignモジュールで定義されている Foreignになっています。

Data.Foreignは、型付けされていないデータ、もっと一般的にいえば実行時表現が不明なデータを扱う方法を提供しています。

演習

  1. (やや難しい) JavaScriptの Windowオブジェクトの confirmメソッドのラッパを書き、 Control.Monad.Eff.Alertモジュールにその関数を追加してください。

  2. (やや難しい)localStorageオブジェクトの removeItemメソッドのラッパを書き、 Control.Monad.Eff.Storageモジュールに追加してください

10.16 型付けされていないデータの操作

この節では、型付けされていないデータを、その型の適切な実行時表現を持った型付けされたデータに変換する、 Data.Foreignライブラリの使い方について見て行きます。

この章のコードは、第8章の住所録の上にフォームの一番下に保存ボタンを追加することで作っていきます。保存ボタンがクリックされると、フォームの状態をJSONに直列化し、ローカルストレージに格納します。ページが再読み込みされると、JSON文書がローカルストレージから取得され、構文解析されます。

Mainモジュールではフォームデータの型を定義します。

newtype FormData = FormData
  { firstName  :: String
  , lastName   :: String
  , street     :: String
  , city       :: String
  , state      :: String
  , homePhone  :: String
  , cellPhone  :: String
  }

問題は、このJSONが正しい形式を持っているという保証がないことです。別の言い方をすれば、JSONが実行時にデータの正しい型を表しているかはわかりません。この問題は purescript-foreignライブラリによって解決することができます。他にも次のような使いかたがあります。

それでは、 PSCipurescript-foreign及び purescript-foreign-genericライブラリを試してみましょう。

二つのモジュールをインポートして起動します。

> import Data.Foreign
> import Data.Foreign.Generic
> import Data.Foreign.JSON

Foreignな値を取得するためには、JSON文書を解析するのがいいでしょう。 purescript-foreignでは次の2つの関数が定義されています。

parseJSON :: String -> F Foreign
decodeJSON :: forall a. Decode a => String -> F a

型構築子Fは、実際にはData.Foreignで定義されている型同義語です。

type F = Except (NonEmptyList ForeignError)

ここでExceptは、Eitherのように、純粋なコードで例外を処理するためのモナドです。runExcept関数を使うと、Fモナドの値をEitherモナドの値に変換することができます。

この Decode型クラスは、それらの型が型付けされていないデータから得られることを表しています。プリミティブ型や配列については型クラスインスタンスがすでに定義されていますが、独自のインスタンスを定義することもできます。

それでは PSCireadJSONを使用していくつかの簡単なJSON文書を解析してみましょう。

> import Control.Monad.Except

> runExcept (decodeJSON "\"Testing\"" :: F String)
Right "Testing"

> runExcept (decodeJSON "true" :: F Boolean)
Right true

> runExcept (decodeJSON "[1, 2, 3]" :: F (Array Int))
Right [1, 2, 3]

Eitherモナドでは Rightデータ構築子は成功を示していることを思い出してください。しかし、その不正なJSONや誤った型はエラーを引き起こすことに注意してください。

> runExcept (decodeJSON "[1, 2, true]" :: F (Array Int))
(Left (NonEmptyList (NonEmpty (ErrorAtIndex 2 (TypeMismatch "Int" "Boolean")) Nil)))

purescript-foreign-genericライブラリはJSON文書で型エラーが発生した位置を教えてくれます。

10.17 nullとundefined値の取り扱い

実世界のJSON文書にはnullやundefined値が含まれているので、それらも扱えるようにしなければなりません。

purescript-foreign-genericでは、この問題を解決する3種類の構築子、 NullUndefinedNullOrUndefinedが定義されています。先に定義した Undefined型の構築子と似た目的を持っていますが、省略可能な値を表すために Maybe型の構築子を内部的に使っています。

それぞれの型の構築子について、ラップされた値から内側の値を取り出す関数、 runNullOrUndefinedが提供されています。 null値を許容するJSON文書を解析するには、 readJSONアクションまで対応する適切な関数を持ち上げます。

> import Prelude
> import Data.Foreign.NullOrUndefined

> runExcept (unNullOrUndefined <$> decodeJSON "42" :: F (NullOrUndefined Int))
(Right (Just 42))

> runExcept (unNullOrUndefined <$> decodeJSON "null" :: F (NullOrUndefined Int))
(Right Nothing)

それぞれの場合で、型注釈が <$>演算子の右辺に適用されています。たとえば、 readJSON "42"は型 F (NullOrUndefined Int)を持っています。 unNullOrUndefined関数は最終的な型 F (Maybe Number)与えるために Fまで持ち上げられます。

NullOrUndefined Intは数またはnullいずれかの値を表しています。各要素が nullをかもしれない数値の配列のように、より興味深いの値を解析したい場合はどうでしょうか。その場合には、次のように readJSONアクションまで関数 map unNullOrUndefinedを持ち上げます。

> runExcept (map unNullOrUndefined <$> decodeJSON "[1, 2, null]"
    :: F (Array (NullOrUndefined Int))) (Right [(Just 1),(Just 2),Nothing])

一般的には、同じ型に異なる直列化戦略を提供するには、newtypesを使って既存の型をラップするのがいいでしょう。 NullOrUndefinedそれぞれの型は、 Maybe型構築子に包まれたnewtypeとして定義されています。

10.18 住所録の項目の直列化

実のところ、purescript-foreign-genericクラスはdatatype-generic programmingという技術を使ってインスタンスの自動導出(derive)することが可能なので、Decodeクラスのインスタンスを自分で書く必要はほとんどありません。このテクニックの完全な説明は本書の範囲を超えていますが、関数を一度記述すれば、型自体の構造に基づいてさまざまなデータ型に再利用することができます。

FormData型の Decodeインスタンスを派生させるためには、まず deriveキーワードを使って Generic型クラスのインスタンスを派生させます。

derive instance genericFormData :: Generic FormData _

そして、genericDecode関数を使って、次のようにdecode関数を定義します。

instance decodeFormData :: Decode FormData where
  decode = genericDecode (defaultOptions { unwrapSingleConstructors = true })

実際、同じ方法で encoderを導出することもできます。

instance encodeFormData :: Encode FormData where
  encode = genericEncode (defaultOptions { unwrapSingleConstructors = true })

デコーダとエンコーダで同じオプションを使用することが重要です。そうしないと、エンコードされたJSONドキュメントが正しくデコードされないことがあります。

保存ボタンをクリックすると、JSON文書への直列化を行うencode関数にFormData型の値が渡されます。FormData型はレコードのnewtypeで、encodeが渡されたFormData型の値はJSONオブジェクトとして直列化されます。これは、JSONエンコーダを定義する際にunwrapSingleConstructorsオプションを指定したためです。

このDecode型クラスのインスタンスは、decodeJSONとともにローカル·ストレージから取得したJSON文書を解析するために次のように使われています。

loadSavedData = do
  item <- getItem "person"

  let
    savedData :: Either (NonEmptyList ForeignError) (Maybe FormData)
    savedData = runExcept do
      jsonOrNull <- traverse readString =<< readNullOrUndefined item
      traverse decodeJSON jsonOrNull

savedDataアクションは2つの手順にわけて FormData構造を読み取ります。まず、 getItemから得た Foreign値を解析します。 jsonOrNullの型はコンパイラによって Null Stringだと推論されます(読者への演習: この型はどのように推論されているのでしょうか?)。 traverse関数は readJSONMaybe.String型の結果の(不足しているかもしれない)要素へと適用するのに使われます。 readJSONについて推論される型クラスのインスタンスはちょうどさっき書いたもので、型 F (Maybe FormData)の値で結果を返します。

traverseの引数には readが最初の行で得た結果 jsonOrNullを使っているので、 Fのモナド構造を使う必要があります。

結果の FormDataには3つの可能性があります。

pulp build -O --to dist/Main.jsを実行してコードを試してから、ブラウザで html/index.htmlを開いてください。 保存ボタンをクリックするとフォームフィールドの内容をローカルストレージへ保存することができ、ページを再読込するとフィールドが再現されるはずです。

注意:ブラウザ特有の問題を避けるために、ローカルなHTTPサーバからHTMLファイルとJavaScriptファイルを提供する必要があるかもしれません。

演習

  1. (簡単)decodeJSONを使って、 [[1, 2, 3], [4, 5], [6]]のようなJavaScriptの数の2次元配列を表現するJSON文書を解析してください。要素をnullにすることが許容されている場合はどうでしょうか。配列自体をnullにすることが許容されている場合はどうなりますか。

  2. (やや難しい)savedDataの実装の型を検証し、計算のそれぞれの部分式の推論された型を書き出してみましょう。

  3. (難しい)次のデータ型は、葉で値を持つ二分木を表しています。

    data Tree a = Leaf a | Branch (Tree a) (Tree a)
    

    purescript-foreign-genericを使ってこのタイプの EncodeDecodeインスタンスを導き、エンコードされた値がPSCiで正しくデコードできることを確認してください。

  4. (難しい) 次のdata型は、整数か文字列のどちらかであるJSONを直接表現しています。

    data IntOrString
      = IntOrString_Int Int
      | IntOrString_String String
    

    この動作を実装する IntOrStringデータ型の EncodeDecodeのインスタンスを記述し、エンコードされた値が PSCiで正しくデコードできることを確認してください。

まとめ

この章では、PureScriptから外部のJavaScriptコードを扱う方法、およびその逆の方法を学びました。また、FFIを使用して信頼できるコードを書く時に生じる問題について見てきました。

その他の例については、Githubの purescript組織、purescript-contrib組織および purescript-node組織が、FFIを使用するライブラリの例を多数提供しています。残りの章では、型安全な方法で現実世界の問題を解決するために使うライブラリを幾つか見ていきます。

第11章 モナドの探求

11.1 この章の目標

この章の目標は、異なるモナドから提供された副作用を合成する方法を提供するモナド変換子(monad transformers)について学ぶことです。NodeJSのコンソール上で遊ぶことができる、テキストアドベンチャーゲームを題材として扱います。ゲームの様々な副作用(ロギング、状態、および設定)がすべてモナド変換子スタックによって提供されます。

11.2 プロジェクトの準備

このモジュールのプロジェクトでは以下のBower依存関係が新たに導入されます。

また、NPMを使って yargsモジュールをインストールする必要があります。

npm install

11.3 ゲームの遊びかた

プロジェクトを実行するには、 pulp runでソースコードをビルドしてから、NodeJSにコンパイルされたJavaScriptを渡します。

デフォルトでは使い方が表示されます。

node ./dist/Main.js -p 

Options:
  -p, --player  Player name  [required]
  -d, --debug   Use debug mode

Missing required arguments: p
The player name is required

-pオプションを使ってプレイヤー名を指定してください。

pulp run -- -p Phil
> 

プロンプトからは、 lookinventorytakeusenorthsoutheastwestなどのコマンドを入力することができます。 --debugコマンドラインオプションが与えられたときには、ゲームの状態を出力するための debugコマンドも使えます。

ゲームは2次元の碁盤の目の上でプレイし、コマンド northsoutheastwestを発行することによってプレイヤーが移動します。ゲームにはアイテムの配列があり、プレイヤーの所持アイテム一覧を表したり、ゲーム盤上のその位置にあるアイテムの一覧を表すのに使われます。 takeコマンドを使うと、プレイヤーの位置にあるアイテムを拾い上げることができます。

参考までに、このゲームのひと通りの流れは次のようになります。

$ pulp run -- -p Phil

> look
You are at (0, 0)
You are in a dark forest. You see a path to the north.
You can see the Matches.

> take Matches
You now have the Matches

> north
> look
You are at (0, 1)
You are in a clearing.
You can see the Candle.

> take Candle
You now have the Candle

> inventory
You have the Candle.
You have the Matches.

> use Matches
You light the candle.
Congratulations, Phil!
You win!

このゲームはとても単純ですが、この章の目的は purescript-transformersパッケージを使用してこのようなゲームを素早く開発できるようにするライブラリを構築することです。

11.4 Stateモナド

purescript-transformersパッケージで提供されるモナドをいくつか見てみましょう。

最初の例は、純粋な変更可能状態を提供する Stateモナドです。すでに Effモナド、すなわち REF作用と ST作用によって提供された変更可能な状態という2つのアプローチについては見てきました。 Stateは第3の選択肢を提供しますが、これは Effモナドを使用して実装されているわけではありません。

State型構築子は、状態の型 s、および返り値の型 aという2種類の引数を取ります。「 Stateモナド」というように説明はしていますが、実際には Monad型クラスのインスタンスが用意されているのは Stateに対してではなく、任意の型 sについての State s型構築子に対してです。

Control.Monad.Stateモジュールは以下のAPIを提供しています。

get    :: forall s.             State s s
put    :: forall s. s        -> State s Unit
modify :: forall s. (s -> s) -> State s Unit

これは REF作用や ST作用が提供するAPIととてもよく似ています。しかし、これらのアクションに RefSTRefに渡しているような、可変領域への参照を引数に渡さないことに注意してください。 StateEffモナドが提供する解決策の違いは、 Stateモナドは暗黙的な単一の状態だけを提供していることです。この状態は Stateモナドの型構築子によって隠された関数の引数として実装されており、参照は明示的には渡されないのです。

例を見てみましょう。 Stateモナドの使いかたのひとつとしては、状態を数として、現在の状態に配列の値を加算していくようなものかもしれません。状態の型 sとして Numberを選択し、配列の走査に traverse_を使って、配列の要素それぞれについて modifyを呼び出すと、これを実現することができます。

import Data.Foldable (traverse_)
import Control.Monad.State
import Control.Monad.State.Class

sumArray :: Array Number -> State Number Unit
sumArray = traverse_ \n -> modify \sum -> sum + n

Control.Monad.Stateモジュールは Stateモナドでの計算を実行するための次の3つの関数を提供します。

evalState :: forall s a. State s a -> s -> a
execState :: forall s a. State s a -> s -> s
runState  :: forall s a. State s a -> s -> Tuple a s

3つの関数はそれぞれ初期値の型 sと計算の型 State s aを引数にとります。 evalStateは返り値だけを返し、 execStateは最終的な状態だけを返し、 runStateTuple a s型の値として表現された返り値と状態の両方を返します。

先ほどの sumArray関数が与えられたとすると、 PSCiで次のように execStateを使うと複数の配列内の数字を合計することができます。

> :paste
… execState (do
…   sumArray [1, 2, 3]
…   sumArray [4, 5]
…   sumArray [6]) 0
… ^D
21

演習

  1. (簡単) 上の例で、 execStaterunStateevalStateで 置き換えると結果はどうなるでしょうか。

  2. (やや難しい)Stateモナドと traverse_関数を使用して、次のような関数を書いてください。

    testParens :: String -> Boolean
    

    これは Stringが括弧の対応が正しく付けられているかどうかを調べる関数です。この関数は次のように動作しなくてはなりません。

    > testParens ""
    true
    
    > testParens "(()(())())"
    true
    
    > testParens ")"
    false
    
    > testParens "(()()"
    false
    

    ヒント: 入力の文字列を文字の配列に変換するのに、 Data.Stringモジュールの split関数を使うと良いでしょう。

11.5 Readerモナド

purescript-transformersパッケージでは Readerというモナドも提供されています。このモナドは大域的な設定を読み取る機能を提供します。 Stateモナドがひとつの可変状態を読み書きする機能を提供するのに対し、 Readerモナドはデータの読み取りの機能だけを提供します。

Reader型構築子は、構成の型を表す型 r、および戻り値の型 aの2つの型引数を取ります。

Contro.Monad.Readerモジュールは以下のAPIを提供します。

ask   :: forall r. Reader r r
local :: forall r a. (r -> r) -> Reader r a -> Reader r a

askアクションは現在の設定を読み取るために使い、 localアクションは局所的に設定を変更して計算を実行するために使います。

たとえば、権限で制御されたアプリケーションを開発しており、現在の利用者の権限オブジェクトを保持するのに Readerモナドを使いたいとしましょう。型 rを次のようなAPIを備えた型 Permissionとして選択します。

hasPermission :: String -> Permissions -> Boolean
addPermission :: String -> Permissions -> Permissions

利用者が特定の権限を持っているかどうかを確認したいときは、 askを使って現在の権限オブジェクトを取得すればいつでも調べることができます。たとえば、管理者だけが新しい利用者の作成を許可されているとしましょう。

createUser :: Reader Permissions (Maybe User)
createUser = do
  permissions <- ask
  if hasPermission "admin" permissions
    then map Just newUser
    else pure Nothing

localアクションを使うと、計算の実行中に Permissionsオブジェクトを局所的に変更し、ユーザーの権限を昇格させることもできます。

runAsAdmin :: forall a. Reader Permissions a -> Reader Permissions a
runAsAdmin = local (addPermission "admin")

こうすると、利用者が admin権限を持っていなかった場合であっても、新しい利用者を作成する関数を書くことができます。

createUserAsAdmin :: Reader Permissions (Maybe User)
createUserAsAdmin = runAsAdmin createUser

Readerモナドの計算を実行するには、大域的な設定を与える runReader関数を使います。

runReader :: forall r a. Reader r a -> r -> a

演習

以下の演習では、 Readerモナドを使って、字下げのついた文書を出力するための小さなライブラリを作っていきます。「大域的な設定」は、現在の字下げの深さを示す数になります。

type Level = Number

type Doc = Reader Level String
  1. (簡単) 現在の字下げの深さで文字列を出力する関数 lineを書いてください。その関数は、以下の型を持っている必要があります。

    line :: String -> Doc
    

    ヒント:現在の字下げの深さを読み取るためには ask関数を使用します。

  2. (やや難しい)local関数を使用して、コードブロックの字下げの深さを大きくする次のような関数を書いてください。

    indent :: Doc -> Doc
    
  3. (やや難しい)Data.Traversableで定義された sequence関数を使用して、文書のリストを改行で区切って連結する次のような関数を書いてください。

    cat :: Array Doc -> Doc
    
  4. (やや難しい)runReader関数を使用して、文書を文字列として出力する次のような関数を書いてください。

    render :: Doc -> String
    

    これで、このライブラリを次のように使うと、簡単な文書を書くことができるはずです。

    render $ cat
      [ line "Here is some indented text:"
      , indent $ cat
          [ line "I am indented"
          , line "So am I"
          , indent $ line "I am even more indented"
          ]
      ]
    

11.6 Writerモナド

Writerモナドは、計算の返り値に加えて、もうひとつの値を累積していく機能を提供します。

よくある使い方としては型 Stringもしくは Array Stringでログを累積していくというものなどがありますが、 Writerモナドはこれよりもっと一般的なものです。これは累積するのに任意のモノイドの値を使うことができ、 Sumモノイドを使って、合計を追跡し続けるのに使ったり、 Anyモノイドを使って途中の Boolean値がすべて真であるかどうかを追跡するのに使うことができます。

Writer型の構築子は、 Monoid型クラスのインスタンスである型 w、および返り値の型 aという2つの型引数を取ります。

WriterのAPIで重要なのは tell関数です。

tell :: forall w a. Monoid w => w -> Writer w Unit

tellアクションは、与えられた値を現在の累積結果に加算します。

例として、 Array Stringモノイドを使用して、既存の関数にログ機能を追加してみましょう。最大公約数関数の以前の実装を考えてみます。

gcd :: Int -> Int -> Int
gcd n 0 = n
gcd 0 m = m
gcd n m = if n > m
            then gcd (n - m) m
            else gcd n (m - n)

Writer (Array String) Intに返り値の型を変更することで、この関数にログ機能を追加することができます。

import Control.Monad.Writer
import Control.Monad.Writer.Class

gcdLog :: Int -> Int -> Writer (Array String) Int

各手順で二つの入力を記録するために、少し関数を変更する必要があります。

gcdLog n 0 = pure n
gcdLog 0 m = pure m
gcdLog n m = do
  tell ["gcdLog " <> show n <> " " <> show m]
  if n > m
    then gcdLog (n - m) m
    else gcdLog n (m - n)

Writerモナドの計算を実行するには、 execWriter関数と runWriter関数のいずれかを使います。

execWriter :: forall w a. Writer w a -> w
runWriter  :: forall w a. Writer w a -> Tuple a w

ちょうど Stateモナドの場合と同じように、 execWriterが累積されたログだけを返すのに対して、 runWriterは累積されたログと結果の両方を返します。

PSCiで修正された関数を試してみましょう。

> import Control.Monad.Writer
> import Control.Monad.Writer.Class

> runWriter (gcdLog 21 15)
Tuple 3 ["gcdLog 21 15","gcdLog 6 15","gcdLog 6 9","gcdLog 6 3","gcdLog 3 3"]

演習

  1. (やや難しい)Writerモナドと purescript-monoidパッケージの Additive Intのモノイドを使うように、上の sumArray関数を書き換えてください。

  2. (やや難しい)コラッツ関数は、自然数 nが偶数なら n / 2nが奇数なら 3 * n + 1であると定義されています。たとえば、 10で始まるコラッツ数列は次のようになります。

    10, 5, 16, 8, 4, 2, 1, ...
    

    コラッツ関数の有限回の適用を繰り返すと、コラッツ数列は必ず最終的に 1になるということとが予想できます。

    数列が 1に到達するまでに何回のコラッツ関数の適用が必要かを計算する再帰的な関数を書いてください。

    Writerモナドを使用してコラッツ関数のそれぞれの適用の経過を記録するように、関数を変更してください。

11.7 モナド変換子

上の3つのモナド、 StateReaderWriterは、いずれもいわゆるモナド変換子(monad transformers)の例となっています。対応するモナド変換子はそれぞれ StateTReaderTWriterTと呼ばれています。

モナド変換子とは何でしょうか。さて、これまで見てきたように、モナドはPureScriptで適切なハンドラ(runStaterunReaderrunWriterなど)を使って解釈される、いろいろな種類の副作用でPureScriptコードを拡張します。使用する必要がある副作用がひとつだけなら、これで問題ありません。しかし、同時に複数の副作用を使用できると便利なことがよくあります。例えば、 MaybeReaderを一緒に使用すると、ある大域的な設定の文脈で省略可能な結果を表現することができます。もしくは、 Eitherモナドの純粋なエラー追跡機能と、 Stateモナドが提供する変更可能な状態が同時に欲しくなるかもしれません。この問題を解決するのがモナド変換子です。

拡張可能作用の手法を使うとネイティブな作用を混在させることができるので、 Effモナドはこの問題に対する部分的な解決策を提供していることをすでに見てきたことに注意してください。モナド変換子はまた異なった解決策を提供しますが、これらの手法にはそれぞれ利点と限界があります。

モナド変換子は型だけでなく別の型構築子によってもパラメータ化される型構築子です。モナド変換子はモナドをひとつ取り、独自のいろいろな副作用を追加した別のモナドへと変換します。

例を見てみましょう。 Control.Monad.State.Transで定義された StateTStateのモナド変換子版です。 PSCiを使って StateTの種を見てみましょう。

> import Control.Monad.State.Trans
> :kind StateT
Type -> (Type -> Type) -> Type -> Type

とても読みにくそうに思うかもしれませんが、使い方を理解するために、 StateTにひとつ引数を与えてみましょう。

Stateの場合、最初の型引数は使いたい状態の型です。それでは型 Stringを与えてみましょう。

> :kind StateT String
(Type -> Type) -> Type -> Type

次の引数は種 Type -> Typeの型構築子です。これは StateTの機能を追加したい元のモナドを表します。例として、 Either Stringモナドを選んでみます。

> :kind StateT String (Either String)
Type -> Type

型構築子が残りました。最後の引数は戻り値の型を表しており、たとえばそれを Numberにすることができます。

> :kind StateT String (Either String) Number
Type

最後に、種 Typeの何かが残りましたが、この型の値を探してみましょう。

構築したモナド StateT String (Either String)は、エラーで失敗する可能性があり、変更可能な状態を使える計算を表しています。

外側の StateT String (Either String)モナドのアクション(getputmodify)は直接使うことができますが、ラップされている内側のモナド(Either String)の作用を使うためには、これらの関数をモナド変換子まで「持ち上げ」なくてはいけません。 Control.MonadTransモジュールでは、モナド変換子であるような型構築子を捕捉する MonadTrans型クラスを次のように定義しています。

class MonadTrans t where
  lift :: forall m a. Monad m => m a -> t m a

このクラスは、基礎となる任意のモナド mの計算をとり、それをラップされたモナド t mへと持ち上げる、 liftというひとつの関数だけを持っています。今回の場合、型構築子 tStateT Stringで、 mEither Stringモナドとなり、 liftは型 Either String aの計算を、型 State String (Either String) aの計算へと持ち上げる方法を提供することになります。これは、型 Either String aの計算を使うときは、 liftを使えばいつでも作用 StateT StringEither Stringを隣り合わせに使うことができることを意味します。

たとえば、次の計算は StateTモナド変換子で導入されている状態を読み込み、状態が空の文字列である場合はエラーを投げます。

import Data.String (drop, take)

split :: StateT String (Either String) String
split = do
  s <- get
  case s of
    "" -> lift $ Left "Empty string"
    _ -> do
      put (drop 1 s)
      pure (take 1 s)

状態が空でなければ、この計算は putを使って状態を drop 1 s(最初の文字を取り除いた s)へと更新し、 take 1 s(sの最初の文字)を返します。

それでは PSCiでこれを試してみましょう。

> runStateT split "test"
Right (Tuple "t" "est")

> runStateT split ""
Left "Empty string"

これは StateTを使わなくても実装できるので、さほど驚くようなことではありません。しかし、モナドとして扱っているので、do記法やApplicativeコンビネータを使って、小さな計算から大きな計算を構築していくことができます。例えば、2回 splitを適用すると、文字列から最初の2文字を読むことができます。

> runStateT ((<>) <$> split <*> split) "test"
(Right (Tuple "te" "st"))

他にもアクションを幾つか用意すれば、 split関数を使って、基本的な構文解析ライブラリを構築することができます。これは実際に purescript-parsingライブラリで採用されている手法です。これがモナド変換子の力なのです。必要な副作用を選択して、do記法とApplicativeコンビネータで表現力を維持しながら、様々な問題のための特注のモナドを作成することができるのです。

11.8 ExceptTモナド変換子

purescript-transformersパッケージでは、 Either eモナドに対応する変換子である ExceptT eモナド変換子も定義されています。これは次のAPIを提供します。

class MonadError e m where
  throwError :: forall a. e -> m a
  catchError :: forall a. m a -> (e -> m a) -> m a

instance monadErrorExceptT :: Monad m => MonadError e (ExceptT e m)

runExceptT :: forall e m a. ExceptT e m a -> m (Either e a)

MonadErrorクラスは e型のエラーのスローとキャッチをサポートするモナドを取得し、 ExceptT eモナド変換子のインスタンスが提供されます。 Either eモナドの Leftと同じように、 throwErrorアクションは失敗を示すために使われます。 catchErrorアクションを使うと、 throwErrorでエラーが投げられたあとでも処理を継続することができるようになります。

runExceptTハンドラを使うと、型 ExceptT e m aの計算を実行することができます。

このAPIは purescript-exceptionsパッケージの Exception作用によって提供されているものと似ています。しかし、いくつかの重要な違いがあります。

試しに ExceptTを使って Writerモナドを包んでみましょう。ここでもモナド変換子 ExceptT eのアクションは自由に使えますが、 Writerモナドの計算は liftを使って持ちあげなければなりません。

import Control.Monad.Trans
import Control.Monad.Writer
import Control.Monad.Writer.Class
import Control.Monad.Error.Class
import Control.Monad.Except.Trans

writerAndExceptT :: ExceptT String (Writer (Array String)) String
writerAndExceptT = do
  lift $ tell ["Before the error"]
  throwError "Error!"
  lift $ tell ["After the error"]
  pure "Return value"

PSCiでこの関数を試すと、ログの蓄積とエラーの送出という2つの作用がどのように相互作用しているのかを見ることができます。まず、 runExceptTを使って外側の ExceptT計算を実行し、型 Write String (Either String String)の結果を残します。それから、 runWriterで内側の Writer計算を実行します。

> runWriter $ runExceptT writerAndExceptT
Tuple (Left "Error!") ["Before the error"]

実際に追加されるログは、エラーが投げられる前に書かれたログメッセージだけであることにも注目してください。

11.9 モナド変換子スタック

これまで見てきたように、モナド変換子を使うと既存のモナドの上に新しいモナドを構築することができます。任意のモナド変換子 t1と任意のモナド mについて、その適用 t1 mもまたモナドになります。これはふたつめのモナド変換子 t2を先ほどの結果 t1 mに適用すると、第3のモナド t2 (t1 m)を作れることを意味しています。このように、構成するモナドによって提供された副作用を組み合わせる、モナド変換子のスタックを構築することができます。

実際には、基本となるモナド mは、ネイティブの副作用が必要なら Effモナド、さもなくば Control.Monad.Identityモジュールで定義されている Identityモナドになります。 Identityモナドは何の新しい副作用も追加しませんから、 Identityモナドの変換は、モナド変換子の作用だけを提供します。実際に、 Stateモナド、 Readerモナド、 Writerモナドは、 Identityモナドをそれぞれ StateTReaderTWriterTで変換することによって実装されています。

それでは3つの副作用が組み合わされている例を見てみましょう。 Identityモナドをスタックの底にして、 StateT作用、 WriterT作用、 ExceptT作用を使います。このモナド変換子スタックは、ログの蓄積し、純粋なエラー、可変状態の副作用を提供します。

このモナド変換子スタックを使うと、ロギングの機能が追加された splitアクションを作ることができます。

type Errors = Array String

type Log = Array String

type Parser = StateT String (WriterT Log (ExceptT Errors Identity))

split :: Parser String
split = do
  s <- get
  lift $ tell ["The state is " <> show s]
  case s of
    "" -> lift $ lift $ throwError ["Empty string"]
    _ -> do
      put (drop 1 s)
      pure (take 1 s)

この計算を PSCiで試してみると、 splitが実行されるたびに状態がログに追加されることがわかります。

モナド変換子スタックに現れる順序に従って、副作用を取り除いていかなければならないことに注意してください。最初に StateT型構築子を取り除くために runStateTを使い、それから runtWriteTを使い、その後 runExceptTを使います。最後に runIdentityを使用して Identityモナドの演算を実行します。

> runParser p s = runIdentity $ runExceptT $ runWriterT $ runStateT p s

> runParser split "test"
(Right (Tuple (Tuple "t" "est") ["The state is test"]))

> runParser ((<>) <$> split <*> split) "test"
(Right (Tuple (Tuple "te" "st") ["The state is test", "The state is est"]))

しかしながら解析が失敗した場合は、状態が空であるためログはまったく出力されません。

> runParser split ""
(Left ["Empty string"])

これは、 ExceptTモナド変換子が提供する副作用が、 WriterTモナド変換子が提供する副作用に影響を受けるためです。これはモナド変換子スタックが構成されている順序を変更することで解決することができます。スタックの最上部に ExceptT変換子を移動すると、先ほど WriterExceptTに変換したときと同じように、最初のエラーまでに書かれたすべてのメッセージが含まれるようになります。

このコードの問題のひとつは、複数のモナド変換子の上まで計算を持ち上げるために、 lift関数を複数回使わなければならないということです。たとえば、 throwErrorの呼び出しは、1回目は WriteTへ、2回目は StateTへと、2回持ちあげなければなりません。小さなモナド変換子スタックならなんとかなりますが、そのうち不便だと感じるようになるでしょう。

幸いなことに、これから見るような型クラス推論によって提供されるコードの自動生成を使うと、ほとんどの「多段持ち上げ」を行うことができます。

演習

  1. (簡単) Identity関手の上の ExceptTモナド変換子を使って、分母がゼロの場合はエラーを投​​げる、2つの数の商を求める関数 safeDivideを書いてください。

  2. (やや難しい) 現在の状態が接頭辞に適合するか、エラーメッセージとともに失敗する、次のような構文解析関数を書いてください。

    string :: String -> Parser String
    

    この構文解析器は次のように動作しなくてはなりません。

    > runParser (string "abc") "abcdef"
    (Right (Tuple (Tuple "abc" "def") ["The state is abcdef"]))
    

    ヒント:出発点として splitの実装を使うといいでしょう。stripPrefix関数も役に立ちます。

  3. (難しい) 以前 Readerモナドを使用して書いた文書出力ライブラリを、 ReaderTWriterTモナド変換子を使用して再実装してください。

    文字列を出力する lineや文字列を連結する catを使うのではなく、 WriteTモナド変換子と一緒に Array Stringモノイドを使い、結果へ行を追加するのに tellを使ってください。

11.10 救済のための型クラス

章の最初で扱った Stateモナドを見てみると、 Stateモナドのアクションには次のような型が与えられていました。

get    :: forall s.             State s s
put    :: forall s. s        -> State s Unit
modify :: forall s. (s -> s) -> State s Unit

Control.Monad.State.Classモジュールで与えられている型は、実際には次のようにもっと一般的です。

get    :: forall m s. MonadState s m =>             m s
put    :: forall m s. MonadState s m => s        -> m Unit
modify :: forall m s. MonadState s m => (s -> s) -> m Unit

Control.Monad.State.Classモジュールには「純粋な変更可能な状態を提供するモナド」への抽象化を可能にする MonadState(多変数)型クラスが定義されています。予想できると思いますが、 State s型構築子は MonadState s型クラスのインスタンスになっており、このクラスには他にも興味深いインスタンスが数多くあります。

特に、 purescript-transformersパッケージではモナド変換子 WriterTReaderTExceptTについての MonadStateのインスタンスが提供されています。実際に、 StateTがモナド変換子スタックのどこかに現れ、 StateTより上のすべてが MonadStateのインスタンスであれば、 getputmodifyを直接自由に使用することができます。

実は、これまで扱ってきた ReaderTWriterTExceptT変換子についても、同じことが成り立っています。 purescript-transformersでは、それらの操作をサポートするモナドの上に抽象化することを可能にする、主な変換子それぞれについての型クラスが定義されています。

上の split関数の場合、構築されたこのモナドスタックは型クラス MonadStateMonadWriterMonadErrorそれぞれのインスタンスです。これはつまり、 liftをまったく呼び出す必要がないことを意味します!まるでモナドスタック自体に定義されていたかのように、アクション getputtellthrowErrorをそのまま使用することができます。

split :: Parser String
split = do
  s <- get
  tell ["The state is " <> show s]
  case s of
    "" -> throwError "Empty string"
    _ -> do
      put (drop 1 s)
      pure (take 1 s)

この計算はまるで、可変状態、ロギング、エラー処理という3つの副作用に対応した、独自のプログラミング言語を拡張したかのようにみえます。しかしながら、内部的にはすべてはあくまで純粋な関数と普通のデータを使って実装されているのです。

11.11 Alternative型クラス

purescript-controlパッケージでは失敗しうる計算を操作するための抽象化がいくつか定義されています。そのひとつは Alternative型クラスです。

class Functor f <= Alt f where
  alt :: forall a. f a -> f a -> f a

class Alt f <= Plus f where
  empty :: forall a. f a

class (Applicative f, Plus f) <= Alternative f

Alternativeは、失敗しうる計算のプロトタイプを提供する empty値、 エラーが起きたときに代替(Alternative)計算へ戻ってやり直す機能を提供する <|>演算子 という、2つの新しいコンビネータを提供しています。

Data.Listモジュールでは Alternative型クラスで型構築子を操作する2つの便利な関数を提供します。

many :: forall f a. Alternative f => Lazy (f (List a)) => f a -> f (List a)
some :: forall f a. Alternative f => Lazy (f (List a)) => f a -> f (List a)

manyコンビネータは計算をゼロ回以上繰り返し実行するために Alternative型クラスを使用しています。 someコンビネータも似ていますが、成功するために少なくとも1回の計算を必要とします。

今回の Parserモナド変換子スタックの場合は、 ExceptTコンポーネントから導かれた、明らかな方法で失敗をサポートする、 Alternativeのインスタンスが存在します。これは、構文解析器を複数回実行するために many関数と some関数を使うことができることを意味します。

> import Split
> import Control.Alternative

> runParser (many split) "test"
(Right (Tuple (Tuple ["t", "e", "s", "t"] "")
              [ "The state is \"test\""
              , "The state is \"est\""
              , "The state is \"st\""
              , "The state is \"t\""
              ]))

ここで、入力文字列 "test"は、1文字の文字列4つの配列を返すように、繰り返し分割されています。残った状態は空文字列で、ログは splitコンビネータが4回適用されたことを示しています。

Alternative型構築子の他の例としては、 Maybeや、 Arrayつまり配列の型構築子があります。

11.12 モナド内包表記

Control.MonadPlusモジュールには MonadPlusと呼ばれる Alternative型クラスの若干の変形が定義されています。 MonadPlusはモナドと Alternativeのインスタンスの両方である型構築子を補足します。

class (Monad m, Alternative m) <= MonadZero m

class MonadZero m <= MonadPlus m

実際、 Parserモナドは MonadPlusのインスタンスです。

以前に本書中で配列内包表記を扱ったとき、不要な結果をフィルタリングするため使われる guard関数を導入しました。実際は guard関数はもっと一般的で、 MonadPlusのインスタンスであるすべてのモナドに対して使うことができます。

guard :: forall m. MonadZero m => Boolean -> m Unit

<|>演算子は失敗時のバックトラッキングをできるようにします。これがどのように役立つかを見るために、大文字だけに適合する splitコンビネータの亜種を定義してみましょう。

upper :: Parser String
upper = do
  s <- split
  guard $ toUpper s == s
  pure s

ここで、文字列が大文字でない場合に失敗するよう guardを使用しています。このコードは前に見た配列内包表記とよく似ていることに注目してください。このように MonadPlusが使われておりモナド内包表記(monad comprehensions)を構築するために参照することがあります。

11.13 バックトラッキング

<|>演算子を使うと、失敗したときに別の代替計算へとバックトラックすることができます。これを確かめるために、小文字に一致するもう一つの構文解析器を定義してみましょう。

lower :: Parser String
lower = do
  s <- split
  guard $ toLower s == s
  pure s

これにより、まずもし最初の文字が大文字なら複数の大文字に適合し、さもなくばもし最初の文字が小文字なら複数の小文字に適合する、という構文解析器を定義することができます。

> upperOrLower = some upper <|> some lower

この構文解析器は、大文字と小文字が切り替わるまで、文字に適合し続けます。

> runParser upperOrLower "abcDEF"
(Right (Tuple (Tuple ["a","b","c"] ("DEF"))
              [ "The state is \"abcDEF\""
              , "The state is \"bcDEF\""
              , "The state is \"cDEF\""
              ]))

manyを使うと、文字列を小文字と大文字の要素に完全に分割することもできます。

> components = many upperOrLower

> runParser components "abCDeFgh"
(Right (Tuple (Tuple [["a","b"],["C","D"],["e"],["F"],["g","h"]] "")
              [ "The state is \"abCDeFgh\""
              , "The state is \"bCDeFgh\""
              , "The state is \"CDeFgh\""
              , "The state is \"DeFgh\""
              , "The state is \"eFgh\""
              , "The state is \"Fgh\""
              , "The state is \"gh\""
              , "The state is \"h\""
              ]))

繰り返しになりますが、これはモナド変換子がもたらす再利用性の威力を示しています。標準的な抽象化を再利用することで、バックトラック構文解析器を宣言型のスタイルでわずか数行のコードで書くことができました!

演習

  1. (簡単)string構文解析器の実装から lift関数の呼び出しを取り除いてください。新しい実装の型が整合していることを確認し、なぜそのようになるのかをよく納得しておきましょう。

  2. (やや難しい)string構文解析器と manyコンビネータを使って、文字列 "a"の連続と、それに続く文字列 "b"の連続からなる文字列を認識する構文解析器を書いてください。

  3. (やや難しい)<|>演算子を使って、文字 aと文字 bが任意の順序で現れるような文字列を認識する構文解析器を書いてください。

  4. (難しい)Parserモナドは次のように定義されるかもしれません。

    type Parser = ExceptT Errors (StateT String (WriterT Log Identity))
    

    このように変更すると、構文解析関数にどのような影響を与えるでしょうか。

11.14 RWSモナド

モナド変換子のある特定の組み合わせは、 purescript-transformersパッケージ内の単一のモナド変換子として提供されるのが一般的です。 ReaderWriterStateのモナドは、Reader-Writer-Stateモナド(RWSモナド)へと結合されます。このモナドは RWSTモナド変換子と呼ばれる、対応するモナド変換子を持っています。

ここでは RWSモナドを使ってテキストアドベンチャーゲームの処理を設計していきます。

RWSモナドは(戻り値の型に加えて)3つの型変数で定義されています。

type RWS r w s = RWST r w s Identity

副作用を提供しない Identityにベースモナドを設定することで、 RWSモナドが独自のモナド変換子の観点から定義されていることに注意してください。

第1型引数 rは大域的な設定の型を表します。第2型引数 wはログを蓄積するために使用するモノイド、第3型引数 sは可変状態の型を表しています。

このゲームの場合には、大域的な設定は Data.GameEnvironmentモジュールの GameEnvironmentと呼ばれる型で定義されています。

type PlayerName = String

newtype GameEnvironment = GameEnvironment
  { playerName    :: PlayerName
  , debugMode     :: Boolean
  }

GameEnvironmentでは、プレイヤー名と、ゲームがデバッグモードで動作しているか否かを示すフラグが定義されています。これらのオプションは、モナド変換子を実行するときにコマンドラインから設定されます。

可変状態は Data.GameStateモジュールの GameStateと呼ばれる型で定義されています。

import qualified Data.Map as M
import qualified Data.Set as S

newtype GameState = GameState
  { items       :: M.Map Coords (S.Set GameItem)
  , player      :: Coords
  , inventory   :: S.Set GameItem
  }

Coordsデータ型は2次元平面の点を表し、 GameItemデータ型はゲーム内のアイテムです。

data GameItem = Candle | Matches

GameState型はソートされたマップを表す Mapとソートされた集合を表す Setという2つの新しいデータ構造を使っています。 itemsプロパティは、そのゲーム平面上の座標と、ゲームアイテムの集合へのマッピングになっています。 playerプロパティはプレイヤーの現在の座標を格納しており、 inventoryプロパティは現在プレイヤーが保有するゲームアイテムの集合です。

MapSetのデータ構造はキーによってソートされ、 Ord型クラスの任意の型をキーとして使用することができます。これは今回のデータ構造のキーが完全に順序付けできることを意味します。

ゲームのアクションを書くために、 MapSet構造がどのように使っていくのかを見ていきましょう。

ログとしては List Stringモノイドを使います。 RWSを使って Gameモナドのための型同義語を定義しておきます。

type Log = L.List String

type Game = RWS GameEnvironment Log GameState

11.15 ゲームロジックの実装

今回は、 Readerモナド、 Writerモナド、 Stateモナドのアクションを再利用し、 Gameモナドで定義されている単純なアクションを組み合わせてゲームを構築していきます。このアプリケーションの最上位では、 Gameモナドで純粋な計算を実行しており、 Effモナドはコンソールにテキストを出力するような追跡可能な副作用へと結果を変換するために使っています。

このゲームで最も簡単なアクションのひとつは hasアクションです。このアクションはプレイヤーの持ち物に特定のゲームアイテムが含まれているかどうかを調べます。これは次のように定義されます。

has :: GameItem -> Game Boolean
has item = do
  GameState state <- get
  pure $ item `S.member` state.inventory

この関数は、現在のゲームの状態を読み取るために Monad.State型クラスで定義されている getアクションを使っており、指定した GameItemが持ち物の Setのなかに出現するかどうかを調べるために Data.Setで定義されている member関数を使っています。

他にも pickUpアクションがあります。現在の位置にゲームアイテムがある場合、プレイヤーの持ち物にそのアイテムを追加します。これには MonadWriterMonadState型クラスのアクションを使っています。まず、現在のゲームの状態を読み取ります。

pickUp :: GameItem -> Game Unit
pickUp item = do
  GameState state <- get

次に pickUpは現在の位置にあるアイテムの集合を検索します。これは Data.Mapで定義された lookup関数を使って行います。

  case state.player `M.lookup` state.items of

lookup関数は Maybe型構築子で示されたオプショナルな結果を返します。 lookup関数は、キーがマップにない場合は Nothingを返し、それ以外の場合は Just構築子で対応する値を返します。

関心があるのは、指定されたゲームアイテムが対応するアイテムの集合に含まれている場合です。 member関数を使うとこれを調べることができます。

    Just items | item `S.member` items -> do

この場合、 putを使ってゲームの状態を更新し、 tellを使ってログにメッセージを追加します。

      let newItems = M.update (Just <<< S.delete item) state.player state.items
          newInventory = S.insert item state.inventory
      put $ GameState state { items     = newItems
                            , inventory = newInventory
                            }
      tell (L.singleton ("You now have the " <> show item))

ここで、 MonadStateMonadWriterの両方について Gameモナド変換子スタックについての適切なインスタンスが存在するので、2つの計算はどちらも liftは必要ないことに注意してください。

putの引数では、レコード更新を使ってゲームの状態の itemsinventoryフィールドを変更しています。特定のキーの値を変更するには Data.Mapupdate関数を使います。このとき、 delete関数を使い指定したアイテムを集合から取り除くことで、プレイヤーの現在の位置にあるアイテムの集合を変更します。

最後に、 pickUp関数は tellを使ってユーザに次のように通知することにより、残りの場合を処理します。

    _ -> tell (L.singleton "I don't see that item here.")

Readerモナドを使う例として、 debugコマンドのコードを見てみましょう。ゲームがデバッグモードで実行されている場合、このコマンドを使うとユーザは実行時にゲームの状態を調べることができます。

  GameEnvironment env <- ask
  if env.debugMode
    then do
      state <- get
      tell (L.singleton (show state))
    else tell (L.singleton "Not running in debug mode.")

ここでは、ゲームの設定を読み込むために askアクションを使用しています。繰り返しますが、どんな計算の liftも必要なく、同じdo記法ブロック内で MonadStateMonadReaderMonadWriter型クラスで定義されているアクションを使うことができることに注意してください。

debugModeフラグが設定されている場合、 tellアクションを使ってログに状態が追加されます。そうでなければ、エラーメッセージが追加されます。

Game.pursモジュールでは、 MonadState型クラス、 MonadReader型クラス、 MonadWriter型クラスでそれぞれ定義されたアクションだけを使って、同様のアクションが定義されています。

11.16 計算の実行

このゲームロジックは RWSモナドで動くため、ユーザのコマンドに応答するためには計算を実行する必要があります。

このゲームのフロントエンドは、 yargsコマンドライン構文解析ライブラリへのApplicativeなインターフェイスを提供する purescript-yargsパッケージと、対話的なコンソールベースのアプリケーションを書くことを可能にするNodeJSの readlineモジュールをラップする purescript-node-readlineパッケージという2つのパッケージで構成されています。

このゲームロジックへのインタフェースは Gameモジュール内の関数 gameによって提供されます。

game :: Array String -> Game Unit

この計算を実行するには、ユーザが入力した単語のリストを文字列の配列として渡してから、 runRWSを使って RWSの計算を実行します。

data RWSResult state result writer = RWSResult state result writer

runRWS :: forall r w s a. RWS r w s a -> r -> s -> RWSResult s a w

runRWSrunReaderrunWriterrunStateを組み合わせたように見えます。これは、引数として大域的な設定および初期状態をとり、ログ、結果、最的な終状態を含むレコードを返します。

このアプリケーションのフロントエンドは、次の型シグネチャを持つ関数 runGameによって定義されます。

runGame :: forall eff . GameEnvironment
  -> Eff ( exception :: EXCEPTION
         , readline :: RL.READLINE
         , console :: CONSOLE
         | eff
         ) Unit

Console作用は、この関数が purescript-node-readlineパッケージを使ってコンソールを介してユーザと対話することを示しています。 runGameは関数の引数としてのゲームの設定とります。

purescript-node-readlineパッケージでは、端末からのユーザ入力を扱う Effモナドのアクションを表す LineHandler型が提供されています。対応するAPIは次のとおりです。

type LineHandler eff a = String -> Eff eff a

setLineHandler :: forall eff a. Interface
                -> LineHandler (readline :: READLINE | eff) a
                -> Eff (readline :: READLINE | eff) Unit

Interface型はコンソールのハンドルを表しており、コンソールと対話する関数への引数として渡されます。 createInterface関数を使用すると Interfaceを作成することができます。

runGame env = do
  interface <- createConsoleInterface noCompletion

最初の手順はコンソールにプロンプトを設定することです。 interfaceハンドルを渡し、プロンプト文字列とインデントレベルを提供します。

setPrompt "> " 2 interface

今回は lineHandler関数を実装してみましょう。 lineHandlerlet宣言内の補助関数を使って次のように定義されています。

lineHandler :: GameState -> String
             -> Eff ( exception :: EXCEPTION
                    , console :: CONSOLE
                    , readline :: RL.READLINE
                    | eff
                    ) Unit
lineHandler currentState input = do
  case runRWS (game (split " " input)) env currentState of
    RWSResult state _ written -> do
      for_ written log
      setLineHandler interface $ lineHandler state
  prompt interface
  pure unit

lineHandlerでは envという名前のゲーム構成や、 interfaceという名前のコンソールハンドルを参照しています。

このハンドラは追加の最初の引数としてゲームの状態を取ります。ゲームのロジックを実行するために runRWSにゲームの状態を渡さなければならないので、これは必要となっています。

このアクションが最初に行うことは、 Data.Stringモジュールの split関数を使用して、ユーザーの入力を単語に分割することです。それから、ゲーム環境と現在のゲームの状態を渡し、 runRWSを使用して(RWSモナドで)gameアクションを実行しています。

純粋な計算であるゲームロジックを実行し、画面にすべてのログメッセージを出力して、ユーザに次のコマンドのプロンプトを表示する必要があります。 for_アクションは(List String型の)ログを走査し、コンソールにその内容を出力するために使われています。そして setLineHandlerを使って lineHandler関数を更新することで、ゲームの状態を更新します。最後に promptアクションを使ってプロンプトが再び表示しています。

runGame関数ではコンソールインターフェイスに最初のlineHandlerを設定して、最初のプロンプトを表示します。

  setLineHandler interface $ lineHandler initialGameState
  prompt interface

演習

  1. (やや難しい) ゲームフィールド上にあるすべてのゲームアイテムをユーザの持ちものに移動する新しいコマンド cheatを実装してください。

  2. (難しい) RWSモナドの Writerコンポーネントは、エラーメッセージと情報メッセージの2つの種類のメッセージのために使われています。このため、コードのいくつかの箇所では、エラーの場合を扱うためにcase式を使用しています。

    エラーメッセージを扱うのに ExceptTモナド変換子を使うようにし、情報メッセージを扱うのに RWSを使うようにするよう、コードをリファクタリングしてください。

11.17 コマンドラインオプションの扱い

このアプリケーションの最後の部品は、コマンドラインオプションの解析と GameEnvironmentレコードを作成する役目にあります。このためには purescript-yargsパッケージを使用します。

purescript-yargsApplicativeなコマンドラインオプション構文解析器の例です。Applicative関手を使うと、いろいろな副作用の型を表す型構築子まで任意個数の引数の関数をを持ち上げられることを思い出してください。 purescript-yargsパッケージの場合には、コマンドラインオプションからの読み取りの副作用を追加する Y関手が興味深い関手になっています。これは次のようなハンドラを提供しています。

runY :: forall a eff. YargsSetup ->
                      Y (Eff (exception :: EXCEPTION, console :: CONSOLE | eff) a) ->
                      Eff (exception :: EXCEPTION, console :: CONSOLE | eff) a

この関数の使いかたは、例で示すのが最も適しているでしょう。このアプリケーションの main関数は runYを使って次のように定義されています。

main = runY (usage "$0 -p <player name>") $ map runGame env

最初の引数は yargsライブラリを設定するために使用されます。今回の場合、使用方法のメッセージだけを提供していますが、 Node.Yargs.Setupモジュールには他にもいくつかのオプションを提供しています。

2番目の引数では、 Y型構築子まで runGame関数を持ち上げるために <$>コンビネータを使用しています。引数 envwhere節でApplicative演算子 <$><*>を使って構築されています。

  where
  env :: Y GameEnvironment
  env = gameEnvironment
          <$> yarg "p" ["player"]
                   (Just "Player name")
                   (Right "The player name is required")
                   false
          <*> flag "d" ["debug"]
                   (Just "Use debug mode")

PlayerName -> Boolean -> GameEnvironmentという型を持つこの gameEnvironment関数は、 Yまで持ち上げられています。このふたつの引数は、コマンドラインオプションからプレイヤー名とデバッグフラグを読み取る方法を指定しています。最初の引数は -pもしくは --playerオプションで指定されるプレイヤー名オプションについて記述しており、2つ目の引数は -dもしくは --debugオプションで指定されるデバッグモードフラグについて記述しています。

これは Node.Yargs.Applicativeモジュールで定義されているふたつの基本的な関数について示しています。 yargは(型 StringNumberBooleanの)オプショナルな引数を取りコマンドラインオプションを定義し、 flagは型 Booleanのコマンドラインフラグを定義しています。

Applicative演算子によるこの記法を使うことで、コマンドラインインターフェイスに対してコンパクトで宣言的な仕様を与えることが可能になったことに注意してください。また、 envの定義で runGame関数に新しい引数を追加し、 <*>を使って追加の引数まで runGameを持ち上げるだけで、簡単に新しいコマンドライン引数を追加することができます。

演習

  1. (やや難しい)GameEnvironmentレコードに新しい真偽値のプロパティ cheatModeを追加してください。 また、 yargs設定に、チートモードを有効にする新しいコマンドラインフラグ -cを追加してください。チートモードが有効になっていない場合、 cheatコマンドは禁止されなければなりません。

まとめ

モナド変換子を使用したゲームの純粋な定義、コンソールを使用したフロントエンドを構築するための Effモナドなと、この章ではこれまで学んできた手法を実用的に使いました。

ユーザインターフェイスからの実装を分離したので、ゲームの別のフロントエンドを作成することも可能でしょう。例えば、 EffモナドでCanvas APIやDOMを使用して、ブラウザでゲームを描画するようなことができるでしょう。

モナド変換子によって、型システムによって作用が追跡される命令型のスタイルで、安全なコードを書くことができることを見てきました。また、型クラスは、コードの再利用を可能にするモナドによって提供される、アクション上の抽象化の強力な方法を提供します。標準的なモナド変換子を組み合わせることにより、 AlternativeMonadPlusのような標準的な抽象化を使用して、役に立つモナドを構築することができました。

モナド変換子は、高階多相や多変数型クラスなどの高度な型システムの機能を利用することによって記述することができ、表現力の高いコードの優れた実演となっています。

次の章では、非同期なJavaScriptのコードにありがちな不満、コールバック地獄の問題に対して、モナド変換子がどのような洗練された解決策を与えるのかを見ていきます。

第12章 コールバック地獄

12.1 この章の目標

この章では、これまでに見てきたモナド変換子やApplicative関手といった道具が、現実世界の問題解決にどのように役立つかを見ていきましょう。ここでは特に、コールバック地獄(callback hell)の問題を解決について見ていきます。

12.2 プロジェクトの準備

この章のソースコードは、 pulp runを使ってコンパイルして実行することができます。 また、 requestモジュールをNPMを使ってインストールする必要があります。

npm install

12.3 問題

通常、JavaScriptの非同期処理コードでは、プログラムの流れを構造化するためにコールバック(callbacks)を使用します。たとえば、ファイルからテキストを読み取るのに好ましいアプローチとしては、 readFile関数を使用し、コールバック、つまりテキストが利用可能になったときに呼び出される関数を渡すことです。

function readText(onSuccess, onFailure) {
  var fs = require('fs');
  fs.readFile('file1.txt', { encoding: 'utf-8' }, function (error, data) {
    if (error) {
      onFailure(error.code);
    } else {
      onSuccess(data);
    }   
  });
}

しかしながら、複数の非同期操作が関与している場合には入れ子になったコールバックを生じることになり、すぐに読めないコードになってしまいます。

function copyFile(onSuccess, onFailure) {
  var fs = require('fs');
  fs.readFile('file1.txt', { encoding: 'utf-8' }, function (error, data1) {
    if (error) {
      onFailure(error.code);
    } else {
      fs.writeFile('file2.txt', data, { encoding: 'utf-8' }, function (error) {
        if (error) {
          onFailure(error.code);
        } else {
          onSuccess();
        }
      });
    }   
  });
} 

この問題に対する解決策のひとつとしては、独自の関数に個々の非同期呼び出しを分割することです。

function writeCopy(data, onSuccess, onFailure) {
  var fs = require('fs');
  fs.writeFile('file2.txt', data, { encoding: 'utf-8' }, function (error) {
    if (error) {
      onFailure(error.code);
    } else {
      onSuccess();
    }
  });
}

function copyFile(onSuccess, onFailure) {
  var fs = require('fs');
  fs.readFile('file1.txt', { encoding: 'utf-8' }, function (error, data) {
    if (error) {
      onFailure(error.code);
    } else {
      writeCopy(data, onSuccess, onFailure);
    }   
  });
} 

この解決策は一応は機能しますが、いくつか問題があります。

次に、これらの問題を解決するために、これまでに学んだ手法を使用する方法について説明していきます。

12.4 継続モナド

copyFileの例をFFIを使ってPureScriptへと翻訳していきましょう。PureScriptで書いていくにつれ、計算の構造はわかりやすくなり、 purescript-transformersパッケージで定義されている継続モナド変換子 ContTが自然に導入されることになるでしょう。

まず、FFIを使って readFilewriteFileに型を与えなくてはなりません。型同義語をいくつかと、ファイル入出力のための作用を定義することから始めましょう。

foreign import data FS :: Effect

type ErrorCode = String
type FilePath = String

readFileはファイル名と2引数のコールバックを引数に取ります。ファイルが正常に読み込まれた場合は、2番目の引数にはファイルの内容が含まれますが、そうでない場合は、最初の引数がエラーを示すために使われます。

今回は readFileを2つのコールバックを引数としてとる関数としてラップすることにします。先ほどの copyFilewriteCopyとまったく同じように、エラーコールバック(onFailure)と結果コールバック(onSuccess)の2つです。簡単のために Data.Functionの多引数関数の機能を使うと、このラップされた関数 readFileImplは次のようになるでしょう。

foreign import readFileImpl
  :: forall eff
   . Fn3 FilePath
         (String -> Eff (fs :: FS | eff) Unit)
         (ErrorCode -> Eff (fs :: FS | eff) Unit)
         (Eff (fs :: FS | eff) Unit)

外部JavaScriptモジュールでは、readFileImplは次のように定義されます。

exports.readFileImpl = function(path, onSuccess, onFailure) {
  return function() {
    require('fs').readFile(path, {
      encoding: 'utf-8'
    }, function(error, data) {
      if (error) {
        onFailure(error.code)();
      } else {
        onSuccess(data)();
      }
    });
  };
};

readFileImplはファイルパス、成功時のコールバック、失敗時のコールバックという3つの引数を取り、空(Unit)の結果を返す副作用のある計算を返す、ということをこの型は言っています。コー​​ルバック自身にも、その作用を追跡するために Effモナドを使うような型が与えられていることに注意してください。

この readFileImplの実装がその型の正しい実行時表現を持っている理由を、よく理解しておくようにしてください。

writeFileImplもよく似ています。違いはファイルがコールバックではなく関数自身に渡されるということだけです。実装は次のようになります。

foreign import writeFileImpl
  :: forall eff
   . Fn4 FilePath
         String
         (Eff (fs :: FS | eff) Unit)
         (ErrorCode -> Eff (fs :: FS | eff) Unit)
         (Eff (fs :: FS | eff) Unit)
exports.writeFileImpl = function(path, data, onSuccess, onFailure) {
  return function() {
    require('fs').writeFile(path, data, {
      encoding: 'utf-8'
    }, function(error) {
      if (error) {
        onFailure(error.code)();
      } else {
        onSuccess();
      }
    });
  };
};

これらのFFIの宣言が与えられれば、 readFilewriteFileの実装を書くことができます。 Data.Functionライブラリを使って、多引数のFFIバインディングを通常の(カリー化された)PureScript関数へと変換するので、もう少し読みやすい型になるでしょう。

さらに、成功時と失敗時の2つの必須のコールバックに代わって、成功か失敗のどちらか(Either) に対応した単一のコールバックを要求するようにします。つまり、新しいコールバックは引数として Either ErrorCodeモナドの値をとります。

readFile :: forall eff . FilePath
  -> (Either ErrorCode String -> Eff (fs :: FS | eff) Unit)
  -> Eff (fs :: FS | eff) Unit
readFile path k =
  runFn3 readFileImpl
         path
         (k <<< Right)
         (k <<< Left)

writeFile :: forall eff . FilePath
  -> String
  -> (Either ErrorCode Unit -> Eff (fs :: FS | eff) Unit)
  -> Eff (fs :: FS | eff) Unit
writeFile path text k =
  runFn4 writeFileImpl
         path
         text
         (k $ Right unit)
         (k <<< Left)

ここで、重要なパターンを見つけることができます。これらの関数は何らかのモナド(この場合は Eff (fs :: FS | eff))で値を返すコールバックをとり、同一のモナドで値を返します。これは、最初のコールバックが結果を返したときに、そのモナドは次の非同期関数の入力に結合するためにその結果を使用することができることを意味しています。実際、 copyFileの例で手作業でやったことがまさにそれです。

これは purescript-transformersControl.Monad.Cont.Transモジュールで定義されている継続モナド変換子(continuation monad transformer)の基礎となっています。

ContTは次のようなnewtypeとして定義されます。

newtype ContT r m a = ContT ((a -> m r) -> m r)

継続(continuation)はコールバックの別名です。継続は計算の残余(remainder)を捕捉します。ここで「残余」とは、非同期呼び出しが行われ、結果が提供された後に起こることを指しています。

ContTデータ構築子の引数は readFilewriteFileの型ととてもよく似ています。実際、もし型aErrorCode String型、rUnitmをモナドEff(fs :: FS | eff)というように選ぶと、readFileの型の右辺を復元することができます。

readFilewriteFileのような非同期のアクションを組み立てるために使うAsyncモナドを定義するため、次のような型同義語を導入します。

type Async eff = ContT Unit (Eff eff)

今回の目的では Effモナドを変換するために常に ContTを使い、型 rは常に Unitになりますが、必ずそうしなければならないというわけではありません。

ContTデータ構築子を適用するだけで、 readFilewriteFileAsyncモナドの計算として扱うことができます。

readFileCont
  :: forall eff
   . FilePath
  -> Async (fs :: FS | eff) (Either ErrorCode String)
readFileCont path = ContT $ readFile path

writeFileCont
  :: forall eff
   . FilePath
  -> String
  -> Async (fs :: FS | eff) (Either ErrorCode Unit)
writeFileCont path text = ContT $ writeFile path text

ここで ContTモナド変換子に対してdo記法を使うだけで、ファイル複製処理を書くことができます。

copyFileCont
  :: forall eff
   . FilePath
  -> FilePath
  -> Async (fs :: FS | eff) (Either ErrorCode Unit)
copyFileCont src dest = do
  e <- readFileCont src
  case e of
    Left err -> pure $ Left err
    Right content -> writeFileCont dest content

readFileContの非同期性がdo記法によってモナドの束縛に隠されていることに注目してください。これはまさに同期的なコードのように見えますが、 ContTモナド変換子は非同期関数を書くのを手助けしているのです。

継続を与えて runContTハンドラを使うと、この計算を実行することができます。この継続は次に何をするか、例えば非同期なファイル複製処理が完了した時に何をするか、を表しています。この簡単な例では、型 Either ErrorCode Unitの結果をコンソールに出力する logShow関数を単に継続として選んでいます。

import Prelude

import Control.Monad.Eff.Console (logShow)
import Control.Monad.Cont.Trans (runContT)

main =
  runContT
    (copyFileCont "/tmp/1.txt" "/tmp/2.txt")
    logShow

演習

  1. (簡単)readFileContwriteFileContを使って、2つのテキストフ​​ァイルを連結する関数を書いてください。

  2. (やや難しい) FFIを使って、 setTimeout関数に適切な型を与えてください。また、 Asyncモナドを使った次のようなラッパー関数を書いてください。

    type Milliseconds = Int
    
    foreign import data TIMEOUT :: Effect
    
    setTimeoutCont
      :: forall eff
       . Milliseconds
      -> Async (timeout :: TIMEOUT | eff) Unit
    

12.5 ExceptTを機能させる

この方法はうまく動きますが、まだ改良の余地があります。

copyFileContの実装において、次に何をするかを決定するためには、パターン照合を使って(型 Either ErrorCode Stringの)readFileCont計算の結果を解析しなければなりません。しかしながら、 Eitherモナドは対応するモナド変換子 ExceptTを持っていることがわかっているので、 ContTを持つ ExceptTを使って非同期計算とエラー処理の2つの作用を結合できると期待するのは理にかなっています。

実際にそれは可能で、 ExceptTの定義を見ればそれがなぜかがわかります。

newtype ExceptT e m a = ExceptT (m (Either e a))

ExceptTは基礎のモナドの結果を単純に aから Either e aに変更します。現在のモナドスタックを ExceptT ErrorCode変換子で変換するように、 copyFileContを書き換えることができることを意味します。それは現在の方法に ExceptTデータ構築子を適用するだけなので簡単です。型同義語を与えると、ここでも型シグネチャを整理することができます。

readFileContEx
  :: forall eff
   . FilePath
  -> ExceptT ErrorCode (Async (fs :: FS | eff)) String
readFileContEx path = ExceptT $ readFileCont path

writeFileContEx
  :: forall eff
   . FilePath
  -> String
  -> ExceptT ErrorCode (Async (fs :: FS | eff)) Unit
writeFileContEx path text = ExceptT $ writeFileCont path text

非同期エラー処理が ExceptTモナド変換子の内部に隠されているので、このファイル複製処理ははるかに単純になります。

copyFileContEx
  :: forall eff
   . FilePath
  -> FilePath
  -> ExceptT ErrorCode (Async (fs :: FS | eff)) Unit
copyFileContEx src dest = do
  content <- readFileContEx src
  writeFileContEx dest content

演習

  1. (やや難しい) 任意のエラーを処理するために、 ExceptTを使用して2つのファイルを連結しする先ほどの解決策を書きなおしてください。

  2. (やや難しい) 入力ファイル名の配列を与えて複数のテキストファイルを連結する関数 concatenateManyを書く。 ヒントtraverseを使用します。

12.6 HTTPクライアント

ContTを使って非同期機能を処理する例として、この章のソースコードの Network.HTTP.Clientモジュールについても見ていきましょう。このモジュールでは Asyncモナドを使用して、NodeJSの非同期を requestモジュールを使っています。

requestモジュールは、URLとコールバックを受け取り、応答が利用可能なとき、またはエラーが発生したときにHTTP(S)リクエストを生成してコールバックを呼び出す関数を提供します。 リクエストの例を次に示します。

require('request')('http://purescript.org'), function(err, _, body) {
  if (err) {
    console.error(err);
  } else {
    console.log(body);
  }
});

Asyncモナドを使うと、この簡単な例をPureScriptで書きなおすことができます。

Network.HTTP.Clientモジュールでは、 requestメソッドは以下のようなAPIを持つ関数 getImplとしてラップされています。

foreign import data HTTP :: Effect

type URI = String

foreign import getImpl
  :: forall eff
   . Fn3 URI
         (String -> Eff (http :: HTTP | eff) Unit)
         (String -> Eff (http :: HTTP | eff) Unit)
         (Eff (http :: HTTP | eff) Unit)
exports.getImpl = function(uri, done, fail) {
  return function() {
    require('request')(uri, function(err, _, body) {
      if (err) {
        fail(err)();
      } else {
        done(body)();
      }
    });
  };
};

再びData.Function.Uncurriedモジュールを使って、これを通常のカリー化されたPureScript関数に変換します。先ほどと同じように、2つのコールバックをMaybe Chunk型の値を受け入れるひとつのコールバックに変換しています。Either String String型の値を受け取り、ContTデータ構築子を適用してAsyncモナドのアクションを構築します。

get :: forall eff.
  URI ->
  Async (http :: HTTP | eff) (Either String String)
get req = ContT \k ->
  runFn3 getImpl req (k <<< Right) (k <<< Left)

演習

  1. (やや難しい)runContTを使ってHTTP応答の各チャンクをコンソールへ出力することで、 getを試してみてください。

  2. (やや難しい)readFileContwriteFileContに対して以前に行ったように、 ExceptTを使い getをラップする関数 getExを書いてください。

1.(難しい) getExwriteFileContExを使って、ディスク上のファイルからの内容をを保存する関数を書いてください。

12.7 並列計算

ContTモナドとdo記法を使って、非同期計算を順番に実行されるように合成する方法を見てきました。非同期計算を並列に合成することもできたら便利でしょう。

もしContTを使ってEffモナドを変換しているなら、単に2つの計算のうち一方を開始した後に他方の計算を開始すれば、並列に計算することができます。

purescript-parallelパッケージは型クラスParallelを定義します。この型クラスはモナドのために並列計算を提供するAsyncのようなものです。以前に本書でApplicative関手を導入したとき、並列計算を合成するときにApplicative関手がどのように便利なのかを観察しました。実はParallelのインスタンスは、(Asyncのような)モナドmと、並列に計算を合成するために使われるApplicative関手fとの対応関係を定義しているのです。

class (Monad m, Applicative f) <= Parallel f m | m -> f, f -> m where
  sequential :: forall a. f a -> m a
  parallel :: forall a. m a -> f a

このクラスは2つの関数を定義しています。

purescript-parallelライブラリは Asyncモナドの Parallelインスタンスを提供します。 これは、2つの継続(continuation)のどちらが呼び出されたかを追跡することによって、変更可能な参照を使用して並列に Asyncアクションを組み合わせます。 両方の結果が返されたら、最終結果を計算してメインの継続に渡すことができます。

parallel関数を使うとreadFileContアクションの別のバージョンを作成することもできます。これは並列に組み合わせることができます。2つのテキストファイルを並列に読み取り、連結してその結果を出力する簡単な例は次のようになります。

import Prelude
import Control.Apply (lift2)
import Control.Monad.Cont.Trans (runContT)
import Control.Monad.Eff.Console (logShow)
import Control.Monad.Parallel (parallel, sequential)

main = flip runContT logShow do
  sequential $
   lift2 append
     <$> parallel (readFileCont "/tmp/1.txt")
     <*> parallel (readFileCont "/tmp/2.txt")

readFileContEither ErrorCode String型の値を返すので、 lift2を使って Either型構築子より append関数を持ち上げて結合関数を形成する必要があることに注意してください。

Applicative関手では任意個引数の関数の持ち上げができるので、このApplicativeコンビネータを使ってより多くの計算を並列に実行することができます。 traversesequenceのようなApplicative関手を扱うすべての標準ライブラリ関数から恩恵を受けることもできます。

必要に応じて ParralelrunParallelを使って型構築子を変更することで、do記法ブロックのApplicativeコンビネータを使って、直列的なコードの一部で並列計算を結合したり、またはその逆を行ったりすることができます。

演習

  1. (簡単)parallelsequentialを使って2つのHTTPリクエストを作成し、それらのレスポンス内容を並行して収集します。あなたの結合関数は2つのレスポンス内容を連結しなければならず、続けて printを使って結果をコンソールに出力してください。

  2. (やや難しい)Asyncに対応するapplicative関手は Alternativeのインスタンスです。このインスタンスによって定義される <|>演算子は2つの計算を並列に実行し、最初に完了する計算結果を返します。

    この Alternativeインスタンスを setTimeoutCont関数と共に使用して関数を定義してください。

    timeout :: forall a eff
             . Milliseconds
            -> Async (timeout :: TIMEOUT | eff) a
            -> Async (timeout :: TIMEOUT | eff) (Maybe a)
    

    指定された計算が指定されたミリ秒数以内に結果を提供しない場合、 Nothingを返します。

  3. (やや難しい)purescript-parallelExceptTを含むいくつかのモナド変換子のための Parallelクラスのインスタンスも提供します。

    lift2appendを持ち上げる代わりに、 ExceptTを使ってエラー処理を行うように、並列ファイル入出力の例を書きなおしてください。解決策は Asyncモナドを変換するために ExceptT変換子を使うとよいでしょう。

    同様の手法で複数の入力ファイルを並列に読み込むために concatenateMany関数を書き換えてください。

  4. (難しい、拡張) ディスク上のJSON文書の配列が与えられ、それぞれの文書はディスク上の他のファイルへの参照の配列を含んでいるとします。

    { references: ['/tmp/1.json', '/tmp/2.json'] }
    

    入力として単一のファイル名をとり、そのファイルから参照されているディスク上のすべてのJSONファイルをたどって、参照されたすべてのファイルの一覧を収集するユーティリティを書いてください。

    そのユーティリティは、JSON文書を解析するために purescript-foreignライブラリを使用する必要があり、単一のファイルが参照するファイルは並列に取得しなければなりません!

まとめ

この章ではモナド変換子の実用的なデモンストレーションを見てきました。

第13章 テストの自動生成

13.1 この章の目標

この章では、テスティングの問題に対する、型クラスの特に洗練された応用について示します。どのようにテストするのかをコンパイラに教えるのではなく、コードがどのような性質を持っているべきかを教えることでテストします。型クラスを使って無作為データ生成のための定型コードを隠し、テストケースを仕様から無作為に生成することができます。これは生成的テスティング(generative testing、またはproperty-based testing)と呼ばれ、HaskellのQuickCheckライブラリによって知られるようになった手法です。

purescript-quickcheckパッケージはHaskellのQuickCheckライブラリをPureScriptにポーティングしたもので、型や構文はもとのライブラリとほとんど同じようになっています。 purescript-quickcheckを使って簡単なライブラリをテストし、Pulpでテストスイートを自動化されたビルドに統合する方法を見ていきます。

13.2 プロジェクトの準備

この章のプロジェクトにはBower依存関係として purescript-quickcheckが追加されます。

Pulpプロジェクトでは、テストソースは testディレクトリに置かれ、テストスイートのメインモジュールは Test.Mainと名づけられます。 テストスイートは、 pulp testコマンドを使用して実行できます。

13.3 プロパティの書き込み

Mergeモジュールでは purescript-quickcheckライブラリの機能を実演するために使う簡単な関数 mergeが実装されています。

merge :: Array Int -> Array Int -> Array Int

mergeは2つのソートされた数の配列をとって、その要素を統合し、ソートされた結果を返します。例えば次のようになります。

> import Merge
> merge [1, 3, 5] [2, 4, 6]

[1, 2, 3, 4, 5, 6]

典型的なテストスイートでは、手作業でこのような小さなテストケースをいくつも作成し、結果が正しい値と等しいことを確認することでテスト実施します。しかし、 merge関数について知る必要があるものはすべて、2つの性質に要約することができます。

purescript-quickcheckでは、無作為なテストケースを生成することで、直接これらの性質をテストすることができます。コードが持つべき性質を、次のような関数として述べるだけです。

main = do
  quickCheck \xs ys ->
    isSorted $ merge (sort xs) (sort ys)
  quickCheck \xs ys ->
    xs `isSubarrayOf` merge xs ys

ここで、 isSortedisSubarrayOfは次のような型を持つ補助関数として実装されています。

isSorted :: forall a. Ord a => Array a -> Boolean
isSubarrayOf :: forall a. Eq a => Array a -> Array a -> Boolean

このコードを実行すると、 purescript-quickcheckは無作為な入力 xsysを生成してこの関数に渡すことで、主張しようとしている性質を反証しようとします。何らかの入力に対して関数が falseを返した場合、性質は正しくないことが示され、ライブラリはエラーを発生させます。幸いなことに、次のように100個の無作為なテストケースを生成しても、ライブラリはこの性質を反証することができません。

$ pulp test

* Build successful. Running tests...

100/100 test(s) passed.
100/100 test(s) passed.

* Tests OK.

もし merge関数に意図的にバグを混入した場合(例えば、大なりのチェックを小なりのチェックへと変更するなど)、最初に失敗したテストケースの後で例外が実行時に投げられます。

Error: Test 1 failed:
Test returned false

このエラーメッセージではあまり役に立ちませんが、これから見ていくように、少しの作業で改良することができます。

13.4 エラーメッセージの改善

テストケースが失敗した時に同時にエラーメッセージを提供するには、 purescript-quickcheck演算子を使います。次のように性質の定義に続けて で区切ってエラーメッセージを書くだけです。

quickCheck \xs ys ->
  let
    result = merge (sort xs) (sort ys)
  in
    xs `isSubarrayOf` result <?> show xs <> " not a subarray of " <> show result

このとき、もしバグを混入するようにコードを変更すると、最初のテストケースが失敗したときに改良されたエラーメッセージが表示されます。

Error: Test 6 failed:
[79168] not a subarray of [-752832,686016]

入力 xsが無作為に選ばれた数の配列として生成されていることに注目してください。

演習

  1. (簡単) 空の配列を持つ配列を統合しても元の配列は変更されない、と主張する性質を書いてください。

  2. (簡単) mergeの残りの性質に対して、適切なエラーメッセージを追加してください。

13.5 多相的なコードのテスト

Mergeモジュールでは、数の配列だけでなく、 Ord型クラスに属するどんな型の配列に対しても動作する、 merge関数を一般化した mergePolyという関数が定義されています。

mergePoly :: forall a. Ord a => Array a -> Array a -> Array a

mergeの代わりに mergePolyを使うように元のテストを変更すると、次のようなエラーメッセージが表示されます。

No type class instance was found for

  Test.QuickCheck.Arbitrary.Arbitrary t0

The instance head contains unknown type variables.
Consider adding a type annotation.

このエラーメッセージは、配列に持たせたい要素の型が何なのかわからないので、コンパイラが無作為なテストケースを生成できなかったということを示しています。このような場合、補助関数を使と、コンパイラが特定の型を推論すること強制できます。例えば、恒等関数の同義語として intsという関数を定義します。

ints :: Array Int -> Array Int
ints = id

それから、コンパイラが引数の2つの配列の型 Array Intを推論するように、テストを変更します。

quickCheck \xs ys ->
  isSorted $ ints $ mergePoly (sort xs) (sort ys)
quickCheck \xs ys ->
  ints xs `isSubarrayOf` mergePoly xs ys

ここで、 numbers関数が不明な型を解消するために使われるので、 xsysはどちらも型 Array Intを持っています。

演習

  1. (簡単)xsysの型を Array Booleanに強制する関数 boolsを書き、 mergePolyをその型でテストする性質を追加してください。

  2. (やや難しい) 標準関数から(例えば purescript-arraysパッケージから)ひとつ関数を選び、適切なエラーメッセージを含めてQuickCheckの性質を書いてください。その性質は、補助関数を使って多相型引数を IntBooleanのどちらかに固定しなければいけません。

13.6 任意のデータの生成

purescript-quickcheckライブラリを使って性質についてのテストケースを無作為に生成する方法について説明します。

無作為に値を生成することができるような型は、次のような型クラス Arbitaryのインスタンスを持っています。

class Arbitrary t where
  arbitrary :: Gen t

Gen型構築子は決定的無作為データ生成の副作用を表しています。 決定的無作為データ生成は、擬似乱数生成器を使って、シード値から決定的無作為関数の引数を生成します。 Test.QuickCheck.Genモジュールは、ジェネレータを構築するためのいくつかの有用なコンビネータを定義します。

GenはモナドでもApplicative関手でもあるので、 Arbitary型クラスの新しいインスタンスを作成するのに、いつも使っているようなコンビネータを自由に使うことができます。

例えば、 purescript-quickcheckライブラリで提供されている Int型の Arbitraryインスタンスは、関数を整数から任意の整数値のバイトまでマップするための Functorインスタンスを Genに使用することで、バイト値の分布した値を生成します。

newtype Byte = Byte Int

instance arbitraryByte :: Arbitrary Byte where
  arbitrary = map intToByte arbitrary
    where
    intToByte n | n >= 0 = Byte (n `mod` 256)
                | otherwise = intToByte (-n)

ここでは、0から255までの間の整数値であるような型 Byteを定義しています。 Arbitraryインスタンスの <$>演算子を使って、 uniformToByte関数を arbitraryアクションまで持ち上げています。この型の arbitraryアクションの型は Gen Numberだと推論されますが、これは0から1の間に均一に分布する数を生成することを意味しています。

この考え方を mergeに対しての既ソート性テストを改良するのに使うこともできます。

quickCheck \xs ys ->
  isSorted $ numbers $ mergePoly (sort xs) (sort ys)

このテストでは、任意の配列 xsysを生成しますが、 mergeはソート済みの入力を期待しているので、 xsysをソートしておかなければなりません。一方で、ソートされた配列を表すnewtypeを作成し、ソートされたデータを生成する Arbitraryインスタンスを書くこともできます。

newtype Sorted a = Sorted (Array a)

sorted :: forall a. Sorted a -> Array a
sorted (Sorted xs) = xs

instance arbSorted :: (Arbitrary a, Ord a) => Arbitrary (Sorted a) where
  arbitrary = map (Sorted <<< sort) arbitrary

この型構築子を使うと、テストを次のように変更することができます。

quickCheck \xs ys ->
  isSorted $ ints $ mergePoly (sorted xs) (sorted ys)

これは些細な変更に見えるかもしれませんが、 xsysの型はただの Array Intから Sorted Intへと変更されています。これにより、 mergePoly関数はソート済みの入力を取る、という意図を、わかりやすく示すことができます。理想的には、 mergePoly関数自体の型が Sorted型構築子を使うようにするといいでしょう。

より興味深い例として、 Treeモジュールでは枝の値でソートされた二分木の型が定義されています。

data Tree a
  = Leaf
  | Branch (Tree a) a (Tree a)

Treeモジュールでは次のAPIが定義されています。

insert    :: forall a. Ord a => a -> Tree a -> Tree a
member    :: forall a. Ord a => a -> Tree a -> Boolean
fromArray :: forall a. Ord a => Array a -> Tree a
toArray   :: forall a. Tree a -> Array a

insert関数は新しい要素をソート済みの二分木に挿入するのに使われ、 member関数は特定の値の有無を木に問い合わせるのに使われます。例えば次のようになります。

> import Tree

> member 2 $ insert 1 $ insert 2 Leaf
true

> member 1 Leaf
false

toArray関数と fromArray関数は、ソートされた木とソートされた配列を相互に変換するために使われます。 fromArrayを使うと、木についての Arbitraryインスタンスを書くことができます。

instance arbTree :: (Arbitrary a, Ord a) => Arbitrary (Tree a) where
  arbitrary = map fromArray arbitrary

aについての有効な Arbitaryインスタンスが存在していれば、テストする性質の引数の型として Tree aを使うことができます。例えば、 memberテストは値を挿入した後は常に trueを返すことをテストできます。

quickCheck \t a ->
  member a $ insert a $ treeOfInt t

ここでは、引数 tTree Number型の無作為に生成された木です。型引数は、識別関数 treeOfIntによって明確化されています。

演習

  1. (やや難しい) a-zの範囲から無作為に選ばれた文字の集まりを生成する Arbitraryインスタンスを持った、 Stringのnewtypeを作ってください。ヒントTest.QuickCheck.Genモジュールから elementsarrayOf関数を使います。

  2. (難しい) 木に挿入された値は、任意に多くの挿入があった後も、その木の構成要素であることを主張する性質を書いてください。

13.7 高階関数のテスト

Mergeモジュールは merge関数についての他の生成も定義します。 mergeAith関数は、統合される要素の順序を決定するのに使われる、追加の関数を引数としてとります。つまり mergeWithは高階関数です。

例えば、すでに長さの昇順になっている2つの配列を統合するのに、 length関数を最初の引数として渡します。このとき、結果も長さの昇順になっていなければなりません。

> import Data.String

> mergeWith length
    ["", "ab", "abcd"]
    ["x", "xyz"]

["","x","ab","xyz","abcd"]

このような関数をテストするにはどうしたらいいでしょうか。理想的には、関数であるような最初の引数を含めた、3つの引数すべてについて、値を生成したいと思うでしょう。

関数を無作為に生成せきるようにする、もうひとつの型クラスがあります。この型クラスは Coarbitraryと呼ばれており、次のように定義されています。

class Coarbitrary t where
  coarbitrary :: forall r. t -> Gen r -> Gen r

coarbitrary関数は、型 tと、関数の結果の型 rについての無作為な生成器を関数の引数としてとり、無作為な生成器をかき乱すのにこの引数を使います。つまり、この引数を使って、乱数生成器の無作為な出力を変更しているのです。

また、もし関数の定義域が Coarbitraryで、値域が Arbitraryなら、 Arbitraryの関数を与える型クラスインスタンスが存在しています。

instance arbFunction :: (Coarbitrary a, Arbitrary b) => Arbitrary (a -> b)

実は、これが意味しているのは、引数として関数を取るような性質を記述できるということです。 mergeWith関数の場合では、新しい引数を考慮するようにテストを修正すると、最初の引数を無作為に生成することができます。

既ソート性の性質については、必ずしも Ordインスタンスを持っているとは限らないので、結果がソートされているということを保証することができませんが、引数として渡す関数 fにしたがって結果がソートされている期待することはできます。さらに、2つの入力配列が fに従ってソートされている必要がありますので、 sortBy関数を使って関数 fが適用されたあとの比較に基づいて xsysをソートします。

quickCheck \xs ys f ->
  isSorted $
    map f $
      mergeWith (intToBool f)
                (sortBy (compare `on` f) xs)
                (sortBy (compare `on` f) ys)

ここでは、関数 fの型を明確にするために、関数 intToBoolを使用しています。

intToBool :: (Int -> Boolean) -> Int -> Boolean
intToBool = id

部分配列性については、単に関数の名前を mergeWithに変えるだけです。引き続き入力配列は結果の部分配列になっていると期待できます。

quickCheck \xs ys f ->
  xs `isSubarrayOf` mergeWith (numberToBool f) xs ys

関数は Arbitraryであるだけでなく Coarbitraryでもあります。

instance coarbFunction :: (Arbitrary a, Coarbitrary b) => Coarbitrary (a -> b)

これは値の生成が単純な関数だけに限定されるものではないことを意味しています。つまり、高階関数や、引数が高階関数であるような関数すら無作為に生成することができるのです。

13.8 Coarbitraryのインスタンスを書く

GenMonadApplicativeインスタンスを使って独自のデータ型に対して Arbitraryインスタンスを書くことができるのとちょうど同じように、独自の Coarbitraryインスタンスを書くこともできます。これにより、無作為に生成される関数の定義域として、独自のデータ型を使うことができるようになります。

Tree型の Coarbitraryインスタンスを書いてみましょう。枝に格納されている要素の型に Coarbitraryインスタンスが必要になります。

instance coarbTree :: Coarbitrary a => Coarbitrary (Tree a) where

Tree aの値を与えられた乱数発生器をかき乱す関数を記述する必要があります。入力値が Leafであれば、そのままの生成器を返します。

coarbitrary Leaf = id

もし木が Branchなら、 関数合成で独自のかき乱し関数を作ることにより、 左の部分木、値、右の部分木を使って生成器をかき乱します。

coarbitrary (Branch l a r) =
  coarbitrary l <<<
  coarbitrary a <<<
  coarbitrary r

これで、木を引数にとるような関数を含む性質を自由に書くことができるようになりました。たとえば、 Treeモジュールでは述語が引数のどんな部分木についても成り立っているかを調べる関数 anywhereが定義されています。

anywhere :: forall a. (Tree a -> Boolean) -> Tree a -> Boolean

これで、無作為にこの述語関数 anywhereを生成することができるようになりました。例えば、 anywhere関数が次のようなある命題のもとで不変であることを期待します。

quickCheck \f g t ->
  anywhere (\s -> f s || g s) t ==
    anywhere f (treeOfInt t) || anywhere g t

ここで、 treeOfInt関数は木に含まれる値の型を型 Intに固定するために使われています。

treeOfInt :: Tree Int -> Tree Int
treeOfInt = id

13.9 副作用のないテスト

テストの目的では通常、テストスイートの mainアクションには quickCheck関数の呼び出しが含まれています。しかし、副作用を使わない quickCheckPureと呼ばれる quickCheck関数の亜種もあります。 quickCheckPureは、入力として乱数の種をとり、テスト結果の配列を返す純粋な関数です。

PSCiを使用して quickCheckPureを使ってみましょう。ここでは merge操作が結合法則を満たすことをテストしてみます。

> import Prelude
> import Merge
> import Test.QuickCheck
> import Test.QuickCheck.LCG (mkSeed)

> :paste
… quickCheckPure (mkSeed 12345) 10 \xs ys zs ->
…   ((xs `merge` ys) `merge` zs) ==
…     (xs `merge` (ys `merge` zs))
… ^D

Success : Success : ...

quickCheckPureは乱数の種、生成するテストケースの数、テストする性質の3つの引数をとります。もしすべてのテストケースに成功したら、 Successデータ構築子の配列がコンソールに出力されます。

quickCheckPureは、性能ベンチマークの入力データ生成や、ウェブアプリケーションのフォームデータ例を無作為に生成するというような状況で便利かもしれません。

演習

  1. (簡単) ByteSorted型構築子についての Coarbitraryインスタンスを書いてください。

  2. (やや難しい)任意の関数 fについて、 mergeWith f関数の結合性を主張する(高階)性質を書いてください。 quickCheckPureを使って PSCiでその性質をテストしてください。

  3. (やや難しい)次のデータ型の Coarbitraryインスタンスを書いてください。

    data OneTwoThree a = One a | Two a a | Three a a a
    

    ヒントTest.QuickCheck.Genで定義された oneOf関数を使って Arbitraryインスタンスを定義します。

  4. (やや難しい)all関数を使って quickCheckPure関数の結果を単純化してください。その関数はもしどんなテストもパスするなら trueを返し、そうでなければ falseを返さなくてはいけません。 purescript-monoidsで定義されている Firstモノイドを、失敗時の最初のエラーを保存するために foldMap関数と一緒に使ってみてください。

まとめ

この章では、生成的テスティングのパラダイムを使って宣言的な方法でテストを書くための、 purescript-quickcheckパッケージを導入しました。

第14章 領域特化言語

14.1 この章の目標

この章では、多数の標準的な手法を使ったPureScriptにおける領域特化言語(domain-specific language, DSL) の実装について探求していきます。

領域特化言語とは、特定の問題領域での開発に適した言語のことです。領域特化言語の構文および機能は、その領域内の考え方を表現するコードの読みやすさを最大限に発揮すべく選択されます。本書の中では、すでに領域特化言語の例を幾つか見てきています。

この章では、領域特化言語の実装において、いくつかの標準的な手法による構造的なアプローチを取ります。これがこの話題の完全な説明だということでは決してありませんが、独自の目的に対する具体的なDSLを構築するには十分な知識を与えてくれるでしょう。

この章で実行している例は、HTML文書を作成するための領域特化言語になります。正しいHTML文書を記述するための型安全な言語を開発することが目的で、少しづつ実装を改善することによって作業していきます。

14.2 プロジェクトの準備

この章で使うプロジェクトには新しいBower依存性が追加されます。これから使う道具のひとつであるFreeモナドが定義されている purescript-freeライブラリです。

このプロジェクトのソースコードは、PSCiを使ってビルドすることができます。

14.3 HTMLデータ型

このHTMLライブラリの最も基本的なバージョンは Data.DOM.Simpleモジュールで定義されています。このモジュールには次の型定義が含まれています。

newtype Element = Element
  { name         :: String
  , attribs      :: Array Attribute
  , content      :: Maybe (Array Content)
  }

data Content
  = TextContent String
  | ElementContent Element

newtype Attribute = Attribute
  { key          :: String
  , value        :: String
  }

Element型はHTMLの要素を表しており、各要素は要素名、属性のペア​​の配列と、要素の内容でで構成されています。 contentプロパティでは、 Maybeタイプを使って要素が開いている(他の要素やテキストを含む)か閉じているかを示しています。

このライブラリの鍵となる機能は次の関数です。

render :: Element -> String

この関数はHTML要素をHTML文字列として出力します。 PSCiで明示的に適当な型の値を構築し、ライブラリのこのバージョンを試してみましょう。

$ pulp repl

> import Prelude
> import Data.DOM.Simple
> import Data.Maybe
> import Control.Monad.Eff.Console

> :paste
… log $ render $ Element
…   { name: "p"
…   , attribs: [
…       Attribute
…         { key: "class"
…         , value: "main"
…         }
…     ]
…   , content: Just [
…       TextContent "Hello World!"
…     ]
…   }
… ^D

Hello World!

unit

現状のライブラリにはいくつかの問題があります。

この章では、さまざまな手法を用いてこれらの問題を解決し、このライブラリーをHTML文書を作成するために使える領域特化言語にしていきます。

14.4 スマート構築子

最初に導入する手法は方法は単純なものですが、とても効果的です。モジュールの使用者にデータの表現を露出する代わりに、モジュールエクスポートリスト(module exports list)を使ってデータ構築子 ElementContentAttributeを隠蔽し、正しいことが明らかなデータだけ構築する、いわゆるスマート構築子(smart constructors)だけをエクスポートします。

例を示しましょう。まず、HTML要素を作成するための便利な関数を提供します。

element :: String -> Array Attribute -> Maybe (Array Content) -> Element
element name attribs content = Element
  { name:      name
  , attribs:   attribs
  , content:   content
  }

次に、 element関数を適用することによってHTML要素を作成する、スマート構築子を作成します。

a :: Array Attribute -> Array Content -> Element
a attribs content = element "a" attribs (Just content)

p :: Array Attribute -> Array Content -> Element
p attribs content = element "p" attribs (Just content)

img :: Array Attribute -> Element
img attribs = element "img" attribs Nothing

最後に、正しいデータ構造だけを構築することがわかっているこれらの関数をエクスポートするように、モジュールエクスポートリストを更新します。

module Data.DOM.Smart
  ( Element
  , Attribute(..)
  , Content(..)

  , a
  , p
  , img

  , render
  ) where

モジュールエクスポートリストはモジュール名の直後の括弧内に書きます。各モジュールのエクスポートは次の3種類のいずれかです。

ここでは、 Elementをエクスポートしていますが、データ構築子はエクスポートしていません。もしデータ構築子をエクスポートすると、モジュールの使用者が不正なHTML要素を構築できてしまいます。

AttributeContent型についてはデータ構築子をすべてエクスポートしています(エクスポートリストの記号 ..で示されています)。これから、これらの型にスマート構築子の手法を適用していきます。

すでにライブラリにいくつかの大きな改良を加わっていることに注意してください。

Content型にもとても簡単にこの手法を適用することができます。単にエクスポートリストから Content型のデータ構築子を取り除き、次のスマート構築子を提供します。

text :: String -> Content
text = TextContent

elem :: Element -> Content
elem = ElementContent

Attribute型にも同じ手法を適用してみましょう。まず、属性のための汎用のスマート構築子を用意します。最初の試みとしては、次のようなものになるかもしれません。

attribute :: String -> String -> Attribute
attribute key value = Attribute
  { key: key
  , value: value
  }

infix 4 attribute as :=

この定義では元の Element型と同じ問題に悩まされています。存在しなかったり、名前が間違っているような属性を表現することが可能です。この問題を解決するために、属性名を表すnewtypeを作成します。

newtype AttributeKey = AttributeKey String

それから、この演算子を次のように変更します。

attribute :: AttributeKey -> String -> Attribute
attribute (AttributeKey key) value = Attribute
  { key: key
  , value: value
  }

AttributeKeyデータ構築子をエクスポートしなければ、明示的にエクスポートされた次のような関数を使う以外に、使用者が型 AttributeKeyの値を構築する方法はありません。いくつかの例を示します。

href :: AttributeKey
href = AttributeKey "href"

_class :: AttributeKey
_class = AttributeKey "class"

src :: AttributeKey
src = AttributeKey "src"

width :: AttributeKey
width = AttributeKey "width"

height :: AttributeKey
height = AttributeKey "height"

新しいモジュールの最終的なエクスポートリストは次のようになります。もうどんなデータ構築子も直接エクスポートしていないことに注意してください。

module Data.DOM.Smart
  ( Element
  , Attribute
  , Content
  , AttributeKey

  , a
  , p
  , img

  , href
  , _class
  , src
  , width
  , height

  , attribute, (:=)
  , text
  , elem

  , render
  ) where

PSCiでこの新しいモジュールを試してみると、コードが大幅に簡潔になり、改良されていることがわかります。

$ pulp repl

> import Prelude
> import Data.DOM.Smart
> import Control.Monad.Eff.Console
> log $ render $ p [ _class := "main" ] [ text "Hello World!" ]

Hello World!

unit

しかし、基礎のデータ表現が変更されていないので、 render関数を変更する必要はなかったことにも注目してください。これはスマート構築子による手法の利点のひとつです。外部APIの使用者によって認識される表現から、モジュールの内部データ表現を分離することができるのです。

演習

  1. (簡単)Data.DOM.Smartモジュールで renderを使った新しいHTML文書の作成を試してみましょう。

  2. (やや難しい) checkeddisabledなど、値を要求しないHTML属性がありますが、これらは次のような空の属性として表示されるかもしれません。

    &lt;input disabled&gt;
    

    空の属性を扱えるように Attributeの表現を変更してください。要素に空の属性を追加するために、 attributeまたは :=の代わりに使える関数を記述してください。

14.5 幻影型

次に適用する手法についての動機を与えるために、次のコードを考えてみます。

> log $ render $ img
    [ src    := "cat.jpg"
    , width  := "foo"
    , height := "bar"
    ]

<img src="cat.jpg" width="foo" height="bar" />
unit

ここでの問題は、 widthheightについての文字列値を提供しているということで、ここで与えることができるのはピクセルやパーセントの単位の数値だけであるべきです。

AttributeKey型にいわゆる幻影型(phantom type)引数を導入すると、この問題を解決できます。

newtype AttributeKey a = AttributeKey String

定義の右辺に対応する型 aの値が存在しないので、この型変数 a幻影型と呼ばれています。この型 aはコンパイル時により多くの情報を提供するためだけに存在しています。任意の型 AttributeKey aの値は実行時には単なる文字列ですが、そのキーに関連付けられた値に期待されている型を教えてくれます。

AttributeKeyの新しい形式で受け取るように、 attribute関数の型を次のように変更します。

attribute :: forall a. IsValue a => AttributeKey a -> a -> Attribute
attribute (AttributeKey key) value = Attribute
  { key: key
  , value: toValue value
  }

ここで、幻影型の引数 aは、属性キーと属性値が互換性のある型を持っていることを確認するために使われます。使用者は AttributeKey aを型の値を直接作成できないので(ライブラリで提供されている定数を介してのみ得ることができます)、すべての属性が正しくなります。

IsValue制約は、キーに関連付けられた値がなんであれ、その値を文字列に変換し、生成したHTML内に出力できることを保証します。 IsValue型クラスは次のように定義されています。

class IsValue a where
  toValue :: a -> String

StringInt型についての型クラスインスタンスも提供しておきます。

instance stringIsValue :: IsValue String where
  toValue = id

instance intIsValue :: IsValue Int where
  toValue = show

また、これらの型が新しい型変数を反映するように、 AttributeKey定数を更新しなければいけません。

href :: AttributeKey String
href = AttributeKey "href"

_class :: AttributeKey String
_class = AttributeKey "class"

src :: AttributeKey String
src = AttributeKey "src"

width :: AttributeKey Int
width = AttributeKey "width"

height :: AttributeKey Int
height = AttributeKey "height"

これで、不正なHTML文書を表現することが不可能で、 widthheight属性を表現するのに数を使うことが強制されていることがわかります。

> import Prelude
> import Data.DOM.Phantom
> import Control.Monad.Eff.Console

> :paste
… log $ render $ img
…   [ src    := "cat.jpg"
…   , width  := 100
…   , height := 200
…   ]
… ^D

<img src="cat.jpg" width="100" height="200" />
unit

演習

  1. (簡単) ピクセルまたはパーセントの長さのいずれかを表すデータ型を作成してください。その型について IsValueのインスタンスを書いてください。この型を使うように widthheight属性を変更してください。

  2. (難しい) 幻影型を使って真偽値 truefalseについての表現を最上位で定義することで、 AttributeKeydisabledchackedのような空の属性を表現しているかどうかを符号化することができます。

    data True
    data False
    

    幻影型を使って、使用者が attribute演算子を空の属性に対して使うことを防ぐように、前の演習の解答を変更してください。

14.6 Freeモナド

APIに施す最後の変更は、 Content型をモナドにしてdo記法を使えるようにするために、Freeモナドと呼ばれる構造を使うことです。Freeモナドは、入れ子になった要素をわかりやすくなるよう、HTML文書の構造化を可能にします。次のようなコードを考えます。

p [ _class := "main" ]
  [ elem $ img
      [ src    := "cat.jpg"
      , width  := 100
      , height := 200
      ]
  , text "A cat"
  ]

これを次のように書くことができるようになります。

p [ _class := "main" ] $ do
  elem $ img
    [ src    := "cat.jpg"
    , width  := 100
    , height := 200
    ]
  text "A cat"

しかし、do記法だけがFreeモナドの恩恵だというわけではありません。モナドのアクションの表現をその解釈から分離し、同じアクションに複数の解釈を持たせることをFreeモナドは可能にします。

Freeモナドは purescript-freeライブラリの Control.Monad.Freeモジュールで定義されています。 PSCiを使うと、次のようにFreeモナドについての基本的な情報を見ることができます。

> import Control.Monad.Free

> :kind Free
(Type -> Type) -> Type -> Type

Freeの種は、引数として型構築子を取り、別の型構築子を返すことを示しています。実は、 Freeモナドは任意の FunctorMonadにするために使うことができます!

モナドのアクションの表現を定義することから始めます。これを行うには、サポートする各モナドアクションそれぞれについて、ひとつのデータ構築子を持つ Functorを作成する必要があります。今回の場合、2つのモナドのアクションは elemtextになります。実際には、 Content型を次のように変更するだけです。

data ContentF a
  = TextContent String a
  | ElementContent Element a

instance functorContentF :: Functor ContentF where
  map f (TextContent s x) = TextContent s (f x)
  map f (ElementContent e x) = ElementContent e (f x)

ここで、この ContentF型構築子は以前の Contentデータ型とよく似ています。 Functorインスタンスでは、単に各データ構築子で型 aの構成要素に関数 fを適用します。

これにより、最初の型引数として ContentF型構築子を使うことで構築された、新しい Content型構築子を Freeモナドを包むnewtypeとして定義することができます。

type Content = Free ContentF

型のシノニムの代わりにnewtypeを使用して、使用者に対してライブラリの内部表現を露出することを避ける事ができます。 Contentデータ構築子を隠すことで、提供しているモナドのアクションだけを使うことを仕様者に制限しています。

ContentFFunctorなので、 Free ContentFに対する Monadインスタンスが自動的に手に入り、このインスタンスを Content上の Monadインスタンスへと持ち上げることができます。

Contentの新しい型引数を考慮するように、少し Elementデータ型を変更する必要があります。モナドの計算の戻り値の型が Unitであることだけが要求されます。

newtype Element = Element
  { name         :: String
  , attribs      :: Array Attribute
  , content      :: Maybe (Content Unit)
  }

また、 Contentモナドについての新しいモナドのアクションになる elemtext関数を変更する必要があります。これを行うには、 Control.Monad.Freeモジュールで提供されている liftF関数を使います。この関数の(簡略化された)型は次のようになっています。

liftF :: forall f a. (Functor f) => f a -> Free f a

liftFは、何らかの型 aについて、型 f aの値からFreeモナドのアクションを構築できるようにします。今回の場合、 ContentF型構築子のデータ構築子を次のようにそのまま使うだけです。

text :: String -> Content Unit
text s = liftF $ TextContent s unit

elem :: Element -> Content Unit
elem e = liftF $ ElementContent e unit

他にもコードの変更はありますが、興味深い変更は render関数に対してのものです。ここでは、このFreeモナドを解釈しなければいけません。

14.7 モナドの解釈

Control.Monad.Freeモジュールでは、Freeモナドで計算を解釈するための多数の関数が提供されています。

runFree
  :: forall f a
   . Functor f
  => (f (Free f a) -> Free f a)
  -> Free f a
  -> a

runFreeM
  :: forall f m a
   . (Functor f, MonadRec m)
  => (f (Free f a) -> m (Free f a))
  -> Free f a
  -> m a

runFree関数は、純粋な結果を計算するために使用されます。 runFreeM関数は、フリーモナドの動作を解釈するためにモナドを使用することを可能にします

厳密には、 MonadRecのより強い制約を満たすモナド mを使用する制限がされています。これはスタックオーバーフローを心配する必要がないことを意味します。なぜなら mは安全な末尾再帰モナド(monadic tail recursion)をサポートするからです。

まず、アクションを解釈することができるモナドを選ばなければなりません。 Writer Stringモナドを使って、結果のHTML文字列を累積することにします。

新しい renderメソッドは補助関数 renderElementに移譲して開始し、 Writerモナドで計算を実行するため execWriterを使用します。

render :: Element -> String
render = execWriter <<< renderElement

renderElementはwhereブロックで定義されています。

  where
    renderElement :: Element -> Writer String Unit
    renderElement (Element e) = do

renderElementの定義は簡単で、いくつかの小さな文字列を累積するために Writerモナドの tellアクションを使っています。

      tell "<"
      tell e.name
      for_ e.attribs $ \x -> do
        tell " "
        renderAttribute x
      renderContent e.content

次に、同じように簡単な renderAttribute関数を定義します。

    where
      renderAttribute :: Attribute -> Writer String Unit
      renderAttribute (Attribute x) = do
        tell x.key
        tell "=\""
        tell x.value
        tell "\""

renderContent関数は、もっと興味深いものです。ここでは、 runFreeM関数を使って、Freeモナドの内部で補助関数 renderContentItemに移譲する計算を解釈しています。

      renderContent :: Maybe (Content Unit) -> Writer String Unit
      renderContent Nothing = tell " />"
      renderContent (Just content) = do
        tell ">"
        runFreeM renderContentItem content
        tell "</"
        tell e.name
        tell ">"

renderContentItemの型は runFreeMの型シグネチャから推測することができます。関手 fは型構築子 ContentFで、モナド mは解釈している計算のモナド、つまり Writer Stringです。これにより renderContentItemについて次の型シグネチャがわかります。

      renderContentItem :: ContentF (Content Unit) -> Writer String (Content Unit)

ContentFの二つのデータ構築子でパターン照合するだけで、この関数を実装することができます。

      renderContentItem (TextContent s rest) = do
        tell s
        pure rest
      renderContentItem (ElementContent e rest) = do
        renderElement e
        pure rest

それぞれの場合において、式 restは型 Writer Stringを持っており、解釈計算の残りを表しています。 restアクションを呼び出すことによって、それぞれの場合を完了することができます。

これで完了です!PSCiで、次のように新しいモナドのAPIを試してみましょう。

> import Prelude
> import Data.DOM.Free
> import Control.Monad.Eff.Console

> :paste
… log $ render $ p [] $ do
…   elem $ img [ src := "cat.jpg" ]
…   text "A cat"
… ^D

<p><img src="cat.jpg" />A cat</p>
unit

演習

  1. (やや難しい)ContentF型に新しいデータ構築子を追加して、生成されたHTMLにコメントを出力する新しいアクション commentに対応してください。 liftFを使ってこの新しいアクションを実装してください。新しい構築子を適切に解釈するように、解釈 renderContentItemを更新してください。

14.8 言語の拡張

すべてのアクションが型 Unitの何かを返すようなモナドは、さほど興味深いものではありません。実際のところ、概ね良くなったと思われる構文は別として、このモナドは Monoid以上の機能は何の追加していません。

意味のある結果を返す新しいモナドアクションでこの言語を拡張することで、Freeモナド構造の威力を説明しましょう​​。

アンカーを使用して文書のさまざまな節へのハイパーリンクが含まれているHTML文書を生成するとします。手作業でアンカーの名前を生成すればいいので、これは既に実現できています。文書中で少なくとも2回、ひとつはアンカーの定義自身に、もうひとつはハイパーリンクに、アンカーが含まれています。しかし、この方法には根本的な問題がいくつかあります。

自分の間違いから開発者を保護するために、アンカー名を表す新しい型を導入し、新しい一意な名前を生成するためのモナドアクションを提供することができます。

最初の手順は、名前の型を新しく追加することです。

newtype Name = Name String

runName :: Name -> String
runName (Name n) = n

繰り返しになりますが、 NameStringのnewtypeとして定義しており、モジュールのエクスポートリスト内でデータ構築子をエクスポートしないように注意する必要があります。

次に、属性値として Nameを使うことができるように、新しい型 IsValue型クラスのインスタンスを定義します。

instance nameIsValue :: IsValue Name where
  toValue (Name n) = n

また、次のように a要素に現れるハイパーリンクの新しいデータ型を定義します。

data Href
  = URLHref String
  | AnchorHref Name

instance hrefIsValue :: IsValue Href where
  toValue (URLHref url) = url
  toValue (AnchorHref (Name nm)) = "#" <> nm

href属性の型の値を変更して、この新しい Href型の使用を強制します。また、要素をアンカーに変換するのに使う新しい name属性を作成します。

href :: AttributeKey Href
href = AttributeKey "href"

name :: AttributeKey Name
name = AttributeKey "name"

残りの問題は、現在モジュールの使用者が新しい名前を生成する方法がないということです。 Contentモナドでこの機能を提供することができます。まず、 ContentF型構築子に新しいデータ構築子を追加する必要があります。

data ContentF a
  = TextContent String a
  | ElementContent Element a
  | NewName (Name -> a)

NewNameデータ構築子は型 Nameの値を返すアクションに対応しています。データ構築子の引数として Nameを要求するのではなく、型 Name -> a関数を提供するように使用者に要求していることに注意してください。型 a計算の残りを表していることを思い出すと、この関数は、型 Nameの値が返されたあとで、計算を継続する方法を提供するというように直感的に理解することができます。

新しいデータ構築子を考慮するように、 ContentFについての Functorインスタンスを更新する必要があります。

instance functorContentF :: Functor ContentF where
  map f (TextContent s x) = TextContent s (f x)
  map f (ElementContent e x) = ElementContent e (f x)
  map f (NewName k) = NewName (f <<< k)

そして、先ほど述べたように、 liftF関数を使うと新しいアクションを構築することができます。

newName :: Content Name
newName = liftF $ NewName id

id関数を継続として提供していることに注意してください。型 Nameの結果を変更せずに返すということを意味しています。

最後に、新しいアクションを解釈するために、解釈関数を更新する必要があります。以前は計算を解釈するために Writer Stringモナドを使っていましたが、このモナドは新しい名前を生成する能力を持っていないので、何か他のものに切り替えなければなりません。WriterTモナド変換子をStateモナドと一緒に使うと、必要な作用を組み合わせることができます。型注釈を短く保てるように、この解釈モナドを型同義語として定義しておきます。

type Interp = WriterT String (State Int)

Int型の引数は状態の型で、この場合は増加していくカウンタとして振る舞う数であり、一意な名前を生成するのに使われます。

WriterWriterTモナドはそれらのアクションを抽象化するのに同じ型クラスメンバを使うので、どのアクションも変更する必要がありません。必要なのは、 Writer Stringへの参照すべてを Interpで置き換えることだけです。しかし、この計算を実行するために使われるハンドラを変更しなければいけません。 execWriterの代わりに、 evalStateを使います。

render :: Element -> String
render e = evalState (execWriterT (renderElement e)) 0

新しい NewNameデータ構築子を解釈するために、 renderContentItemに新しい場合分けを追加しなければいけません。

renderContentItem (NewName k) = do
  n <- get
  let fresh = Name $ "name" <> show n
  put $ n + 1
  pure (k fresh)

ここで、型 Name -> Interp aの継続 kが与えられているので、型 Interp aの解釈を構築しなければいけません。この解釈は単純です。 getを使って状態を読み、その状態を使って一意な名前を生成し、それから putで状態をインクリメントしています。最後に、継続にこの新しい名前を渡して、計算を完了します。

これにより、 PSCiで、 Contentモナドの内部で一意な名前を生成し、要素の名前とハイパーリンクのリンク先の両方を使って、この新しい機能を試してみましょう。

> import Prelude
> import Data.DOM.Name
> import Control.Monad.Eff.Console

> :paste
… render $ p [ ] $ do
…   top <- newName
…   elem $ a [ name := top ] $
…     text "Top"
…   elem $ a [ href := AnchorHref top ] $
…     text "Back to top"
… ^D

TopBack to top

unit

複数回の newName呼び出しの結果が、実際に一意な名前になっていることを確かめてみてください。

演習

  1. (やや難しい) 使用者から Element型を隠蔽すると、さらにAPIを簡素化することができます。次の手順に従って、これらの変更を行ってください。

    • pimgのような(返り値が Elementの)関数を elemアクションと結合して、型 Content Unitを返す新しいアクションを作ってください。
    • Content aの引数を許容し、結果の型 Tuple Stringを返すように、 render関数を変更してください。
  2. (やや難しい) 型同義語の代わりに newtypeを使って Contentモナドの実装を隠し、 newtypeのためにデータ構築子をエクスポートしないでください。

  3. (難しい) ContentF型を変更して、次の新しいアクションをサポートするようにしてください。

    isMobile :: Content Boolean
    

このアクションは、この文書がモバイルデバイス上での表示のためにレンダリングされているかどうかを示す真偽値を返します。  
  ヒントaskアクションとReaderT型変換子を使って、このアクションを解釈してみてください。あるいは、RWSモナドを使うほうが好みの人もいるかもしれません。

まとめ

この章では、いくつかの標準的な技術を使って、単純な実装を段階的に改善することにより、HTML文書を作成するための領域特化言語を開発しました。

使用者が間違いを犯すのを防ぎ、領域特化言語の構文を改良するために、これらの手法はすべてPureScriptのモジュールと型システムを活用しています。

関数型プログラミング言語による領域特化言語の実装は活発に研究されている分野ですが、いくつかの簡単なテクニックに対して役に立つ導入を提供し、表現力豊かな型を持つ言語で作業すること威力を示すことができていれば幸いです。