{-# LANGUAGE GADTs #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE ViewPatterns #-}
{-# OPTIONS_GHC -fno-warn-orphans #-}

-- | Parser for Haskell source code.
module Ormolu.Parser
  ( parseModule,
    manualExts,
  )
where

import Control.Exception
import Control.Monad
import Control.Monad.Except (ExceptT (..), runExceptT)
import Control.Monad.IO.Class
import Data.Char (isSpace)
import Data.Functor
import Data.Generics hiding (orElse)
import Data.List qualified as L
import Data.List.NonEmpty qualified as NE
import Data.Text (Text)
import GHC.Builtin.Names (mAIN_NAME)
import GHC.Data.Bag (bagToList)
import GHC.Data.EnumSet qualified as EnumSet
import GHC.Data.FastString qualified as GHC
import GHC.Data.Maybe (orElse)
import GHC.Data.StringBuffer (StringBuffer)
import GHC.Driver.CmdLine qualified as GHC
import GHC.Driver.Config.Parser (initParserOpts)
import GHC.Driver.Errors.Types qualified as GHC
import GHC.Driver.Session as GHC
import GHC.DynFlags (baseDynFlags)
import GHC.Hs hiding (UnicodeSyntax)
import GHC.LanguageExtensions.Type (Extension (..))
import GHC.Parser qualified as GHC
import GHC.Parser.Annotation qualified as GHC
import GHC.Parser.Header qualified as GHC
import GHC.Parser.Lexer qualified as GHC
import GHC.Types.Error qualified as GHC
import GHC.Types.SourceError qualified as GHC
import GHC.Types.SrcLoc
import GHC.Utils.Error
import GHC.Utils.Exception (ExceptionMonad)
import GHC.Utils.Outputable (defaultSDocContext)
import GHC.Utils.Panic qualified as GHC
import Ormolu.Config
import Ormolu.Exception
import Ormolu.Fixity hiding (packageFixityMap)
import Ormolu.Fixity.Imports (applyModuleReexports, extractFixityImports)
import Ormolu.Imports (normalizeImports)
import Ormolu.Parser.CommentStream
import Ormolu.Parser.Result
import Ormolu.Processing.Common
import Ormolu.Processing.Preprocess
import Ormolu.Utils (incSpanLine, showOutputable, textToStringBuffer)

-- | Parse a complete module from 'Text'.
parseModule ::
  (MonadIO m) =>
  -- | Ormolu configuration
  Config RegionDeltas ->
  -- | Package fixity map
  PackageFixityMap ->
  -- | File name (only for source location annotations)
  FilePath ->
  -- | Input for parser
  Text ->
  m
    ( [GHC.Warn],
      Either (SrcSpan, String) [SourceSnippet]
    )
parseModule :: forall (m :: * -> *).
MonadIO m =>
Config RegionDeltas
-> PackageFixityMap
-> String
-> Text
-> m ([Warn], Either (SrcSpan, String) [SourceSnippet])
parseModule config :: Config RegionDeltas
config@Config {Bool
[DynOption]
Set PackageName
ColorMode
ModuleReexports
FixityOverrides
RegionDeltas
SourceType
cfgRegion :: forall region. Config region -> region
cfgColorMode :: forall region. Config region -> ColorMode
cfgSourceType :: forall region. Config region -> SourceType
cfgCheckIdempotence :: forall region. Config region -> Bool
cfgDebug :: forall region. Config region -> Bool
cfgUnsafe :: forall region. Config region -> Bool
cfgDependencies :: forall region. Config region -> Set PackageName
cfgModuleReexports :: forall region. Config region -> ModuleReexports
cfgFixityOverrides :: forall region. Config region -> FixityOverrides
cfgDynOptions :: forall region. Config region -> [DynOption]
cfgRegion :: RegionDeltas
cfgColorMode :: ColorMode
cfgSourceType :: SourceType
cfgCheckIdempotence :: Bool
cfgDebug :: Bool
cfgUnsafe :: Bool
cfgDependencies :: Set PackageName
cfgModuleReexports :: ModuleReexports
cfgFixityOverrides :: FixityOverrides
cfgDynOptions :: [DynOption]
..} PackageFixityMap
packageFixityMap String
path Text
rawInput = forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ do
  -- It's important that 'setDefaultExts' is done before
  -- 'parsePragmasIntoDynFlags', because otherwise we might enable an
  -- extension that was explicitly disabled in the file.
  let baseFlags :: DynFlags
baseFlags =
        GeneralFlag -> DynFlags -> DynFlags
GHC.setGeneralFlag'
          GeneralFlag
GHC.Opt_Haddock
          (DynFlags -> DynFlags
setDefaultExts DynFlags
baseDynFlags)
      extraOpts :: [Located String]
extraOpts = DynOption -> Located String
dynOptionToLocatedStr forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> [DynOption]
cfgDynOptions
      rawInputStringBuffer :: StringBuffer
rawInputStringBuffer = Text -> StringBuffer
textToStringBuffer Text
rawInput
      beginningLoc :: SrcSpan
beginningLoc =
        SrcLoc -> SrcLoc -> SrcSpan
mkSrcSpan
          (FastString -> Int -> Int -> SrcLoc
mkSrcLoc (String -> FastString
GHC.mkFastString String
path) Int
1 Int
1)
          (FastString -> Int -> Int -> SrcLoc
mkSrcLoc (String -> FastString
GHC.mkFastString String
path) Int
1 Int
1)
  ([Warn]
warnings, DynFlags
dynFlags) <-
    DynFlags
-> [Located String]
-> String
-> StringBuffer
-> IO (Either String ([Warn], DynFlags))
parsePragmasIntoDynFlags DynFlags
baseFlags [Located String]
extraOpts String
path StringBuffer
rawInputStringBuffer forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= \case
      Right ([Warn], DynFlags)
res -> forall (f :: * -> *) a. Applicative f => a -> f a
pure ([Warn], DynFlags)
res
      Left String
err -> forall e a. Exception e => e -> IO a
throwIO (SrcSpan -> String -> OrmoluException
OrmoluParsingFailed SrcSpan
beginningLoc String
err)
  let cppEnabled :: Bool
cppEnabled = forall a. Enum a => a -> EnumSet a -> Bool
EnumSet.member Extension
Cpp (DynFlags -> EnumSet Extension
GHC.extensionFlags DynFlags
dynFlags)
      implicitPrelude :: Bool
implicitPrelude = forall a. Enum a => a -> EnumSet a -> Bool
EnumSet.member Extension
ImplicitPrelude (DynFlags -> EnumSet Extension
GHC.extensionFlags DynFlags
dynFlags)
  [FixityImport]
fixityImports <-
    DynFlags
-> Bool
-> String
-> StringBuffer
-> IO (Either String [LImportDecl GhcPs])
parseImports DynFlags
dynFlags Bool
implicitPrelude String
path StringBuffer
rawInputStringBuffer forall (m :: * -> *) a b. Monad m => m a -> (a -> m b) -> m b
>>= \case
      Right [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
res ->
        forall (f :: * -> *) a. Applicative f => a -> f a
pure (ModuleReexports -> [FixityImport] -> [FixityImport]
applyModuleReexports ModuleReexports
cfgModuleReexports ([LImportDecl GhcPs] -> [FixityImport]
extractFixityImports [GenLocated SrcSpanAnnA (ImportDecl GhcPs)]
res))
      Left String
err ->
        forall e a. Exception e => e -> IO a
throwIO (SrcSpan -> String -> OrmoluException
OrmoluParsingFailed SrcSpan
beginningLoc String
err)
  let modFixityMap :: ModuleFixityMap
modFixityMap =
        FixityOverrides -> ModuleFixityMap -> ModuleFixityMap
applyFixityOverrides
          FixityOverrides
cfgFixityOverrides
          (PackageFixityMap -> [FixityImport] -> ModuleFixityMap
moduleFixityMap PackageFixityMap
packageFixityMap [FixityImport]
fixityImports)
  Either (SrcSpan, String) [SourceSnippet]
snippets <- forall e (m :: * -> *) a. ExceptT e m a -> m (Either e a)
runExceptT forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (t :: * -> *) (m :: * -> *) a b.
(Traversable t, Monad m) =>
t a -> (a -> m b) -> m (t b)
forM (Bool -> RegionDeltas -> Text -> [Either Text RegionDeltas]
preprocess Bool
cppEnabled RegionDeltas
cfgRegion Text
rawInput) forall a b. (a -> b) -> a -> b
$ \case
    Right RegionDeltas
region ->
      forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap ParseResult -> SourceSnippet
ParsedSnippet forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall e (m :: * -> *) a. m (Either e a) -> ExceptT e m a
ExceptT forall a b. (a -> b) -> a -> b
$
        forall (m :: * -> *).
MonadIO m =>
Config RegionDeltas
-> ModuleFixityMap
-> DynFlags
-> String
-> Text
-> m (Either (SrcSpan, String) ParseResult)
parseModuleSnippet (Config RegionDeltas
config forall (f :: * -> *) a b. Functor f => f a -> b -> f b
$> RegionDeltas
region) ModuleFixityMap
modFixityMap DynFlags
dynFlags String
path Text
rawInput
    Left Text
raw -> forall (f :: * -> *) a. Applicative f => a -> f a
pure forall a b. (a -> b) -> a -> b
$ Text -> SourceSnippet
RawSnippet Text
raw
  forall (f :: * -> *) a. Applicative f => a -> f a
pure ([Warn]
warnings, Either (SrcSpan, String) [SourceSnippet]
snippets)

parseModuleSnippet ::
  (MonadIO m) =>
  Config RegionDeltas ->
  ModuleFixityMap ->
  DynFlags ->
  FilePath ->
  Text ->
  m (Either (SrcSpan, String) ParseResult)
parseModuleSnippet :: forall (m :: * -> *).
MonadIO m =>
Config RegionDeltas
-> ModuleFixityMap
-> DynFlags
-> String
-> Text
-> m (Either (SrcSpan, String) ParseResult)
parseModuleSnippet Config {Bool
[DynOption]
Set PackageName
ColorMode
ModuleReexports
FixityOverrides
RegionDeltas
SourceType
cfgRegion :: RegionDeltas
cfgColorMode :: ColorMode
cfgSourceType :: SourceType
cfgCheckIdempotence :: Bool
cfgDebug :: Bool
cfgUnsafe :: Bool
cfgDependencies :: Set PackageName
cfgModuleReexports :: ModuleReexports
cfgFixityOverrides :: FixityOverrides
cfgDynOptions :: [DynOption]
cfgRegion :: forall region. Config region -> region
cfgColorMode :: forall region. Config region -> ColorMode
cfgSourceType :: forall region. Config region -> SourceType
cfgCheckIdempotence :: forall region. Config region -> Bool
cfgDebug :: forall region. Config region -> Bool
cfgUnsafe :: forall region. Config region -> Bool
cfgDependencies :: forall region. Config region -> Set PackageName
cfgModuleReexports :: forall region. Config region -> ModuleReexports
cfgFixityOverrides :: forall region. Config region -> FixityOverrides
cfgDynOptions :: forall region. Config region -> [DynOption]
..} ModuleFixityMap
modFixityMap DynFlags
dynFlags String
path Text
rawInput = forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO forall a b. (a -> b) -> a -> b
$ do
  let (Text
input, Int
indent) = Text -> (Text, Int)
removeIndentation forall b c a. (b -> c) -> (a -> b) -> a -> c
. RegionDeltas -> Text -> Text
linesInRegion RegionDeltas
cfgRegion forall a b. (a -> b) -> a -> b
$ Text
rawInput
  let pStateErrors :: PState -> Maybe (SrcSpan, String)
pStateErrors PState
pstate =
        let errs :: [MsgEnvelope PsMessage]
errs = forall a. Bag a -> [a]
bagToList forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall e. Messages e -> Bag (MsgEnvelope e)
GHC.getMessages forall a b. (a -> b) -> a -> b
$ PState -> Messages PsMessage
GHC.getPsErrorMessages PState
pstate
            fixupErrSpan :: SrcSpan -> SrcSpan
fixupErrSpan = Int -> SrcSpan -> SrcSpan
incSpanLine (RegionDeltas -> Int
regionPrefixLength RegionDeltas
cfgRegion)
            rateSeverity :: Severity -> Int
rateSeverity = \case
              Severity
SevError -> Int
1 :: Int
              Severity
SevWarning -> Int
2
              Severity
SevIgnore -> Int
3
            showErr :: MsgEnvelope a -> String
showErr (forall e. MsgEnvelope e -> e
errMsgDiagnostic -> a
err) = String
codeMsg forall a. Semigroup a => a -> a -> a
<> String
msg
              where
                codeMsg :: String
codeMsg = case forall a. Diagnostic a => a -> Maybe DiagnosticCode
diagnosticCode a
err of
                  Just DiagnosticCode
code -> String
"[" forall a. Semigroup a => a -> a -> a
<> forall o. Outputable o => o -> String
showOutputable DiagnosticCode
code forall a. Semigroup a => a -> a -> a
<> String
"] "
                  Maybe DiagnosticCode
Nothing -> String
""
                msg :: String
msg =
                  forall o. Outputable o => o -> String
showOutputable
                    forall b c a. (b -> c) -> (a -> b) -> a -> c
. SDocContext -> DecoratedSDoc -> SDoc
formatBulleted SDocContext
defaultSDocContext
                    forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a. Diagnostic a => DiagnosticOpts a -> a -> DecoratedSDoc
diagnosticMessage NoDiagnosticOpts
GHC.NoDiagnosticOpts
                    forall a b. (a -> b) -> a -> b
$ a
err
         in case forall b a. Ord b => (a -> b) -> [a] -> [a]
L.sortOn (Severity -> Int
rateSeverity forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall e. MsgEnvelope e -> Severity
errMsgSeverity) [MsgEnvelope PsMessage]
errs of
              [] -> forall a. Maybe a
Nothing
              MsgEnvelope PsMessage
err : [MsgEnvelope PsMessage]
_ ->
                forall a. a -> Maybe a
Just (SrcSpan -> SrcSpan
fixupErrSpan (forall e. MsgEnvelope e -> SrcSpan
errMsgSpan MsgEnvelope PsMessage
err), forall {a}.
(DiagnosticOpts a ~ NoDiagnosticOpts, Diagnostic a) =>
MsgEnvelope a -> String
showErr MsgEnvelope PsMessage
err)
      parser :: P (Located (HsModule GhcPs))
parser = case SourceType
cfgSourceType of
        SourceType
ModuleSource -> P (Located (HsModule GhcPs))
GHC.parseModule
        SourceType
SignatureSource -> P (Located (HsModule GhcPs))
GHC.parseSignature
      r :: Either (SrcSpan, String) ParseResult
r = case forall a. P a -> DynFlags -> String -> Text -> ParseResult a
runParser P (Located (HsModule GhcPs))
parser DynFlags
dynFlags String
path Text
input of
        GHC.PFailed PState
pstate ->
          case PState -> Maybe (SrcSpan, String)
pStateErrors PState
pstate of
            Just (SrcSpan, String)
err -> forall a b. a -> Either a b
Left (SrcSpan, String)
err
            Maybe (SrcSpan, String)
Nothing -> forall a. HasCallStack => String -> a
error String
"PFailed does not have an error"
        GHC.POk PState
pstate (L SrcSpan
_ (HsModule GhcPs -> HsModule GhcPs
normalizeModule -> HsModule GhcPs
hsModule)) ->
          case PState -> Maybe (SrcSpan, String)
pStateErrors PState
pstate of
            -- Some parse errors (pattern/arrow syntax in expr context)
            -- do not cause a parse error, but they are replaced with "_"
            -- by the parser and the modified AST is propagated to the
            -- later stages; but we fail in those cases.
            Just (SrcSpan, String)
err -> forall a b. a -> Either a b
Left (SrcSpan, String)
err
            Maybe (SrcSpan, String)
Nothing ->
              let (Maybe LComment
stackHeader, [([LComment], Pragma)]
pragmas, CommentStream
comments) =
                    Text
-> HsModule GhcPs
-> (Maybe LComment, [([LComment], Pragma)], CommentStream)
mkCommentStream Text
input HsModule GhcPs
hsModule
               in forall a b. b -> Either a b
Right
                    ParseResult
                      { prParsedSource :: HsModule GhcPs
prParsedSource = HsModule GhcPs
hsModule,
                        prSourceType :: SourceType
prSourceType = SourceType
cfgSourceType,
                        prStackHeader :: Maybe LComment
prStackHeader = Maybe LComment
stackHeader,
                        prPragmas :: [([LComment], Pragma)]
prPragmas = [([LComment], Pragma)]
pragmas,
                        prCommentStream :: CommentStream
prCommentStream = CommentStream
comments,
                        prExtensions :: EnumSet Extension
prExtensions = DynFlags -> EnumSet Extension
GHC.extensionFlags DynFlags
dynFlags,
                        prModuleFixityMap :: ModuleFixityMap
prModuleFixityMap = ModuleFixityMap
modFixityMap,
                        prIndent :: Int
prIndent = Int
indent
                      }
  forall (m :: * -> *) a. Monad m => a -> m a
return Either (SrcSpan, String) ParseResult
r

-- | Normalize a 'HsModule' by sorting its import\/export lists, dropping
-- blank comments, etc.
normalizeModule :: HsModule GhcPs -> HsModule GhcPs
normalizeModule :: HsModule GhcPs -> HsModule GhcPs
normalizeModule HsModule GhcPs
hsmod =
  (forall a. Data a => a -> a) -> forall a. Data a => a -> a
everywhere
    (forall a b.
(Typeable a, Typeable b) =>
(a -> a) -> (b -> b) -> a -> a
extT (forall a b. (Typeable a, Typeable b) => (b -> b) -> a -> a
mkT GenLocated SrcSpanAnnA (HsType GhcPs)
-> GenLocated SrcSpanAnnA (HsType GhcPs)
dropBlankTypeHaddocks) LHsContext GhcPs -> LHsContext GhcPs
patchContext)
    HsModule GhcPs
hsmod
      { hsmodImports :: [LImportDecl GhcPs]
hsmodImports =
          [LImportDecl GhcPs] -> [LImportDecl GhcPs]
normalizeImports (forall p. HsModule p -> [LImportDecl p]
hsmodImports HsModule GhcPs
hsmod),
        hsmodDecls :: [LHsDecl GhcPs]
hsmodDecls =
          forall a. (a -> Bool) -> [a] -> [a]
filter (Bool -> Bool
not forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall {pass}. HsDecl pass -> Bool
isBlankDocD forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc) (forall p. HsModule p -> [LHsDecl p]
hsmodDecls HsModule GhcPs
hsmod),
        hsmodExt :: XCModule GhcPs
hsmodExt =
          (forall p. HsModule p -> XCModule p
hsmodExt HsModule GhcPs
hsmod)
            { hsmodHaddockModHeader :: Maybe (LHsDoc GhcPs)
hsmodHaddockModHeader =
                forall (m :: * -> *) a. MonadPlus m => (a -> Bool) -> m a -> m a
mfilter (Bool -> Bool
not forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall {l} {pass}.
GenLocated l (WithHsDocIdentifiers HsDocString pass) -> Bool
isBlankDocString) (XModulePs -> Maybe (LHsDoc GhcPs)
hsmodHaddockModHeader (forall p. HsModule p -> XCModule p
hsmodExt HsModule GhcPs
hsmod))
            },
        hsmodExports :: Maybe (XRec GhcPs [LIE GhcPs])
hsmodExports =
          (forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap) (forall a. (a -> Bool) -> [a] -> [a]
filter (Bool -> Bool
not forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall {pass}. IE pass -> Bool
isBlankDocIE forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc)) (forall p. HsModule p -> Maybe (XRec p [LIE p])
hsmodExports HsModule GhcPs
hsmod)
      }
  where
    isBlankDocString :: GenLocated l (WithHsDocIdentifiers HsDocString pass) -> Bool
isBlankDocString = forall (t :: * -> *) a. Foldable t => (a -> Bool) -> t a -> Bool
all Char -> Bool
isSpace forall b c a. (b -> c) -> (a -> b) -> a -> c
. HsDocString -> String
renderHsDocString forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall a pass. WithHsDocIdentifiers a pass -> a
hsDocString forall b c a. (b -> c) -> (a -> b) -> a -> c
. forall l e. GenLocated l e -> e
unLoc
    isBlankDocD :: HsDecl pass -> Bool
isBlankDocD = \case
      DocD XDocD pass
_ DocDecl pass
s -> forall {l} {pass}.
GenLocated l (WithHsDocIdentifiers HsDocString pass) -> Bool
isBlankDocString forall a b. (a -> b) -> a -> b
$ forall pass. DocDecl pass -> LHsDoc pass
docDeclDoc DocDecl pass
s
      HsDecl pass
_ -> Bool
False
    isBlankDocIE :: IE pass -> Bool
isBlankDocIE = \case
      IEGroup XIEGroup pass
_ Int
_ LHsDoc pass
s -> forall {l} {pass}.
GenLocated l (WithHsDocIdentifiers HsDocString pass) -> Bool
isBlankDocString LHsDoc pass
s
      IEDoc XIEDoc pass
_ LHsDoc pass
s -> forall {l} {pass}.
GenLocated l (WithHsDocIdentifiers HsDocString pass) -> Bool
isBlankDocString LHsDoc pass
s
      IE pass
_ -> Bool
False
    dropBlankTypeHaddocks :: LHsType GhcPs -> LHsType GhcPs
dropBlankTypeHaddocks = \case
      L SrcSpanAnnA
_ (HsDocTy XDocTy GhcPs
_ LHsType GhcPs
ty LHsDoc GhcPs
s) :: LHsType GhcPs
        | forall {l} {pass}.
GenLocated l (WithHsDocIdentifiers HsDocString pass) -> Bool
isBlankDocString LHsDoc GhcPs
s -> LHsType GhcPs
ty
      LHsType GhcPs
a -> LHsType GhcPs
a
    patchContext :: LHsContext GhcPs -> LHsContext GhcPs
    patchContext :: LHsContext GhcPs -> LHsContext GhcPs
patchContext = forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap forall a b. (a -> b) -> a -> b
$ \case
      [x :: GenLocated SrcSpanAnnA (HsType GhcPs)
x@(L SrcSpanAnnA
_ (HsParTy XParTy GhcPs
_ LHsType GhcPs
_))] -> [GenLocated SrcSpanAnnA (HsType GhcPs)
x]
      [x :: GenLocated SrcSpanAnnA (HsType GhcPs)
x@(L SrcSpanAnnA
lx HsType GhcPs
_)] -> [forall l e. l -> e -> GenLocated l e
L SrcSpanAnnA
lx (forall pass. XParTy pass -> LHsType pass -> HsType pass
HsParTy forall ann. EpAnn ann
EpAnnNotUsed GenLocated SrcSpanAnnA (HsType GhcPs)
x)]
      [GenLocated SrcSpanAnnA (HsType GhcPs)]
xs -> [GenLocated SrcSpanAnnA (HsType GhcPs)]
xs

-- | Enable all language extensions that we think should be enabled by
-- default for ease of use.
setDefaultExts :: DynFlags -> DynFlags
setDefaultExts :: DynFlags -> DynFlags
setDefaultExts DynFlags
flags = forall (t :: * -> *) b a.
Foldable t =>
(b -> a -> b) -> b -> t a -> b
L.foldl' DynFlags -> Extension -> DynFlags
xopt_set (DynFlags -> Maybe Language -> DynFlags
lang_set DynFlags
flags (forall a. a -> Maybe a
Just Language
Haskell2010)) [Extension]
autoExts
  where
    autoExts :: [Extension]
autoExts = [Extension]
allExts forall a. Eq a => [a] -> [a] -> [a]
L.\\ [Extension]
manualExts
    allExts :: [Extension]
allExts = [forall a. Bounded a => a
minBound .. forall a. Bounded a => a
maxBound]

-- | Extensions that are not enabled automatically and should be activated
-- by user.
manualExts :: [Extension]
manualExts :: [Extension]
manualExts =
  [ Extension
Arrows, -- steals proc
    Extension
Cpp, -- forbidden
    Extension
BangPatterns, -- makes certain patterns with ! fail
    Extension
PatternSynonyms, -- steals the pattern keyword
    Extension
RecursiveDo, -- steals the rec keyword
    Extension
StaticPointers, -- steals static keyword
    Extension
TransformListComp, -- steals the group keyword
    Extension
UnboxedTuples, -- breaks (#) lens operator
    Extension
MagicHash, -- screws {-# these things #-}
    Extension
AlternativeLayoutRule,
    Extension
AlternativeLayoutRuleTransitional,
    Extension
MonadComprehensions,
    Extension
UnboxedSums,
    Extension
UnicodeSyntax, -- gives special meanings to operators like (→)
    Extension
TemplateHaskell, -- changes how $foo is parsed
    Extension
TemplateHaskellQuotes, -- enables TH subset of quasi-quotes, this
    -- apparently interferes with QuasiQuotes in
    -- weird ways
    Extension
ImportQualifiedPost, -- affects how Ormolu renders imports, so the
    -- decision of enabling this style is left to the user
    Extension
NegativeLiterals, -- with this, `- 1` and `-1` have differing AST
    Extension
LexicalNegation, -- implies NegativeLiterals
    Extension
LinearTypes, -- steals the (%) type operator in some cases
    Extension
OverloadedRecordDot, -- f.g parses differently
    Extension
OverloadedRecordUpdate, -- qualified fields are not supported
    Extension
OverloadedLabels -- a#b is parsed differently
  ]

-- | Run a 'GHC.P' computation.
runParser ::
  -- | Computation to run
  GHC.P a ->
  -- | Dynamic flags
  GHC.DynFlags ->
  -- | Module path
  FilePath ->
  -- | Module contents
  Text ->
  -- | Parse result
  GHC.ParseResult a
runParser :: forall a. P a -> DynFlags -> String -> Text -> ParseResult a
runParser P a
parser DynFlags
flags String
filename Text
input = forall a. P a -> PState -> ParseResult a
GHC.unP P a
parser PState
parseState
  where
    location :: RealSrcLoc
location = FastString -> Int -> Int -> RealSrcLoc
mkRealSrcLoc (String -> FastString
GHC.mkFastString String
filename) Int
1 Int
1
    buffer :: StringBuffer
buffer = Text -> StringBuffer
textToStringBuffer Text
input
    parseState :: PState
parseState = ParserOpts -> StringBuffer -> RealSrcLoc -> PState
GHC.initParserState (DynFlags -> ParserOpts
initParserOpts DynFlags
flags) StringBuffer
buffer RealSrcLoc
location

----------------------------------------------------------------------------
-- Helpers taken from HLint

-- | Detect pragmas in the given input and return them as a collection of
-- 'DynFlags'.
parsePragmasIntoDynFlags ::
  -- | Pre-set 'DynFlags'
  DynFlags ->
  -- | Extra options (provided by user)
  [Located String] ->
  -- | File name (only for source location annotations)
  FilePath ->
  -- | Input for parser
  StringBuffer ->
  IO (Either String ([GHC.Warn], DynFlags))
parsePragmasIntoDynFlags :: DynFlags
-> [Located String]
-> String
-> StringBuffer
-> IO (Either String ([Warn], DynFlags))
parsePragmasIntoDynFlags DynFlags
flags [Located String]
extraOpts String
filepath StringBuffer
input =
  forall (m :: * -> *) a.
ExceptionMonad m =>
m (Either String a) -> m (Either String a)
catchGhcErrors forall a b. (a -> b) -> a -> b
$ do
    let (Messages PsMessage
_warnings, [Located String]
fileOpts) =
          ParserOpts
-> StringBuffer -> String -> (Messages PsMessage, [Located String])
GHC.getOptions
            (DynFlags -> ParserOpts
initParserOpts DynFlags
flags)
            StringBuffer
input
            String
filepath
    (DynFlags
flags', [Located String]
leftovers, [Warn]
warnings) <-
      forall (m :: * -> *).
MonadIO m =>
DynFlags
-> [Located String] -> m (DynFlags, [Located String], [Warn])
parseDynamicFilePragma DynFlags
flags ([Located String]
extraOpts forall a. Semigroup a => a -> a -> a
<> [Located String]
fileOpts)
    case forall a. [a] -> Maybe (NonEmpty a)
NE.nonEmpty [Located String]
leftovers of
      Maybe (NonEmpty (Located String))
Nothing -> forall (m :: * -> *) a. Monad m => a -> m a
return ()
      Just NonEmpty (Located String)
unrecognizedOpts ->
        forall e a. Exception e => e -> IO a
throwIO (NonEmpty String -> OrmoluException
OrmoluUnrecognizedOpts (forall l e. GenLocated l e -> e
unLoc forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> NonEmpty (Located String)
unrecognizedOpts))
    let flags'' :: DynFlags
flags'' = DynFlags
flags' DynFlags -> GeneralFlag -> DynFlags
`gopt_set` GeneralFlag
Opt_KeepRawTokenStream
    forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a b. b -> Either a b
Right ([Warn]
warnings, DynFlags
flags'')

-- | Detect the collection of imports used in the given input.
parseImports ::
  -- | Pre-set 'DynFlags'
  DynFlags ->
  -- | Implicit Prelude?
  Bool ->
  -- | File name (only for source location annotations)
  FilePath ->
  -- | Input for the parser
  StringBuffer ->
  IO (Either String [LImportDecl GhcPs])
parseImports :: DynFlags
-> Bool
-> String
-> StringBuffer
-> IO (Either String [LImportDecl GhcPs])
parseImports DynFlags
flags Bool
implicitPrelude String
filepath StringBuffer
input =
  case forall a. P a -> PState -> ParseResult a
GHC.unP P (Located (HsModule GhcPs))
GHC.parseHeader (ParserOpts -> StringBuffer -> RealSrcLoc -> PState
GHC.initParserState ParserOpts
popts StringBuffer
input RealSrcLoc
loc) of
    GHC.PFailed PState
pst ->
      forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a b. a -> Either a b
Left (forall o. Outputable o => o -> String
showOutputable (PState -> Messages PsMessage
GHC.getPsErrorMessages PState
pst))
    GHC.POk PState
pst Located (HsModule GhcPs)
rdr_module ->
      forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$
        let (Messages PsMessage
_warnings, Messages PsMessage
errors) = PState -> (Messages PsMessage, Messages PsMessage)
GHC.getPsMessages PState
pst
         in if Bool -> Bool
not (forall e. Messages e -> Bool
isEmptyMessages Messages PsMessage
errors)
              then forall a b. a -> Either a b
Left (forall o. Outputable o => o -> String
showOutputable (PsMessage -> GhcMessage
GHC.GhcPsMessage forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Messages PsMessage
errors))
              else
                let hsmod :: HsModule GhcPs
hsmod = forall l e. GenLocated l e -> e
unLoc Located (HsModule GhcPs)
rdr_module
                    mmoduleName :: Maybe (XRec GhcPs ModuleName)
mmoduleName = forall p. HsModule p -> Maybe (XRec p ModuleName)
hsmodName HsModule GhcPs
hsmod
                    main_loc :: SrcSpan
main_loc = SrcLoc -> SrcSpan
srcLocSpan (FastString -> Int -> Int -> SrcLoc
mkSrcLoc (String -> FastString
GHC.mkFastString String
filepath) Int
1 Int
1)
                    mod' :: GenLocated SrcSpanAnnA ModuleName
mod' = Maybe (XRec GhcPs ModuleName)
mmoduleName forall a. Maybe a -> a -> a
`orElse` forall l e. l -> e -> GenLocated l e
L (forall ann. SrcSpan -> SrcAnn ann
GHC.noAnnSrcSpan SrcSpan
main_loc) ModuleName
mAIN_NAME
                    explicitImports :: [LImportDecl GhcPs]
explicitImports = forall p. HsModule p -> [LImportDecl p]
hsmodImports HsModule GhcPs
hsmod
                    implicitImports :: [LImportDecl GhcPs]
implicitImports =
                      ModuleName
-> SrcSpan -> Bool -> [LImportDecl GhcPs] -> [LImportDecl GhcPs]
GHC.mkPrelImports (forall l e. GenLocated l e -> e
unLoc GenLocated SrcSpanAnnA ModuleName
mod') SrcSpan
main_loc Bool
implicitPrelude [LImportDecl GhcPs]
explicitImports
                 in forall a b. b -> Either a b
Right ([LImportDecl GhcPs]
explicitImports forall a. [a] -> [a] -> [a]
++ [LImportDecl GhcPs]
implicitImports)
  where
    popts :: ParserOpts
popts = DynFlags -> ParserOpts
initParserOpts DynFlags
flags
    loc :: RealSrcLoc
loc = FastString -> Int -> Int -> RealSrcLoc
mkRealSrcLoc (String -> FastString
GHC.mkFastString String
filepath) Int
1 Int
1

-- | Catch and report GHC errors.
catchGhcErrors :: (ExceptionMonad m) => m (Either String a) -> m (Either String a)
catchGhcErrors :: forall (m :: * -> *) a.
ExceptionMonad m =>
m (Either String a) -> m (Either String a)
catchGhcErrors m (Either String a)
m =
  forall (m :: * -> *) a.
ExceptionMonad m =>
(GhcException -> m a) -> m a -> m a
GHC.handleGhcException
    forall {m :: * -> *} {a} {b}.
(Monad m, Show a) =>
a -> m (Either String b)
reportErr
    (forall (m :: * -> *) a.
MonadCatch m =>
(SourceError -> m a) -> m a -> m a
GHC.handleSourceError forall {m :: * -> *} {a} {b}.
(Monad m, Show a) =>
a -> m (Either String b)
reportErr m (Either String a)
m)
  where
    reportErr :: a -> m (Either String b)
reportErr a
e = forall (m :: * -> *) a. Monad m => a -> m a
return forall a b. (a -> b) -> a -> b
$ forall a b. a -> Either a b
Left (forall a. Show a => a -> String
show a
e)