Modulehaskell-src-exts-1.23.1Haskell98

Language.Haskell.Exts.Parser

Annotated parser for Haskell with extensions.

7 types
1 class
25 values

Packagehaskell-src-exts-1.23.1
Exports33
LanguageHaskell98
LicenceBSD-3-Clause
SourceParser.hs

General parsing

5 declarations

classclass Parseable ast where

Class providing function for parsing at many different types.

Note that for convenience of implementation, the default methods have definitions equivalent to undefined. The minimal definition is all of the visible methods.

Methods

parse :: String -> ParseResult ast
Parse a string with default mode.
parseWithMode :: ParseMode -> String -> ParseResult ast
Parse a string with an explicit ParseMode.
parseWithComments :: ParseMode -> String -> ParseResult (ast, [Comment])
Parse a string with an explicit ParseMode, returning all comments along with the AST.

Instances11Parseable, …

Parseable (NonGreedy (ListOf (ModulePragma SrcSpanInfo)))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (ModuleHeadAndImports SrcSpanInfo))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (PragmasAndModuleHead SrcSpanInfo))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (PragmasAndModuleName SrcSpanInfo))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (Decl SrcSpanInfo)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser · orphan
Parseable (Exp SrcSpanInfo)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser · orphan
Parseable (ImportDecl SrcSpanInfo)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser · orphan
Parseable (Module SrcSpanInfo)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser · orphan
Parseable (Pat SrcSpanInfo)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser · orphan
Parseable (Stmt SrcSpanInfo)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser · orphan
Parseable (Type SrcSpanInfo)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser · orphan

datadata 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
- parseFilename :: String
  original name of the file being parsed
- baseLanguage :: Language
  base language (e.g. Haskell98, Haskell2010)
- 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
- ignoreLinePragmas :: Bool
  if True, the parser won't read line position information from LINE pragmas in source files
- fixities :: Maybe [Fixity]
  list of fixities to be aware of
- ignoreFunctionArity :: Bool
  Checks whether functions have a consistent arity

valuedefaultParseMode :: ParseMode

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

datadata 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.

Instances9Monad, Functor, MonadFail, Applicative, Eq, Ord, …

Monad ParseResultDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.ParseMonad
Functor ParseResultDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.ParseMonad
MonadFail ParseResultDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.ParseMonad
Applicative ParseResultDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.ParseMonad
Eq a => Eq (ParseResult a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.ParseMonad
Ord a => Ord (ParseResult a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.ParseMonad
Show a => Show (ParseResult a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.ParseMonad
Semigroup m => Semigroup (ParseResult m)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.ParseMonad
(Monoid m, Semigroup m) => Monoid (ParseResult m)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.ParseMonad

valuefromParseResult :: 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

0 declarations

Modules

valueparseModule :: String -> ParseResult (Module SrcSpanInfo)

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

valueparseModuleWithMode

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

valueparseModuleWithComments

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

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

Expressions

valueparseExp :: String -> ParseResult (Exp SrcSpanInfo)

Parse of a string containing a Haskell expression, using defaultParseMode.

valueparseExpWithMode :: ParseMode -> String -> ParseResult (Exp SrcSpanInfo)

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

valueparseExpWithComments

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

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

Statements

valueparseStmt :: String -> ParseResult (Stmt SrcSpanInfo)

Parse of a string containing a Haskell statement, using defaultParseMode.

valueparseStmtWithMode :: ParseMode -> String -> ParseResult (Stmt SrcSpanInfo)

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

valueparseStmtWithComments

:: ParseMode
-> String
-> ParseResult (Stmt SrcSpanInfo, [Comment])

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

Patterns

valueparsePat :: String -> ParseResult (Pat SrcSpanInfo)

Parse of a string containing a Haskell pattern, using defaultParseMode.

valueparsePatWithMode :: ParseMode -> String -> ParseResult (Pat SrcSpanInfo)

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

valueparsePatWithComments

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

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

Declarations

valueparseDecl :: String -> ParseResult (Decl SrcSpanInfo)

Parse of a string containing a Haskell top-level declaration, using defaultParseMode.

valueparseDeclWithMode :: ParseMode -> String -> ParseResult (Decl SrcSpanInfo)

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

valueparseDeclWithComments

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

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

Types

valueparseType :: String -> ParseResult (Type SrcSpanInfo)

Parse of a string containing a Haskell type, using defaultParseMode.

valueparseTypeWithMode :: ParseMode -> String -> ParseResult (Type SrcSpanInfo)

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

valueparseTypeWithComments

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

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

Imports

valueparseImportDecl :: String -> ParseResult (ImportDecl SrcSpanInfo)

Parse of a string containing a Haskell statement, using defaultParseMode.

valueparseImportDeclWithMode

:: ParseMode
-> String
-> ParseResult (ImportDecl SrcSpanInfo)

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

valueparseImportDeclWithComments

:: ParseMode
-> String
-> ParseResult (ImportDecl SrcSpanInfo, [Comment])

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

Non-greedy parsers

3 declarations

newtypenewtype NonGreedy a

Instances of Parseable for NonGreedy a will only consume the input until a is fully parsed. This means that parse errors that come later in the input will be ignored. It's also more efficient, as it's fully lazy in the remainder of the input:

Example1 expression

>>> parse (unlines ("module A where" : "main =" : repeat "blah")) :: ParseResult PragmasAndModuleHeadParseOk (NonGreedy {unNonGreedy = PragmasAndModuleHead [] (ModuleName "A",Nothing,Nothing)})

(this example uses the simplified AST)

Constructors

NonGreedy
- unNonGreedy :: a

Instances9Functor, Eq, Data, Ord, Show, Parseable, …

Functor NonGreedyDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Eq a => Eq (NonGreedy a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Data a => Data (NonGreedy a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Ord a => Ord (NonGreedy a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Show a => Show (NonGreedy a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (ListOf (ModulePragma SrcSpanInfo)))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (ModuleHeadAndImports SrcSpanInfo))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (PragmasAndModuleHead SrcSpanInfo))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (PragmasAndModuleName SrcSpanInfo))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser

datadata ListOf a

ListOf a stores lists of the AST type a, along with a SrcSpanInfo, in order to provide Parseable instances for lists. These instances are provided when the type is used as a list in the syntax, and the same delimiters are used in all of its usages. Some exceptions are made:

Constructors

ListOf SrcSpanInfo [a]

Instances6Functor, Eq, Data, Ord, Show, Parseable

Functor ListOfDefined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Eq a => Eq (ListOf a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Data a => Data (ListOf a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Ord a => Ord (ListOf a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Show a => Show (ListOf a)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (ListOf (ModulePragma SrcSpanInfo)))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser

valueunListOf :: ListOf a -> [a]

Module head parsers

valuegetTopPragmas :: String -> ParseResult [ModulePragma SrcSpanInfo]

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

datadata PragmasAndModuleName l

Type intended to be used with Parseable, with instances that implement a non-greedy parse of the module name, including top-level pragmas. This means that a parse error that comes after the module header won't be returned. If the Maybe value is Nothing, then this means that there was no module header.

Constructors

PragmasAndModuleName l [ModulePragma l] (Maybe (ModuleName l))

Instances5Eq, Data, Ord, Show, Parseable

Eq l => Eq (PragmasAndModuleName l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Data l => Data (PragmasAndModuleName l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Ord l => Ord (PragmasAndModuleName l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Show l => Show (PragmasAndModuleName l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (PragmasAndModuleName SrcSpanInfo))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser

datadata PragmasAndModuleHead l

Constructors

PragmasAndModuleHead l [ModulePragma l] (Maybe (ModuleHead l))

Instances5Eq, Data, Ord, Show, Parseable

Eq l => Eq (PragmasAndModuleHead l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Data l => Data (PragmasAndModuleHead l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Ord l => Ord (PragmasAndModuleHead l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Show l => Show (PragmasAndModuleHead l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (PragmasAndModuleHead SrcSpanInfo))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser

datadata ModuleHeadAndImports l

Constructors

ModuleHeadAndImports l [ModulePragma l] (Maybe (ModuleHead l)) [ImportDecl l]

Instances5Eq, Data, Ord, Show, Parseable

Eq l => Eq (ModuleHeadAndImports l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Data l => Data (ModuleHeadAndImports l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Ord l => Ord (ModuleHeadAndImports l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Show l => Show (ModuleHeadAndImports l)Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser
Parseable (NonGreedy (ModuleHeadAndImports SrcSpanInfo))Defined in haskell-src-exts-1.23.1 · Language.Haskell.Exts.Parser

Orphan instances

7 instances