parsec: Monadic parser combinators

[ bsd2, library, parsing ] [ Propose Tags ]

Parsec is designed from scratch as an industrial-strength parser library. It is simple, safe, well documented (on the package homepage), has extensive libraries, good error messages, and is fast. It is defined as a monad transformer that can be stacked on arbitrary monads, and it is also parametric in the input stream type.

The main entry point is the Text.Parsec module which provides defaults for parsing Character data.

The Text.ParserCombinators.Parsec module hierarchy contains the legacy parsec-2 API and may be removed at some point in the future.

[Skip to Readme]

Downloads

parsec-3.1.17.0.tar.gz [browse] (Cabal source package)
Package description (revised from the package)

Note: This package has metadata revisions in the cabal description newer than included in the tarball. To unpack the package including the revisions, use 'cabal get'.

Maintainer's Corner

Package maintainers

AntoineLatter, HerbertValerioRiedel, phadej

For package maintainers and hackage trustees

edit package information

Candidates

No Candidates

Versions [RSS]	2.0, 2.0.0.1, 2.1.0.0, 2.1.0.1, 3.0.0, 3.0.1, 3.1.0, 3.1.1, 3.1.2, 3.1.3, 3.1.4, 3.1.5, 3.1.6, 3.1.7, 3.1.8, 3.1.9, 3.1.10, 3.1.11, 3.1.12.0, 3.1.13.0, 3.1.14.0, 3.1.15.0, 3.1.15.1, 3.1.16.0, 3.1.16.1, 3.1.17.0
Change log	ChangeLog.md
Dependencies	base (>=4.5.1.0 && <4.21), bytestring (>=0.9.2.1 && <0.13), fail (>=4.9 && <4.10), mtl (>=2.1.3.1 && <2.4), semigroups (>=0.18 && <0.21), text (>=1.2.3.0 && <1.3 \|\| >=2.0 && <2.2) [details]
License	BSD-2-Clause
Author	Daan Leijen <daan@microsoft.com>, Paolo Martini <paolo@nemail.it>, Antoine Latter <aslatter@gmail.com>
Maintainer	Oleg Grenrus <oleg.grenrus@iki.fi>, Herbert Valerio Riedel <hvr@gnu.org>
Revised	Revision 1 made by phadej at 2024-04-05T09:09:28Z
Category	Parsing
Home page	https://github.com/haskell/parsec
Bug tracker	https://github.com/haskell/parsec/issues
Source repo	head: git clone https://github.com/haskell/parsec
Uploaded	by phadej at 2023-10-04T06:08:08Z
Distributions	Arch:3.1.15.0, Fedora:3.1.16.1, FreeBSD:3.1.9
Reverse Dependencies	938 direct, 13921 indirect [details]
Downloads	402866 total (488 in the last 30 days)
Rating	2.75 (votes: 17) [estimated by Bayesian average]
Your Rating	λ λ λ
Status	Docs available [build log] Last success reported on 2023-10-04 [all 1 reports]

Readme for parsec-3.1.17.0

[back to package description]

Parsec

Please refer to the package description on Hackage for more information.

A monadic parser combinator library, written by Daan Leijen. Parsec is designed from scratch as an industrial-strength parser library. It is simple, safe, well documented, has extensive libraries, good error messages, and is fast.

Some links:

Parsec on Hackage, contains the generated documentation.
The 2001 paper written by Daan Leijen, some what outdated (PDF, HTML, thanks to archive.org; and PDF, thanks to Microsoft Research).
Using Parsec, chapter 16 of Real World Haskell.
An introduction to the Parsec library on Kunigami's blog.
An introduction to parsing text in Haskell with Parsec on Wilson's blog.
Differences between Parsec and Attoparsec (Haskell's other prominent parser library) as explained in an answer on StackExchange.
Differences between Parsec and Happy (Haskell's parser generator) as explained in two answers on separate StackExchange questions (1, 2).
Differences between Parsec and Megaparsec (an advanced fork of Parsec) as explained in Megaparsec's README.

By analyzing Parsec's reverse dependencies on Hackage we can find open source project that make use of Parsec. For example bibtex, ConfigFile, csv and hjson.

Getting started

This requires a working version of cabal and ghci, which are part of any modern installation of Haskell, such as Haskell Platform.

First install Parsec.

cabal install parsec

Below we show how a very simple parser that tests matching parentheses was made from GHCI (the interactive GHC environment), which we started with the ghci command).

Prelude> :m +Text.Parsec
Prelude Text.Parsec> let parenSet = char '(' >> many parenSet >> char ')' :: Parsec String () Char
Loading package transformers-0.3.0.0 ... linking ... done.
Loading package array-0.5.0.0 ... linking ... done.
Loading package deepseq-1.3.0.2 ... linking ... done.
Loading package bytestring-0.10.4.0 ... linking ... done.
Loading package mtl-2.1.3.1 ... linking ... done.
Loading package text-1.1.1.3 ... linking ... done.
Loading package parsec-3.1.5 ... linking ... done.
Prelude Text.Parsec> let parens = (many parenSet >> eof) <|> eof
Prelude Text.Parsec> parse parens "" "()"
Right ()
Prelude Text.Parsec> parse parens "" "()(())"
Right ()
Prelude Text.Parsec> parse parens "" "("
Left (line 1, column 2):
unexpected end of input
expecting "(" or ")"

The Right () results indicate successes: the parentheses matched. The Left [...] result indicates a parse failure, and is detailed with an error message.

For a more thorough introduction to Parsec we recommend the links at the top of this README file.

Contributing

Issues (bugs, feature requests or otherwise feedback) may be reported in the Github issue tracker for this project.

Pull-requests are also welcome.

License

See the LICENSE file in the repository.