| Copyright | Bryan O'Sullivan 2007-2015 |
|---|---|
| License | BSD3 |
| Maintainer | bos@serpentine.com |
| Stability | experimental |
| Portability | unknown |
| Safe Haskell | None |
| Language | GHC2024 |
Data.Attoparsec.Internal.Types
Description
Simple, efficient parser combinators, loosely based on the Parsec library.
Synopsis
- type Parser = DirParser 'Forward
- newtype DirParser (d :: Dir) i a = Parser {
- runParser :: forall r. DirState d i -> DirPos d -> More -> DirFailure d i (DirState d i) r -> DirSuccess d i (DirState d i) a r -> IResult i r
- type State x = DirState 'Forward x
- type family DirState (d :: Dir) i
- type Failure i t r = DirFailure 'Forward i t r
- type Success i t a r = DirSuccess 'Forward i t a r
- type DirFailure (d :: Dir) i t r = t -> DirPos d -> More -> [String] -> String -> IResult i r
- type DirSuccess (d :: Dir) i t a r = t -> DirPos d -> More -> a -> IResult i r
- type Pos = DirPos 'Forward
- data IResult i r
- data More
- (<>) :: Semigroup a => a -> a -> a
- class Monoid c => Chunk c where
- class (DirectedPlus d, Chunk c, Show (DirState d c)) => DirChunk (d :: Dir) c where
- type DirChunkElem (d :: Dir) c
- notAtBufferEnd :: c -> DirPos d -> DirState d c -> Bool
- bufferElemAt :: c -> DirPos d -> DirState d c -> Maybe (DirChunkElem d c, Int)
- shiftPositionOnBufferExtend :: DirPos d -> c -> DirPos d
- pappendChunk :: DirState d c -> Tagged d c -> DirState d c
- concatReverse :: [Tagged d c] -> Tagged d c
- data Dir
- newtype DirPos (d :: Dir) = Pos {}
- class DirectedPlus (d :: Dir) where
Documentation
newtype DirParser (d :: Dir) i a Source #
The core parser type. This is parameterised over the type i
of string being processed.
This type is an instance of the following classes:
Monad, wherefailthrows an exception (i.e. fails) with an error message.FunctorandApplicative, which follow the usual definitions.MonadPlus, wheremzerofails (with no error message) andmplusexecutes the right-hand parser if the left-hand one fails. When the parser on the right executes, the input is reset to the same state as the parser on the left started with. (In other words, attoparsec is a backtracking parser that supports arbitrary lookahead.)Alternative, which followsMonadPlus.
Constructors
| Parser | |
Fields
| |
Instances
type family DirState (d :: Dir) i Source #
Instances
| type DirState 'Backward ByteString Source # | |
Defined in Data.Attoparsec.Internal.Types | |
| type DirState 'Forward ByteString Source # | |
Defined in Data.Attoparsec.Internal.Types | |
| type DirState 'Forward Text Source # | |
Defined in Data.Attoparsec.Internal.Types | |
type Failure i t r = DirFailure 'Forward i t r Source #
type Success i t a r = DirSuccess 'Forward i t a r Source #
type DirFailure (d :: Dir) i t r = t -> DirPos d -> More -> [String] -> String -> IResult i r Source #
The result of a parse. This is parameterised over the type i
of string that was processed.
This type is an instance of Functor, where fmap transforms the
value in a Done result.
Constructors
| Fail i [String] String | The parse failed. The |
| Partial (i -> IResult i r) | Supply this continuation with more input so that the parser can resume. To indicate that no more input is available, pass an empty string to the continuation. Note: if you get a |
| Done i r | The parse succeeded. The |
Have we read all available input?
Constructors
| Complete | |
| Incomplete |
(<>) :: Semigroup a => a -> a -> a infixr 6 #
An associative operation.
Examples
>>>[1,2,3] <> [4,5,6][1,2,3,4,5,6]
>>>Just [1, 2, 3] <> Just [4, 5, 6]Just [1,2,3,4,5,6]
>>>putStr "Hello, " <> putStrLn "World!"Hello, World!
class Monoid c => Chunk c where Source #
A common interface for input chunks.
Methods
nullChunk :: c -> Bool Source #
Test if the chunk is empty.
chunkElemToChar :: c -> ChunkElem c -> Char Source #
Map an element to the corresponding character. The first argument is ignored.
Instances
| Chunk ByteString Source # | |||||
Defined in Data.Attoparsec.Internal.Types Associated Types
Methods nullChunk :: ByteString -> Bool Source # chunkElemToChar :: ByteString -> ChunkElem ByteString -> Char Source # | |||||
| Chunk Text Source # | |||||
class (DirectedPlus d, Chunk c, Show (DirState d c)) => DirChunk (d :: Dir) c where Source #
Associated Types
type DirChunkElem (d :: Dir) c Source #
Methods
notAtBufferEnd :: c -> DirPos d -> DirState d c -> Bool Source #
Position at the end of a buffer. The first argument is ignored.
bufferElemAt :: c -> DirPos d -> DirState d c -> Maybe (DirChunkElem d c, Int) Source #
Return the buffer element at the given position along with its length.
shiftPositionOnBufferExtend :: DirPos d -> c -> DirPos d Source #
pappendChunk :: DirState d c -> Tagged d c -> DirState d c Source #
Append chunk to a buffer.
concatReverse :: [Tagged d c] -> Tagged d c Source #
Instances
class DirectedPlus (d :: Dir) where Source #