Test.Hspec.Megaparsec.AdHoc

Ad-hoc helpers used in Megaparsec's test suite.

Types

type Parser = Parsec Void String

The type of parser that consumes a String.

Helpers to run parsers

prs

Arguments

:: Parser a

Parser to run

-> String

Input for the parser

-> Either (ParseErrorBundle String Void) a

Result of parsing

Apply parser to given input. This is a specialized version of parse that assumes empty file name.

prs'

Arguments

:: Parser a

Parser to run

-> String

Input for the parser

-> (State String Void, Either (ParseErrorBundle String Void) a)

Result of parsing

Just like prs, but allows to inspect the final state of the parser.

prs_

Arguments

:: Parser a

Parser to run

-> String

Input for the parser

-> Either (ParseErrorBundle String Void) a

Result of parsing

Just like prs, but forces the parser to consume all input by adding eof:

prs_ p = parse (p <* eof) ""

grs

Arguments

:: (forall m. MonadParsec Void String m => m a)

Parser to run

-> String

Input for the parser

-> (Either (ParseErrorBundle String Void) a -> Expectation)

How to check result of parsing

-> Expectation

Just like prs, but interprets given parser as various monads (tries all supported monads transformers in turn).

grs'

Arguments

:: (forall m. MonadParsec Void String m => m a)

Parser to run

-> String

Input for the parser

-> ((State String Void, Either (ParseErrorBundle String Void) a) -> Expectation)

How to check result of parsing

-> Expectation

grs' to grs is as prs' to prs.

Other

nes :: a -> NonEmpty a

Make a singleton non-empty list from a value.

abcRow :: Int -> Int -> Int -> String

abcRow a b c generates string consisting of character “a” repeated a times, character “b” repeated b times, and character “c” repeated c times.

rightOrder

Arguments

:: Parser String

The parser to test

-> String

Input for the parser

-> String

Expected result

-> Spec

Check that the given parser returns the list in the right order.

scaleDown :: Gen a -> Gen a

Scale down.

getTabWidth :: MonadParsec e s m => m Pos

Get tab width from PosState. Use with care only for testing.

setTabWidth :: MonadParsec e s m => Pos -> m ()

Set tab width in PosState. Use with care only for testing.

strSourcePos :: Pos -> SourcePos -> String -> SourcePos

A helper function that is used to advance SourcePos given a String.

Char and byte conversion

toChar :: Word8 -> Char

Convert a byte to char.

fromChar :: Char -> Maybe Word8

Covert a char to byte.

Proxies

sproxy :: Proxy String

bproxy :: Proxy ByteString

blproxy :: Proxy ByteString

tproxy :: Proxy Text

tlproxy :: Proxy Text

Orphan instances

Arbitrary Void

Methods

arbitrary :: Gen Void

shrink :: Void -> [Void]

Arbitrary ByteString

Methods

arbitrary :: Gen ByteString

shrink :: ByteString -> [ByteString]

Arbitrary ByteString

Methods

arbitrary :: Gen ByteString

shrink :: ByteString -> [ByteString]

Arbitrary Text

Methods

arbitrary :: Gen Text

shrink :: Text -> [Text]

Arbitrary Pos

Methods

arbitrary :: Gen Pos

shrink :: Pos -> [Pos]

Arbitrary SourcePos

Methods

arbitrary :: Gen SourcePos

shrink :: SourcePos -> [SourcePos]

Arbitrary Text

Methods

arbitrary :: Gen Text

shrink :: Text -> [Text]

Arbitrary a => Arbitrary (NonEmpty a)

Methods

arbitrary :: Gen (NonEmpty a)

shrink :: NonEmpty a -> [NonEmpty a]

Arbitrary t => Arbitrary (ErrorItem t)

Methods

arbitrary :: Gen (ErrorItem t)

shrink :: ErrorItem t -> [ErrorItem t]

Arbitrary (ErrorFancy a)

Methods

arbitrary :: Gen (ErrorFancy a)

shrink :: ErrorFancy a -> [ErrorFancy a]

Arbitrary s => Arbitrary (PosState s)

Methods

arbitrary :: Gen (PosState s)

shrink :: PosState s -> [PosState s]

(Arbitrary (Token s), Ord (Token s), Arbitrary e, Ord e) => Arbitrary (ParseError s e)

Methods

arbitrary :: Gen (ParseError s e)

shrink :: ParseError s e -> [ParseError s e]

Arbitrary s => Arbitrary (State s e)

Methods

arbitrary :: Gen (State s e)

shrink :: State s e -> [State s e]