Language.Haskell.GHC.ExactPrint.Parsers · ghc-exactprint-1.10.0.0

Utility

6 declarations

typetype Parser a = DynFlags -> FilePath -> String -> ParseResult a

#

typetype ParseResult a = Either ErrorMessages a

#

valuewithDynFlags :: LibDir -> (DynFlags -> a) -> IO a

#

Provides a safe way to consume a properly initialised set of DynFlags.

myParser fname expr = withDynFlags (\d -> parseExpr d fname expr)

datadata CppOptions

#

Constructors

CppOptions
- cppDefine :: [String]
  CPP #define macros
- cppInclude :: [FilePath]
  CPP Includes directory
- cppFile :: [FilePath]
  CPP pre-include file

valuedefaultCppOptions :: CppOptions

#

typetype LibDir = FilePath

#

Module Parsers

4 declarations

valueparseModule :: LibDir -> FilePath -> IO (ParseResult ParsedSource)

#

This entry point will also work out which language extensions are required and perform CPP processing if necessary.

parseModule = parseModuleWithCpp defaultCppOptions

Note: ParsedSource is a synonym for Located (HsModule GhcPs)

valueparseModuleFromString

#

This entry point will work out which language extensions are required but will _not_ perform CPP processing. In contrast to parseModoule the input source is read from the provided string; the FilePath parameter solely exists to provide a name in source location annotations.

valueparseModuleWithOptions

:: LibDir
GHC libdir
-> FilePath
-> IO (ParseResult ParsedSource)

#

valueparseModuleWithCpp

:: LibDir
GHC libdir
-> CppOptions
-> FilePath
File to be parsed
-> IO (ParseResult ParsedSource)

#

Parse a module with specific instructions for the C pre-processor.

Basic Parsers

7 declarations

valueparseExpr :: Parser (LHsExpr GhcPs)

#

valueparseImport :: Parser (LImportDecl GhcPs)

#

valueparseType :: Parser (LHsType GhcPs)

#

valueparseDecl :: Parser (LHsDecl GhcPs)

#

valueparsePattern :: Parser (LPat GhcPs)

#

valueparseStmt :: Parser (ExprLStmt GhcPs)

#

valueparseWith :: DynFlags -> FilePath -> P w -> String -> ParseResult w

#

Wrapper function which returns Annotations along with the parsed element.

Internal

7 declarations

valueghcWrapper :: LibDir -> Ghc a -> IO a

#

Internal function. Default runner of GHC.Ghc action in IO.

valueinitDynFlags :: GhcMonad m => FilePath -> m DynFlags

#

Internal function. Initializes DynFlags value for parsing.

Passes "-hide-all-packages" to the GHC API to prevent parsing of package environment files. However this only works if there is no invocation of setSessionDynFlags before calling initDynFlags. See ghc tickets #15513, #15541.

valueinitDynFlagsPure :: GhcMonad m => FilePath -> String -> m DynFlags

#

Requires GhcMonad constraint because there is no pure variant of parseDynamicFilePragma. Yet, in constrast to initDynFlags, it does not (try to) read the file at filepath, but solely depends on the module source in the input string.

Passes "-hide-all-packages" to the GHC API to prevent parsing of package environment files. However this only works if there is no invocation of setSessionDynFlags before calling initDynFlagsPure. See ghc tickets #15513, #15541.