Language.Haskell.Exts.Annotated.Parser

General parsing

class Parseable ast where

Class to reuse the parse function at many different types.

Methods

parse :: String -> ParseResult ast

Parse a string with default mode.

parseWithMode :: ParseMode -> String -> ParseResult ast

Parse a string with an explicit mode.

parseWithComments :: ParseMode -> String -> ParseResult (ast, [Comment])

Parse a string with an explicit mode, returning all comments along the AST

Instances

SrcInfo loc => Parseable (Pat loc)

SrcInfo loc => Parseable (Exp loc)

SrcInfo loc => Parseable (Type loc)

SrcInfo loc => Parseable (Decl loc)

SrcInfo loc => Parseable (Module loc)

data ParseMode

Static parameters governing a parse. Note that the various parse functions in Language.Haskell.Exts.Parser never look at LANGUAGE pragmas, regardless of what the ignoreLanguagePragmas flag is set to. Only the various parseFile functions in Language.Haskell.Exts will act on it, when set to False.

Constructors

ParseMode

Fields

parseFilename :: String

original name of the file being parsed

extensions :: [Extension]

list of extensions enabled for parsing

ignoreLanguagePragmas :: Bool

if True, the parser won't care about further extensions in LANGUAGE pragmas in source files

fixities :: [Fixity]

list of fixities to be aware of

defaultParseMode :: ParseMode

Default parameters for a parse. The default is an unknown filename, no extensions (i.e. Haskell 98), don't ignore LANGUAGE pragmas, and be aware of fixities from the Prelude.

data ParseResult a

The result of a parse.

Constructors

ParseOk a

The parse succeeded, yielding a value.

ParseFailed SrcLoc String

The parse failed at the specified source location, with an error message.

Instances

Monad ParseResult

Functor ParseResult

Applicative ParseResult

Show a => Show (ParseResult a)

Monoid m => Monoid (ParseResult m)

fromParseResult :: ParseResult a -> a

Retrieve the result of a successful parse, throwing an error if the parse is actually not successful.

Parsing of specific AST elements

Modules

parseModule :: String -> ParseResult (Module L)

Parse of a string, which should contain a complete Haskell module.

parseModuleWithMode :: ParseMode -> String -> ParseResult (Module L)

Parse of a string containing a complete Haskell module, using an explicit mode.

parseModuleWithComments :: ParseMode -> String -> ParseResult (Module L, [Comment])

Parse of a string containing a complete Haskell module, using an explicit mode, retaining comments.

Expressions

parseExp :: String -> ParseResult (Exp L)

Parse of a string containing a Haskell expression.

parseExpWithMode :: ParseMode -> String -> ParseResult (Exp L)

Parse of a string containing a Haskell expression, using an explicit mode.

parseExpWithComments :: ParseMode -> String -> ParseResult (Exp L, [Comment])

Parse of a string containing a complete Haskell module, using an explicit mode, retaining comments.

Patterns

parsePat :: String -> ParseResult (Pat L)

Parse of a string containing a Haskell pattern.

parsePatWithMode :: ParseMode -> String -> ParseResult (Pat L)

Parse of a string containing a Haskell pattern, using an explicit mode.

parsePatWithComments :: ParseMode -> String -> ParseResult (Pat L, [Comment])

Parse of a string containing a complete Haskell module, using an explicit mode, retaining comments.

Declarations

parseDecl :: String -> ParseResult (Decl L)

Parse of a string containing a Haskell top-level declaration.

parseDeclWithMode :: ParseMode -> String -> ParseResult (Decl L)

Parse of a string containing a Haskell top-level declaration, using an explicit mode.

parseDeclWithComments :: ParseMode -> String -> ParseResult (Decl L, [Comment])

Parse of a string containing a complete Haskell module, using an explicit mode, retaining comments.

Types

parseType :: String -> ParseResult (Type L)

Parse of a string containing a Haskell type.

parseTypeWithMode :: ParseMode -> String -> ParseResult (Type L)

Parse of a string containing a Haskell type, using an explicit mode.

parseTypeWithComments :: ParseMode -> String -> ParseResult (Type L, [Comment])

Parse of a string containing a complete Haskell module, using an explicit mode, retaining comments.

Option pragmas

getTopPragmas :: String -> ParseResult [OptionPragma L]

Partial parse of a string starting with a series of top-level option pragmas.