incremental-parser 0.2.4.1 → 0.2.5

raw patch · 3 files changed

+54/−5 lines, 3 filesPVP ok

version bump matches the API change (PVP)

API changes (from Hackage documentation)

Files

• Benchmarks/CSV.hs +2/−2
• README.md +49/−0
• incremental-parser.cabal +3/−3

@@ -1,5 +1,5 @@ {--    Copyright 2010-2015 Mario Blazevic+    Copyright 2010-2016 Mario Blazevic      This file is part of the Streaming Component Combinators (SCC) project. @@ -36,7 +36,7 @@ import qualified Data.Text.IO as T  import Data.Monoid.Instances.ByteString.UTF8 (ByteStringUTF8(ByteStringUTF8))-import Data.Monoid.Instances.Concat (Concat(extract))+import Data.Monoid.Instances.Concat (Concat, extract)  instance NFData ByteStringUTF8 where   rnf (ByteStringUTF8 b) = rnf b

@@ -0,0 +1,49 @@+The incremental-parser library is yet another parser combinator library, providing the usual set of `Applicative`,+`Alternative`, and `Monad` combinators. Apart from this, it has three twists that make it unique.++#### Parsing incrementally++First, the parser is incremental. Not only can it be fed its input in chunks, but in proper circumstances it can also+provide its output in parsed chunks. For this to be possible the result type must be a `Monoid`. The complete parsing+result is then a concatenation of the partial results.++In order to make the incremental parsing easier, the combinator set is optimized for monoidal results. Apart from the+usual combinators `many` and `some`, for example, there are `concatMany` and `concatSome` operators.++    many :: Parser s r -> Parser s [r]+    concatMany :: (Monoid s, Monoid r) => Parser s r -> Parser s r++#### Arbitrary monoidal inputs++The second weirdness, this one shared with [Picoparsec](http://hackage.haskell.org/package/picoparsec), is that the the+parser is generic in its input stream type, but this type is parameterized in a holistic way. There is no separate token+type. Primitive parsers that need to peek into the input require its type to be an instance of a monoid subclass, from+the [monoid-subclasses](http://hackage.haskell.org/package/monoid-subclasses) package.++In Parsec:++    string :: Stream s m Char => String -> ParsecT s u m String+    char :: Stream s m Char => Char -> ParsecT s u m Char+    anyToken :: (Stream s m t, Show t) => ParsecT s u m t++In Attoparsec:++    string :: ByteString -> Parser ByteString+    word8 :: Word8 -> Parser Word8+    anyWord8 :: Parser Word8++In incremental-parser and Picoparsec:++    string :: (LeftCancellativeMonoid s, MonoidNull s) => s -> Parser s s+    token :: (Eq s, FactorialMonoid s) => s -> Parser s s+    anyToken :: FactorialMonoid s => Parser s s++#### Two `Alternative` alternatives++Finally, the library being implemented on the basis of Brzozowski derivatives, it can provide both the symmetric and the+left-biased choice, `<||>` and `<<|>`. This is the same design choice made by+[`Text.ParserCombinators.ReadP`](http://hackage.haskell.org/package/base/docs/Text-ParserCombinators-ReadP.html#g:2) and+[uu-parsinglib](http://hackage.haskell.org/package/uu-parsinglib). Parsec and its progeny on the other hand provide only+the faster left-biased choice, at some cost to the expressiveness of the combinator language. The standard `<|>`+operator from the `Alternative` class acts as one or the other of the above, depending on whether the first type+parameter of `Parser` is `Symmetric` or `LeftBiasedLocal`.

@@ -1,5 +1,5 @@ Name:                incremental-parser-Version:             0.2.4.1+Version:             0.2.5 Cabal-Version:       >= 1.10 Build-Type:          Simple Synopsis:            Generic parser library capable of providing partial results from partial input.@@ -14,11 +14,11 @@    License:             GPL License-file:        LICENSE.txt-Copyright:           (c) 2011-2015 Mario Blazevic+Copyright:           (c) 2011-2016 Mario Blazevic Author:              Mario Blazevic Maintainer:          blamario@yahoo.com Homepage:            https://github.com/blamario/incremental-parser-Extra-Source-Files:  Benchmarks/airports.dat+Extra-Source-Files:  Benchmarks/airports.dat, README.md  Source-repository head   type:              git