mirror of https://github.com/mrkkrp/megaparsec.git synced 2024-11-27 15:32:14 +03:00

Benjamin Kaestner d97398a016 Add compatibility to base-4.7.0.x

This patch introduces compatibility to base-4.7.0.x. It was tested
on Win 8.1 x86_64, using GHC 7.8.4. It mainly consists of a bunch
of #if !MIN_VERSION(4,8,0) ... #endif additions and a lower bound
on base in the cabal file as well as a general introduction of the
CPP extension via default-extensions.

It also removes a potential error source in tests/Util.hs, since
the backslash in /=\ can lead to strange quirks on certain systems
(backslash and newline only separated by whitespace).

Other, squashed commits:

- Remove 'recent version of base' from Readme

- Change necessary version of GHC

2015-09-30 20:18:25 +02:00

3.8 KiB

Raw Blame History

Megaparsec

This is industrial-strength monadic parser combinator library. Megaparsec is a fork of Parsec library originally written by Daan Leijen.

Megaparsec is different from Parsec in the following ways:

Better error messages. We test our error messages using dense QuickCheck tests. Good error messages are just as important for us as correct return values of our parsers. Megaparsec will be especially useful if you write compiler or interpreter for some language.
Some quirks and “buggy features” (as well as plain bugs) of original Parsec are fixed. There is no undocumented surprising stuff in Megaparsec.
Better support for Unicode parsing in Text.Megaparsec.Char.
Megaparsec has more powerful combinators and can parse languages where indentation matters.
Comprehensive QuickCheck test suite covering nearly 100% of our code.
We have benchmarks to detect performance regressions.
Better documentation, with 100% of functions covered, without typos and obsolete information, with working examples. Megaparsec's documentation is well-structured and doesn't contain things useless to end user.
Megaparsec's code is clearer and doesn't contain “magic” found in original Parsec.

Megaparsec vs Parsec

There are good reasons to use Parsec:

You need to work with legacy code or with older versions of GHC (< 7.8).

And that's it. In other cases you should prefer Megaparsec for your own sake. If you think you have a reason to use Parsec other than listed here, open an issue. We are glad to hear from you.

Megaparsec vs Parsers

There is parsers package, which is great. You can use it, but consider the following:

It depends on both Attoparsec and Parsec, which means you always grab useless code installing it. This is ridiculous, by the way, because this package is supposed to be useful for parser builders, so they can write basic core functionality and get the rest “for free”. But with these useful functions you get two more parsers as dependencies.
It currently has a bug in definition of lookAhead for various monad transformers like StateT, etc. which is visible when you create backtracking state via monad stack, not via built-in features. See #27.

We intended to use Parsers library in Megaparsec at some point, but aside from already mentioned flaws the library has different conventions for naming of things, different set of “core” functions, etc., different approach to lexer. So it didn't happen, Megaparsec has minimal dependencies, it is feature-rich and self-contained.

Contributing

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

Pull requests are also welcome (and yes, they will get attention and will be merged quickly if they are good, we are progressive folks).

Spread the Word

Many people still don't know about Megaparsec, you can help the project by writing about it in a blog, creating a tutorial or something like that. This is highly appreciated.

License

Distributed under BSD3 license.

3.8 KiB Raw Blame History Unescape Escape