Language.Haskell.GHC.Parser

Documentation

runParser :: DynFlags -> Parser a -> String -> ParseOutput a

Run a GHC parser on a string. Return success or failure with associated information for both.

type LineNumber = Int

A line number in an input string.

type ColumnNumber = Int

A column number in an input string.

type ErrMsg = String

An error message string.

data StringLoc

A location in an input string.

Constructors

Loc LineNumber ColumnNumber

Instances

Eq StringLoc

Methods

(==) :: StringLoc -> StringLoc -> Bool

(/=) :: StringLoc -> StringLoc -> Bool

Show StringLoc

Methods

showsPrec :: Int -> StringLoc -> ShowS

show :: StringLoc -> String

showList :: [StringLoc] -> ShowS

data ParseOutput a

Output from running a parser.

Constructors

Failure ErrMsg StringLoc

Parser failed with given error message and location.

Parsed a

Parser succeeded with an output.

Partial a (String, String)

Partial parser succeeded with an output.

Instances

Eq a => Eq (ParseOutput a)

Methods

(==) :: ParseOutput a -> ParseOutput a -> Bool

(/=) :: ParseOutput a -> ParseOutput a -> Bool

Show a => Show (ParseOutput a)

Methods

showsPrec :: Int -> ParseOutput a -> ShowS

show :: ParseOutput a -> String

showList :: [ParseOutput a] -> ShowS

data Parser a

data Located a

Store locations along with a value.

Constructors

Located

Fields

• line :: LineNumber
• unloc :: a

Instances

Functor Located

Methods

fmap :: (a -> b) -> Located a -> Located b

(<$) :: a -> Located b -> Located a

Eq a => Eq (Located a)

Methods

(==) :: Located a -> Located a -> Bool

(/=) :: Located a -> Located a -> Bool

Show a => Show (Located a)

Methods

showsPrec :: Int -> Located a -> ShowS

show :: Located a -> String

showList :: [Located a] -> ShowS

parserStatement :: Parser (Maybe (LStmt RdrName (LHsExpr RdrName)))

parserImport :: Parser (LImportDecl RdrName)

parserDeclaration :: Parser (OrdList (LHsDecl RdrName))

parserTypeSignature :: Parser (Located (OrdList (LHsDecl RdrName)))

parserModule :: Parser (Located (HsModule RdrName))

parserExpression :: Parser (LHsExpr RdrName)

removeComments :: String -> String

Drop comments from Haskell source. Simply gets rid of them, does not replace them in any way.

layoutChunks :: String -> [Located String]

Split an input string into chunks based on indentation. A chunk is a line and all lines immediately following that are indented beyond the indentation of the first line. This parses Haskell layout rules properly, and allows using multiline expressions via indentation.

Quasiquotes are allowed via a post-processing step.