HaskellのParsecライブラリのまとめ

インポート

Parsecを使用するには、モジュールParsecをインポートする。

1	import Text.ParserCombinators.Parsec

パーサ一覧

関数/パーサ	runParser
引数	パーサ, 状態の初期値, ファイルパス, パース対象
パーサの戻り値	Either
説明	パーサを実行し、Eitherを返す。パースが成功した場合はRight、失敗した場合はLeftを返す。ファイルパスは、パースが失敗したときのメッセージに使わる。
例	1  2  3  4  5  6  7  putStrLn $ show $ runParser (string "test") () "error" "test" -- > Right "test" putStrLn $ show $ runParser (string "test") () "error" "abc" -- > Left "error" (line 1, column 1): -- > unexpected "a" -- > expecting "test"
関数/パーサ	parseTest
引数	パーサ, パーサ対象文字列
パーサの戻り値	IO (), 結果をコンソールに出力
説明	パーサを実行し、結果をコンソールに出力する
例	1  2  3  parseTest (string "this is test") "this is test" -- > "this is test"
関数/パーサ	string
引数	String
パーサの戻り値	String
説明	文字列をパースし、マッチした文字列を返す
例	1  2  3  parseTest (string "Hello") "Hello World" -- > "Hello" parseTest (string "Hello") "hello world" -- > Error
関数/パーサ	char
引数	Char
パーサの戻り値	Char
説明	文字をパースし、マッチした文字を返す
例	1  2  3  parseTest (char 'a') "a" -- > "a" parseTest (char 'a') "b" -- > Error
関数/パーサ	many
引数	パーサ
パーサの戻り値	パーサの戻り値の配列
説明	０回以上与えられたパーサを適用する。 まっちしなくてもパースは成功する。
例	1  2  3  4  5  parseTest (many $ char 'a') "aaa" -- > "aaa" parseTest (many $ char 'a') "abc" -- > "a" parseTest (many $ char 'a') "" -- > "" parseTest (many $ char 'a') "b" -- > ""
関数/パーサ	many1
引数	パーサ
パーサの戻り値	パーサの戻り値の配列
説明	１回以上与えられたパーサを適用する。
例	1  2  3  4  5  parseTest (many1 $ char 'a') "aaa" -- > "aaa" parseTest (many1 $ char 'a') "abc" -- > "a" parseTest (many1 $ char 'a') "" -- > Error parseTest (many1 $ char 'a') "b" -- > Error
関数/パーサ	upper
引数	なし
パーサの戻り値	Char
説明	大文字とマッチする
例	1  2  3  4  parseTest (many upper) "AAA" -- > "AAA" parseTest (many upper) "Abc" -- > "A" parseTest (many upper) "abc" -- > ""
関数/パーサ	lower
引数	なし
パーサの戻り値	Char
説明	小文字とマッチする
例	1  2  3  4  parseTest (many lower) "abc" -- > "abc" parseTest (many lower) "aBc" -- > "a" parseTest (many lower) "A" -- > ""
関数/パーサ	alphaNum
引数	なし
パーサの戻り値	Char
説明	数字とアルファベットにマッチする
例	1  2  3  4  5  6  parseTest (many alphaNum) "abc" -- > "abc" parseTest (many alphaNum) "123" -- > "123" parseTest (many alphaNum) "1b3" -- > "1b3" parseTest (many alphaNum) "1_3" -- > "1" parseTest (many alphaNum) "%" -- > ""
関数/パーサ	letter
引数	なし
パーサの戻り値	Char
説明	アルファベットにマッチする
例	1  2  3  4  parseTest (many letter) "abc" -- > "abc" parseTest (many letter) "123" -- > "" parseTest (many letter) "%" -- > ""
関数/パーサ	digit
引数	なし
パーサの戻り値	Char
説明	数字にマッチする
例	1  2  3  4  parseTest (many digit) "abc" -- > "" parseTest (many digit) "123" -- > "123" parseTest (many digit) "%" -- > ""
関数/パーサ	anyChar
引数	なし
パーサの戻り値	Char
説明	どんな文字にもマッチする
例	1  2  3  parseTest (many anyChar) "a|~" -- > "a|~" parseTest (many anyChar) "1/+" -- > "1/+"
関数/パーサ	oneOf
引数	[Char]
パーサの戻り値	Char
説明	指定した文字のどれかにマッチする
例	1  2  3  4  parseTest (many $ oneOf "xyz") "abc" -- > "" parseTest (many $ oneOf "xyz") "xxx" -- > "xxx" parseTest (many $ oneOf "xyz") "xy_" -- > "xy"
関数/パーサ	noneOf
引数	[Char]
パーサの戻り値	Char
説明	指定した文字以外の文字にマッチする
例	1  2  3  4  parseTest (many $ noneOf "xyz") "abc" -- > "abc" parseTest (many $ noneOf "xyz") "xxx" -- > "" parseTest (many $ noneOf "xyz") "abz" -- > "ab"
関数/パーサ	<|>
引数	パーサ <|> パーサ
パーサの戻り値	パーサ
説明	２つのパーサのうち成功した方を返す。
例	1  2  3  4  5  6  7  8  9  10  11  12  13  14  15  16  parseTest (string "abc" <|> string "xyz") "abc" -- > "abc" parseTest (string "abc" <|> string "xyz") "xyz" -- > "xyz" parseTest (string "abc" <|> string "xyz") "123" -- > Error -- > "123"は"abc"と"xyz"にはマッチしないので失敗 parseTest ((string "abc") <|> return "failed") "xyz" -- > "failed" -- > "abc"は"xyz"とはマッチしないので、 -- > 'return "failed"'が呼ばれた。 parseTest ((string "abc") <|> return "failed") "abx" -- > Error -- > "abx"が"abc"の"ab"までマッチしたので全体が失敗。 -- > 途中までマッチして失敗すると全体が失敗する。
関数/パーサ	try
引数	パーサ
パーサの戻り値	パーサ
説明	指定したパーサが途中失敗しても、入力列を消費せずにパースを続ける
例	1  2  3  4  5  6  parseTest ((try $ string "abc") <|> return "failed") "abc" -- > "abc" parseTest ((try $ string "abc") <|> return "failed") "abx" -- > "failed" -- > 途中までマッチして失敗しても、次のパーサが呼ばれた。
関数/パーサ	choice
引数	パーサの配列
パーサの戻り値	マッチしたパーサの戻り値
説明	指定したパーサのどれかにマッチする
例	1  2  3  4  5  6  7  8  9  10  11  12  13  parseTest (choice [string "abc", string "xyz"]) "abc" -- > "abc" parseTest (choice [string "abc", string "xyz"]) "xyz" -- > "xyz" parseTest (choice [string "abc", string "abd"]) "abd" -- > Error -- > "abd"が"abc"の"ab"までマッチしているので -- > 失敗する。Parsecは、途中まで成功して失敗すると、 -- > 全体が終了する。 tryを使うと良い。 parseTest (choice [try $ string "abc", string "abd"]) "abd" -- > "abd" -- > tryを使うことで途中で失敗しても、次のパーサを適用する。
関数/パーサ	option
引数	失敗したときの戻り値, パーサ
パーサの戻り値	パーサの戻り値
説明	マッチしたパーサか指定した戻り値を返す
例	1  2  3  parseTest (option "abc" $ string "xyz") "xyz" -- > "xyz" parseTest (option "abc" $ string "xyz") "123" -- > "abc"
関数/パーサ	sepBy
引数	トークンを表すパーサ, 区切りのパーサ
パーサの戻り値	トークンの配列
説明	同じトークンがある区切りを挟んで連続している列をパースする
例	1  2  3  4  parseTest (alphaNum `sepBy` (char ',')) "x,y,z" -- > "xyz" parseTest (alphaNum `sepBy` (char ',')) "x,y," -- > Error parseTest (alphaNum `sepBy` (char ',')) ",x,y," -- > ""
関数/パーサ	endBy
引数	トークンを表すパーサ, 区切りのパーサ
パーサの戻り値	トークンの配列
説明	ある区切りで終わるトークンの連続している列をパースする
例	1  2  3  4  parseTest (alphaNum `endBy` (char ';')) "x;y;z" -- > Error parseTest (alphaNum `endBy` (char ';')) "x;y;z;" -- > "xyz" parseTest (alphaNum `endBy` (char ';')) ";x;y;" -- > ""
関数/パーサ	eof
引数	なし
パーサの戻り値	()
説明	入力列の終わりとマッチする
例	1  2  parseTest (eof >> return "eof") "" -- > "eof"
関数/パーサ	notFlowedBy
引数	パーサ
パーサの戻り値	()
説明	指定したパーサの失敗を成功とする。入力列を消費しない。
例	1  2  3  4  5  6  7  8  9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  parseTest (do { x <- string "abc"               ; notFollowedBy letter               ; return x               }) "abc" -- > "abc"        parseTest (do { x <- string "abc"               ; notFollowedBy letter               ; return x               }) "abca" -- > Error        parseTest (do { x <- string "abc"               ; notFollowedBy letter               ; return x               }) "abc;" -- > "abc"        parseTest (do { x <- string "abc"               ; notFollowedBy letter               ; y <- char ';'               ; return $ x ++ [y]               }) "abc;" -- > "abc;" -- > notFollowedByで';'が消費されていないことがわかる
関数/パーサ	lookAead
引数	パーサ
パーサの戻り値	指定したパーサの戻り値
説明	入力列を消費せずに、指定したパーサの適用する。
例	1  2  3  4  5  6  7  8  9  10  11  12  13  14  15  16  17  18  19  20  parseTest (do { x <- string "abc"               ; y <- lookAhead $ string "123"               ; return $ x ++ y               }) "abc123" -- > "abc123" parseTest (do { x <- string "abc"               ; y <- lookAhead $ string "123"               ; return $ x ++ y               }) "abc;" -- > Error    parseTest (do { x <- string "abc"               ; lookAhead $ char ';'               ; y <- char ';'               ; return $ x ++ [y]               }) "abc;" -- > "abc;" -- > lookAheadで';'が消費されていないことがわかる
関数/パーサ	getState
引数	なし
パーサの戻り値	状態
説明	現在の状態を取り出す
例	1  2  3  4  5  6  7  8  9  10  runParser (getState >>= \x -> return x) "xyz" "error" "abc" -- > Right "xyz"    runParser (do { x <- many anyChar               ; setState x               ; y <- getState               ; return y               }) "" "error" "abc" -- > Right "abc"
関数/パーサ	setState
引数	状態
パーサの戻り値	()
説明	状態を設定する
例	1  2  3  4  5  6  7  8  9  10  runParser (getState >>= \x -> return x) "xyz" "error" "abc" -- > Right "xyz"    runParser (do { x <- many anyChar               ; setState x               ; y <- getState               ; return y               }) "" "error" "abc" -- > Right "abc"
関数/パーサ	getPosition
引数	なし
パーサの戻り値	SourcePos
説明	現在のパース位置を取得する
例	1  2  3  4  5  6  7  8  9  10  parseTest (do { x <- string "abc\nx"               ; p <- getPosition               ; return $ f p               }) "abc\nxyz"   where     lineNum p = show $ sourceLine p     columnNum p = show $ sourceColumn p     f p = "line: " ++ (lineNum p) ++ " column: " ++ (columnNum p) -- > "line: 2 column: 2"