mirror of
https://github.com/mrkkrp/megaparsec.git
synced 2024-12-25 09:12:29 +03:00
Merge pull request #11 from cies/master
Created a README and have the homepage point to that.
This commit is contained in:
Antoine Latter
commit
c84822310c
95
README.md
Normal file
95
README.md
Normal file
@ -0,0 +1,95 @@
|
||||
Parsec
|
||||
======
|
||||
|
||||
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](https://hackage.haskell.org/package/parsec),
|
||||
contains the generated documentation.
|
||||
* The 2001 paper written by Daan Leijen, some what outdated
|
||||
([PDF](https://web.archive.org/web/20140528151730/http://legacy.cs.uu.nl/daan/download/parsec/parsec.pdf),
|
||||
[HTML](https://web.archive.org/web/20140528151730/http://legacy.cs.uu.nl/daan/download/parsec/parsec.html),
|
||||
thanks to [archive.org](http://web.archive.org);
|
||||
and [PDF](https://research.microsoft.com/en-us/um/people/daan/download/parsec/parsec.pdf),
|
||||
thanks to Microsoft Research).
|
||||
* [Using Parsec](http://book.realworldhaskell.org/read/using-parsec.html),
|
||||
chapter 16 of [Real World Haskell](http://book.realworldhaskell.org/).
|
||||
* [An introduction to the Parsec library](http://kunigami.wordpress.com/2014/01/21/an-introduction-to-the-parsec-library)
|
||||
on Kunigami's blog.
|
||||
* [An introduction to parsing text in Haskell with Parsec](http://unbui.lt/#!/post/haskell-parsec-basics) on Wilson's blog.
|
||||
* Differences between Parsec and
|
||||
[Attoparsec](http://hackage.haskell.org/package/attoparsec)
|
||||
(Haskell's other prominent parser library) as explained in
|
||||
[an answer on StackExchange](http://stackoverflow.com/a/19213247).
|
||||
* Differences between Parsec and [Happy](http://www.haskell.org/happy)
|
||||
(Haskell's parser generator) as explained in two
|
||||
answers on separate StackExchange questions
|
||||
([1](http://stackoverflow.com/a/7270904),
|
||||
[2](http://stackoverflow.com/a/14775331)).
|
||||
|
||||
By analyzing [Parsec's reverse dependencies on Hackage](http://packdeps.haskellers.com/reverse/parsec)
|
||||
we can find open source project that make use of Parsec. For example
|
||||
[bibtex](http://hackage.haskell.org/package/bibtex),
|
||||
[ConfigFile](http://hackage.haskell.org/package/ConfigFile),
|
||||
[csv](http://hackage.haskell.org/package/csv) and
|
||||
[hjson](http://hackage.haskell.org/package/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](https://www.haskell.org/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 ')'
|
||||
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](https://github.com/aslatter/parsec/issues).
|
||||
|
||||
Pull-requests are also welcome.
|
||||
|
||||
|
||||
## License
|
||||
|
||||
See the [LICENSE](https://github.com/aslatter/parsec/blob/master/LICENSE)
|
||||
file in the repository.
|
||||
@ -5,7 +5,7 @@ license: BSD3
|
||||
license-file: LICENSE
|
||||
author: Daan Leijen <daan@microsoft.com>, Paolo Martini <paolo@nemail.it>
|
||||
maintainer: Antoine Latter <aslatter@gmail.com>
|
||||
homepage: http://www.cs.uu.nl/~daan/parsec.html
|
||||
homepage: https://github.com/aslatter/parsec
|
||||
bug-reports: https://github.com/aslatter/parsec/issues
|
||||
category: Parsing
|
||||
synopsis: Monadic parser combinators
|
||||
@ -13,8 +13,8 @@ build-type: Simple
|
||||
description:
|
||||
Parsec is designed from scratch as an industrial-strength parser
|
||||
library. It is simple, safe, well documented (on the package
|
||||
homepage), has extensive libraries and good error messages,
|
||||
and is also fast. It is defined as a monad transformer that can be
|
||||
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.
|
||||
extra-source-files: CHANGES
|
||||
|
||||
@ -1,5 +0,0 @@
|
||||
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 and good error messages, and is also
|
||||
fast. More documentation can be found on:
|
||||
<http://www.cs.uu.nl/~daan/parsec.html>
|
||||
Loading…
Reference in New Issue
Block a user