Safe Haskell	None
Language	Haskell2010

Language.Haskell.Exts.Simple.Parser

Description

This module partially reexports Language.Haskell.Exts.Parser with adaptations.

IMPORTANT: if you require compatiblity with ghc 7.8, you should use the function listOf for constructing ListOf values!

Synopsis

type ModuleHeadAndImports = ModuleHeadAndImports ()
type PragmasAndModuleHead = PragmasAndModuleHead ()
type PragmasAndModuleName = PragmasAndModuleName ()
type ListOf = ListOf
pattern ModuleHeadAndImports :: [ModulePragma] -> Maybe ModuleHead -> [ImportDecl] -> ModuleHeadAndImports ()
pattern PragmasAndModuleHead :: [ModulePragma] -> Maybe ModuleHead -> PragmasAndModuleHead ()
pattern PragmasAndModuleName :: [ModulePragma] -> Maybe ModuleName -> PragmasAndModuleName
pattern ListOf :: forall a. [a] -> ListOf a
listOf :: [a] -> ListOf a
parse :: (Parseable (ast SrcSpanInfo), Functor ast) => String -> ParseResult (ast ())
parseWithMode :: (Parseable (ast SrcSpanInfo), Functor ast) => ParseMode -> String -> ParseResult (ast ())
parseModule :: String -> ParseResult Module
parseModuleWithMode :: ParseMode -> String -> ParseResult Module
parseModuleWithComments :: ParseMode -> String -> ParseResult (Module, [Comment])
parseExp :: String -> ParseResult Exp
parseExpWithMode :: ParseMode -> String -> ParseResult Exp
parseExpWithComments :: ParseMode -> String -> ParseResult (Exp, [Comment])
parsePat :: String -> ParseResult Pat
parsePatWithMode :: ParseMode -> String -> ParseResult Pat
parsePatWithComments :: ParseMode -> String -> ParseResult (Pat, [Comment])
parseDecl :: String -> ParseResult Decl
parseDeclWithMode :: ParseMode -> String -> ParseResult Decl
parseDeclWithComments :: ParseMode -> String -> ParseResult (Decl, [Comment])
parseType :: String -> ParseResult Type
parseTypeWithMode :: ParseMode -> String -> ParseResult Type
parseTypeWithComments :: ParseMode -> String -> ParseResult (Type, [Comment])
parseStmt :: String -> ParseResult Stmt
parseStmtWithMode :: ParseMode -> String -> ParseResult Stmt
parseStmtWithComments :: ParseMode -> String -> ParseResult (Stmt, [Comment])
parseImportDecl :: String -> ParseResult ImportDecl
parseImportDeclWithMode :: ParseMode -> String -> ParseResult ImportDecl
parseImportDeclWithComments :: ParseMode -> String -> ParseResult (ImportDecl, [Comment])
getTopPragmas :: String -> ParseResult [ModulePragma]
unListOf :: ListOf a -> [a]
newtype NonGreedy a = NonGreedy {
- unNonGreedy :: a
}
defaultParseMode :: ParseMode
fromParseResult :: ParseResult a -> a
class Parseable ast
data ParseResult a
- = ParseOk a
- | ParseFailed SrcLoc String
data ParseMode = ParseMode {
- parseFilename :: String
- baseLanguage :: Language
- extensions :: [Extension]
- ignoreLanguagePragmas :: Bool
- ignoreLinePragmas :: Bool
- fixities :: Maybe [Fixity]
- ignoreFunctionArity :: Bool
}

Documentation

type ModuleHeadAndImports = ModuleHeadAndImports () Source #

type PragmasAndModuleHead = PragmasAndModuleHead () Source #

type PragmasAndModuleName = PragmasAndModuleName () Source #

type ListOf = ListOf Source #

Beware that the ListOf constructor only works in a pattern context in ghc-7.8, because that version does not support explicitly bidirectional pattern synonyms.

For code that needs to work with ghc-7.8, we provide the listOf function constructing ListOf values.

pattern ModuleHeadAndImports :: [ModulePragma] -> Maybe ModuleHead -> [ImportDecl] -> ModuleHeadAndImports () Source #

pattern PragmasAndModuleHead :: [ModulePragma] -> Maybe ModuleHead -> PragmasAndModuleHead () Source #

pattern PragmasAndModuleName :: [ModulePragma] -> Maybe ModuleName -> PragmasAndModuleName Source #

pattern ListOf :: forall a. [a] -> ListOf a Source #

listOf :: [a] -> ListOf a Source #

parse :: (Parseable (ast SrcSpanInfo), Functor ast) => String -> ParseResult (ast ()) Source #

parseWithMode :: (Parseable (ast SrcSpanInfo), Functor ast) => ParseMode -> String -> ParseResult (ast ()) Source #

parseModule :: String -> ParseResult Module Source #

parseModuleWithMode :: ParseMode -> String -> ParseResult Module Source #

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

parseExp :: String -> ParseResult Exp Source #

parseExpWithMode :: ParseMode -> String -> ParseResult Exp Source #

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

parsePat :: String -> ParseResult Pat Source #

parsePatWithMode :: ParseMode -> String -> ParseResult Pat Source #

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

parseDecl :: String -> ParseResult Decl Source #

parseDeclWithMode :: ParseMode -> String -> ParseResult Decl Source #

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

parseType :: String -> ParseResult Type Source #

parseTypeWithMode :: ParseMode -> String -> ParseResult Type Source #

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

parseStmt :: String -> ParseResult Stmt Source #

parseStmtWithMode :: ParseMode -> String -> ParseResult Stmt Source #

parseStmtWithComments :: ParseMode -> String -> ParseResult (Stmt, [Comment]) Source #

parseImportDecl :: String -> ParseResult ImportDecl Source #

parseImportDeclWithMode :: ParseMode -> String -> ParseResult ImportDecl Source #

parseImportDeclWithComments :: ParseMode -> String -> ParseResult (ImportDecl, [Comment]) Source #

getTopPragmas :: String -> ParseResult [ModulePragma] Source #

unListOf :: ListOf a -> [a] #

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

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

(this example uses the simplified AST)

Constructors

NonGreedy
Fields unNonGreedy :: a

Instances

Functor NonGreedy
Instance details Defined in Language.Haskell.Exts.Parser Methods fmap :: (a -> b) -> NonGreedy a -> NonGreedy b # (<$) :: a -> NonGreedy b -> NonGreedy a #
Eq a => Eq (NonGreedy a)
Instance details Defined in Language.Haskell.Exts.Parser Methods (==) :: NonGreedy a -> NonGreedy a -> Bool # (/=) :: NonGreedy a -> NonGreedy a -> Bool #
Data a => Data (NonGreedy a)
Instance details Defined in Language.Haskell.Exts.Parser Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> NonGreedy a -> c (NonGreedy a) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (NonGreedy a) # toConstr :: NonGreedy a -> Constr # dataTypeOf :: NonGreedy a -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (NonGreedy a)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (NonGreedy a)) # gmapT :: (forall b. Data b => b -> b) -> NonGreedy a -> NonGreedy a # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> NonGreedy a -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> NonGreedy a -> r # gmapQ :: (forall d. Data d => d -> u) -> NonGreedy a -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> NonGreedy a -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> NonGreedy a -> m (NonGreedy a) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> NonGreedy a -> m (NonGreedy a) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> NonGreedy a -> m (NonGreedy a) #
Ord a => Ord (NonGreedy a)
Instance details Defined in Language.Haskell.Exts.Parser Methods compare :: NonGreedy a -> NonGreedy a -> Ordering # (<) :: NonGreedy a -> NonGreedy a -> Bool # (<=) :: NonGreedy a -> NonGreedy a -> Bool # (>) :: NonGreedy a -> NonGreedy a -> Bool # (>=) :: NonGreedy a -> NonGreedy a -> Bool # max :: NonGreedy a -> NonGreedy a -> NonGreedy a # min :: NonGreedy a -> NonGreedy a -> NonGreedy a #
Show a => Show (NonGreedy a)
Instance details Defined in Language.Haskell.Exts.Parser Methods showsPrec :: Int -> NonGreedy a -> ShowS # show :: NonGreedy a -> String # showList :: [NonGreedy a] -> ShowS #
Parseable (NonGreedy (PragmasAndModuleName SrcSpanInfo))
Instance details Defined in Language.Haskell.Exts.Parser Methods parse :: String -> ParseResult (NonGreedy (PragmasAndModuleName SrcSpanInfo)) # parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleName SrcSpanInfo)) # parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleName SrcSpanInfo), [Comment]) # parser :: Maybe [Fixity] -> P (NonGreedy (PragmasAndModuleName SrcSpanInfo))
Parseable (NonGreedy (PragmasAndModuleHead SrcSpanInfo))
Instance details Defined in Language.Haskell.Exts.Parser Methods parse :: String -> ParseResult (NonGreedy (PragmasAndModuleHead SrcSpanInfo)) # parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleHead SrcSpanInfo)) # parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleHead SrcSpanInfo), [Comment]) # parser :: Maybe [Fixity] -> P (NonGreedy (PragmasAndModuleHead SrcSpanInfo))
Parseable (NonGreedy (ModuleHeadAndImports SrcSpanInfo))
Instance details Defined in Language.Haskell.Exts.Parser Methods parse :: String -> ParseResult (NonGreedy (ModuleHeadAndImports SrcSpanInfo)) # parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (ModuleHeadAndImports SrcSpanInfo)) # parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (ModuleHeadAndImports SrcSpanInfo), [Comment]) # parser :: Maybe [Fixity] -> P (NonGreedy (ModuleHeadAndImports SrcSpanInfo))
Parseable (NonGreedy (ListOf (ModulePragma SrcSpanInfo)))
Instance details Defined in Language.Haskell.Exts.Parser Methods parse :: String -> ParseResult (NonGreedy (ListOf (ModulePragma SrcSpanInfo))) # parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (ListOf (ModulePragma SrcSpanInfo))) # parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (ListOf (ModulePragma SrcSpanInfo)), [Comment]) # parser :: Maybe [Fixity] -> P (NonGreedy (ListOf (ModulePragma SrcSpanInfo)))

defaultParseMode :: 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.

fromParseResult :: ParseResult a -> a #

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

class Parseable ast #

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.

Minimal complete definition

parser

Instances

Parseable (NonGreedy (PragmasAndModuleName SrcSpanInfo))
Instance details Defined in Language.Haskell.Exts.Parser Methods parse :: String -> ParseResult (NonGreedy (PragmasAndModuleName SrcSpanInfo)) # parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleName SrcSpanInfo)) # parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleName SrcSpanInfo), [Comment]) # parser :: Maybe [Fixity] -> P (NonGreedy (PragmasAndModuleName SrcSpanInfo))
Parseable (NonGreedy (PragmasAndModuleHead SrcSpanInfo))
Instance details Defined in Language.Haskell.Exts.Parser Methods parse :: String -> ParseResult (NonGreedy (PragmasAndModuleHead SrcSpanInfo)) # parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleHead SrcSpanInfo)) # parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (PragmasAndModuleHead SrcSpanInfo), [Comment]) # parser :: Maybe [Fixity] -> P (NonGreedy (PragmasAndModuleHead SrcSpanInfo))
Parseable (NonGreedy (ModuleHeadAndImports SrcSpanInfo))
Instance details Defined in Language.Haskell.Exts.Parser Methods parse :: String -> ParseResult (NonGreedy (ModuleHeadAndImports SrcSpanInfo)) # parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (ModuleHeadAndImports SrcSpanInfo)) # parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (ModuleHeadAndImports SrcSpanInfo), [Comment]) # parser :: Maybe [Fixity] -> P (NonGreedy (ModuleHeadAndImports SrcSpanInfo))
Parseable (NonGreedy (ListOf (ModulePragma SrcSpanInfo)))
Instance details Defined in Language.Haskell.Exts.Parser Methods parse :: String -> ParseResult (NonGreedy (ListOf (ModulePragma SrcSpanInfo))) # parseWithMode :: ParseMode -> String -> ParseResult (NonGreedy (ListOf (ModulePragma SrcSpanInfo))) # parseWithComments :: ParseMode -> String -> ParseResult (NonGreedy (ListOf (ModulePragma SrcSpanInfo)), [Comment]) # parser :: Maybe [Fixity] -> P (NonGreedy (ListOf (ModulePragma SrcSpanInfo)))

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
Instance details Defined in Language.Haskell.Exts.ParseMonad Methods (>>=) :: ParseResult a -> (a -> ParseResult b) -> ParseResult b # (>>) :: ParseResult a -> ParseResult b -> ParseResult b # return :: a -> ParseResult a # fail :: String -> ParseResult a #
Functor ParseResult
Instance details Defined in Language.Haskell.Exts.ParseMonad Methods fmap :: (a -> b) -> ParseResult a -> ParseResult b # (<$) :: a -> ParseResult b -> ParseResult a #
MonadFail ParseResult
Instance details Defined in Language.Haskell.Exts.ParseMonad Methods fail :: String -> ParseResult a #
Applicative ParseResult
Instance details Defined in Language.Haskell.Exts.ParseMonad Methods pure :: a -> ParseResult a # (<>) :: ParseResult (a -> b) -> ParseResult a -> ParseResult b # liftA2 :: (a -> b -> c) -> ParseResult a -> ParseResult b -> ParseResult c # (>) :: ParseResult a -> ParseResult b -> ParseResult b # (<*) :: ParseResult a -> ParseResult b -> ParseResult a #
Eq a => Eq (ParseResult a)
Instance details Defined in Language.Haskell.Exts.ParseMonad Methods (==) :: ParseResult a -> ParseResult a -> Bool # (/=) :: ParseResult a -> ParseResult a -> Bool #
Ord a => Ord (ParseResult a)
Instance details Defined in Language.Haskell.Exts.ParseMonad Methods compare :: ParseResult a -> ParseResult a -> Ordering # (<) :: ParseResult a -> ParseResult a -> Bool # (<=) :: ParseResult a -> ParseResult a -> Bool # (>) :: ParseResult a -> ParseResult a -> Bool # (>=) :: ParseResult a -> ParseResult a -> Bool # max :: ParseResult a -> ParseResult a -> ParseResult a # min :: ParseResult a -> ParseResult a -> ParseResult a #
Show a => Show (ParseResult a)
Instance details Defined in Language.Haskell.Exts.ParseMonad Methods showsPrec :: Int -> ParseResult a -> ShowS # show :: ParseResult a -> String # showList :: [ParseResult a] -> ShowS #
Semigroup m => Semigroup (ParseResult m)
Instance details Defined in Language.Haskell.Exts.ParseMonad Methods (<>) :: ParseResult m -> ParseResult m -> ParseResult m # sconcat :: NonEmpty (ParseResult m) -> ParseResult m # stimes :: Integral b => b -> ParseResult m -> ParseResult m #
(Monoid m, Semigroup m) => Monoid (ParseResult m)
Instance details Defined in Language.Haskell.Exts.ParseMonad Methods mempty :: ParseResult m # mappend :: ParseResult m -> ParseResult m -> ParseResult m # mconcat :: [ParseResult m] -> ParseResult m #

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